voteable_mongo 0.9.1 → 0.9.2

data/CHANGELOG.rdoc

@@ -1,3 +1,7 @@
+== 0.9.2
+  * Replace votee_type to votee_class
+  * Bug fixes
+  
 == 0.9.1
   * Update gem description
   

data/README.rdoc

@@ -1,14 +1,29 @@
 = Voteable Mongo
 
-voteable_mongo allows you to make your Mongoid::Document or MongoMapper::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.
+voteable_mongo allows you to make your Mongoid::Document or MongoMapper::Document objects voteable 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. It's optimized for speed by using only ONE database request per collection to validate, update, and retrieve updated data.
 
-voteable_mongo 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
+Initial idea 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
+Wonder how fast voteable_mongo is compare to other SQL & MongoDB solutions?
+Visit benchmarks at https://github.com/vinova/voteable_benchmarks
 
-=== Sites using voteable_mongo
+== Why voteable_mongo?
+
+There are various solution for up / down voting problem (see list below)
+* https://github.com/medihack/make_voteable
+* https://github.com/brady8/thumbs_up
+* https://github.com/icaruswings/mm-voteable
+* https://github.com/jcoene/mongoid_voteable
+
+Most of them using additional votes table (SQL) or votes collection (MongoDB) to store votes and do data tabulation on that votes table or votes collection.
+
+voteable_mongo is different. It can do much more with a single request to MongoDB database. It takes advantage of document-oriented database to store all related votes data inside voteable document do you don't have to maintain additional collection. When do vote up, vote down, revote, unvote, voteable_mongo validates vote data, updates voteable document data and retrieves updated data using only ONE database request (thanks to atomic find_and_modify operation). When voteable document is loaded, all votes data related to it also be loaded, no more additional database requests to see how many votes this document got?, who give up votes? who give down vote? total vote points, votes count ...
+
+So use voteable_mongo and save your database requests for other other tasks.
+
+== Sites using voteable_mongo
 * http://www.amorveneris.com
 * http://zheye.org (https://github.com/huacnlee/quora)
 
@@ -108,7 +123,7 @@ Is equivalent to
     @post.vote(:voter => @user, :value => :up)
 
 In case you don't need to init voter and / or votee objects you can
-    @user.vote(:votee_type => 'Post', :votee_id => post_id, :value => :down)
+    @user.vote(:votee_class => Post, :votee_id => post_id, :value => :down)
     @post.vote(:voter_id => user_id, :value => :up)
     Post.vote(:voter_id => user_id, :votee_id => post_id, :value => :up)
 
@@ -132,14 +147,14 @@ Note: vote function always return updated votee object
 === Get vote_value
     
     @user.vote_value(@post)
-    @user.vote_value(:class_type => 'Post', :votee_id => post_id)
+    @user.vote_value(:votee_class => Post, :votee_id => post_id)
     @post.vote_value(@user)
     @post.vote_value(user_id)
 
 === Check if voted?
 
     @user.voted?(@post)
-    @user.voted?(:class_type => 'Post', :votee_id => post_id)
+    @user.voted?(:votee_class => Post, :votee_id => post_id)
     @post.voted_by?(@user)
     @post.voted_by?(user_id)
 
@@ -180,16 +195,16 @@ Rails
 Ruby
     Mongo::Voteable::Tasks::init_stats
 
-=== Migrate from version < 0.7.0
+=== Migrate from voteable_mongoid version < 0.7.0
 Rails
     rake mongo:voteable:migrate_old_votes
 Ruby
     Mongo::Voteable::Tasks.migrate_old_votes
 
 == Credits
-* Alex Nguyen (alex@vinova.sg) - Author
-* Stefan Nguyen (stefan@vinova.sg) - Unvoting
+* Alex Nguyen - Author
+* https://github.com/vinova/voteable_mongo/contributors
 
