mongoid_socializer_actions 1.1.0 → 1.2.0

data/Readme.md

@@ -125,8 +125,42 @@ You can query for comments like that:
     photo.commenters
     # => [user]
 
+## SHARES
+Add the Sharer module in User model and Sharable in Photo, Album etc.
+
+    class User
+      include Mongoid::Document
+
+      include Mongoid::Sharer
+    end
+
+    class Photo
+      include Mongoid::Document
+
+      include Mongoid::Sharable
+    end
+
+You can now comment objects like this:
+
+    user = User.create
+    photo = Photo.create
+
+    user.share(photo)
+
+You can query for comments like that:
+
+    photo.sharers
+    # => [user]
+
+    user.unshare(photo)
+    # => true
+
+    user.photo_shares_count
+    # => 1
+
+    photo.shares_count
+    # => 1
 
 # TODOs
 
-- Implement sharable
 - Implement taggable

data/app/models/share.rb

@@ -0,0 +1,8 @@
+module Mongoid
+  class Share
+    include Mongoid::Document
+
+    belongs_to :sharer, :class_name => 'User', :inverse_of => :shares
+    belongs_to :sharable, :polymorphic => true
+  end
+end

data/lib/mongoid_socializer_actions/likeable.rb

@@ -4,7 +4,6 @@ module Mongoid
 
     included do |base|
       base.field    :likers_count, :type => Integer, :default => 0
-      base.field    :liker_ids, :type => Array, :default => []
       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
     end

data/lib/mongoid_socializer_actions/sharable.rb

@@ -0,0 +1,15 @@
+module Mongoid
+  module Sharable
+    extend ActiveSupport::Concern
+
+    included do |base|
+      base.field    :shares_count, :type => Integer, :default => 0
+      base.has_many :shares, :class_name => 'Mongoid::Share', :as => :sharable, :dependent => :destroy
+    end
+
+    def sharers
+      sharer_ids = shares.distinct('sharer_id')
+      User.find(sharer_ids)
+    end
+  end
+end

data/lib/mongoid_socializer_actions/sharer.rb

@@ -0,0 +1,107 @@
+module Mongoid
+  module Sharer
+    extend ActiveSupport::Concern
+
+    included do |base|
+      base.has_many :shares, :class_name => 'Mongoid::Share', :inverse_of => :sharer, :dependent => :destroy
+    end
+
+    # share a model
+    #
+    # Example:
+    # => @john.share(@photo)
+    def share(model)
+      model.before_shared_by(self) if model.respond_to?('before_shared_by')
+      shares << model.shares.create!
+      model.inc(:shares_count, 1)
+      model.after_shared_by(self) if model.respond_to?('after_shared_by')
+      self.before_share(model) if self.respond_to?('before_share')
+      self.after_share(model) if self.respond_to?('after_share')
+    end
+
+    # unshare a model
+    #
+    # Example:
+    # => @john.unshare(@photo)
+    def unshare(model)
+      if shared?(model)
+        model.reload
+        self.reload
+
+        shares.where(:sharable_type => model.class.name, :sharable_id => model.id).destroy
+        model.inc(:shares_count, -1)
+
+        model.before_unshare_by(self) if model.respond_to?('before_unshare_by')
+        model.after_unshare_by(self) if model.respond_to?('after_unshare_by')
+        self.before_unshare(model) if self.respond_to?('before_unshare')
+        self.after_unshare(model) if self.respond_to?('after_unshare')
+        return true
+      else
+        return false
+      end
+    end
+
+    # know if user is already shared model
+    #
+    # Example:
+    # => @john.shared?(@photo)
+    # => true
+    def shared?(model)
+      shares.where(sharable_type: model.class.name, sharable_id: model.id).exists?
+    end
+
+    # get likes count by model
+    #
+    # Example:
+    # => @john.shares_count_by_model("Photo")
+    # => 1
+    def shares_count_by_model(model)
+      self.shares.where(:sharable_type => model).count
+    end
+
+    # view all selfs shares
+    #
+    # Example:
+    # => @john.liked_objects
+    # => [@photo]
+    def shared_objects
+      get_shared_objects_of_kind
+    end
+
+    # view all selfs likes by model
+    #
+    # Example:
+    # => @john.get_shared_objects_of_kind('Photo')
+    # => [@photo]
+    def get_shared_objects_of_kind(model = nil)
+      if model
+        user_shares = shares.where(sharable_type: model)
+        extract_shares_from(user_shares, model)
+      else
+        sharable_types = shares.map(&:sharable_type).uniq
+        sharable_types.collect do |sharable_type|
+          user_shares = shares.select{ |share| share.sharable_type == sharable_type }
+          extract_shares_from(user_likes, likable_type)
+        end.flatten
+      end
+    end
+
+    def extract_shares_from(user_shares, sharable_type)
+      return [] unless user_shares.present?
+      sharable_ids = user_shares.map(&:sharable_id)
+      sharable_type.constantize.find(sharable_ids)
+    end
+
+    private
+
+    def method_missing(missing_method, *args, &block)
+      if missing_method.to_s =~ /^(.+)_shares_count$/
+        shares_count_by_model($1.camelize)
+      elsif missing_method.to_s =~ /^shared_(.+)$/
+        get_shared_objects_of_kind($1.singularize.camelize)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/mongoid_socializer_actions/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module MongoidSocializerActions
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

