mongoid_socializer_actions 1.2.3 → 1.2.4

data/Readme.md

@@ -1,6 +1,6 @@
 # mongoid_socializer_actions
 
-mongoid_socializer_actions gives ability to like, comment  mongoid documents
+mongoid_socializer_actions gives ability to like, comment, share  mongoid documents
 
 
 ## Installation
@@ -22,6 +22,13 @@ Or install it yourself as:
 
 This gem has been tested with [MongoID](http://mongoid.org/) version 3.0.21
 
+## Configuration
+
+Set the user(commenter, liker, sharer) class name. By default its 'User'. In some cases, the class name will be 'Customer' or 'Administrator', etc. In the following examples the 'User' class should be same as this Configuration user_class_name
+
+    Socializer.configure do |configuration|
+        configuration.user_class_name = 'User'
+    end
 
 ## Usage
 
@@ -93,7 +100,13 @@ You can now comment objects like this:
     user = User.create
     photo = Photo.create
 
-    user.comment_on(photo, "Beautiful")
+    @comment = user.comment_on(photo, "Beautiful")
+
+    @comment.persisted?
+    # => true
+
+    @comment.errors
+    # => []
 
 Load the commets with eager loaded user(Enable [Identity map](http://mongoid.org/en/mongoid/docs/identity_map.html))
 
@@ -140,14 +153,14 @@ Add the Sharer module in User model and Sharable in Photo, Album etc.
       include Mongoid::Sharable
     end
 
-You can now comment objects like this:
+You can now share objects like this:
 
     user = User.create
     photo = Photo.create
 
     user.share(photo)
 
-You can query for comments like that:
+You can query for shares like that:
 
     photo.sharers
     # => [user]

data/app/models/comment.rb

@@ -6,7 +6,7 @@ module Mongoid
     field :body, type: String
     validates :body, presence: true
 
-    belongs_to :commenter, :class_name => 'User', :inverse_of => :comments
+    belongs_to :commenter, :class_name => Socializer.user_class_name, :inverse_of => :comments
     belongs_to :commentable, :polymorphic => true
 
     def commentabled_obj

data/app/models/like.rb

@@ -3,7 +3,7 @@ module Mongoid
     include Mongoid::Document
     include Mongoid::Timestamps::Created
 
-    belongs_to :liker, :class_name => 'User', :inverse_of => :likes
+    belongs_to :liker, :class_name => Socializer.user_class_name, :inverse_of => :likes
     belongs_to :likable, :polymorphic => true
   end
 end

data/app/models/share.rb

@@ -2,7 +2,7 @@ module Mongoid
   class Share
     include Mongoid::Document
 
-    belongs_to :sharer, :class_name => 'User', :inverse_of => :shares
+    belongs_to :sharer, :class_name => Socializer.user_class_name, :inverse_of => :shares
     belongs_to :sharable, :polymorphic => true
   end
 end

data/lib/mongoid_socializer_actions.rb

@@ -1,3 +1,8 @@
+require 'mongoid_socializer_actions/config'
+module Socializer
+  extend Configuration
+end
+
 require 'mongoid_socializer_actions/likeable'
 require 'mongoid_socializer_actions/liker'
 require 'mongoid_socializer_actions/helper'
@@ -9,4 +14,5 @@ require 'models/comment'
 
 require 'mongoid_socializer_actions/sharable'
 require 'mongoid_socializer_actions/sharer'
-require 'models/share'
+require 'models/share'
+

data/lib/mongoid_socializer_actions/commenter.rb

@@ -10,10 +10,10 @@ module Mongoid
     # Comment on a model
     #
     # Example:
-    # => @john.comment_on(@photo, { with: "Beautiful" } )
+    # => @john.comment_on(@photo, "Beautiful")
     def comment_on(model, comment_body)
         model.before_commented_by(self) if model.respond_to?('before_commented_by')
-        comment = model.comments.create!(body: comment_body)
+        comment = model.comments.create(body: comment_body)
         comments << comment
         model.inc(:comments_count, 1)
         self.inc(:comments_count, 1)

data/lib/mongoid_socializer_actions/config.rb

@@ -0,0 +1,20 @@
+module Socializer
+  # Configuration settings
+  module Configuration
+    attr_writer :user_class_name
+
+    # Example:
+    #
+    #   Socializer.configure do |configuration|
+    #     configuration.user_class_name = 'User'
+    #   end
+
+    def configure
+      yield self
+    end
+
+    def user_class_name
+      @user_class_name ||= 'User'
+    end
+  end
+end

data/lib/mongoid_socializer_actions/likeable.rb

@@ -5,7 +5,7 @@ module Mongoid
     included do |base|
       base.field    :likers_count, :type => Integer, :default => 0
       base.has_many :likes, :class_name => 'Mongoid::Like', :as => :likable, :dependent => :destroy
-      base.has_and_belongs_to_many :likers, :class_name => 'User', :inverse_of => nil
+      base.has_and_belongs_to_many :likers, :class_name => Socializer.user_class_name, :inverse_of => nil
     end
 
     # know if self is liked by model

data/lib/mongoid_socializer_actions/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module MongoidSocializerActions
-    VERSION = "1.2.3"
+    VERSION = "1.2.4"
   end
 end

data/spec/mongoid/mongoid_socializer_actions/comments_spec.rb

@@ -21,6 +21,13 @@ describe Mongoid::Commenter do
         expect{ @john.comment_on(@photo1, "Beautiful") }.to change(Mongoid::Comment, :count).by(1)
       end
 
+      it "comment body should not be empty" do
+        comment = @john.comment_on(@photo1, '')
+        comment.errors.present?.should be_true
+        comment.errors[:body].should == ["can't be blank"]
+        comment.persisted?.should be_false
+      end
+
       it "should be commented by commenter" do
         @john.comment_on(@photo1, 'Beautiful')
         @photo1.commenters.should include @john
@@ -46,8 +53,8 @@ describe Mongoid::Commenter do
       end
 
       it "should have the correct comments count" do
-        @jashua.comment_on(@photo1, '')
-        @john.comment_on(@photo1, '')
+        @jashua.comment_on(@photo1, 'test1')
+        @john.comment_on(@photo1, 'test2')
         @photo1.comments_count.should be 2
         @jashua.comments_count.should be 1
         @john.comments_count.should be 1

data/spec/mongoid/mongoid_socializer_actions/config_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Socializer::Configuration do
+  describe '#configure' do
+    it 'should have default attributes' do
+      Socializer.configure do |configuration|
+        configuration.user_class_name.should eql('User')
+      end
+    end
+
+    it 'should have default attributes' do
+      Socializer.user_class_name.should eql('User')
+    end
+
+    it 'should accept user settings' do
+      Socializer.configure do |configuration|
+        configuration.user_class_name = 'Customer'
+      end
+
+      Socializer.user_class_name.should eql('Customer')
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_socializer_actions
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &2152177240 !ruby/object:Gem::Requirement
+  requirement: &2164461600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152177240
+  version_requirements: *2164461600
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2152175860 !ruby/object:Gem::Requirement
+  requirement: &2164461020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *2152175860
+  version_requirements: *2164461020
 description: Add liking, commentable, sharabel, tagabel ability to Mongoid documents.
 email:
 - sreehari@activesphere.com
@@ -52,6 +52,7 @@ files:
 - lib/mongoid_socializer_actions.rb
 - lib/mongoid_socializer_actions/commentable.rb
 - lib/mongoid_socializer_actions/commenter.rb
+- lib/mongoid_socializer_actions/config.rb
 - lib/mongoid_socializer_actions/helper.rb
 - lib/mongoid_socializer_actions/likeable.rb
 - lib/mongoid_socializer_actions/liker.rb
@@ -64,6 +65,7 @@ files:
 - spec/mongoid/models/photo.rb
 - spec/mongoid/models/user.rb
 - spec/mongoid/mongoid_socializer_actions/comments_spec.rb
+- spec/mongoid/mongoid_socializer_actions/config_spec.rb
 - spec/mongoid/mongoid_socializer_actions/likes_spec.rb
 - spec/mongoid/mongoid_socializer_actions/shares_spec.rb
 - spec/spec_helper.rb
@@ -98,6 +100,7 @@ test_files:
 - spec/mongoid/models/photo.rb
 - spec/mongoid/models/user.rb
 - spec/mongoid/mongoid_socializer_actions/comments_spec.rb
+- spec/mongoid/mongoid_socializer_actions/config_spec.rb
 - spec/mongoid/mongoid_socializer_actions/likes_spec.rb
 - spec/mongoid/mongoid_socializer_actions/shares_spec.rb
 - spec/spec_helper.rb