popular 0.4.0 → 0.5.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NzNkYjliYTc5YjZhMTQ0YzYzZDQ3NGY0ZGI1M2VkMjRhMjBlZDcyZQ==
+    NWE5Mjc5N2Q5YjVlNzc2OTM5ODM0MjdlYzkwNmJlOWQ1NTI5MGQ1Mg==
   data.tar.gz: !binary |-
-    MzdlYjQzM2UwNWJkZGI3NTVmMDVlMDgzNTg3YWMzMmM4NzUxMDY5Zg==
+    ZTdhZGY1MjM0MDdhNjM5NDZhODhiNTRkNzYwOTMzODRlY2EyNjM4OQ==
 SHA512:
   metadata.gz: !binary |-
-    N2YyOGQ2ZmUwNDczNzVhNjhlYjA3N2M2N2MzNjJkODQ4ODMzNWU0YjJkODcz
-    ZWM0Yzc0OGU3OWU5OTBiMTAzMGI2YWEwMTZkNDM0MDNhZDVkOGQ2NGU0MTYy
-    NmFhOGIwMTE5NjdjZDU2YTQ3ZGE1NjY1YWZmMWViMWNiOTU3MmY=
+    OWJjMTBiYjRlOGNkN2NhMmQxYjEyYWJiZGNmOWNkYmQ2ZDhmYTQzOWZkODgw
+    YTk5MWE1ZTFkMzNkZTliMmNkYTE1ZGUxYzE2YzJjMzNjODllNTUzNDAzODM4
+    YTE3MzNhMTRhNWMzOGVmOTliMDlhZjExNWJlMDA4OGYwZTY4ZTk=
   data.tar.gz: !binary |-
-    Y2YwNTRhZDI5YWNkMzc5NjNjYjg3ZDRmZDQzNWQ0NmEzMjYwMjU1N2IzODk5
-    ZjUxOTNiOWM5NWM0ZjZhNmIwZjY5MzU3OWFmYTc3ZjM2ZDFhZGY3ODRhYjc2
-    NzQxZDM5ZWYyZDJjMjhmN2JhMmRkZTQwYWIxZDJmYjI2NzY1NjQ=
+    ZWM0NGMwM2RjOGY3N2Y0NjE5OGQ3MDc1ZTcyNmI0N2Y2MzA1MjFlZWE0ZDg2
+    YjNmZjQ2ZmEyMjhiZDg3ZGM3YmFjZmM2MzJjYzk5ZWUxYTgzNjRjMTlmZGRl
+    NzY4ODI4YTBiZTM5ZTU2NWZlNThhNzJhNmIyMTBhM2NlNTZmNTA=

data/lib/popular.rb

@@ -3,8 +3,6 @@ require "active_record"
 # Namespace for classes and modules that handle friendship related tasks
 #
 # @author Justin Chapman
-#
-# @since 0.0.1
 module Popular
 
   if defined? ActiveRecord::Base

data/lib/popular/popular.rb

@@ -7,6 +7,8 @@ module Popular
     included do |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
+      has_many :inverse_friends, through: :inverse_friendships, source: :popular_model, source_type: base
 
       include ActiveSupport::Callbacks
       define_callbacks :befriend, :unfriend
@@ -66,7 +68,26 @@ module Popular
       end
     end
 
-    # Helper method for finding whether or not the instance is friends with 
+    # Helper method for finding whether or not the instance has 
+    # been befriended by another given popular_model
+    # 
+    # @param [Object] popular_model
+    # @return [Boolean] if the instance has been friended by another popular_model
+    #
+    # @example
+    #   user = User.create name: "Justin"
+    #   other_user = User.create name: "Jenny"
+    #
+    #   user.friended_by? other_user #=> false
+    #
+    #   other_user.befriend user
+    #
+    #   user.friended_by? other_user #=> true
+    def friended_by? popular_model
+      inverse_friends.include? popular_model
+    end
+
+    # Helper method for finding whether or not the instance has befriended
     # another given popular_model
     # 
     # @param [Object] popular_model
@@ -82,7 +103,7 @@ module Popular
     #
     #   user.friends_with? other_user #=> true
     def friends_with? popular_model
-      friendships.where( friend: popular_model ).any?
+      friends.include? popular_model
     end
 
     # ClassMethods included in popular models
@@ -90,8 +111,6 @@ module Popular
 
       # after_unfriend callback convenience class method
       #
-      # @since 0.4.0
-      #
       # @example
       #
       #   class User < ActiveRecord::Base
@@ -113,8 +132,6 @@ module Popular
 
       # before_unfriend callback convenience class method
       #
-      # @since 0.4.0
-      #
       # @example
       #
       #   class User < ActiveRecord::Base
@@ -136,8 +153,6 @@ module Popular
 
       # before_befriend callback convenience class method
       #
-      # @since 0.3.0
-      #
       # @example
       #
       #   class User < ActiveRecord::Base
@@ -158,8 +173,6 @@ module Popular
 
       # after_befriend callback convenience class method
       #
-      # @since 0.3.0
-      #
       # @example
       #
       #   class User < ActiveRecord::Base

data/lib/popular/version.rb

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

data/spec/popular/popular_model_spec.rb

@@ -1,5 +1,13 @@
 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
+
+      expect( popular_model ).to be_friended_by another_popular_model
+    end
+  end
+
   describe '.befriend!' do
     it 'creates a one way friendship' do
       popular_model.befriend! another_popular_model

data/spec/popular/popular_spec.rb

@@ -15,7 +15,6 @@ describe Popular::Popular do
   end
 
   it_behaves_like 'a popular model' do
-    let ( :random_object ) { RandomClass.new }
     let ( :popular_model ) { PopularModel.create }
     let ( :another_popular_model ) { PopularModel.create }
     let ( :popular_model_with_callbacks ) { PopularModelWithCallbacks.create }

data/spec/support/popular_model_with_callbacks.rb

@@ -6,9 +6,7 @@ class PopularModelWithCallbacks < PopularModel
 
       send hook, method_name
 
-      define_method method_name do
-        true
-      end
+      define_method method_name, ->{}
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: popular
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - thejchap
@@ -168,7 +168,6 @@ files:
 - spec/spec_helper.rb
 - spec/support/popular_model.rb
 - spec/support/popular_model_with_callbacks.rb
-- spec/support/random_class.rb
 - spec/support/unpopular_model.rb
 homepage: http://thejchap.github.io/popular
 licenses:
@@ -202,6 +201,5 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/popular_model.rb
 - spec/support/popular_model_with_callbacks.rb
-- spec/support/random_class.rb
 - spec/support/unpopular_model.rb
 has_rdoc: 

data/spec/support/random_class.rb

@@ -1 +0,0 @@
-RandomClass = Class.new