data/lib/mongoid_socializer_actions.rb

@@ -5,4 +5,8 @@ require 'models/like'
 
 require 'mongoid_socializer_actions/commentable'
 require 'mongoid_socializer_actions/commenter'
-require 'models/comment'
+require 'models/comment'
+
+require 'mongoid_socializer_actions/sharable'
+require 'mongoid_socializer_actions/sharer'
+require 'models/share'

data/spec/mongoid/models/album.rb

@@ -2,4 +2,5 @@ class Album
   include Mongoid::Document
   include Mongoid::Likeable
   include Mongoid::Commentable
+  include Mongoid::Sharable
 end

data/spec/mongoid/models/photo.rb

@@ -2,4 +2,5 @@ class Photo
   include Mongoid::Document
   include Mongoid::Likeable
   include Mongoid::Commentable
+  include Mongoid::Sharable
 end

data/spec/mongoid/models/user.rb

@@ -2,6 +2,7 @@ class User
   include Mongoid::Document
   include Mongoid::Liker
   include Mongoid::Commenter
+  include Mongoid::Sharer
 
   field :name, type: String
 end

data/spec/mongoid/mongoid_socializer_actions/shares_spec.rb

@@ -0,0 +1,103 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Mongoid::Sharer do
+  describe User do
+    before :each do
+      @john = User.create(name: 'john')
+      @jashua = User.create(name: 'jashua')
+    end
+
+    it "should have no shares" do
+      [@john, @jashua].each {|u| u.shared_objects.should be_empty}
+    end
+
+    describe Photo do
+      before :each do
+        @photo1 = Photo.create
+        @photo2 = Photo.create
+      end
+
+      it "should have no shares" do
+        [@photo1, @photo2].each { |p| p.shares.should be_empty }
+      end
+
+      it "should be sharable" do
+        expect{ @john.share(@photo1) }.to change(Mongoid::Share, :count).by(1)
+      end
+
+      it "should be shared by sharer" do
+        @john.share(@photo1)
+        @john.shared?(@photo1).should be_true
+      end
+
+      it "should be unshared by sharer" do
+        @john.share(@photo1)
+        @john.unshare(@photo1)
+        @john.shared?(@photo1).should be_false
+      end
+
+      it "should have the liker as sharer" do
+        @john.share(@photo1)
+        @photo1.sharers.should include @john
+      end
+
+      it "should not have others as sharer" do
+        @photo1.sharers.should_not include @jashua
+      end
+
+      it "should be increase likes_count" do
+        expect{ @jashua.share(@photo1) }.to change(@photo1, :shares_count).by(1)
+      end
+
+      it "should be shared by multiple sharers" do
+        @jashua.share(@photo1)
+        @john.share(@photo1)
+        @photo1.sharers.should include @john, @jashua
+      end
+
+      it "should have the correct sharers count" do
+        @jashua.share(@photo1)
+        @john.share(@photo1)
+        @photo1.shares_count.should be 2
+      end
+
+      it "should be unsharable" do
+        @jashua.share(@photo1)
+        @jashua.unshare(@photo1).should be_true
+      end
+
+      it "should not be unsharable by shere" do
+        @jashua.unshare(@photo1).should be_false
+      end
+
+      it "should not include former liker" do
+        @photo1.sharers.should_not include @jashua
+      end
+
+      it "should not be included in former likes" do
+        @jashua.shared_objects.should_not include @photo1
+      end
+    end
+
+    describe "get likes by model" do
+      before :each do
+        @photo1 = Photo.create
+        @photo2 = Photo.create
+        @album1 = Album.create
+        @album2 = Album.create
+        @john.share(@photo1)
+        @john.share(@photo2)
+        @john.share(@album1)
+      end
+
+      it "should return photo likes count" do
+        @john.photo_shares_count.should == 2
+        @john.album_shares_count.should == 1
+      end
+
+      it "should return liked photos " do
+        @john.shared_photos.should == [@photo1, @photo2]
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -11,7 +11,7 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'app'))
 
