voteable_mongoid 0.5.0 → 0.6.0

data/CHANGELOG.rdoc

@@ -0,0 +1,19 @@
+== 0.6.0
+  * Minimize vote data store (using short field names votes.u, votes.d, votes.c ...)
+  * Add Voter#up_votees, Voter#down_votees
+  * Remove index and scope from statistic module. User have to add indexes and scopes manually (see https://github.com/vinova/simple_qa/blob/master/app/models/question.rb)
+  * Bug fixes
+
+== 0.5.0
+  * Rename vote_point to voteable
+  
+== 0.4.5
+  * Can use rake db:mongoid:voteable:remake_stats in Rails apps
+  * Use mongoid 2.0.0
+  
+== 0.4.4
+  * Add up_votes_count, down_votes_count
+  * Re-generate vote statistic data (counters and point)
+ 
+== 0.4.3
+  * Wrap vote data in voteable namespace (voteable.up_voters_id, voteable.down_voters_ids, voteable.votes_count ...)

data/lib/voteable_mongoid/version.rb

@@ -1,3 +1,3 @@
 module VoteableMongoid
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/lib/voteable_mongoid/voteable/stats.rb

@@ -3,36 +3,24 @@ module Mongoid
     module Stats
       extend ActiveSupport::Concern
 
-      included do
-        index 'voteable.up_votes_count'
-        index 'voteable.down_votes_count'
-        index 'voteable.votes_count'
-        index 'voteable.votes_point'
-      
-        scope :most_up_voted, order_by(['voteable.up_votes_count', :desc])
-        scope :most_down_voted, order_by(['voteable.down_votes_count', :desc])
-        scope :most_voted, order_by(['voteable.votes_count', :desc])
-        scope :best_voted, order_by(['voteable.votes_point', :desc])
-      end
-    
       # Get the number of up votes
       def up_votes_count
-        voteable.try(:[], 'up_votes_count') || 0
+        votes.try(:[], 'uc') || 0
       end
     
       # Get the number of down votes
       def down_votes_count
-        voteable.try(:[], 'down_votes_count') || 0
+        votes.try(:[], 'dc') || 0
       end
     
       # Get the number of votes
       def votes_count
-        voteable.try(:[], 'votes_count') || 0
+        votes.try(:[], 'c') || 0
       end
     
       # Get the votes point
       def votes_point
-        voteable.try(:[], 'votes_point') || 0
+        votes.try(:[], 'p') || 0
       end
 
       # Re-generate vote counters and vote points
@@ -42,11 +30,11 @@ module Mongoid
       end
       
       def self.remake_stats(log)
-        Mongoid::Voteable::VOTEABLE.each do |class_name, value_point|
+        VOTEABLE.each do |class_name, value_point|
           klass = class_name.constantize
           klass_value_point = value_point[class_name]
           puts "Generating stats for #{class_name}" if log
-          klass.voteable_data_only.each{ |doc|
+          klass.all.each{ |doc|
             doc.remake_stats(klass_value_point)
           }
         end
@@ -55,12 +43,14 @@ module Mongoid
       def remake_stats(value_point)
         up_count = up_voter_ids.length
         down_count = down_voter_ids.length
-
+        
+        # puts self, votes.inspect # DEBUG
+        
         update_attributes(
-          'voteable.up_votes_count' => up_count,
-          'voteable.down_votes_count' => down_count,          
-          'voteable.votes_count' => up_count + down_count,
-          'voteable.votes_point' => value_point[:up]*up_count + value_point[:down]*down_count
+          UP_VOTES_COUNT => up_count,
+          DOWN_VOTES_COUNT => down_count,          
+          VOTES_COUNT => up_count + down_count,
+          VOTES_POINT => value_point[:up]*up_count + value_point[:down]*down_count
         )
       end
     
@@ -73,7 +63,7 @@ module Mongoid
               parent_class = parent_class_name.constantize
               foreign_key = relation_metadata.foreign_key
               puts "Updating stats for #{class_name} > #{parent_class_name}" if log
-              klass.voteable_data_only.each{ |doc|
+              klass.all.each{ |doc|
                 doc.update_parent_stats(parent_class, foreign_key, parent_value_point)
               }
             end
@@ -90,17 +80,19 @@ module Mongoid
           return if up_count == 0 && down_count == 0
 
           inc_options = {
-            'voteable.votes_point' => value_point[:up]*up_count + value_point[:down]*down_count
+            VOTES_POINT => value_point[:up]*up_count + value_point[:down]*down_count
           }
-      
+          
           unless value_point[:update_counters] == false
             inc_options.merge!(
-              'voteable.votes_count' => up_count + down_count,
-              'voteable.up_votes_count' => up_count,
-              'voteable.down_votes_count' => down_count
+              VOTES_COUNT => up_count + down_count,
+              UP_VOTES_COUNT => up_count,
+              DOWN_VOTES_COUNT => down_count
             )
           end
         
+          # puts parent_id, inc_options.inspect # DEBUG
+      
           parent_class.collection.update(
             { :_id => parent_id }, 
             { '$inc' =>  inc_options }

data/lib/voteable_mongoid/voteable/votes.rb

@@ -0,0 +1,21 @@
+module Mongoid
+  module Voteable
+    UP_VOTER_IDS      = 'votes.u'
+    DOWN_VOTER_IDS    = 'votes.d'
+    UP_VOTES_COUNT    = 'votes.uc'
+    DOWN_VOTES_COUNT  = 'votes.dc'
+    VOTES_COUNT       = 'votes.c'
+    VOTES_POINT       = 'votes.p'
+    
+    class Votes
+      include Mongoid::Document
+      
+      field :u, :type => Array
+      field :d, :type => Array
+      field :uc, :type => Integer, :default => 0
+      field :dc, :type => Integer, :default => 0
+      field :c, :type => Integer, :default => 0
+      field :p, :type => Integer, :default => 0
+    end
+  end
+end

data/lib/voteable_mongoid/voteable.rb

@@ -7,13 +7,10 @@ module Mongoid
     VOTEABLE = {}
 
     included do
+      include Mongoid::Document
       include Mongoid::Voteable::Stats
+      field :votes, :type => Mongoid::Voteable::Votes
       
-      def self.voteable_data_only
-        foreign_keys = relations.values.map{ |meta| meta.try(:foreign_key) }.compact
-        only(foreign_keys + %w[voteable])
-      end
-
       # Set vote point for each up (down) vote on an object of this class
       # 
       # @param [Hash] options a hash containings:
@@ -54,16 +51,16 @@ module Mongoid
         
         if options[:revote]
           if value == :up
-            positive_voter_ids = 'voteable.up_voter_ids'
-            negative_voter_ids = 'voteable.down_voter_ids'
-            positive_votes_count = 'voteable.up_votes_count'
-            negative_votes_count = 'voteable.down_votes_count'
+            positive_voter_ids = UP_VOTER_IDS
+            negative_voter_ids = DOWN_VOTER_IDS
+            positive_votes_count = UP_VOTES_COUNT
+            negative_votes_count = DOWN_VOTES_COUNT
             point_delta = value_point[:up] - value_point[:down]
           else
-            positive_voter_ids = 'voteable.down_voter_ids'
-            negative_voter_ids = 'voteable.up_voter_ids'
-            positive_votes_count = 'voteable.down_votes_count'
-            negative_votes_count = 'voteable.up_votes_count'
+            positive_voter_ids = DOWN_VOTER_IDS
+            negative_voter_ids = UP_VOTER_IDS
+            positive_votes_count = DOWN_VOTES_COUNT
+            negative_votes_count = UP_VOTES_COUNT
             point_delta = -value_point[:up] + value_point[:down]
           end
           
@@ -79,7 +76,7 @@ module Mongoid
             '$inc' => {
               positive_votes_count => +1,
               negative_votes_count => -1,
-              'voteable.votes_point' => point_delta
+              VOTES_POINT => point_delta
             }
           }, {
             :safe => true
@@ -87,13 +84,13 @@ module Mongoid
 
         elsif options[:unvote]
           if value == :up
-            positive_voter_ids = 'voteable.up_voter_ids'
-            negative_voter_ids = 'voteable.down_voter_ids'
-            positive_votes_count = 'voteable.up_votes_count'
+            positive_voter_ids = UP_VOTER_IDS
+            negative_voter_ids = DOWN_VOTER_IDS
+            positive_votes_count = UP_VOTES_COUNT
           else
-            positive_voter_ids = 'voteable.down_voter_ids'
-            negative_voter_ids = 'voteable.up_voter_ids'
-            positive_votes_count = 'voteable.down_votes_count'
+            positive_voter_ids = DOWN_VOTER_IDS
+            negative_voter_ids = UP_VOTER_IDS
+            positive_votes_count = DOWN_VOTES_COUNT
           end
           
           # Check if voter_id did a vote with value for votee_id
@@ -107,8 +104,8 @@ module Mongoid
             '$pull' => { positive_voter_ids => voter_id },
             '$inc' => {
               positive_votes_count => -1,
-              'voteable.votes_count' => -1,
-              'voteable.votes_point' => -value_point[value]
+              VOTES_COUNT => -1,
+              VOTES_POINT => -value_point[value]
             }
           }, {
             :safe => true
@@ -116,25 +113,25 @@ module Mongoid
           
         else # new vote
           if value.to_sym == :up
-            positive_voter_ids = 'voteable.up_voter_ids'
-            positive_votes_count = 'voteable.up_votes_count'
+            positive_voter_ids = UP_VOTER_IDS
+            positive_votes_count = UP_VOTES_COUNT
           else
-            positive_voter_ids = 'voteable.down_voter_ids'
-            positive_votes_count = 'voteable.down_votes_count'
+            positive_voter_ids = DOWN_VOTER_IDS
+            positive_votes_count = DOWN_VOTES_COUNT
           end
 
           update_result = collection.update({ 
             # Validate voter_id did not vote for votee_id yet
             :_id => votee_id,
-            'voteable.up_voter_ids' => { '$ne' => voter_id },
-            'voteable.down_voter_ids' => { '$ne' => voter_id }
+            UP_VOTER_IDS => { '$ne' => voter_id },
+            DOWN_VOTER_IDS => { '$ne' => voter_id }
           }, {
             # then update
             '$push' => { positive_voter_ids => voter_id },
             '$inc' => {  
-              'voteable.votes_count' => +1,
+              VOTES_COUNT => +1,
               positive_votes_count => +1,
-              'voteable.votes_point' => value_point[value] }
+              VOTES_POINT => value_point[value] }
           }, {
             :safe => true
           })
@@ -149,7 +146,7 @@ module Mongoid
           VOTEABLE[klass].each do |class_name, value_point|
             # For other class in VOTEABLE options, if is parent of current class
             next unless relation_metadata = relations[class_name.underscore]
-            next unless votee ||= options[:votee] || voteable_data_only.where(:id => options[:votee_id]).first
+            next unless votee ||= options[:votee] || find(options[:votee_id])
             # If can find current votee foreign_key value for that class
             next unless foreign_key_value = votee.read_attribute(relation_metadata.foreign_key)
           
@@ -157,36 +154,36 @@ module Mongoid
             
             if options[:revote]
               if value == :up
-                inc_options['voteable.votes_point'] = value_point[:up] - value_point[:down]
+                inc_options[VOTES_POINT] = value_point[:up] - value_point[:down]
                 unless value_point[:update_counters] == false
-                  inc_options['voteable.up_votes_count'] = +1
-                  inc_options['voteable.down_votes_count'] = -1
+                  inc_options[UP_VOTES_COUNT] = +1
+                  inc_options[DOWN_VOTES_COUNT] = -1
                 end
               else
-                inc_options['voteable.votes_point'] = -value_point[:up] + value_point[:down]
+                inc_options[VOTES_POINT] = -value_point[:up] + value_point[:down]
                 unless value_point[:update_counters] == false
-                  inc_options['voteable.up_votes_count'] = -1
-                  inc_options['voteable.down_votes_count'] = +1
+                  inc_options[UP_VOTES_COUNT] = -1
+                  inc_options[DOWN_VOTES_COUNT] = +1
                 end
               end
             elsif options[:unvote]
-              inc_options['voteable.votes_point'] = -value_point[value]
+              inc_options[VOTES_POINT] = -value_point[value]
               unless value_point[:update_counters] == false
-                inc_options['voteable.votes_count'] = -1
+                inc_options[VOTES_COUNT] = -1
                 if value == :up
-                  inc_options['voteable.up_votes_count'] = -1
+                  inc_options[UP_VOTES_COUNT] = -1
                 else
-                  inc_options['voteable.down_votes_count'] = -1
+                  inc_options[DOWN_VOTES_COUNT] = -1
                 end
               end
             else # new vote
-              inc_options['voteable.votes_point'] = value_point[value]
+              inc_options[VOTES_POINT] = value_point[value]
               unless value_point[:update_counters] == false
-                inc_options['voteable.votes_count'] = 1
+                inc_options[VOTES_COUNT] = 1
                 if value == :up
-                  inc_options['voteable.up_votes_count'] = 1
+                  inc_options[UP_VOTES_COUNT] = 1
                 else
-                  inc_options['voteable.down_votes_count'] = 1
+                  inc_options[DOWN_VOTES_COUNT] = 1
                 end
               end
             end
@@ -231,17 +228,12 @@ module Mongoid
 
     # Array of up voter ids
     def up_voter_ids
-      voteable.try(:[], 'up_voter_ids') || []
+      votes.try(:[], 'u') || []
     end
     
     # Array of down voter ids
     def down_voter_ids
-      voteable.try(:[], 'down_voter_ids') || []
+      votes.try(:[], 'd') || []
     end
-    
-    def voteable
-      read_attribute('voteable')
-    end
-
   end
 end

data/lib/voteable_mongoid/voter.rb

@@ -4,10 +4,26 @@ module Mongoid
 
     # Get list of voted votees
     #
-    # @param [Class] klass the votee class, e.g. `Post` or `Comment`
+    # @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 })
+      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.any_of(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.any_of(Voteable::DOWN_VOTER_IDS => _id)
     end
 
     # Check to see if this voter voted on the votee or not
@@ -40,7 +56,7 @@ module Mongoid
       votee = unless options.is_a?(Hash)
         options
       else
-        options[:votee] || options[:votee_type].classify.constantize.only(:up_vote_ids, :down_vote_ids).where(
+        options[:votee] || options[:votee_type].classify.constantize.only(:votes).where(
           :_id => options[:votee_id]
         ).first
       end

data/lib/voteable_mongoid.rb

@@ -1,4 +1,6 @@
+require 'mongoid'
 require 'voteable_mongoid/voteable/stats'
+require 'voteable_mongoid/voteable/votes'
 require 'voteable_mongoid/voteable'
 require 'voteable_mongoid/voter'
 

data/spec/spec_helper.rb

@@ -20,6 +20,7 @@ Mongoid.configure do |config|
   name = "voteable_mongoid_test"
   host = "localhost"
   config.master = Mongo::Connection.new.db(name)
+  config.embedded_object_id = false
 end
 
 

data/spec/voteable_mongoid/voteable_spec.rb

@@ -60,7 +60,6 @@ describe Mongoid::Voteable do
   context 'user1 vote up post1 the first time' do
     before :all do    
       Post.vote(:votee_id => @post1.id, :voter_id => @user1.id, :value => :up)
-      Mongoid::Voteable::Stats.remake
       @post1.reload
     end
     
@@ -93,7 +92,6 @@ describe Mongoid::Voteable do
   context 'user2 vote down post1 the first time' do
     before :all do
       Post.vote(:votee_id => @post1.id, :voter_id => @user2.id, :value => :down)
-      Mongoid::Voteable::Stats.remake
       @post1.reload
     end
     
@@ -135,7 +133,6 @@ describe Mongoid::Voteable do
   context 'user1 vote down post2 the first time' do
     before :all do
       Post.vote(:votee_id => @post2.id, :voter_id => @user1.id, :value => :down)
-      Mongoid::Voteable::Stats.remake
       @post2.reload
     end
     
@@ -176,7 +173,6 @@ describe Mongoid::Voteable do
   context 'user1 vote up post2 comment the first time' do
     before :all do
       @comment.vote(:voter_id => @user1.id, :value => :up)
-      Mongoid::Voteable::Stats.remake
       @comment.reload
       @post2.reload
     end
@@ -198,7 +194,6 @@ describe Mongoid::Voteable do
   context 'user1 revote post2 comment from up to down' do
     before :all do
       @user1.vote(:votee => @comment, :value => :down)
-      Mongoid::Voteable::Stats.remake
       @comment.reload
       @post2.reload
     end
@@ -263,14 +258,7 @@ describe Mongoid::Voteable do
       @post2.down_votes_count.should == 1
       @post2.votes_count.should == 2
       @post2.votes_point.should == 0
-    end
-    
-    it "test scopes" do
-      Post.most_up_voted.first.should == @post2
-      Post.most_down_voted.first.should == @post1
-      Post.most_voted.first.should == @post2
-      Post.best_voted.first.should == @post2
-    end
+    end    
   end
   
   context "user1 unvote on comment" do
@@ -282,15 +270,15 @@ describe Mongoid::Voteable do
     end
     
     it "" do      
-      @post2.up_votes_count.should == 1
-      @post2.down_votes_count.should == 0
-      @post2.votes_count.should == 1
-      @post2.votes_point.should == 1
-      
       @comment.up_votes_count.should == 0
       @comment.down_votes_count.should == 0
       @comment.votes_count.should == 0
       @comment.votes_point.should == 0
+
+      @post2.up_votes_count.should == 1
+      @post2.down_votes_count.should == 0
+      @post2.votes_count.should == 1
+      @post2.votes_point.should == 1      
     end
   end
   

data/spec/voteable_mongoid/voter_spec.rb

@@ -14,10 +14,14 @@ 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
       @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
       @user2.voted?(@post1).should be_false
       @user2.voted?(@post2).should be_false
     end
@@ -48,6 +52,8 @@ describe Mongoid::Voter do
       @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
     end
     
@@ -77,6 +83,8 @@ describe Mongoid::Voter do
 
       @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 ]
     end
   end
   

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: voteable_mongoid
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 7
   prerelease: 
   segments: 
   - 0
-  - 5
+  - 6
   - 0
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Alex Nguyen
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-30 00:00:00 +08:00
+date: 2011-03-31 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -88,38 +88,18 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - .watchr
+- CHANGELOG.rdoc
 - Gemfile
 - README.rdoc
 - Rakefile
 - TODO
-- doc/Mongoid.html
-- doc/Mongoid/Voteable.html
-- doc/Mongoid/Voteable/Stats.html
-- doc/Mongoid/Voter.html
-- doc/Rails.html
-- doc/Rails/VoteableMongoid.html
-- doc/Rails/VoteableMongoid/Railtie.html
-- doc/VoteableMongoid.html
-- doc/_index.html
-- doc/class_list.html
-- doc/css/common.css
-- doc/css/full_list.css
-- doc/css/style.css
-- doc/file.README.html
-- doc/file_list.html
-- doc/frames.html
-- doc/index.html
-- doc/js/app.js
-- doc/js/full_list.js
-- doc/js/jquery.js
-- doc/method_list.html
-- doc/top-level-namespace.html
 - lib/voteable_mongoid.rb
 - lib/voteable_mongoid/railtie.rb
 - lib/voteable_mongoid/railties/database.rake
 - lib/voteable_mongoid/version.rb
 - lib/voteable_mongoid/voteable.rb
 - lib/voteable_mongoid/voteable/stats.rb
+- lib/voteable_mongoid/voteable/votes.rb
 - lib/voteable_mongoid/voter.rb
 - spec/.rspec
 - spec/models/comment.rb