mongoid_follow 0.2.1 → 0.2.2

data/README.rdoc

@@ -48,6 +48,40 @@ You can also be a follower of other models
   @gang.follower?(@bonnie)
   @bonnie.follows?(@gang)
 
+=== Getting followers/followees
+
+Get all followers/followees by
+
+  @gang.all_followers
+  @bonnie.all_followees
+
+You can also get followers/followees by a certain model
+
+  @gang.all_followers_by_model(User)
+  @bonnie.all_followees_by_model(Gang)
+
+=== Counting followers/followees
+
+Get the count of followers/followees using
+
+  @gang.followers_count
+  @bonnie.followees_count
+
+Or by a certain model by
+
+  @gang.followers_count_by_model(User)
+  @bonnie.followees_count_by_model(User)
+
+=== Dynamic methods
+
+You can use dynamic methods to shorten code for getting followers/followees or their count of a certain model by
+
+  @gang.all_user_followers
+  @bonnie.all_gang_followees
+
+  @gang.user_followers_count
+  @bonnie.user_followees_count
+
 == Callbacks
 
 You can attach callbacks to the follower/followee models before or after the follow.
@@ -73,7 +107,7 @@ You can attach callbacks to the follower/followee models before or after the fol
   before_unfollowed_by
   after_unfollowed_by
 
-* Note: careful with using callbacks, we have no transaction so if breaks on your callbacks, what gets saved is saved.
+Note: careful with using callbacks, we have no transaction so if it breaks on your callbacks, what gets saved is saved.
 
 * Any bug or issue, please send me an email to aeguintu@gmail.com
 
@@ -88,15 +122,13 @@ You can attach callbacks to the follower/followee models before or after the fol
 
 == TODO
 
-* finish up todo's (list of followers and followees) ==FINISHED
-* count of followers/followees ==FINISHED
-* common followers (or maybe followees) ==FINISHED
+* limit result of followers/followees
 
 == Thanks
 
-Super thanks:
-to mongoid_followable.
-to Tristan Peralta.
+Awesome thanks to:
+  to mongoid_followable
+  to Tristan Peralta
 
 == Copyright
 

data/lib/mongoid_follow.rb

@@ -1,3 +1,4 @@
 require File.join(File.dirname(__FILE__), "mongoid_follow/follower")
 require File.join(File.dirname(__FILE__), "mongoid_follow/followee")
+require File.join(File.dirname(__FILE__), "mongoid_follow/helper")
 require File.join(File.dirname(__FILE__), "../app/models/follow")

data/lib/mongoid_follow/followee.rb

@@ -10,34 +10,53 @@ module Mongoid
     # know if self is followed by model
     #
     # Example:
-    # >> @clyde.follower?(@bonnie)
+    # => @clyde.follower?(@bonnie)
     # => true
     def follower?(model)
       0 < self.followers.find(:all, conditions: {ff_id: model.id}).limit(1).count
     end
 
-    # get followees count
+    # get followers count
+    # Note: this is a cache counter
     #
     # Example:
-    # >> @bonnie.followees_count
+    # => @bonnie.followers_count
     # => 1
     def followers_count
       self.fferc
     end
 
+    # get followers count by model
+    #
+    # Example:
+    # => @bonnie.followers_count_by_model(User)
+    # => 1
+    def followers_count_by_model(model)
+      self.followers.where(:ff_type => model.to_s).count
+    end
+
     # view all selfs followers
     #
     # Example:
-    # >> @clyde.all_followers
+    # => @clyde.all_followers
     # => [@bonnie, @alec]
     def all_followers
       get_followers_of(self)
     end
 
+    # view all selfs followers by model
+    #
+    # Example:
+    # => @clyde.all_followers_by_model
+    # => [@bonnie]
+    def all_followers_by_model(model)
+      get_followers_of(self, model)
+    end
+
     # view all common followers of self against model
     #
     # Example:
-    # >> @clyde.common_followers_with(@gang)
+    # => @clyde.common_followers_with(@gang)
     # => [@bonnie, @alec]
     def common_followers_with(model)
       model_followers = get_followers_of(model)
@@ -47,10 +66,22 @@ module Mongoid
     end
 
     private
-    def get_followers_of(me)
-      me.followers.collect do |f|
+    def get_followers_of(me, model = nil)
+      followers = !model ? me.followers : me.followers.where(:ff_type => model.to_s)
+
+      followers.collect do |f|
         f.ff_type.constantize.find(f.ff_id)
       end
     end
