popular 0.6.0 → 0.7.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZGExM2NmNGUxNmI3ZTk5MjgwMDE2OTJiN2E3NWY0Njk4NTgxMjZiZg==
+    NWU5MzFlMWEwZGQyYTMxNTU1ZWQ4OTgxYzA0MmZhMzYzMDhkMDczNg==
   data.tar.gz: !binary |-
-    OWY2NTBmYzRlMmI3NDIzMTU5YmI4MzVmMGVhNTg3MzdmZGQ2NzkyYg==
+    M2ZiMmI2ZmM0NmY5ZmUxYzliYzRmYTIzZjcwODE4OGI4ZjNkMGZkMw==
 SHA512:
   metadata.gz: !binary |-
-    NjYxZjRhZGI3YTI0NmNiY2Q1NDZhNWVjYzQ2MDdiOTEyYjY2YzJmMTZkZTEz
-    MzgwY2ZmNWNiYTUwZjk4ZjBiZTkxNzFlZjU4ZmUwNjJkNWRhZDI4ZDZiODc3
-    YjJhMmU4M2U1YTZjN2VlMzQ5NjE2NzI3YzcwOTNhN2FjMzI0MjY=
+    ZGIzNDViYzY0MDUyMmExMTMxMWQ5YzBkZDRlYjM4NDNlNjRiNmVhNjBkNmY0
+    YTI5YmI5ZDYxM2E0MWMwOTlhMTNkZjUxMDA1NDY0OWM5OWJkNGEwYTU0NGNh
+    MjAxODMxNzlmYmM3YzhlZmE3YzQ1Y2VkNmEzODA0ODc4ODcxNWQ=
   data.tar.gz: !binary |-
-    OWMyZTZmM2U0Yjc3MmMyMTU0MGJlNGM5YmZiODQxNzZjZDdmYzkzNmFkMGY3
-    NGEzYjljYjU1MTk3NDczNmJjZjU1YjZmYWNhOTQxZmJiMTIyNjFjNDQ1Yzlh
-    NTA4NTAyZjhlNDEyOWRmNzMzZTZiMWFlYmUyZDE0YjMxMTAyN2E=
+    NzU0YzA1ZDFkN2QxYjM3YWQ2NTFmZmM0MjVkNGM1MDllNTVhNTFhNzQzMTQz
+    OTk2N2UxMjRhNmM5OTY5MGUyOGFmZTFhMDNhYTNhMjI4YTg2ZWU3ODRjNWZh
+    ZWQ0ZmVkZWE5ZDRmZTZjOGI3ZTJiMWViNjdlODQ2YTU2M2I5NTE=

data/README.md

