popular 0.3.2 → 0.4.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDBkZDk2OTY1OTczYjYzMzkzOTVmN2QyZDMyMjYwNmE1ZjBjOWYxOA==
+    NzNkYjliYTc5YjZhMTQ0YzYzZDQ3NGY0ZGI1M2VkMjRhMjBlZDcyZQ==
   data.tar.gz: !binary |-
-    NTA3NTI1MmUwY2UzMzk1MWY1MTMxM2FmZGQxNzE4NTZmMGVjY2ZhZA==
+    MzdlYjQzM2UwNWJkZGI3NTVmMDVlMDgzNTg3YWMzMmM4NzUxMDY5Zg==
 SHA512:
   metadata.gz: !binary |-
-    ZDc4MDI4NjI3OWNlNmM4MzRmNzVmMzYxZDBjYWRhYzFjNDgxM2E2NWExMDRk
-    ZjgwNjZmMDAyYzQzOGE3NzkxMDZjNjA3MWVlZTVkMzIyZDk4NjllMjQ4YzRj
-    NDU5ZjZhMjMxZGE4OGM2Njk2NGM0NGE5ZGRjNGU3ZDQ4MTMxMWU=
+    N2YyOGQ2ZmUwNDczNzVhNjhlYjA3N2M2N2MzNjJkODQ4ODMzNWU0YjJkODcz
+    ZWM0Yzc0OGU3OWU5OTBiMTAzMGI2YWEwMTZkNDM0MDNhZDVkOGQ2NGU0MTYy
+    NmFhOGIwMTE5NjdjZDU2YTQ3ZGE1NjY1YWZmMWViMWNiOTU3MmY=
   data.tar.gz: !binary |-
-    OThiOGJlNDljMmUzMTNmOTI4NGNkYmFmYzliOWJiNzgxODAwYzEzODljZGUx
-    N2YzNjg3NTVlODFjN2NhZjUyMDc1MzgzNTIyOGFhMTIxYTM0NGE5OTYyZjA4
-    MDI3Y2E5YmI1MmVkOTJhYjZhZDlmMTlmMWZlNjEwMjFiNzM3OTA=
+    Y2YwNTRhZDI5YWNkMzc5NjNjYjg3ZDRmZDQzNWQ0NmEzMjYwMjU1N2IzODk5
+    ZjUxOTNiOWM5NWM0ZjZhNmIwZjY5MzU3OWFmYTc3ZjM2ZDFhZGY3ODRhYjc2
+    NzQxZDM5ZWYyZDJjMjhmN2JhMmRkZTQwYWIxZDJmYjI2NzY1NjQ=

data/README.md

@@ -59,22 +59,30 @@ end
 Popular provides callbacks that are fired around friendship creation. Available callbacks are:
   - after_befriend
   - before_befriend
+  - after_unfriend
+  - before_unfriend
 
 
 ```ruby
 class User < ActiveRecord::Base
   popular
-  after_befriend :notify
+  after_befriend :notify_friendship_created
+  after_unfriend :notify_unfriended
 
-  def notify
+  def notify_friendship_created
     puts "Friendship created successfully"
   end
+
+  def notify_unfriended
+    puts ":("
+  end
 end
 
 @justin = User.create name: "Justin"
 @jenny = User.create name: "Jenny"
 
 @justin.befriend @jenny #=> "Friendship created successfully"
+@justin.unfriend @jenny #=> ":("
 ```
 
 ## Contributing

data/lib/popular/popular.rb

@@ -9,9 +9,9 @@ module Popular
       has_many :friends, through: :friendships, source_type: base
 
       include ActiveSupport::Callbacks
-      define_callbacks :befriend
+      define_callbacks :befriend, :unfriend
 
-      [:before_befriend, :after_befriend].each do |callback|
+      [:before_unfriend, :after_unfriend, :before_befriend, :after_befriend].each do |callback|
         send callback
       end
     end
@@ -61,7 +61,9 @@ module Popular
     #
     #   user.friends_with? other_user # => false
     def unfriend friend
-      friendships.where( friend: friend ).first.destroy
+      run_callbacks :unfriend do
+        friendships.where( friend: friend ).first.destroy
+      end
     end
 
     # Helper method for finding whether or not the instance is friends with 
@@ -86,6 +88,52 @@ module Popular
     # ClassMethods included in popular models
     module ClassMethods
 
+      # after_unfriend callback convenience class method
+      #
+      # @since 0.4.0
+      #
+      # @example
+      #
+      #   class User < ActiveRecord::Base
+      #     after_unfriend :do_something_amazing
+      #
+      #     def do_something_amazing
+      #       puts name
+      #     end
+      #   end
+      #
+      #   user = User.create name: "Justin"
+      #   another_user = User.create name: "Jenny"
+      #
+      #   user.befriend another_user
+      #   user.unfriend another_user #=> "Justin"
+      def after_unfriend *args, &blk
+        set_callback :unfriend, :after, *args, &blk
+      end
+
+      # before_unfriend callback convenience class method
+      #
+      # @since 0.4.0
+      #
+      # @example
+      #
+      #   class User < ActiveRecord::Base
+      #     before_unfriend :do_something_amazing
+      #
+      #     def do_something_amazing
+      #       puts name
+      #     end
+      #   end
+      #
+      #   user = User.create name: "Justin"
+      #   another_user = User.create name: "Jenny"
+      #
+      #   user.befriend another_user
+      #   user.unfriend another_user #=> "Justin"
+      def before_unfriend *args, &blk
+        set_callback :unfriend, :before, *args, &blk
+      end
+
       # before_befriend callback convenience class method
       #
       # @since 0.3.0