+
+    def method_missing(missing_method, *args, &block)
+      if missing_method.to_s =~ /^(.+)_followers_count$/
+        followers_count_by_model($1.camelize)
+      elsif missing_method.to_s =~ /^all_(.+)_followers$/
+        all_followers_by_model($1.camelize)
+      else
+        super
+      end
+    end
   end
 end

data/lib/mongoid_follow/follower.rb

@@ -10,7 +10,7 @@ module Mongoid
     # follow a model
     #
     # Example:
-    # >> @bonnie.follow(@clyde)
+    # => @bonnie.follow(@clyde)
     def follow(model)
       if self.id != model.id && !self.follows?(model)
 
@@ -32,7 +32,7 @@ module Mongoid
     # unfollow a model
     #
     # Example:
-    # >> @bonnie.unfollow(@clyde)
+    # => @bonnie.unfollow(@clyde)
     def unfollow(model)
       if self.id != model.id && self.follows?(model)
 
@@ -54,34 +54,53 @@ module Mongoid
     # know if self is already following model
     #
     # Example:
-    # >> @bonnie.follows?(@clyde)
+    # => @bonnie.follows?(@clyde)
     # => true
     def follows?(model)
       0 < self.followees.find(:all, conditions: {ff_id: model.id}).limit(1).count
     end
 
     # get followees count
+    # Note: this is a cache counter
     #
     # Example:
-    # >> @bonnie.followees_count
+    # => @bonnie.followees_count
     # => 1
     def followees_count
       self.ffeec
     end
 
+    # get followees count by model
+    #
+    # Example:
+    # => @bonnie.followees_count_by_model(User)
+    # => 1
+    def followees_count_by_model(model)
+      self.followees.where(:ff_type => model.to_s).count
+    end
+
     # view all selfs followees
     #
     # Example:
-    # >> @alec.all_followees
+    # => @alec.all_followees
     # => [@bonnie]
     def all_followees
       get_followees_of(self)
     end
 
+    # view all selfs followees by model
+    #
+    # Example:
+    # => @clyde.all_followees_by_model
+    # => [@bonnie]
+    def all_followees_by_model(model)
+      get_followees_of(self, model)
+    end
+
     # view all common followees of self against model
     #
     # Example:
-    # >> @clyde.common_followees_with(@gang)
+    # => @clyde.common_followees_with(@gang)
     # => [@bonnie, @alec]
     def common_followees_with(model)
       model_followees = get_followees_of(model)
@@ -91,10 +110,22 @@ module Mongoid
     end
 
     private
-    def get_followees_of(me)
-      me.followees.collect do |f|
+    def get_followees_of(me, model = nil)
+      followees = !model ? me.followees : me.followees.where(:ff_type => model.to_s)
+
+      followees.collect do |f|
         f.ff_type.constantize.find(f.ff_id)
       end
     end
+
+    def method_missing(missing_method, *args, &block)
+      if missing_method.to_s =~ /^(.+)_followees_count$/
+        followees_count_by_model($1.camelize)
+      elsif missing_method.to_s =~ /^all_(.+)_followees$/
+        all_followees_by_model($1.camelize)
+      else
+        super
+      end
+    end
   end
 end

data/lib/mongoid_follow/helper.rb

@@ -0,0 +1,5 @@
+class String
+  def camelize
+    self.to_s.gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }
+  end
+end

data/lib/mongoid_follow/version.rb

@@ -1,3 +1,3 @@
 module MongoidFollow
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/spec/models/other_user.rb

@@ -0,0 +1,6 @@
+class OtherUser
+  include Mongoid::Document
+  include Mongoid::Follower
+
+  field :name
+end

data/spec/spec_helper.rb

@@ -11,6 +11,7 @@ end
 
 require File.expand_path("../../lib/mongoid_follow", __FILE__)
 require File.expand_path("../models/user", __FILE__)
+require File.expand_path("../models/other_user", __FILE__)
 require File.expand_path("../models/group", __FILE__)
 
 RSpec.configure do |c|

data/spec/specs/follow_spec.rb

@@ -8,6 +8,7 @@ describe Mongoid::Follower do
       @bonnie = User.create(:name => 'Bonnie')
       @clyde = User.create(:name => 'Clyde')
       @alec = User.create(:name => 'Alec')
