popular 0.5.1 → 0.6.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NWQyNWFkOTY3ZjlhNTY0Y2JhZTFmZjM4NGUxNmQ1YjZjZjhlYmRkMg==
+    ZGExM2NmNGUxNmI3ZTk5MjgwMDE2OTJiN2E3NWY0Njk4NTgxMjZiZg==
   data.tar.gz: !binary |-
-    ODhhNmU2ZDc1ODU0NGU2YjU1Zjc0ZjU1YjFjYWQyZTlhMmIyNDkwMg==
+    OWY2NTBmYzRlMmI3NDIzMTU5YmI4MzVmMGVhNTg3MzdmZGQ2NzkyYg==
 SHA512:
   metadata.gz: !binary |-
-    M2NjNzI0MGY5NTQyZGYxNDZiNGJjMDZhZWQ4YmIxYWI2MDM5YTY3MjhiZDkx
-    MzhjYzM5ZjNhYzA1OWQzN2Y2ZTc2NTFiN2U1NDMyZGRjZTViNTk0NTgxMDcw
-    MTlkZmRhZDM4NzAxYjQyMWRhNGYzY2QwODRiN2EwZTAyOWM2MWE=
+    NjYxZjRhZGI3YTI0NmNiY2Q1NDZhNWVjYzQ2MDdiOTEyYjY2YzJmMTZkZTEz
+    MzgwY2ZmNWNiYTUwZjk4ZjBiZTkxNzFlZjU4ZmUwNjJkNWRhZDI4ZDZiODc3
+    YjJhMmU4M2U1YTZjN2VlMzQ5NjE2NzI3YzcwOTNhN2FjMzI0MjY=
   data.tar.gz: !binary |-
-    YjJmYmNkZGQxYzA2Zjk4NjJjZDcyNjU3YzIyOTEwMjhhYjk0OGVmMDJiOWY3
-    NzUzNTk4ZjE3ZmVhYTA4MzM1NWIyZmUxMDc5NTAyMzA5MjU2NjA0NWE3ZGE1
-    NGI2NmFjNzk3MzBmNTQ0ZjczMWU0NzlmMTQzOTc3MmRiNDM0ZTM=
+    OWMyZTZmM2U0Yjc3MmMyMTU0MGJlNGM5YmZiODQxNzZjZDdmYzkzNmFkMGY3
+    NGEzYjljYjU1MTk3NDczNmJjZjU1YjZmYWNhOTQxZmJiMTIyNjFjNDQ1Yzlh
+    NTA4NTAyZjhlNDEyOWRmNzMzZTZiMWFlYmUyZDE0YjMxMTAyN2E=

data/README.md

@@ -8,6 +8,10 @@
 
 Popular is a friendship gem designed for Rails/ActiveRecord models.
 