-Copyright (c) 2010-2011 Vinova Pte Ltd (http://vinova.sg)
+Copyright (c) 2010-2011 Vinova Pte Ltd
 
 Licensed under the MIT license.

data/TODO

@@ -1,3 +1,11 @@
+* Add :foreign_key => ... option to update parents' votes
+  - Reduce time to check relationships and foreign keys
+  - More flexible
+  - Need to change votable interface?
+* Support https://github.com/benmyles/mongomatic &
+          https://github.com/carlosparamio/mongo_odm
+  - Don't have scope
+  - Don't have relationships
 * Add options hash validations
 * Refactor specs
 * More test cases for Tasks module

data/lib/voteable_mongo.rb

@@ -1,5 +1,3 @@
-require 'mongoid'
-
 require 'voteable_mongo/voteable'
 require 'voteable_mongo/voter'
 require 'voteable_mongo/tasks'

data/lib/voteable_mongo/railtie.rb

@@ -4,7 +4,9 @@ module Rails #:nodoc:
 
       initializer "preload all application models" do |app|
         config.to_prepare do
-          ::Rails::Mongoid.load_models(app)
+          if defined?(Mongoid)
+            ::Rails::Mongoid.load_models(app)
+          end
         end
       end
 

data/lib/voteable_mongo/tasks.rb

@@ -145,7 +145,7 @@ module Mongo
           parent_class.collection.update(
             { '_id' => { '$in' => parent_ids } }, 
             { '$inc' =>  inc_options },
-            { :safe => true }
+            { :safe => true, :multi => true }
           )
         end
       end

data/lib/voteable_mongo/version.rb

@@ -1,3 +1,3 @@
 module VoteableMongo
-  VERSION = '0.9.1'
+  VERSION = '0.9.2'
 end

data/lib/voteable_mongo/voter.rb

@@ -23,7 +23,7 @@ module Mongo
             votee_class = votee.class
             votee_id = votee.id
           else
-            votee_class = options[:votee_type].classify.constantize
+            votee_class = options[:votee_class]
             votee_id = options[:votee_id]
           end
         end
@@ -39,9 +39,7 @@ module Mongo
         votee = unless options.is_a?(Hash)
           options
         else
-          options[:votee] || options[:votee_type].classify.constantize.where(
-            :_id => options[:votee_id]
-          ).first
+          options[:votee] || options[:votee_class].find(options[:votee_id])
         end
         votee.vote_value(_id)
       end
@@ -74,7 +72,7 @@ module Mongo
           options[:votee_id] = votee.id
           votee_class = votee.class
         else
-          votee_class = options[:votee_type].classify.constantize
+          votee_class = options[:votee_class]
         end
       
         if options[:value].nil?
@@ -87,7 +85,7 @@ module Mongo
         options[:voter] = self
         options[:voter_id] = id
 
-        ( votee || votee_class ).vote(options)
+        (votee || votee_class).vote(options)
       end
     end
     

data/lib/voteable_mongo/voting.rb

@@ -27,13 +27,16 @@ module Mongo
               new_vote_query_and_update(options)
             end
 
-            # If votee exits or need to update parent
-            # use Collection#find_and_modify to retrieve updated votes data and parent_ids
-            doc = voteable_collection.find_and_modify(
-              :query => query,
-              :update => update,
-              :new => true
-            )
+            # http://www.mongodb.org/display/DOCS/findAndModify+Command
+            begin
+              doc = voteable_collection.find_and_modify(
+                :query => query,
+                :update => update,
+                :new => true
+              )
+            rescue Mongo::OperationFailure
+              doc = nil
+            end  
 
             if doc
               update_parent_votes(doc, options) if options[:voteable][:update_parents]

data/spec/spec_helper.rb

@@ -2,8 +2,8 @@ require 'rubygems'
 require 'bundler'
 Bundler.setup
 
-
-if rand > 0.6
+# TODO: Need better solution
+if rand > 0.5
   puts 'Mongoid'
   require 'mongoid'
   models_folder = File.join(File.dirname(__FILE__), 'mongoid/models')
@@ -33,5 +33,5 @@ Dir[ File.join(models_folder, '*.rb') ].each { |file|
   require file
   file_name = File.basename(file).sub('.rb', '')
   klass = file_name.classify.constantize
-  # klass.collection.drop
+  klass.collection.drop
 }

data/spec/voteable_mongo/voteable_spec.rb

@@ -44,6 +44,10 @@ describe Mongo::Voteable do
     @user2 = User.create!
   end
   
+  it "vote for unexisting post" do
+    @user1.vote(:votee_class => Post, :votee_id => BSON::ObjectId.new, :value => :up).should == false
+  end
+  
   context "just created" do
     it 'votes_count, up_votes_count, down_votes_count, votes_point should be zero' do
       @category1.up_votes_count.should == 0

data/spec/voteable_mongo/voter_spec.rb

@@ -35,7 +35,7 @@ describe Mongo::Voter do
   
   context 'user1 vote up post1 the first time' do
     before :all do    
-      @user1.vote(:revote => '', :votee_id => @post1.id, :votee_type => 'Post', :value => :up)
+      @user1.vote(:revote => '', :votee_id => @post1.id, :votee_class => Post, :value => :up)
       @post1.reload
     end
     
@@ -44,10 +44,10 @@ describe Mongo::Voter do
       @post1.votes_point.should == 1
 
       @user1.vote_value(@post1).should == :up
-      @user2.vote_value(:votee_type => 'Post', :votee_id => @post1.id).should be_nil
+      @user2.vote_value(:votee_class => Post, :votee_id => @post1.id).should be_nil
       
       @user1.should be_voted(@post1)
-      @user2.should_not be_voted(:votee_type => 'Post', :votee_id => @post1.id)
+      @user2.should_not be_voted(:votee_class => Post, :votee_id => @post1.id)
       
       Post.voted_by(@user1).to_a.should == [ @post1 ]
       Post.up_voted_by(@user1).to_a.should == [ @post1 ]

data/voteable_mongo.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors     = ['Alex Nguyen']
   s.email       = ['alex@vinova.sg']
   s.homepage    = 'https://github.com/vinova/voteable_mongo'
-  s.summary     = %q{Add Up / Down Voting for Mongoid and MongoMapper}
-  s.description = %q{Add Up / Down Voting for Mongoid and MongoMapper. Built for speed by using only one database request per collection to validate, update, and retrieve updated data.}
+  s.summary     = %q{Add up / down voting ability to Mongoid and MongoMapper documents}
+  s.description = %q{Add up / down voting ability to Mongoid and MongoMapper documents. Optimized for speed by using only ONE request to MongoDB to validate, update, and retrieve updated data.}
 
   s.add_development_dependency 'rspec', '~> 2.5.0'
   s.add_development_dependency 'mongoid', '~> 2.0.0'

metadata

@@ -2,7 +2,7 @@
 name: voteable_mongo
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors: 
 - Alex Nguyen
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-04 00:00:00 Z
+date: 2011-05-07 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -56,7 +56,7 @@ dependencies:
         version: 1.3.0
   type: :development
   version_requirements: *id004
-description: Add Up / Down Voting for Mongoid and MongoMapper. Built for speed by using only one database request per collection to validate, update, and retrieve updated data.
+description: Add up / down voting ability to Mongoid and MongoMapper documents. Optimized for speed by using only ONE request to MongoDB to validate, update, and retrieve updated data.
 email: 
 - alex@vinova.sg
 executables: []
@@ -121,10 +121,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: voteable_mongo
-rubygems_version: 1.7.2
+rubygems_version: 1.8.1
 signing_key: 
 specification_version: 3
-summary: Add Up / Down Voting for Mongoid and MongoMapper
+summary: Add up / down voting ability to Mongoid and MongoMapper documents
 test_files: 
 - spec/mongo_mapper/models/category.rb
 - spec/mongo_mapper/models/comment.rb