voteable_mongoid 0.6.3 → 0.6.4

data/CHANGELOG.rdoc

@@ -1,3 +1,6 @@
+== 0.6.4
+  * Drop Voter#votees, Voter#up_votees, Voter#down_votees in favor of Voteable#voted_by(voter), Voteable#up_voted_by(voter), Voteable#down_voted_by(voter) scopes
+  
 == 0.6.3
   * Add rake db:mongoid:voteable:migrate_old_votes to migrate vote data created by version < 0.6.0 to new vote data storage
 

data/README.rdoc

@@ -1,9 +1,10 @@
 = Voteable Mongoid
 
-Voteable Mongoid allows you to make your Mongoid::Document objects voteable (up or down)
+Voteable Mongoid allows you to make your Mongoid::Document objects voteable (up or down).
 For instance, in a forum, a user can vote up (or down) on a post or a comment.
 
-Voteable Mongoid is built for speed. It minimizes vote data storage and uses only one database request per collection to do both data validation and data update.
+Voteable Mongoid is built for speed. It minimizes vote data storage and uses 
+only one database request per collection to do both data validation and data update.
 
 Sample app at https://github.com/vinova/simple_qa
 
@@ -72,30 +73,36 @@ user.rb
     puts @post.up_votes_count
     puts @post.down_votes_count
 
-=== Getting the list of voted objects (votees) of a class
+=== Getting the list of voted objects of a class
 
-    @user.votees(Post)
+    Post.voted_by(@user)
+    Post.up_voted_by(@user)
+    Post.down_voted_by(@user)
 
 === Undo a vote
 
     @user.unvote(@comment)
 
-=== Re-generate counters and vote points
+== Utilities
 
+=== Re-generate counters and vote points in case you change :up / :down vote points
 Rails
     rake db:mongoid:voteable:remake_stats
-  
 Ruby
     Mongoid::Voteable::Stats.remake
 
 === Set counters and point to 0 for uninitialized voteable objects in order sort and query
-
 Rails
     rake db:mongoid:voteable:init_stats
-  
 Ruby
     Mongoid::Voteable::Stats.init
 
+=== Migrate from version < 0.6.0
+Rails
+    rake db:mongoid:voteable:migrate_old_votes
+Ruby
+    Mongoid::Voteable.migrate_old_votes
+
 == Credits
 
 * Alex N. - Author

data/lib/voteable_mongoid/version.rb

@@ -1,3 +1,3 @@
 module VoteableMongoid
-  VERSION = '0.6.3'
+  VERSION = '0.6.4'
 end

data/lib/voteable_mongoid/voteable.rb

@@ -11,6 +11,21 @@ module Mongoid
       include Mongoid::Voteable::Stats
       field :votes, :type => Mongoid::Voteable::Votes
       
+      scope :voted_by, lambda { |voter|
+        voter_id = voter.is_a?(BSON::ObjectId) ? voter : voter._id
+        any_of({ UP_VOTER_IDS => voter_id }, { DOWN_VOTER_IDS => voter_id })
+      }
+      
+      scope :up_voted_by, lambda { |voter|
+        voter_id = voter.is_a?(BSON::ObjectId) ? voter : voter._id
+        where( UP_VOTER_IDS => voter_id )
+      }
+      
+      scope :down_voted_by, lambda { |voter|
+        voter_id = voter.is_a?(BSON::ObjectId) ? voter : voter._id
+        where( DOWN_VOTER_IDS => voter_id )
+      }
+      
       before_create do
         # Init votes so that counters and point have numeric values (0)
         self.votes = VOTES_DEFAULT_ATTRIBUTES
@@ -201,7 +216,6 @@ module Mongoid
         end
         true
       end
-      
     end
   
     # Make a vote on this votee
@@ -224,7 +238,7 @@ module Mongoid
 
     # Get a voted value on this votee
     #
-    # @param [Mongoid Object, BSON::ObjectId] voter is Mongoid object the id of the voter who made the vote
+    # @param [Mongoid Object, BSON::ObjectId] voter is Mongoid object or the id of the voter who made the vote
     def vote_value(voter)
       voter_id = voter.is_a?(BSON::ObjectId) ? voter : voter._id
       return :up if up_voter_ids.include?(voter_id)

data/lib/voteable_mongoid/voter.rb