+- RubyGems: ( https://rubygems.org/gems/popular )
+- Website: ( http://thejchap.github.io/popular )
+- RDoc: ( http://rubydoc.info/github/thejchap/popular/master/frames )
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -61,6 +65,20 @@ end
 @sam.mutual_friends_with? @jackson  #=> true
 ```
 
+### Aliases
+
+In Popular, `befriend` is synonomous with `follow`, so if it better fits the context of your application, you can use
+follow methods/relations instead. For example:
+
+```ruby
+@sam.follow @jackson
+@sam.following? @jackson          #=> true
+
+@jackson.follow @sam
+@sam.followers.include? @jackson  #=> true
+```
+
+
 ### Callbacks
 
 Popular provides callbacks that are fired around friendship creation. Available callbacks are:
@@ -92,6 +110,22 @@ end
 @justin.unfriend @jenny #=> ":("
 ```
 
+## Related gems
+
+If Popular isn't quite what you're looking for, here are some other useful gems in the same category:
+
+- Amistad ( https://github.com/raw1z/amistad )
+- Friendable ( https://github.com/yuki24/friendable )
+
+*Disclaimer: I have not used either of the above gems*
+
+
+## Resources
+
+Popular was heavily inspired by this screencast: ( http://railscasts.com/episodes/163-self-referential-association?view=asciicast )
+
+
+
 ## Contributing
 
 1. Fork it ( http://github.com/thejchap/popular/fork )

data/lib/popular/popular.rb

@@ -5,6 +5,11 @@ module Popular
     extend ActiveSupport::Concern
 
     included do |base|
+      has_many :followings, class_name: 'Popular::Friendship', as: :popular_model, dependent: :destroy
+      has_many :followeds, through: :followings, source: :friend, source_type: base
+      has_many :inverse_followings, class_name: 'Popular::Friendship', as: :friend, foreign_key: :friend_id
+      has_many :followers, through: :inverse_followings, source: :popular_model, source_type: base
+
       has_many :friendships, class_name: 'Popular::Friendship', as: :popular_model, dependent: :destroy
       has_many :friends, through: :friendships, source_type: base
       has_many :inverse_friendships, class_name: 'Popular::Friendship', as: :friend, foreign_key: :friend_id
@@ -16,6 +21,18 @@ module Popular
       [:before_unfriend, :after_unfriend, :before_befriend, :after_befriend].each do |callback|
         send callback
       end
+
+      aliases = {
+        befriend: [:follow],
+        befriend!: [:follow!],
+        unfriend: [:unfollow],
+        friends_with?: [:following?],
+        friended_by?: [:followed_by?]
+      }
+
+      aliases.each do |method, links|
+        links.each { |linked_method| alias_method( linked_method, method ) }
+      end
     end
 
     # Adds a friend to an instance's friend's list

data/lib/popular/version.rb

@@ -1,3 +1,3 @@
 module Popular
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/spec/popular/popular_model_spec.rb

@@ -1,10 +1,19 @@
 shared_examples "a popular model" do
 
   describe 'mutual friendships' do
-    it '.inverse_friends includes popular_models who have added an instance as a friend' do
-      another_popular_model.befriend popular_model
+    describe '.inverse_friends' do
+      it 'includes popular_models who have added an instance as a friend' do
+        another_popular_model.befriend popular_model
+
+        expect( popular_model ).to be_friended_by another_popular_model
+      end
 
-      expect( popular_model ).to be_friended_by another_popular_model
+      it 'can be called with followers' do
+        another_popular_model.follow popular_model
+
+        expect( popular_model ).to be_followed_by another_popular_model
+        expect( popular_model.followers ).to match_array [another_popular_model]
+      end
     end
 
     it '#mutual_friends_with? returns false if instances are not mutual friends' do
@@ -20,6 +29,12 @@ shared_examples "a popular model" do
   end
 
   describe '.befriend!' do
+    it 'can be called with .follow!' do
+      popular_model.follow! another_popular_model
+
+      expect( popular_model).to be_following another_popular_model
+    end
+
     it 'creates a one way friendship' do
       popular_model.befriend! another_popular_model
 
@@ -42,6 +57,12 @@ shared_examples "a popular model" do
   end
 
   describe '.befriend' do
+    it 'can be called with .follow' do
+      popular_model.follow another_popular_model
+
+      expect( popular_model).to be_following another_popular_model
+    end
+
 
     context 'successful' do
       it 'triggers before_befriend callback' do
@@ -66,7 +87,7 @@ shared_examples "a popular model" do
   end
 
   describe '#friends_with?' do
-    it 'returns true if a popular_model is friends with a given popular_model' do
+    it 'returns false if a popular_model is not friends with a given popular_model' do
       expect( popular_model ).to_not be_friends_with another_popular_model
     end
 
@@ -78,6 +99,14 @@ shared_examples "a popular model" do
   end
 
   describe '.unfriend' do
+    it 'can be called with .unfollow' do
+      [:follow, :unfollow].each do |method|
+        popular_model.send method, another_popular_model
+      end
+
+      expect( popular_model).to_not be_following another_popular_model
+    end
+
     it 'destroys a friendship' do
       [:befriend, :unfriend].each do |method|
         popular_model.send method, another_popular_model

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: popular
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - thejchap