data/lib/popular/version.rb

@@ -1,3 +1,3 @@
 module Popular
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/spec/popular/popular_model_spec.rb

@@ -8,22 +8,16 @@ shared_examples "a popular model" do
     end
 
     it 'triggers before_befriend callback' do
-        popular_model_with_before_befriend_callback
-          .should_receive( :callback_worked )
-          .once
-          .and_return true
+      ensure_callback_fired_on popular_model_with_callbacks, :before_befriend_callback
 
-        popular_model_with_before_befriend_callback.befriend! another_popular_model
+      popular_model_with_callbacks.befriend! another_popular_model
     end
 
     context 'successful' do
       it 'triggers after_befriend callback' do
-        popular_model_with_after_befriend_callback
-          .should_receive( :callback_worked )
-          .once
-          .and_return true
+        ensure_callback_fired_on popular_model_with_callbacks, :after_befriend_callback
 
-        popular_model_with_after_befriend_callback.befriend! another_popular_model
+        popular_model_with_callbacks.befriend! another_popular_model
       end
     end
   end
@@ -31,13 +25,16 @@ shared_examples "a popular model" do
   describe '.befriend' do
 
     context 'successful' do
+      it 'triggers before_befriend callback' do
+        ensure_callback_fired_on popular_model_with_callbacks, :before_befriend_callback
+
+        popular_model_with_callbacks.befriend another_popular_model
+      end
+
       it 'triggers after_befriend callback' do
-        popular_model_with_after_befriend_callback
-          .should_receive( :callback_worked )
-          .once
-          .and_return true
+        ensure_callback_fired_on popular_model_with_callbacks, :after_befriend_callback
 
-        popular_model_with_after_befriend_callback.befriend another_popular_model
+        popular_model_with_callbacks.befriend another_popular_model
       end
 
       it 'creates a one way friendship' do
@@ -53,6 +50,7 @@ shared_examples "a popular model" do
     it 'returns true if a popular_model is friends with a given popular_model' do
       expect( popular_model ).to_not be_friends_with another_popular_model
     end
+
     it 'returns true if a popular_model is friends with a given popular_model' do
       popular_model.befriend another_popular_model
 
@@ -68,6 +66,25 @@ shared_examples "a popular model" do
 
       expect( popular_model).to_not be_friends_with another_popular_model
     end
+
+    it 'triggers before_unfriend callback' do
+      ensure_callback_fired_on popular_model_with_callbacks, :before_unfriend_callback
+
+      [:befriend, :unfriend].each do |method|
+        popular_model_with_callbacks.send method, another_popular_model
+      end
+    end
+
+    it 'triggers after_unfriend callback' do
+      ensure_callback_fired_on popular_model_with_callbacks, :after_unfriend_callback
+
+      [:befriend, :unfriend].each do |method|
+        popular_model_with_callbacks.send method, another_popular_model
+      end
+    end
   end
 
+  def ensure_callback_fired_on model, method
+    model.send( :should_receive, method ).once.and_return true
+  end
 end

data/spec/popular/popular_spec.rb

@@ -18,8 +18,7 @@ describe Popular::Popular do
     let ( :random_object ) { RandomClass.new }
     let ( :popular_model ) { PopularModel.create }
     let ( :another_popular_model ) { PopularModel.create }
-    let ( :popular_model_with_after_befriend_callback ) { PopularModelWithAfterBefriendCallback.create }
-    let ( :popular_model_with_before_befriend_callback ) { PopularModelWithBeforeBefriendCallback.create }
+    let ( :popular_model_with_callbacks ) { PopularModelWithCallbacks.create }
   end
 
 end

data/spec/support/popular_model_with_callbacks.rb

@@ -0,0 +1,14 @@
+class PopularModelWithCallbacks < PopularModel
+  [:after, :before].each do |filter|
+    [:befriend, :unfriend].each do |action|
+      hook = "#{filter}_#{action}".to_sym
+      method_name = "#{hook}_callback".to_sym
+
+      send hook, method_name
+
+      define_method method_name do
+        true
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: popular
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - thejchap
@@ -167,8 +167,7 @@ files:
 - spec/popular/popular_spec.rb
 - spec/spec_helper.rb
 - spec/support/popular_model.rb
-- spec/support/popular_model_with_after_befriend_callback.rb
-- spec/support/popular_model_with_before_befriend_callback.rb
+- spec/support/popular_model_with_callbacks.rb
 - spec/support/random_class.rb
 - spec/support/unpopular_model.rb
 homepage: http://thejchap.github.io/popular
@@ -202,8 +201,7 @@ test_files:
 - spec/popular/popular_spec.rb
 - spec/spec_helper.rb
 - spec/support/popular_model.rb
-- spec/support/popular_model_with_after_befriend_callback.rb
-- spec/support/popular_model_with_before_befriend_callback.rb
+- spec/support/popular_model_with_callbacks.rb
 - spec/support/random_class.rb
 - spec/support/unpopular_model.rb
 has_rdoc: 

data/spec/support/popular_model_with_after_befriend_callback.rb

@@ -1,7 +0,0 @@
-class PopularModelWithAfterBefriendCallback < PopularModel
-  after_befriend :callback_worked
-
-  def callback_worked
-    true
-  end
-end

data/spec/support/popular_model_with_before_befriend_callback.rb

@@ -1,7 +0,0 @@
-class PopularModelWithBeforeBefriendCallback < PopularModel
-  before_befriend :callback_worked
-
-  def callback_worked
-    true
-  end
-end