@@ -110,6 +110,33 @@ end
 @justin.unfriend @jenny #=> ":("
 ```
 
+### Customization
+
+Popular is intended to provide basic utilities around self-referential relationships in social apps.
+Often, more customization is necessary. If you would like to store more information around the friendship,
+Popular provides a hook to connect its `friendship` model to a user defined `friendship_profile` model. 
+This allows Popular to remain somewhat lightweight and factor out only the code that is repeated  alot between apps,
+while allowing flexibility where it is needed.
+
+Do to this, create a `FriendshipProfile` model that belongs to `friendship`, and has whatever custom attributes
+you want
+
+```ruby
+rails g model FriendshipProfile friendship:belongs_to meeting_location:string meeting_latitude:float meeting_longitude:float
+rake db:migrate
+```
+
+Then, in your Popular model, just set the `friendship_profile` option to true:
+
+```ruby
+class User < ActiveRecord::Base
+  popular friendship_profile: true
+end
+```
+
+Now, everytime a `friendship` is created, an accompanying `friendship_profile` will be attached to it, allowing you to define
+as many custom attributes as you wish in a separate table
+
 ## Related gems
 
 If Popular isn't quite what you're looking for, here are some other useful gems in the same category:

data/lib/popular/extenders/popular.rb

@@ -15,12 +15,17 @@ module Popular
 
       # Includes the module in a given class
       #
-      # @overload friendable *args
+      # @overload popular *args
       #   @param [Hash] options
+      #   @option args [Boolean] :friendship_profile whether or not friendships should create a friendship_profile
       def popular *args
         require 'popular/popular'
         include ::Popular::Popular
-        
+
+        args.extract_options!.each do |key, val|
+          send "#{key}=", val
+        end
+
         class_eval do
           def self.popular?
             true

data/lib/popular/friendship.rb

@@ -2,17 +2,31 @@ module Popular
 
   # Friendship class. Provides self-referential join for popular_models and their friends
   class Friendship < ::ActiveRecord::Base
-
     belongs_to :popular_model, polymorphic: true
     belongs_to :friend, polymorphic: true
+    has_one :friendship_profile
 
     validates_presence_of :friend, :popular_model
 
     # Ensures that popular_models cannot add themselves as a friend
     validate :ensure_popular_model_different_from_friend
 
+    # If the user has created a friendship profile table, this will get attached
+    # after create
+    after_create :create_friendship_profile!,
+      if: Proc.new { |friendship| friendship.popular_model.class.friendship_profile }
+
     private
 
+    def create_friendship_profile!
+      if defined? FriendshipProfile
+        super
+      else
+        warn "You have set friendship_profile: true in your popular model, however no FriendshipProfile model exists"
+        warn "To fix this, run 'rails g model FriendshipProfile friendship:belongs_to'"
+      end
+    end
+
     # Checks friend against popular_model.
     #
     # TODO add more descriptive error message/i18n

data/lib/popular/popular.rb

@@ -1,4 +1,5 @@
 module Popular
+
   # Namespace for methods included in popular models
   module Popular
 
@@ -145,12 +146,15 @@ module Popular
 
     # ClassMethods included in popular models
     module ClassMethods
+      attr_accessor :friendship_profile
 
       # after_unfriend callback convenience class method
+      # Fired after a popular_model unfriends another popular_model
       #
       # @example
       #
       #   class User < ActiveRecord::Base
+      #     popular
       #     after_unfriend :do_something_amazing
       #
       #     def do_something_amazing
@@ -168,10 +172,12 @@ module Popular
       end
 
       # before_unfriend callback convenience class method
+      # Fired before a popular_model unfriends another popular_model
       #
       # @example
       #
       #   class User < ActiveRecord::Base
+      #     popular
       #     before_unfriend :do_something_amazing
       #
       #     def do_something_amazing
@@ -189,10 +195,12 @@ module Popular
       end
 
       # before_befriend callback convenience class method
+      # Fired before a popular model befriends another popular_model
       #
       # @example
       #
       #   class User < ActiveRecord::Base
+      #     popular
       #     before_befriend :do_something_amazing
       #
       #     def do_something_amazing
@@ -209,10 +217,12 @@ module Popular
       end
 
       # after_befriend callback convenience class method
+      # Fired after a popular_model befriends another popular_model
       #
       # @example
       #
       #   class User < ActiveRecord::Base
+      #     popular
       #     after_befriend :do_something_amazing
       #
       #     def do_something_amazing

data/lib/popular/version.rb

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

data/spec/popular/friendship_model_spec.rb

@@ -1,5 +1,19 @@
 shared_examples 'a friendship model' do
 
+  describe 'custom data' do
+    it 'allows for a one-to-one mapping between friendship and a friendship_profile' do
+      friendship = custom_popular_model.befriend another_custom_popular_model
+
+      expect( friendship.friendship_profile ).to_not be_nil
+    end
+
+    it 'model does not get created unless explicitly opted in' do
+      friendship = popular_model.befriend another_popular_model
+
+      expect( friendship.friendship_profile ).to be_nil
+    end
+  end
+
   it 'ensures the friend is not the same as the popular_model' do
     invalid_model = described_class.new(
       friend: popular_model,

data/spec/popular/friendship_spec.rb

@@ -5,6 +5,8 @@ describe Popular::Friendship do
   it_behaves_like 'a friendship model' do
     let ( :popular_model ) { PopularModel.create }
     let ( :another_popular_model ) { PopularModel.create }
+    let ( :custom_popular_model ) { CustomPopularModel.create }
+    let ( :another_custom_popular_model ) { CustomPopularModel.create }
   end
 
 end

data/spec/spec_helper.rb

@@ -18,6 +18,10 @@ ActiveRecord::Schema.define version: 1 do
   end
 
   create_table :popular_models
+  create_table :custom_popular_models
+  create_table :friendship_profiles do |t|
+    t.references :friendship
+  end
 
 end
 
@@ -26,7 +30,7 @@ RSpec.configure do |config|
 end
 
 def clean_database
-  [PopularModel, Popular::Friendship].each do |model|
+  [CustomPopularModel, PopularModel, Popular::Friendship].each do |model|
     ActiveRecord::Base.connection.execute "DELETE FROM #{model.table_name}"
   end
 end

data/spec/support/custom_popular_model.rb

@@ -0,0 +1,3 @@
+class CustomPopularModel < ActiveRecord::Base
+  popular friendship_profile: true
+end

data/spec/support/friendship_profile.rb

@@ -0,0 +1,2 @@
+class FriendshipProfile < ActiveRecord::Base
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: popular
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - thejchap
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-30 00:00:00.000000000 Z
+date: 2014-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -166,6 +166,8 @@ files:
 - spec/popular/popular_model_spec.rb
 - spec/popular/popular_spec.rb
 - spec/spec_helper.rb
+- spec/support/custom_popular_model.rb
+- spec/support/friendship_profile.rb
 - spec/support/popular_model.rb
 - spec/support/popular_model_with_callbacks.rb
 - spec/support/unpopular_model.rb
@@ -199,6 +201,8 @@ test_files:
 - spec/popular/popular_model_spec.rb
 - spec/popular/popular_spec.rb
 - spec/spec_helper.rb
+- spec/support/custom_popular_model.rb
+- spec/support/friendship_profile.rb
 - spec/support/popular_model.rb
 - spec/support/popular_model_with_callbacks.rb
 - spec/support/unpopular_model.rb