-Mongoid.load! '/Users/sreehari/MyProjects/mongoid_likes/spec/config/mongoid.yml', :test
+Mongoid.load! '/Users/sreehari/MyProjects/mongoid_socializer_actions/spec/config/mongoid.yml', :test
 
 require 'mongoid_socializer_actions'
 require 'rspec'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_socializer_actions
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &2156352400 !ruby/object:Gem::Requirement
+  requirement: &2160400880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156352400
+  version_requirements: *2160400880
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2156351880 !ruby/object:Gem::Requirement
+  requirement: &2160398860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *2156351880
+  version_requirements: *2160398860
 description: Add liking, commentable, sharabel, tagabel ability to Mongoid documents.
 email:
 - sreehari@activesphere.com
@@ -48,12 +48,15 @@ files:
 - Readme.md
 - app/models/comment.rb
 - app/models/like.rb
+- app/models/share.rb
 - lib/mongoid_socializer_actions.rb
 - lib/mongoid_socializer_actions/commentable.rb
 - lib/mongoid_socializer_actions/commenter.rb
 - lib/mongoid_socializer_actions/helper.rb
 - lib/mongoid_socializer_actions/likeable.rb
 - lib/mongoid_socializer_actions/liker.rb
+- lib/mongoid_socializer_actions/sharable.rb
+- lib/mongoid_socializer_actions/sharer.rb
 - lib/mongoid_socializer_actions/version.rb
 - mongoid_socializer_actions.gemspec
 - spec/config/mongoid.yml
@@ -62,6 +65,7 @@ files:
 - spec/mongoid/models/user.rb
 - spec/mongoid/mongoid_socializer_actions/comments_spec.rb
 - spec/mongoid/mongoid_socializer_actions/likes_spec.rb
+- spec/mongoid/mongoid_socializer_actions/shares_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/sreehari/mongoid_socializer_actions
 licenses: []
@@ -95,4 +99,5 @@ test_files:
 - spec/mongoid/models/user.rb
 - spec/mongoid/mongoid_socializer_actions/comments_spec.rb
 - spec/mongoid/mongoid_socializer_actions/likes_spec.rb
+- spec/mongoid/mongoid_socializer_actions/shares_spec.rb
 - spec/spec_helper.rb