mongoid_follow 0.0.2 → 0.1.0

data/README.rdoc

@@ -1,57 +1,75 @@
-= Follow stuff for Mongoid
+= Follow feature for Rails3 with Mongoid
 
 == Installation
 
 In Gemfile:
-  gem 'mongoid_follow""
+  gem 'mongoid_follow'
+
+== Legend (to ease complications)
+
+  "follower" is a model who follows
+  "followee" is a model who would be followed
 
 == To use
 
-To make mongoid_follow usable you need to include Mongoid::Followee into your document
-Meanwhile, you also need to include Mongoid::Follower in your follower model:
+To make mongoid_follow usable you need to include Mongoid::Followee into your document who would be followed then you also need to include Mongoid::Follower in your follower model:
 
   class User
     include Mongoid::Document
+
     include Mongoid::Followee
     include Mongoid::Follower
   end
 
   class Group
     include Mongoid::Document
+
     include Mongoid::Followee
   end
 
 You can then follow a model using:
 
-  @bonnie = User.new
-  @bonnie.save
+  @bonnie = User.create
+  @clyde = User.create
+
+  @bonnie.follow(@clyde)
+  @bonnie.unfollow(@clyde)
+
+You can also see whether a model is a follower of another model or if a model is a followee of another model:
+
+  @clyde.follower?(@bonnie)
+  @bonnie.followee?(@clyde)
+
+You can also be a follower of other models
 
-  current_user.follow(@clyde)
-  current_user.unfollow?(@clyde)
+  @gang = Group.create
+  @bonnie.follow(@group)
 
-You can also see whether a model is a follower of another model or a model is a followee of another model:
+  @gang.follower?(@bonnie)
+  @bonnie.follows?(@gang)
 
-    current_user.follower?(@clyde)
-    current_user.followee?(@clyde)
+* Any bug or issue, please send me an email to aeguintu@gmail.com
 
-Of course, you can get a list of followers/followees:
+== For development
 
-    @clyde.followers
-    @bonnie.followees
+  gem install 'mongoid'
+  gem install 'bson_ext'
+  gem install 'database_cleaner'
+  gem install 'rspec'
 
-* Any bug or issue, please send me an email: aeguintu@gmail.com
+  rake spec/specs/follow_spec_rb
 
 == TODO
 
-* finish up todo's
-* count of followers/followees
-* common followers (or maybe followees)
-* maybe... (un)authorization of who can follow (model)
-* most/least followed/following #FINISHED
+* finish up todo's (list of followers and followees) ==FINISHED
+* count of followers/followees ==FINISHED
+* common followers (or maybe followees) ==FINISHED
 
 == Thanks
 
-Thanks the mongoid_followable for 
+Super thanks:
+to mongoid_followable.
+to Tristan Peralta.
 
 == Copyright
 

data/lib/mongoid_follow/followee.rb

@@ -3,10 +3,11 @@ module Mongoid
     extend ActiveSupport::Concern
 
     included do |base|
+      base.field    :fferc, :type => Integer, :default => 0
       base.has_many :followers, :class_name => 'Follow', :as => :follower, :dependent => :destroy
     end
 
-    # see if this model is followed of some model
+    # know if self is followed by model
     #
     # Example:
     # >> @clyde.follower?(@bonnie)
@@ -15,13 +16,41 @@ module Mongoid
       0 < self.followers.find(:all, conditions: {ff_id: model.id}).limit(1).count
     end
 
+    # get followees count
+    #
+    # Example:
+    # >> @bonnie.followees_count
+    # => 1
+    def followers_count
+      self.fferc
+    end
+
     # view all selfs followers
     #
     # Example:
-    # >> @clyde.follower?(@bonnie)
-    # => true
-    def followers(model)
-      #TODO
+    # >> @clyde.all_followers
+    # => [@bonnie, @alec]
+    def all_followers
+      get_followers_of(self)
+    end
+
+    # view all common followers of self against model
+    #
+    # Example:
+    # >> @clyde.common_followers_with(@gang)
+    # => [@bonnie, @alec]
+    def common_followers_with(model)
+      model_followers = get_followers_of(model)
+      self_followers = get_followers_of(self)
+
+      self_followers & model_followers
+    end
+
+    private
+    def get_followers_of(me)
+      me.followers.collect do |f|
+        f.ff_type.constantize.find(f.ff_id)
+      end
     end
   end
 end

data/lib/mongoid_follow/follower.rb

@@ -3,6 +3,7 @@ module Mongoid
     extend ActiveSupport::Concern
 
     included do |base|
+      base.field    :ffeec, :type => Integer, :default => 0
       base.has_many :followees, :class_name => 'Follow', :as => :followee, :dependent => :destroy
     end
 
@@ -11,9 +12,15 @@ module Mongoid
     # Example:
     # >> @bonnie.follow(@clyde)
     def follow(model)
-      model.followers.create!(:ff_type => self.class.name, :ff_id => self.id)
+      if self.id != model.id && !self.follows?(model)
+        model.followers.create!(:ff_type => self.class.name, :ff_id => self.id)
+        model.inc(:fferc, 1)
 
-      self.followees.create!(:ff_type => model.class.name, :ff_id => model.id)
+        self.followees.create!(:ff_type => model.class.name, :ff_id => model.id)
+        self.inc(:ffeec, 1)
+      else
+        return false
+      end
     end
 
     # unfollow a model
@@ -21,12 +28,18 @@ module Mongoid
     # Example:
     # >> @bonnie.unfollow(@clyde)
     def unfollow(model)
-      model.followers.where(:ff_type => self.class.name, :ff_id => self.id).destroy
+      if self.id != model.id && self.follows?(model)
+        model.followers.where(:ff_type => self.class.name, :ff_id => self.id).destroy
+        model.inc(:fferc, -1)
 
