voteable_mongo 0.9.2 → 0.9.3

data/CHANGELOG.rdoc

@@ -1,3 +1,6 @@
+== 0.9.3
+  * Support mongoid ~> 2.0, mongo_mapper ~> 0.9
+  
 == 0.9.2
   * Replace votee_type to votee_class
   * Bug fixes

data/README.rdoc

@@ -2,34 +2,37 @@
 
 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.
 
-Initial idea 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
+Sample app at https://github.com/vinova/simple_qa.
 
 Wonder how fast voteable_mongo is compare to other SQL & MongoDB solutions?
 Visit benchmarks at https://github.com/vinova/voteable_benchmarks
 
 == 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
+There are various solutions for up / down voting problem (1[https://github.com/medihack/make_voteable], 2[https://github.com/brady8/thumbs_up], 3[https://github.com/icaruswings/mm-voteable], 4[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.
 
-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 takes advantage of document-oriented database to store all related votes data inside voteable document. That has following benefits:
 
-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 ...
+* Don't have to maintain additional votes table or votes collection.
 
-So use voteable_mongo and save your database requests for other other tasks.
+* 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 ...
+
+* When vote up, vote down, revote, unvote, voteable_mongo validates vote data, updates voteable document and retrieves updated data using only ONE database request thanks to atomic findAndModify operation.
+
+* Atomic operations on single document warranty data integrity that makes sure if votes created / changed / deleted their associated counters and points will be updated.
+
+So use voteable_mongo for less maintain cost, data integrity and save database requests for other tasks.
 
 == Sites using voteable_mongo
+* http://www.naiku.net
 * http://www.amorveneris.com
-* http://zheye.org (https://github.com/huacnlee/quora)
+* http://zheye.org
 
 == Installation
 
-=== Rails 3.0.x
+=== Rails 3.x
 
 To install the gem, add this to your Gemfile
 
@@ -183,18 +186,18 @@ Note: vote function always return updated votee object
 
 == Utilities
 
-=== Re-generate counters and vote points in case you change :up / :down vote points
-Rails
-    rake mongo:voteable:remake_stats
-Ruby
-    Mongo::Voteable::Tasks.remake_stats
-
 === Set counters and point to 0 for uninitialized voteable objects in order sort and query
 Rails
     rake mongo:voteable:init_stats
 Ruby
     Mongo::Voteable::Tasks::init_stats
 
+=== Re-generate counters and vote points in case you change :up / :down vote points
+Rails
+    rake mongo:voteable:remake_stats
+Ruby
+    Mongo::Voteable::Tasks.remake_stats
+
 === Migrate from voteable_mongoid version < 0.7.0
 Rails
     rake mongo:voteable:migrate_old_votes
@@ -203,7 +206,7 @@ Ruby
 
 == Credits
 * Alex Nguyen - Author
-* https://github.com/vinova/voteable_mongo/contributors
+* Contributors[https://github.com/vinova/voteable_mongo/contributors]
 
 Copyright (c) 2010-2011 Vinova Pte Ltd
 

data/Rakefile

@@ -3,7 +3,7 @@ Bundler::GemHelper.install_tasks
 
 require 'rspec'
 require 'rspec/core/rake_task'
-Rspec::Core::RakeTask.new(:spec) do |spec|
+RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
 end
 

data/TODO

@@ -1,11 +1,17 @@
+* Support Mongoid / MongoMapper embedded documents
+
 * 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,3 +1,4 @@
+require 'voteable_mongo/helpers'
 require 'voteable_mongo/voteable'
 require 'voteable_mongo/voter'
 require 'voteable_mongo/tasks'

data/lib/voteable_mongo/helpers.rb

@@ -0,0 +1,15 @@
+module Mongo
+  module Voteable
+    module Helpers
+
+      def self.try_to_convert_string_to_object_id(x)
+        x.is_a?(String) && BSON::ObjectId.legal?(x) ? BSON::ObjectId(x) : x
+      end
+
+      def self.get_mongo_id(x)
+        x.respond_to?(:id) ? x.id : x
+      end
+
+    end
+  end
+end

data/lib/voteable_mongo/version.rb

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

data/lib/voteable_mongo/voteable.rb

@@ -16,26 +16,26 @@ module Mongo
     }
 
     included do
-      include ::Mongo::Voteable::Voting
+      include Mongo::Voteable::Voting
 
       if defined?(Mongoid) && defined?(field)
-        include ::Mongo::Voteable::Integrations::Mongoid
+        include Mongo::Voteable::Integrations::Mongoid
       elsif defined?(MongoMapper)
-        include ::Mongo::Voteable::Integrations::MongoMapper
+        include Mongo::Voteable::Integrations::MongoMapper
       end
       
       scope :voted_by, lambda { |voter|
-        voter_id = voter.is_a?(::BSON::ObjectId) ? voter : voter.id
+        voter_id = Helpers.get_mongo_id(voter)
         where('$or' => [{ 'votes.up' => voter_id }, { 'votes.down' => voter_id }])
       }
 
       scope :up_voted_by, lambda { |voter|
-        voter_id = voter.is_a?(::BSON::ObjectId) ? voter : voter.id
+        voter_id = Helpers.get_mongo_id(voter)
         where('votes.up' => voter_id)
       }
 
       scope :down_voted_by, lambda { |voter|
-        voter_id = voter.is_a?(::BSON::ObjectId) ? voter : voter.id
+        voter_id = Helpers.get_mongo_id(voter)
         where('votes.down' => voter_id)
       }
     end
@@ -140,9 +140,9 @@ module Mongo
     
       # Get a voted value on this votee
       #
-      # @param [Mongoid Object, BSON::ObjectId] voter is Mongoid object or the id of the voter who made the vote
+      # @param voter is 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
+        voter_id = Helpers.get_mongo_id(voter)
         return :up if up_voter_ids.include?(voter_id)
         return :down if down_voter_ids.include?(voter_id)
       end

data/lib/voteable_mongo/voting.rb

@@ -53,8 +53,8 @@ module Mongo
         private
           def validate_and_normalize_vote_options(options)
             options.symbolize_keys!
-            options[:votee_id] = BSON::ObjectId(options[:votee_id]) if options[:votee_id].is_a?(String)
-            options[:voter_id] = BSON::ObjectId(options[:voter_id]) if options[:voter_id].is_a?(String)
+            options[:votee_id] = Helpers.try_to_convert_string_to_object_id(options[:votee_id])
+            options[:voter_id] = Helpers.try_to_convert_string_to_object_id(options[:voter_id])
             options[:value] &&= options[:value].to_sym
           end
         
@@ -152,7 +152,7 @@ module Mongo
           def update_parent_votes(doc, options)
             VOTEABLE[name].each do |class_name, voteable|
               if metadata = voteable_relation(class_name)
-                if parent_id = doc[voteable_foreign_key(metadata)]
+                if (parent_id = doc[voteable_foreign_key(metadata)]).present?
                   parent_ids = parent_id.is_a?(Array) ? parent_id : [ parent_id ]
                   class_name.constantize.collection.update( 
                     { '_id' => { '$in' => parent_ids } },

data/spec/mongoid/models/post.rb

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

data/spec/voteable_mongo/tasks_spec.rb

@@ -3,8 +3,8 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe Mongo::Voteable::Tasks do
   describe 'Mongo::Voteable::Tasks.init_stats' do
     before :all do
-      @post1 = Post.create!
-      @post2 = Post.create!
+      @post1 = Post.create!(:title => 'post1')
+      @post2 = Post.create!(:title => 'post2')
     end
 
     it 'after create votes has default value' do

data/spec/voteable_mongo/voteable_spec.rb

@@ -35,9 +35,12 @@ describe Mongo::Voteable do
     @category1 = Category.create!(:name => 'xyz')
     @category2 = Category.create!(:name => 'abc')
     
-    @post1 = Post.create!(:category_ids => [@category1.id, @category2.id])
-    @post2 = Post.create!
-        
+    @post1 = Post.create!(:title => 'post1')
+    @post2 = Post.create!(:title => 'post2')
+
+    @post1.category_ids = [@category1.id, @category2.id]
+    @post1.save!
+
     @comment = @post2.comments.create!
     
     @user1 = User.create!

data/spec/voteable_mongo/voter_spec.rb

@@ -2,8 +2,8 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe Mongo::Voter do
   before :all do
-    @post1 = Post.create!
-    @post2 = Post.create!
+    @post1 = Post.create!(:title => 'post_1')
+    @post2 = Post.create!(:title => 'post_2')
 
     @user1 = User.create!
     @user2 = User.create!

data/voteable_mongo.gemspec

@@ -12,10 +12,10 @@ Gem::Specification.new do |s|
   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'
-  s.add_development_dependency 'mongo_mapper', '~> 0.9.0'
-  s.add_development_dependency 'bson_ext', '~> 1.3.0'
+  s.add_development_dependency 'rspec', '~> 2.5'
+  s.add_development_dependency 'mongoid', '~> 2.0'
+  s.add_development_dependency 'mongo_mapper', '~> 0.9'
+  s.add_development_dependency 'bson_ext', '~> 1.4'
 
   s.rubyforge_project = 'voteable_mongo'
 

metadata

@@ -1,71 +1,69 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: voteable_mongo
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.9.3
   prerelease: 
-  version: 0.9.2
 platform: ruby
-authors: 
+authors:
 - Alex Nguyen
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-07 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2166657880 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: 2.5.0
+      - !ruby/object:Gem::Version
+        version: '2.5'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: mongoid
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2166657880
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: &2166657380 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: 2.0.0
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: mongo_mapper
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2166657380
+- !ruby/object:Gem::Dependency
+  name: mongo_mapper
+  requirement: &2166656920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: 0.9.0
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: bson_ext
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2166656920
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: &2166656460 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: 1.3.0
+      - !ruby/object:Gem::Version
+        version: '1.4'
   type: :development
-  version_requirements: *id004
-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: 
+  prerelease: false
+  version_requirements: *2166656460
+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: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rvmrc
 - .watchr
@@ -75,6 +73,7 @@ files:
 - Rakefile
 - TODO
 - lib/voteable_mongo.rb
+- lib/voteable_mongo/helpers.rb
 - lib/voteable_mongo/integrations/mongo_mapper.rb
 - lib/voteable_mongo/integrations/mongoid.rb
 - lib/voteable_mongo/railtie.rb
@@ -100,32 +99,29 @@ files:
 - voteable_mongo.gemspec
 homepage: https://github.com/vinova/voteable_mongo
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: voteable_mongo
-rubygems_version: 1.8.1
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Add up / down voting ability to Mongoid and MongoMapper documents
-test_files: 
+test_files:
 - spec/mongo_mapper/models/category.rb
 - spec/mongo_mapper/models/comment.rb
 - spec/mongo_mapper/models/post.rb