voteable_mongoid 0.7.4 → 0.7.5

data/.rvmrc

@@ -1,2 +1,2 @@
 rvm_gemset_create_on_use_flag=1
-rvm use 1.9.2@mongoid
+rvm use 1.9.2@voteable

data/CHANGELOG.rdoc

@@ -1,13 +1,13 @@
 == 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 Votee#up_voters(VoterClass), Votee#down_voters(VoterClass), Votee#voters(VoterClass)
+  * Add Voter scopes: Voter.up_voted_for(votee), Voter.down_voted_for(votee), Voter.voted_for(votee)
   * 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?
+  * Add Votee.voted?, Votee.up_voted?, Votee.down_voted?
   * Update parent for ManyToMany relationship
   * Refactor
   
@@ -23,7 +23,7 @@
   * Use readable field names (up, down, up_count, down_count, count, point) instead of very short field names (u, d, uc, dc, c, p)
 
 == 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
+  * Drop Voter#votees, Voter#up_votees, Voter#down_votees in favor of Votee#voted_by(voter), Votee#up_voted_by(voter), Votee#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,14 +1,17 @@
 = Voteable Mongoid
 
-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 allows you to make your Mongoid::Document objects voteable (up or down) and tabulate votes count and votes point for you. For instance, in a forum, a user can vote up (or down) on a post or a comment.
 
-Initial idea is based on http://cookbook.mongodb.org/patterns/votes
-
-Voteable Mongoid is built for speed. It uses only one database request per collection to validate data, update data, and get updated data.
+Voteable Mongoid is built for speed. It uses only one database request per collection to validate data, update data, and get updated data. Initial idea is based on http://cookbook.mongodb.org/patterns/votes
 
 Sample app at https://github.com/vinova/simple_qa
 
+Benchmarks at https://github.com/vinova/voteable_benchmarks
+
+=== Sites using voteable_mongoid
+* http://www.amorveneris.com
+* http://zheye.org (https://github.com/huacnlee/quora)
+
 == Installation
 
 === Rails 3.0.x
@@ -21,7 +24,7 @@ After that, remember to run "bundle install"
 
 == Usage
 
-=== Making Post and Comment voteable, User being the voter
+=== Make Post and Comment voteable, User become the voter
 
 post.rb
 
@@ -58,7 +61,7 @@ user.rb
       include Mongoid::Voter
     end
 
-=== Making a vote
+=== Make a vote
 
     @user.vote(@post, :up)
 
@@ -89,7 +92,7 @@ Un-vote
 In-case you need updated voteable object, add :return_votee => true
     votee = Post.vote(:voter_id => user_id, :votee_id => post_id, :value => :up, :return_votee => true)
 
-=== Getting vote_value
+=== Get vote_value
     
     @user.vote_value(@post)
     @user.vote_value(:class_type => 'Post', :votee_id => post_id)
@@ -103,14 +106,24 @@ In-case you need updated voteable object, add :return_votee => true
     @post.voted_by?(@user)
     @post.voted_by?(user_id)
 
-=== Getting votes counts and points
+=== Get votes counts and points
 
     puts @post.votes_point
     puts @post.votes_count
     puts @post.up_votes_count
     puts @post.down_votes_count
 
-=== Getting the list of voted objects of a class
+=== Get voters given voted object and voter class
+
+    @post.up_voters(User)
+    @post.down_voters(User)
+    @post.voters(User)
+    - or -
+    User.up_voted_for(@post)
+    User.down_voted_for(@post)
+    User.voted_for(@post)
+
+=== Get the list of voted objects of a class
 
     Post.voted_by(@user)
     Post.up_voted_by(@user)
@@ -137,7 +150,6 @@ Ruby
     Mongoid::Voteable::Tasks.migrate_old_votes
 
 == Credits
-
 * Alex Nguyen (alex@vinova.sg) - Author
 * Stefan Nguyen (stefan@vinova.sg) - Unvoting
 

data/lib/voteable_mongoid/version.rb

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

data/lib/voteable_mongoid/voteable/tasks.rb

@@ -42,10 +42,10 @@ module Mongoid
           # count, point)
           votes = doc['votes'] || doc['voteable'] || {}
 
-          up_voter_ids = votes['u'] || votes['up'] || 
+          up_voter_ids = votes['up'] || votes['u'] ||
             votes['up_voter_ids'] || doc['up_voter_ids'] || []
 
-          down_voter_ids = votes['d'] || votes['down'] || 
+          down_voter_ids = votes['down'] || votes['d'] ||
             votes['down_voter_ids'] || doc['down_voter_ids'] || []
 
           up_count = up_voter_ids.size
@@ -67,7 +67,13 @@ module Mongoid
               'down_voter_ids' => true,
               'votes_count' => true,
               'votes_point' => true,
-              'voteable' => true
+              'voteable' => true,
+              'votes.u' => true,
+              'votes.d' => true,
+              'votes.uc' => true,
+              'votes.dc' => true,
+              'votes.c' => true,
+              'votes.p' => true
             }
           }, { :safe => true })
         end

data/lib/voteable_mongoid/voteable.rb

@@ -99,14 +99,16 @@ module Mongoid
           # 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 [['votes.up', ::Mongo::ASCENDING], ['_id', ::Mongo::ASCENDING]],
+            :unique => true, :background => true
+          index [['votes.down', ::Mongo::ASCENDING], ['_id', ::Mongo::ASCENDING]],
+            :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]]
+          index [['votes.up_count', ::Mongo::DESCENDING]]
+          index [['votes.down_count', ::Mongo::DESCENDING]]
+          index [['votes.count', ::Mongo::DESCENDING]]
+          index [['votes.point', ::Mongo::DESCENDING]]
         end
       end
     end

data/spec/spec_helper.rb

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

data/voteable_mongoid.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.email       = ["alex@vinova.sg"]
   s.homepage    = "https://github.com/vinova/voteable_mongoid"
   s.summary     = %q{Add Up / Down Voting for Mongoid}
-  s.description = %q{Add Up / Down Voting for Mongoid (built for speed by using one Mongodb update-in-place for each collection when provided enough information)}
+  s.description = %q{Renamed to voteable_mongo to support both Mongoid and MongoMapper.}
 
   s.add_dependency 'mongoid', '~> 2.0.0'
   

metadata

@@ -2,7 +2,7 @@
 name: voteable_mongoid
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.7.4
+  version: 0.7.5
 platform: ruby
 authors: 
 - Alex Nguyen
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-02 00:00:00 Z
+date: 2011-05-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: mongoid
@@ -45,7 +45,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id003
-description: Add Up / Down Voting for Mongoid (built for speed by using one Mongodb update-in-place for each collection when provided enough information)
+description: Renamed to voteable_mongo to support both Mongoid and MongoMapper.
 email: 
 - alex@vinova.sg
 executables: []