-      self.followees.where(:ff_type => model.class.name, :ff_id => model.id).destroy
+        self.followees.where(:ff_type => model.class.name, :ff_id => model.id).destroy
+        self.inc(:ffeec, -1)
+      else
+        return false
+      end
     end
 
-    # follow a model
+    # know if self is already following model
     #
     # Example:
     # >> @bonnie.follows?(@clyde)
@@ -35,12 +48,41 @@ module Mongoid
       0 < self.followees.find(:all, conditions: {ff_id: model.id}).limit(1).count
     end
 
+    # get followees count
+    #
+    # Example:
+    # >> @bonnie.followees_count
+    # => 1
+    def followees_count
+      self.ffeec
+    end
+
     # view all selfs followees
     #
     # Example:
-    # >> @alec.followees
-    def followees(model)
-      # TODO
+    # >> @alec.all_followees
+    # => [@bonnie]
+    def all_followees
+      get_followees_of(self)
+    end
+
+    # view all common followees of self against model
+    #
+    # Example:
+    # >> @clyde.common_followees_with(@gang)
+    # => [@bonnie, @alec]
+    def common_followees_with(model)
+      model_followees = get_followees_of(model)
+      self_followees = get_followees_of(self)
+
+      self_followees & model_followees
+    end
+
+    private
+    def get_followees_of(me)
+      me.followees.collect do |f|
+        f.ff_type.constantize.find(f.ff_id)
+      end
     end
   end
 end

data/lib/mongoid_follow/version.rb

@@ -1,3 +1,3 @@
 module MongoidFollow
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/mongoid_follow.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Alec Guintu"]
   s.email       = ["animerei12@gmail.com"]
   s.homepage    = "https://github.com/alecguintu/mongoid_follow"
-  s.summary     = %q{ Add basic "follow" features to rails3/mongoid }
-  s.description = %q{ A gem to add a basic "follow" feature if you're using rails3 with mongoid }
+  s.summary     = %q{ Add basic "follow" features to rails3 + mongoid }
+  s.description = %q{ Gem to add basic "follow" features if you're using rails3 with mongoid }
 
   s.rubyforge_project = "mongoid_follow"
 

data/spec/models/group.rb

@@ -1,4 +1,6 @@
 class Group
   include Mongoid::Document
   include Mongoid::Followee
+
+  field :name
 end

data/spec/models/user.rb

@@ -2,4 +2,6 @@ class User
   include Mongoid::Document
   include Mongoid::Followee
   include Mongoid::Follower
+
+  field :name
 end

data/spec/specs/follow_spec.rb

@@ -5,17 +5,11 @@ describe Mongoid::Follower do
   describe User do
 
     before do
-      @bonnie = User.new
-      @bonnie.save
+      @bonnie = User.create(:name => 'Bonnie')
+      @clyde = User.create(:name => 'Clyde')
+      @alec = User.create(:name => 'Alec')
 
-      @clyde = User.new
-      @clyde.save
-
-      @alec = User.new
-      @alec.save
-
-      @gang = Group.new
-      @gang.save
+      @gang = Group.create(:name => 'Gang')
     end
 
     it "should have no follows or followers" do
@@ -33,6 +27,16 @@ describe Mongoid::Follower do
       @clyde.follower?(@bonnie).should be_true
     end
 
+    it "should decline to follow self" do
+      @bonnie.follow(@bonnie).should be_false
+    end
+
+    it "should decline two follows" do
+      @bonnie.follow(@clyde)
+
+      @bonnie.follow(@clyde).should be_false
+    end
+
     it "can unfollow another User" do
       @bonnie.follows?(@clyde).should be_false
       @clyde.follower?(@bonnie).should be_false
@@ -46,11 +50,80 @@ describe Mongoid::Follower do
       @clyde.follower?(@bonnie).should be_false
     end
 
+    it "should decline unfollow of non-followed User" do
+      @bonnie.unfollow(@clyde).should be_false
+    end
+
+    it "should decline unfollow of self" do
+      @bonnie.unfollow(@bonnie).should be_false
+    end
+
     it "can follow a group" do
       @bonnie.follow(@gang)
 
       @bonnie.follows?(@gang).should be_true
       @gang.follower?(@bonnie).should be_true
     end
+
+    it "should increment / decrement counters" do
+      @clyde.followers_count.should == 0
+
+      @bonnie.follow(@clyde)
+
+      @bonnie.followees_count.should == 1
+      @clyde.followers_count.should == 1
+
+      @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
+
+      @bonnie.unfollow(@clyde)
+      @bonnie.followees_count.should == 0
+      @clyde.followers_count.should == 0
+    end
+
+    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)
+      @clyde.all_followers.should == [@bonnie, @alec]
+    end
+
+    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
+
+      @bonnie.follow(@gang)
+      @bonnie.all_followees.should == [@clyde, @gang]
+    end
+
+    it "should have common followers" do
+      @bonnie.follow(@clyde)
+      @bonnie.follow(@gang)
+
+      @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
 end

metadata

@@ -2,7 +2,7 @@
 name: mongoid_follow
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - Alec Guintu
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-10 00:00:00 +08:00
+date: 2011-11-03 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -57,7 +57,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id004
-description: " A gem to add a basic \"follow\" feature if you're using rails3 with mongoid "
+description: " Gem to add basic \"follow\" features if you're using rails3 with mongoid "
 email: 
 - animerei12@gmail.com
 executables: []
@@ -109,7 +109,7 @@ rubyforge_project: mongoid_follow
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Add basic "follow" features to rails3/mongoid
+summary: Add basic "follow" features to rails3 + mongoid
 test_files: 
 - spec/models/group.rb
 - spec/models/user.rb