@@ -2,30 +2,6 @@ module Mongoid
   module Voter
     extend ActiveSupport::Concern
 
-    # Get list of voted votees
-    #
-    # @param [Class] klass the voteable class, e.g. `Post` or `Comment`
-    # @return [Array, nil] an array of voteable objects voted by this voter
-    def votees(klass)
-      klass.any_of({ Voteable::UP_VOTER_IDS => _id }, { Voteable::DOWN_VOTER_IDS => _id })
-    end
-
-    # Get list of up voted votees
-    #
-    # @param [Class] klass the voteable class, e.g. `Post` or `Comment`
-    # @return [Array, nil] an array of voteable objects up voted by this voter
-    def up_votees(klass)
-      klass.where(Voteable::UP_VOTER_IDS => _id)
-    end
-
-    # Get list of down voted votees
-    #
-    # @param [Class] klass the voteable class, e.g. `Post` or `Comment`
-    # @return [Array, nil] an array of voteable objects down voted by this voter
-    def down_votees(klass)
-      klass.where(Voteable::DOWN_VOTER_IDS => _id)
-    end
-
     # Check to see if this voter voted on the votee or not
     #
     # @param [Hash, Object] options the hash containing the votee, or the votee itself
@@ -45,7 +21,7 @@ module Mongoid
         end
       end
       
-      votees(votee_class).where(:_id => votee_id).count == 1
+      votee_class.voted_by(self).where(:_id => votee_id).count == 1
     end
 
     # Get the voted value on a votee

data/spec/voteable_mongoid/voteable_spec.rb

@@ -33,9 +33,9 @@ describe Mongoid::Voteable do
       @post2.down_voter_ids.should be_empty
     end
     
-    it 'voter votees should be empty' do
-      @user1.votees(Post).should be_empty
-      @user2.votees(Post).should be_empty
+    it 'posts voted voter should be empty' do
+      Post.voted_by(@user1).should be_empty
+      Post.voted_by(@user2).should be_empty
     end
     
     it 'test Stats.init' do
@@ -91,8 +91,8 @@ describe Mongoid::Voteable do
       @post1.vote_value(@user1).should == :up
       @post1.vote_value(@user2.id).should be_nil
 
-      @user1.votees(Post).to_a.should == [ @post1 ]
-      @user2.votees(Post).to_a.should be_empty
+      Post.voted_by(@user1).to_a.should == [ @post1 ]
+      Post.voted_by(@user2).to_a.should be_empty
     end
     
     it 'user1 vote post1 has no effect' do
@@ -123,8 +123,8 @@ describe Mongoid::Voteable do
       @post1.vote_value(@user1.id).should == :up
       @post1.vote_value(@user2.id).should == :down
 
-      @user1.votees(Post).to_a.should == [ @post1 ]
-      @user2.votees(Post).to_a.should == [ @post1 ]
+      Post.voted_by(@user1).to_a.should == [ @post1 ]
+      Post.voted_by(@user2).to_a.should == [ @post1 ]
     end
   end
   
@@ -144,8 +144,8 @@ describe Mongoid::Voteable do
       @post1.vote_value(@user1.id).should == :down
       @post1.vote_value(@user2.id).should == :down
 
-      @user1.votees(Post).to_a.should == [ @post1 ]
-      @user2.votees(Post).to_a.should == [ @post1 ]
+      Post.voted_by(@user1).to_a.should == [ @post1 ]
+      Post.voted_by(@user2).to_a.should == [ @post1 ]
     end
   end
   
@@ -164,7 +164,7 @@ describe Mongoid::Voteable do
       @post2.vote_value(@user1.id).should == :down
       @post2.vote_value(@user2.id).should be_nil
 
-      @user1.votees(Post).to_a.should == [ @post1, @post2 ]
+      Post.voted_by(@user1).to_a.should == [ @post1, @post2 ]
     end
   end
   
@@ -184,7 +184,7 @@ describe Mongoid::Voteable do
       @post2.vote_value(@user1.id).should == :up
       @post2.vote_value(@user2.id).should be_nil
 
-      @user1.votees(Post).to_a.should == [ @post1, @post2 ]
+      Post.voted_by(@user1).to_a.should == [ @post1, @post2 ]
     end
   end
   