+      @just_another_user = OtherUser.create(:name => 'Another User')
 
       @gang = Group.create(:name => 'Gang')
     end
@@ -65,75 +66,145 @@ describe Mongoid::Follower do
       @gang.follower?(@bonnie).should be_true
     end
 
-    it "should increment / decrement counters" do
-      @clyde.followers_count.should == 0
+    describe "counting stuff" do
+      it "should increment / decrement cache counters" do
+        @clyde.followers_count.should == 0
 
-      @bonnie.follow(@clyde)
+        @bonnie.follow(@clyde)
+        @bonnie.followees_count.should == 1
+        @clyde.followers_count.should == 1
 
-      @bonnie.followees_count.should == 1
-      @clyde.followers_count.should == 1
+        @alec.follow(@clyde)
+        @clyde.followers_count.should == 2
+        @bonnie.followers_count.should == 0
 
-      @alec.follow(@clyde)
-      @clyde.followers_count.should == 2
-      @bonnie.followers_count.should == 0
+        @alec.unfollow(@clyde)
+        @alec.followees_count.should == 0
+        @clyde.followers_count.should == 1
 
-      @alec.unfollow(@clyde)
-      @alec.followees_count.should == 0
-      @clyde.followers_count.should == 1
+        @bonnie.unfollow(@clyde)
+        @bonnie.followees_count.should == 0
+        @clyde.followers_count.should == 0
+      end
 
-      @bonnie.unfollow(@clyde)
-      @bonnie.followees_count.should == 0
-      @clyde.followers_count.should == 0
-    end
+      it "should allow to count followees by model" do
+        @alec.follow(@gang)
+        @alec.followees_count.should == 1
+        @alec.followees_count_by_model(Group).should == 1
 
-    it "should list all followers" do
-      @bonnie.follow(@clyde)
-      # @clyde.all_followers.should == [@bonnie] # spec has an error on last #all_followers when this is called
+        @alec.follow(@clyde)
+        @alec.followees_count.should == 2
+        @alec.followees_count_by_model(Group).should == 1
+      end
 
-      @alec.follow(@clyde)
-      @clyde.all_followers.should == [@bonnie, @alec]
-    end
+      it "should also allow to count followees by model with dynamic method" do
+        @alec.follow(@gang)
+        @alec.follow(@clyde)
 
-    it "should list all followee" do
-      @bonnie.follow(@clyde)
-      # @bonnie.all_followees.should == [@clyde] # spec has an error on last #all_followees when this is called
+        @alec.group_followees_count.should == 1
+      end
 
-      @bonnie.follow(@gang)
-      @bonnie.all_followees.should == [@clyde, @gang]
+      it "should allow to count followers by model" do
+        @just_another_user.follow(@gang)
+        @gang.followers_count.should == 1
+        @gang.followers_count_by_model(OtherUser).should == 1
+
+        @alec.follow(@gang)
+        @gang.followers_count.should == 2
+        @gang.followers_count_by_model(OtherUser).should == 1
+      end
+
+      it "should also allow to count followers by model with dynamic method" do
+        @just_another_user.follow(@gang)
+        @alec.follow(@gang)
+
+        @gang.user_followers_count.should == 1
+      end
     end
 
-    it "should have common followers" do
-      @bonnie.follow(@clyde)
-      @bonnie.follow(@gang)
+    describe "listing stuff" do
+      it "should list all followers" do
+        @bonnie.follow(@clyde)
+        # @clyde.all_followers.should == [@bonnie] # spec has an error on last #all_followers when this is called
 
-      @gang.common_followers_with(@clyde).should == [@bonnie]
+        @alec.follow(@clyde)
+        @clyde.all_followers.should == [@bonnie, @alec]
+      end
 
-      @alec.follow(@clyde)
-      @alec.follow(@gang)
+      it "should list all followers by model" do
+        @bonnie.follow(@gang)
+        @just_another_user.follow(@gang)
 
-      @clyde.common_followers_with(@gang).should == [@bonnie, @alec]
-    end
+        @gang.all_followers.should == [@bonnie, @just_another_user]
+        @gang.all_followers_by_model(User).should == [@bonnie]
+      end
 
-    it "should have common followees" do
-      @bonnie.follow(@gang)
-      @alec.follow(@gang)
+      it "should list all followers by model with dynamic method" do
+        @bonnie.follow(@gang)
+        @just_another_user.follow(@gang)
 
