voteable_mongoid 0.7.3 → 0.7.4

data/CHANGELOG.rdoc

@@ -1,3 +1,10 @@
+== 0.7.4
+  * Add Voteable#up_voters(VoterClass), Voteable#down_voters(VoterClass), Voteable#voters(VoterClass)
+  * Add Voter scopes: Voter.up_voted_for(voteable_object), Voter.down_voted_for(voteable_object), Voter.voted_for(voteable_object)
+  * Add voteable ..., :index => true options
+  * Optimization on unvote and revote validations
+  * Fix for :up & :down points are nil in rake tasks
+  
 == 0.7.3
   * Add :return_votee => true option to vote function to warranty always return voteable object
   * Add Voteable.voted?, Voteable.up_voted?, Voteable.down_voted?

data/lib/voteable_mongoid/version.rb

@@ -1,3 +1,3 @@
 module VoteableMongoid
-  VERSION = '0.7.3'
+  VERSION = '0.7.4'
 end

data/lib/voteable_mongoid/voteable.rb

@@ -46,8 +46,12 @@ module Mongoid
       def voteable(klass = self, options = nil)
         VOTEABLE[name] ||= {}
         VOTEABLE[name][klass.name] ||= options
-        if klass != self
-          VOTEABLE[name][name][:update_parents] = true
+        if klass == self
+          if options[:index] == true
+            create_voteable_indexes
+          end
+        else
+          VOTEABLE[name][name][:update_parents] ||= true
         end
       end
       
@@ -86,6 +90,25 @@ module Mongoid
         validate_and_normalize_vote_options(options)
         down_voted_by(options[:voter_id]).where(:_id => options[:votee_id]).count == 1
       end
+      
+      private
+      def create_voteable_indexes
+        class_eval do
+          # Compound index _id and voters.up, _id and voters.down
+          # to make up_voted_by, down_voted_by, voted_by scopes and voting faster
+          # Should run in background since it introduce new index value and
+          # while waiting to build, the system can use _id for voting
+          # http://www.mongodb.org/display/DOCS/Indexing+as+a+Background+Operation
+          index [['votes.up', 1], ['_id', 1]], :unique => true, :background => true
+          index [['votes.down', 1], ['_id', 1]], :unique => true, :background => true
+
+          # Index counters and point for desc ordering
+          index [['votes.count', -1]]
+          index [['votes.up_count', -1]]
+          index [['votes.down_count', -1]]
+          index [['votes.point', -1]]
+        end
+      end
     end
     
     module InstanceMethods
@@ -133,6 +156,11 @@ module Mongoid
         votes.try(:[], 'down') || []
       end
 
+      # Array of voter ids
+      def voter_ids
+        up_voter_ids + down_voter_ids
+      end
+
       # Get the number of up votes
       def up_votes_count
         votes.try(:[], 'up_count') || 0
@@ -152,7 +180,21 @@ module Mongoid
       def votes_point
         votes.try(:[], 'point') || 0
       end
+
+      # Get up voters
+      def up_voters(klass)
+        klass.where(:_id => { '$in' =>  up_voter_ids })
+      end
+
+      # Get down voters
+      def down_voters(klass)
+        klass.where(:_id => { '$in' => down_voter_ids })
+      end
+
+      # Get voters
+      def voters(klass)
+        klass.where(:_id => { '$in' => voter_ids })
+      end
     end
-    
   end
 end

data/lib/voteable_mongoid/voteable/tasks.rb

@@ -59,7 +59,7 @@ module Mongoid
                   'up_count' => up_count,
                   'down_count' => down_count,
                   'count' => up_count + down_count,
-                  'point' => voteable[:up]*up_count + voteable[:down]*down_count
+                  'point' => voteable[:up].to_i*up_count + voteable[:down].to_i*down_count
                 }
             },
             '$unset' => {
@@ -94,7 +94,7 @@ module Mongoid
           'votes.up_count' => up_count,
           'votes.down_count' => down_count,
           'votes.count' => up_count + down_count,
-          'votes.point' => voteable[:up]*up_count + voteable[:down]*down_count
+          'votes.point' => voteable[:up].to_i*up_count + voteable[:down].to_i*down_count
         )
       end
 
@@ -126,7 +126,7 @@ module Mongoid
           return if up_count == 0 && down_count == 0
 
           inc_options = {
-            'votes.point' => voteable[:up]*up_count + voteable[:down]*down_count
+            'votes.point' => voteable[:up].to_i*up_count + voteable[:down].to_i*down_count
           }
         
           unless voteable[:update_counters] == false

data/lib/voteable_mongoid/voteable/voting.rb

@@ -78,10 +78,11 @@ module Mongoid
             }, {
               # then update
               '$push' => { positive_voter_ids => options[:voter_id] },
-              '$inc' => {  
+              '$inc' => {
                 'votes.count' => +1,
                 positive_votes_count => +1,
-                'votes.point' => options[:voteable][options[:value]] }
+                'votes.point' => options[:voteable][options[:value]]
+              }
             }
           end
 
