popular 0.3.1 → 0.3.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDZmMzVhOWMxNzU4YTQ0YjlmMTQwODcyNzcyZDBmMTY3MTk5N2I0NQ==
+    MDBkZDk2OTY1OTczYjYzMzkzOTVmN2QyZDMyMjYwNmE1ZjBjOWYxOA==
   data.tar.gz: !binary |-
-    YmRlZWFlMjNjZTRlZWQ5NjgxZGY1NWIzZDIxZjcxZjIyY2NjMWQ2Yg==
+    NTA3NTI1MmUwY2UzMzk1MWY1MTMxM2FmZGQxNzE4NTZmMGVjY2ZhZA==
 SHA512:
   metadata.gz: !binary |-
-    YTUzYjRjNzI2ZTk0YzFiZjA0NjU5YzQ0MzUzOWM2M2ZlMjM1M2JjMWYwYjcw
-    OTQ0YjM1MzljZTBmNWFkNDczNDAxMDVmMzk5ZGQxMTMzNDRhOTk3OGM3ZmFm
-    ZWZjYjlhYjE2NDJiZDhhZDI1OTAxOTVkMjIyZDNiNWRmMTgyYWE=
+    ZDc4MDI4NjI3OWNlNmM4MzRmNzVmMzYxZDBjYWRhYzFjNDgxM2E2NWExMDRk
+    ZjgwNjZmMDAyYzQzOGE3NzkxMDZjNjA3MWVlZTVkMzIyZDk4NjllMjQ4YzRj
+    NDU5ZjZhMjMxZGE4OGM2Njk2NGM0NGE5ZGRjNGU3ZDQ4MTMxMWU=
   data.tar.gz: !binary |-
-    NTdmODI0Njk3M2ZjYTFkNWYwM2FjODBlOTMyMTA2ZTk2MjE4NzhlZDRjNTFj
-    YjUxNjM2NmQ5MGRmZDk0ODM2MTJjZDg4YTEyZTNlYjcxNmVjYjZhMzkzODI3
-    MmZmOGFiZGE3MDllNGI4YzQwN2UyNzVlZTg3ZGVjYzI3YTY3MGQ=
+    OThiOGJlNDljMmUzMTNmOTI4NGNkYmFmYzliOWJiNzgxODAwYzEzODljZGUx
+    N2YzNjg3NTVlODFjN2NhZjUyMDc1MzgzNTIyOGFhMTIxYTM0NGE5OTYyZjA4
+    MDI3Y2E5YmI1MmVkOTJhYjZhZDlmMTlmMWZlNjEwMjFiNzM3OTA=

data/.inch.yml

@@ -0,0 +1,3 @@
+files:
+  excluded:
+    - lib/generators

data/README.md

@@ -44,11 +44,14 @@ end
 @sam = User.create name: "Samuel"
 @jackson = User.create name: "Jackson"
 
-@sam.friends_with? @jackson #=> false
+# Adding and removing friends
+@sam.friends_with? @jackson   #=> false
+@sam.friends.length           #=> 0
 @sam.befriend @jackson
-@sam.friends_with? @jackson #=> true
+@sam.friends_with? @jackson   #=> true
+@sam.friends.length           #=> 1
 @sam.unfriend @jackson
-@sam.friends_with? @jackson #=> false
+@sam.friends_with? @jackson   #=> false
 ```
 
 ### Callbacks

data/lib/popular/extenders/popular.rb

@@ -2,7 +2,7 @@ module Popular
   # Namespace for classes and modules that handle including the library's modules
   module Extenders
 
-    # Namespace for classes and modules that handle making a given model friendly
+    # Namespace for classes and modules that handle making a given model popular
     module Popular
 
       # Helper method for determining whether or not a model has included

data/lib/popular/friendship.rb

@@ -1,10 +1,25 @@
 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
 
+    validates_presence_of :friend, :popular_model
+
+    # Ensures that popular_models cannot add themselves as a friend
+    validate :ensure_popular_model_different_from_friend
+
+    private
+
+    # Checks friend against popular_model.
+    #
+    # TODO add more descriptive error message/i18n
+    def ensure_popular_model_different_from_friend
+      errors.add( :friend ) if friend == popular_model
+    end
+
   end
 
 end

data/lib/popular/popular.rb

@@ -1,5 +1,5 @@
 module Popular
-
+  # Namespace for methods included in popular models
   module Popular
 
     extend ActiveSupport::Concern
@@ -83,6 +83,7 @@ module Popular
       friendships.where( friend: popular_model ).any?
     end
 
+    # ClassMethods included in popular models
     module ClassMethods
 
       # before_befriend callback convenience class method

data/lib/popular/version.rb

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

data/spec/popular/friendship_model_spec.rb

@@ -0,0 +1,24 @@
+shared_examples 'a friendship model' do
+
+  it 'ensures the friend is not the same as the popular_model' do
+    invalid_model = described_class.new(
+      friend: popular_model,
+      popular_model: popular_model
+    )
+
+    expect( invalid_model ).to_not be_valid
+  end
+
+  it 'validates presence of popular_model' do
+    invalid_model = described_class.new friend: popular_model
+
+    expect( invalid_model ).to_not be_valid
+  end
+
+  it 'validates presence of friend' do
+    invalid_model = described_class.new popular_model: popular_model
+
+    expect( invalid_model ).to_not be_valid
+  end
+
+end

data/spec/popular/friendship_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Popular::Friendship do
+
+  it_behaves_like 'a friendship model' do
+    let ( :popular_model ) { PopularModel.create }
+    let ( :another_popular_model ) { PopularModel.create }
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: popular
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - thejchap
@@ -146,6 +146,7 @@ extra_rdoc_files: []
 files:
 - .gemrelease
 - .gitignore
+- .inch.yml
 - .rspec
 - .travis.yml
 - Gemfile
@@ -160,6 +161,8 @@ files:
 - lib/popular/popular.rb
 - lib/popular/version.rb
 - popular.gemspec
+- spec/popular/friendship_model_spec.rb
+- spec/popular/friendship_spec.rb
 - spec/popular/popular_model_spec.rb
 - spec/popular/popular_spec.rb
 - spec/spec_helper.rb
@@ -193,6 +196,8 @@ signing_key:
 specification_version: 4
 summary: Friendship gem for Rails/ActiveRecord
 test_files:
+- spec/popular/friendship_model_spec.rb
+- spec/popular/friendship_spec.rb
 - spec/popular/popular_model_spec.rb
 - spec/popular/popular_spec.rb
 - spec/spec_helper.rb