-      @alec.common_followees_with(@bonnie).should == [@gang]
+        @gang.all_user_followers(User).should == [@bonnie]
+      end
 
-      @bonnie.follow(@clyde)
-      @alec.follow(@clyde)
+      it "should list all followees" do
+        @bonnie.follow(@clyde)
+        # @bonnie.all_followees.should == [@clyde] # spec has an error on last #all_followees when this is called
+
+        @bonnie.follow(@gang)
+        @bonnie.all_followees.should == [@clyde, @gang]
+      end
+
+      it "should list all followees by model" do
+        @bonnie.follow(@gang)
+        @bonnie.follow(@clyde)
+
+        @bonnie.all_followees.should == [@gang, @clyde]
+        @bonnie.all_followees_by_model(User).should == [@clyde]
+      end
+
+      it "should list all followees by model with dynamic method" do
+        @bonnie.follow(@gang)
+        @bonnie.follow(@clyde)
+
+        @bonnie.all_user_followees.should == [@clyde]
+      end
+
+      it "should have common followers" do
+        @bonnie.follow(@clyde)
+        @bonnie.follow(@gang)
 
-      @bonnie.common_followees_with(@alec).should == [@gang, @clyde]
+        @gang.common_followers_with(@clyde).should == [@bonnie]
+
+        @alec.follow(@clyde)
+        @alec.follow(@gang)
+
+        @clyde.common_followers_with(@gang).should == [@bonnie, @alec]
+      end
+
+      it "should have common followees" do
+        @bonnie.follow(@gang)
+        @alec.follow(@gang)
+
+        @alec.common_followees_with(@bonnie).should == [@gang]
+
+        @bonnie.follow(@clyde)
+        @alec.follow(@clyde)
+
+        @bonnie.common_followees_with(@alec).should == [@gang, @clyde]
+      end
     end
 
-    # Duh... this is a useless spec... Hrmn...
-    it "should respond on callbacks" do
-      @bonnie.respond_to?('after_follow').should be_true
-      @bonnie.respond_to?('after_unfollowed_by').should be_true
-      @bonnie.respond_to?('before_follow').should be_false
+    describe "callback stuff" do
+      # Duh... this is a useless spec... Hrmn...
+      it "should respond on callbacks" do
+        @bonnie.respond_to?('after_follow').should be_true
+        @bonnie.respond_to?('after_unfollowed_by').should be_true
+        @bonnie.respond_to?('before_follow').should be_false
 
-      @gang.respond_to?('before_followed_by').should be_true
-      @gang.respond_to?('after_followed_by').should be_false
+        @gang.respond_to?('before_followed_by').should be_true
+        @gang.respond_to?('after_followed_by').should be_false
+      end
     end
+
   end
 end

metadata

@@ -1,72 +1,67 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: mongoid_follow
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.2.2
   prerelease: 
-  version: 0.2.1
 platform: ruby
-authors: 
+authors:
 - Alec Guintu
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-11-17 00:00:00 +08:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: mongoid
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70284082589660 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: bson_ext
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70284082589660
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: &70284082589180 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: database_cleaner
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70284082589180
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: &70284082588680 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70284082588680
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70284082588160 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-description: " Gem to add basic \"follow\" features if you're using rails3 with mongoid "
-email: 
+  prerelease: false
+  version_requirements: *70284082588160
+description: ! ' Gem to add basic "follow" features if you''re using rails3 with mongoid '
+email:
 - animerei12@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - LICENSE.txt
@@ -76,42 +71,41 @@ files:
 - lib/mongoid_follow.rb
 - lib/mongoid_follow/followee.rb
 - lib/mongoid_follow/follower.rb
+- lib/mongoid_follow/helper.rb
 - lib/mongoid_follow/version.rb
 - mongoid_follow.gemspec
 - spec/models/group.rb
+- spec/models/other_user.rb
 - spec/models/user.rb
 - spec/spec_helper.rb
 - spec/specs/follow_spec.rb
-has_rdoc: true
 homepage: https://github.com/alecguintu/mongoid_follow
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: mongoid_follow
-rubygems_version: 1.6.2
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Add basic "follow" features to rails3 + mongoid
-test_files: 
+test_files:
 - spec/models/group.rb
+- spec/models/other_user.rb
 - spec/models/user.rb
 - spec/spec_helper.rb
 - spec/specs/follow_spec.rb