@@ -104,7 +105,9 @@ module Mongoid
             return {
               # Validate voter_id did a vote with value for votee_id
               :_id => options[:votee_id],
-              positive_voter_ids => { '$ne' => options[:voter_id] },
+              # Can skip $ne validation since creating a new vote
+              # already warranty that a voter can vote one only
+              # positive_voter_ids => { '$ne' => options[:voter_id] },
               negative_voter_ids => options[:voter_id]
             }, {
               # then update
@@ -133,7 +136,9 @@ module Mongoid
             return {
               :_id => options[:votee_id],
               # Validate if voter_id did a vote with value for votee_id
-              negative_voter_ids => { '$ne' => options[:voter_id] },
+              # Can skip $ne validation since creating a new vote 
+              # already warranty that a voter can vote one only
+              # negative_voter_ids => { '$ne' => options[:voter_id] },
               positive_voter_ids => options[:voter_id]
             }, {
               # then update

data/lib/voteable_mongoid/voter.rb

@@ -1,7 +1,15 @@
 module Mongoid
   module Voter
     extend ActiveSupport::Concern
-    
+
+    included do
+      include ::Mongoid::Document
+
+      scope :up_voted_for, lambda { |votee| where(:_id => { '$in' =>  votee.up_voter_ids }) }
+      scope :down_voted_for, lambda { |votee| where(:_id => { '$in' =>  votee.down_voter_ids }) }
+      scope :voted_for, lambda { |votee| where(:_id => { '$in' =>  votee.voter_ids }) }
+    end
+
     module InstanceMethods
       # Check to see if this voter voted on the votee or not
       #

data/spec/models/category.rb

@@ -5,4 +5,6 @@ class Category
   field :name  
 
   has_and_belongs_to_many :posts
+  
+  voteable self, :index => true
 end

data/spec/models/post.rb

@@ -8,6 +8,6 @@ class Post
   has_and_belongs_to_many :categories
   has_many :comments
 
-  voteable self, :up => +1, :down => -1
+  voteable self, :up => +1, :down => -1, :index => true
   voteable Category, :up => +3, :down => -5, :update_counters => false
 end

data/spec/voteable_mongoid/voteable_spec.rb

@@ -1,6 +1,35 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe Mongoid::Voteable do
+  
+  context 'when :index is passed as an argument' do
+    before do
+      Post.collection.drop_indexes
+      Category.collection.drop_indexes
+    end
+
+    it 'defines indexes' do
+      [Post, Category].each do |klass|
+        klass.create_indexes
+        [ 'votes.up_1__id_1',
+          'votes.down_1__id_1'
+        ].each { |index_key|
+          klass.collection.index_information.should have_key index_key
+          klass.collection.index_information[index_key]['unique'].should be_true
+          klass.collection.index_information[index_key]['background'].should be_true
+        }
+
+        [ 'votes.count_-1',
+          'votes.up_count_-1',
+          'votes.down_count_-1',
+          'votes.point_-1'
+        ].each { |index_key|
+          klass.collection.index_information.should have_key index_key
+        }
+      end
+    end
+  end
+  
   before :all do
     @category1 = Category.create!(:name => 'xyz')
     @category2 = Category.create!(:name => 'abc')
@@ -123,6 +152,10 @@ describe Mongoid::Voteable do
       @post1.vote_value(@user2.id).should be_nil
       @post1.should_not be_voted_by(@user2.id)
 
+      @post1.up_voters(User).should == [ @user1 ]
+      @post1.voters(User).should == [ @user1 ]
+      @post1.down_voters(User).should be_empty
+
       Post.voted_by(@user1).to_a.should == [ @post1 ]
       Post.voted_by(@user2).to_a.should be_empty
       
@@ -173,6 +206,12 @@ describe Mongoid::Voteable do
       @post1.vote_value(@user2.id).should == :down
     end
     
+    it 'post1 get voters' do
+      @post1.up_voters(User).should == [ @user1 ]
+      @post1.down_voters(User).should == [ @user2 ]
+      @post1.voters(User).should == [ @user1, @user2 ]
+    end
+    
     it 'posts voted_by user1, user2 is post1 only' do
       Post.voted_by(@user1).to_a.should == [ @post1 ]
       Post.voted_by(@user2).to_a.should == [ @post1 ]
@@ -248,7 +287,7 @@ describe Mongoid::Voteable do
       @post2.vote_value(@user1.id).should == :up
       @post2.vote_value(@user2.id).should be_nil
 
-      Post.voted_by(@user1).to_a.should == [ @post1, @post2 ]
+      Post.voted_by(@user1).sort.should == [ @post1, @post2 ].sort
     end
   end
   

data/spec/voteable_mongoid/voter_spec.rb

@@ -53,6 +53,10 @@ describe Mongoid::Voter do
       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
+      
+      User.up_voted_for(@post1).should == [ @user1 ]
+      User.down_voted_for(@post1).should be_empty
+      User.voted_for(@post1).should == [ @user1 ]
     end
     
     it 'user1 vote post1 has no effect' do
@@ -83,6 +87,10 @@ describe Mongoid::Voter do
       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 ]
+
+      User.up_voted_for(@post1).should == [ @user1 ]
+      User.down_voted_for(@post1).should == [ @user2 ]
+      User.voted_for(@post1).should == [ @user1, @user2 ]
     end
   end
   
@@ -134,7 +142,7 @@ describe Mongoid::Voter do
       @user1.vote_value(@post2).should == :up
       @user2.vote_value(@post2).should be_nil
 
-      Post.voted_by(@user1).to_a.should == [ @post1, @post2 ]
+      Post.voted_by(@user1).sort.should == [ @post1, @post2 ].sort
     end
   end  
 end

metadata

@@ -2,7 +2,7 @@
 name: voteable_mongoid
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.7.3
+  version: 0.7.4
 platform: ruby
 authors: 
 - Alex Nguyen
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-24 00:00:00 Z
+date: 2011-05-02 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: mongoid