@@ -260,7 +260,7 @@ describe Mongoid::Voteable do
       @post1.vote_value(@user1.id).should be_nil
       @post1.vote_value(@user2.id).should == :down
       
-      @user1.votees(Post).to_a.should_not include(@post1)
+      Post.voted_by(@user1).to_a.should_not include(@post1)
     end
   end
   

data/spec/voteable_mongoid/voter_spec.rb

@@ -13,15 +13,15 @@ describe Mongoid::Voter do
   
   context "just created" do
     it '' do
-      @user1.votees(Post).should be_empty
-      @user1.up_votees(Post).should be_empty
-      @user1.down_votees(Post).should be_empty
+      Post.voted_by(@user1).should be_empty
+      Post.up_voted_by(@user1).should be_empty
+      Post.down_voted_by(@user1).should be_empty
       @user1.voted?(@post1).should be_false
       @user1.voted?(@post2).should be_false
       
-      @user2.votees(Post).should be_empty
-      @user2.up_votees(Post).should be_empty
-      @user2.down_votees(Post).should be_empty
+      Post.voted_by(@user2).should be_empty
+      Post.up_voted_by(@user2).should be_empty
+      Post.down_voted_by(@user2).should be_empty
       @user2.voted?(@post1).should be_false
       @user2.voted?(@post2).should be_false
     end
@@ -51,10 +51,10 @@ describe Mongoid::Voter do
       @user1.should be_voted(@post1)
       @user2.should_not be_voted(:votee_type => 'Post', :votee_id => @post1.id)
       
-      @user1.votees(Post).to_a.should == [ @post1 ]
-      @user1.up_votees(Post).to_a.should == [ @post1 ]
-      @user1.down_votees(Post).to_a.should be_empty
-      @user2.votees(Post).to_a.should be_empty
+      Post.voted_by(@user1).to_a.should == [ @post1 ]
+      Post.up_voted_by(@user1).to_a.should == [ @post1 ]
+      Post.down_voted_by(@user1).to_a.should be_empty
+      Post.voted_by(@user2).to_a.should be_empty
     end
     
     it 'user1 vote post1 has no effect' do
@@ -81,10 +81,10 @@ describe Mongoid::Voter do
       @user1.vote_value(@post1).should == :up
       @user2.vote_value(@post1).should == :down
 
-      @user1.votees(Post).to_a.should == [ @post1 ]
-      @user2.votees(Post).to_a.should == [ @post1 ]
-      @user2.up_votees(Post).to_a.should be_empty
-      @user2.down_votees(Post).to_a.should == [ @post1 ]
+      Post.voted_by(@user1).to_a.should == [ @post1 ]
+      Post.voted_by(@user2).to_a.should == [ @post1 ]
+      Post.up_voted_by(@user2).to_a.should be_empty
+      Post.down_voted_by(@user2).to_a.should == [ @post1 ]
     end
   end
   
@@ -101,8 +101,8 @@ describe Mongoid::Voter do
       @user1.vote_value(@post1).should == :down
       @user2.vote_value(@post1).should == :down
 
-      @user1.votees(Post).to_a.should == [ @post1 ]
-      @user2.votees(Post).to_a.should == [ @post1 ]
+      Post.voted_by(@user1).to_a.should == [ @post1 ]
+      Post.voted_by(@user2).to_a.should == [ @post1 ]
     end
   end
   
@@ -119,7 +119,7 @@ describe Mongoid::Voter do
       @user1.vote_value(@post2).should == :down
       @user2.vote_value(@post2).should be_nil
 
-      @user1.votees(Post).to_a.should == [ @post1, @post2 ]
+      Post.voted_by(@user1).to_a.should == [ @post1, @post2 ]
     end
   end
   
@@ -136,7 +136,7 @@ describe Mongoid::Voter do
       @user1.vote_value(@post2).should == :up
       @user2.vote_value(@post2).should be_nil
 
-      @user1.votees(Post).to_a.should == [ @post1, @post2 ]
+      Post.voted_by(@user1).to_a.should == [ @post1, @post2 ]
     end
   end  
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: voteable_mongoid
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 15
   prerelease: 
   segments: 
   - 0
   - 6
-  - 3
-  version: 0.6.3
+  - 4
+  version: 0.6.4
 platform: ruby
 authors: 
 - Alex Nguyen
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-01 00:00:00 +08:00
+date: 2011-04-02 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency