Add friendship features to your ActiveRecord models.
HasFriendship allows ActiveRecord objects to send, accept, and decline friend requests using self-refernetial polymorphic association.
Add HasFriendship to your Gemfile:
gem 'has_friendship'
After you install HasFriendship, you need to run the generator:
$ rails generate has_friendship
The generator will copy a migration that creates friendships
table. Run the migration to finish the setup.
$ rake db:migrate
Simply drop in has_friendship
to a model:
class User < ActiveRecord::Base
has_friendship
end
Now, instances of User
can send, accept, and decline friend requests:
@mac = User.create(name: "Mac")
@dee = User.create(name: "Dee")
# @mac sends a friend request to @dee
@mac.friend_request(@dee)
# @dee can accept the friend request
@dee.accept_request(@mac)
# @dee can also decline the friend request
@dee.decline_request(@mac)
A Friendship can also be removed:
# @dee removes @mac from its friends
@dee.remove_friend(@mac)
# Check if there is an accepted friendship between @mac and @dee
@mac.friends_with?(@dee)
There are three types of friends:
- requested_friends
- pending_friends
- friends
They can be accessed using association.
Instances that sent friend request that has not been accepted.
@mac.friend_request(@dee)
@dee.requested_friends # => [@mac]
Instances that received but has not accepted the friend request.
@mac.friend_request(@dee)
@mac.pending_friends # => [@dee]
Instances with accepted Friendship.
@mac.friend_request(@dee)
@dee.accept_request(@mac)
@mac.friends # => [@dee]
@dee.friends # => [@mac]
Issues and pull requests are welcomed.