rs_voteable_mongo 1.0.0

data/spec/voteable_mongo/voteable_spec.rb

@@ -0,0 +1,436 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Mongo::Voteable do
+  
+  context 'when :index is passed as an argument' do
+    before do
+      Post.remove_indexes
+      Category.remove_indexes
+      
+      Post.create_voteable_indexes
+      Category.create_voteable_indexes
+    end
+  
+    it 'defines indexes' do
+      [Post, Category].each do |klass|
+        [ {'votes.up' => 1, '_id' => 1},
+          {'votes.down' => 1, '_id' => 1},
+        ].each { |index_key|
+          klass.collection.indexes[index_key].should_not be_nil
+          klass.collection.indexes[index_key]['unique'].should be_true
+        }
+  
+        [ {'votes.count' => -1},
+          {'votes.up_count' => -1},
+          {'votes.down_count' => -1},
+          {'votes.point' => -1},
+        ].each { |index_key|
+          klass.collection.indexes[index_key].should_not be_nil
+        }
+      end
+    end
+  end
+  
+  before :all do
+    Category.destroy_all
+    @category1 = Category.create!(:name => 'xyz')
+    @category2 = Category.create!(:name => 'abc')
+    Post.destroy_all
+    @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!
+    @user2 = User.create!
+  end
+  
+  it "vote for unexisting post" do
+    object_id = defined?(Moped::BSON) ? Moped::BSON::ObjectId : BSON::ObjectId
+    @user1.vote(:votee_class => Post, :votee_id => object_id.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
+      @category1.down_votes_count.should == 0
+      @category1.votes_count.should == 0
+      @category1.votes_point.should == 0
+
+      @category2.up_votes_count.should == 0
+      @category2.down_votes_count.should == 0
+      @category2.votes_count.should == 0
+      @category2.votes_point.should == 0
+
+      @post1.up_votes_count.should == 0
+      @post1.down_votes_count.should == 0
+      @post1.votes_count.should == 0
+      @post1.votes_point.should == 0
+
+      @post2.up_votes_count.should == 0
+      @post2.down_votes_count.should == 0
+      @post2.votes_count.should == 0
+      @post2.votes_point.should == 0
+
+      @comment.up_votes_count.should == 0
+      @comment.down_votes_count.should == 0
+      @comment.votes_count.should == 0
+      @comment.votes_point.should == 0
+    end
+    
+    it 'up_voter_ids, down_voter_ids should be empty' do
+      @category1.up_voter_ids.should be_empty
+      @category1.down_voter_ids.should be_empty
+
+      @category2.up_voter_ids.should be_empty
+      @category2.down_voter_ids.should be_empty
+
+      @post1.up_voter_ids.should be_empty
+      @post1.down_voter_ids.should be_empty
+
+      @post2.up_voter_ids.should be_empty
+      @post2.down_voter_ids.should be_empty
+
+      @comment.up_voter_ids.should be_empty
+      @comment.down_voter_ids.should be_empty
+    end
+    
+    it 'voted by voter should be empty' do
+      Category.voted_by(@user1).should be_empty
+      Category.voted_by(@user2).should be_empty
+
+      Post.voted_by(@user1).should be_empty
+      Post.voted_by(@user2).should be_empty
+      
+      Comment.voted_by(@user1).should be_empty
+      Comment.voted_by(@user2).should be_empty
+    end
+        
+    it 'revote post1 has no effect' do
+      @post1.vote(:revote => true, :voter => @user1, :value => 'up')
+
+      @post1.up_votes_count.should == 0
+      @post1.down_votes_count.should == 0
+      @post1.votes_count.should == 0
+      @post1.votes_point.should == 0
+    end
+    
+    it 'revote post2 has no effect' do
+      Post.vote(:revote => true, :votee_id => @post2.id, :voter_id => @user2.id, :value => :down)
+      @post2.reload
+      
+      @post2.up_votes_count.should == 0
+      @post2.down_votes_count.should == 0
+      @post2.votes_count.should == 0
+      @post2.votes_point.should == 0
+    end
+  end
+  
+  context 'user1 vote up post1 the first time' do
+    before :all do
+      @post = @post1.vote(:voter_id => @user1.id, :value => :up)
+    end
+    
+    it 'validates return post' do
+      @post.should be_is_a Post
+      @post.should_not be_new_record
+
+      @post.votes.should == {
+        'up' => [@user1.id],
+        'down' => [],
+        'up_count' => 1,
+        'down_count' => 0,
+        'count' => 1,
+        'point' => 1
+      }
+    end
+    
+    it 'validates' do
+      @post1.up_votes_count.should == 1
+      @post1.down_votes_count.should == 0
+      @post1.votes_count.should == 1
+      @post1.votes_point.should == 1
+
+      @post1.vote_value(@user1).should == :up
+      @post1.should be_voted_by(@user1)
+      @post1.vote_value(@user2.id).should be_nil
+      @post1.should_not be_voted_by(@user2.id)
+
+      @post1.up_voters(User).to_a.should == [ @user1 ]
+      @post1.voters(User).to_a.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
+      
+      @category1.reload
+      @category1.up_votes_count.should == 0
+      @category1.down_votes_count.should == 0
+      @category1.votes_count.should == 0
+      @category1.votes_point.should == 3
+
+      @category2.reload
+      @category2.up_votes_count.should == 0
+      @category2.down_votes_count.should == 0
+      @category2.votes_count.should == 0
+      @category2.votes_point.should == 3
+    end
+    
+    it 'user1 vote post1 has no effect' do
+      Post.vote(:revote => false, :votee_id => @post1.id, :voter_id => @user1.id, :value => :up)
+      @post1.reload
+      
+      @post1.up_votes_count.should == 1
+      @post1.down_votes_count.should == 0
+      @post1.votes_count.should == 1
+      @post1.votes_point.should == 1
+      
+      @post1.vote_value(@user1.id).should == :up
+    end
+  end
+  
+  context 'user2 vote down post1 the first time' do
+    before :all do
+      Post.vote(:votee_id => @post1.id, :voter_id => @user2.id, :value => :down)
+      @post1.reload
+    end
+    
+    it 'post1 up_votes_count is the same' do
+      @post1.up_votes_count.should == 1
+    end
+    
+    it 'post1 vote_value on user1 is the same' do
+      @post1.vote_value(@user1.id).should == :up
+    end
+    
+    it 'down_votes_count, votes_count, and votes_point changed' do
+      @post1.down_votes_count.should == 1
+      @post1.votes_count.should == 2
+      @post1.votes_point.should == 0
+      @post1.vote_value(@user2.id).should == :down
+    end
+    
+    it 'post1 get voters' do
+      @post1.up_voters(User).to_a.should == [ @user1 ]
+      @post1.down_voters(User).to_a.should == [ @user2 ]
+      @post1.voters(User).to_a.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 ]
+    end
+    
+    it 'categories votes' do
+      @category1.reload
+      @category1.up_votes_count.should == 0
+      @category1.down_votes_count.should == 0
+      @category1.votes_count.should == 0
+      @category1.votes_point.should == -2
+
+      @category2.reload
+      @category2.up_votes_count.should == 0
+      @category2.down_votes_count.should == 0
+      @category2.votes_count.should == 0
+      @category2.votes_point.should == -2
+    end
+  end
+  
+  context 'user1 change vote on post1 from up to down' do
+    before :all do
+      Post.vote(:revote => true, :votee_id => @post1.id, :voter_id => @user1.id, :value => :down)
+      Mongo::Voteable::Tasks.remake_stats
+      @post1.reload
+    end
+    
+    it 'validates' do
+      @post1.up_votes_count.should == 0
+      @post1.down_votes_count.should == 2
+      @post1.votes_count.should == 2
+      @post1.votes_point.should == -2
+
+      @post1.vote_value(@user1.id).should == :down
+      @post1.vote_value(@user2.id).should == :down
+
+      Post.voted_by(@user1).to_a.should == [ @post1 ]
+      Post.voted_by(@user2).to_a.should == [ @post1 ]
+    end
+  end
+  
+  context 'user1 vote down post2 the first time' do
+    before :all do
+      @post2.vote(:voter_id => @user1.id, :value => :down)
+    end
+    
+    it 'validates' do
+      @post2.up_votes_count.should == 0
+      @post2.down_votes_count.should == 1
+      @post2.votes_count.should == 1
+      @post2.votes_point.should == -1
+      
+      @post2.vote_value(@user1.id).should == :down
+      @post2.vote_value(@user2.id).should be_nil
+
+      Post.voted_by(@user1).to_a.should == [ @post1, @post2 ]
+    end
+  end
+  
+  context 'user1 change vote on post2 from down to up' do
+    before :all do
+      Post.vote(:revote => true, :votee_id => @post2.id.to_s, :voter_id => @user1.id.to_s, :value => :up)
+      Mongo::Voteable::Tasks.remake_stats
+      @post2.reload
+    end
+    
+    it 'validates' do
+      @post2.up_votes_count.should == 1
+      @post2.down_votes_count.should == 0
+      @post2.votes_count.should == 1
+      @post2.votes_point.should == 1
+      
+      @post2.vote_value(@user1.id).should == :up
+      @post2.vote_value(@user2.id).should be_nil
+
+      Post.voted_by(@user1).size.should == 2
+      Post.voted_by(@user1).should be_include @post1
+      Post.voted_by(@user1).should be_include @post2
+    end
+  end
+  
+
+  context 'user1 vote up post2 comment the first time' do
+    before :all do
+      @comment.vote(:voter_id => @user1.id, :value => :up)
+      @comment.reload
+      @post2.reload
+    end
+    
+    it 'validates' do
+      @post2.up_votes_count.should == 2
+      @post2.down_votes_count.should == 0
+      @post2.votes_count.should == 2
+      @post2.votes_point.should == 3
+      
+      @comment.up_votes_count.should == 1
+      @comment.down_votes_count.should == 0
+      @comment.votes_count.should == 1
+      @comment.votes_point.should == 1
+    end
+  end
+  
+  
+  context 'user1 revote post2 comment from up to down' do
+    before :all do
+      @user1.vote(:votee => @comment, :value => :down)
+      @comment.reload
+      @post2.reload
+    end
+    
+    it 'validates' do
+      @post2.up_votes_count.should == 1
+      @post2.down_votes_count.should == 1
+      @post2.votes_count.should == 2
+      @post2.votes_point.should == 0
+      
+      @comment.up_votes_count.should == 0
+      @comment.down_votes_count.should == 1
+      @comment.votes_count.should == 1
+      @comment.votes_point.should == -3
+    end
+    
+    it 'revote with wrong value has no effect' do
+      @user1.vote(:votee => @comment, :value => :down)
+      
+      @post2.up_votes_count.should == 1
+      @post2.down_votes_count.should == 1
+      @post2.votes_count.should == 2
+      @post2.votes_point.should == 0
+      
+      @comment.up_votes_count.should == 0
+      @comment.down_votes_count.should == 1
+      @comment.votes_count.should == 1
+      @comment.votes_point.should == -3
+    end
+  end
+  
+  context "user1 unvote on post1" do
+    before(:all) do
+      @post1.vote(:voter_id => @user1.id, :votee_id => @post1.id, :unvote => true)
+      Mongo::Voteable::Tasks.remake_stats
+      @post1.reload
+    end
+    
+    it 'validates' do
+      @post1.up_votes_count.should == 0
+      @post1.down_votes_count.should == 1
+      @post1.votes_count.should == 1
+      @post1.votes_point.should == -1
+      
+      @post1.vote_value(@user1.id).should be_nil
+      @post1.vote_value(@user2.id).should == :down
+      
+      Post.voted_by(@user1).to_a.should_not include(@post1)
+    end
+  end
+  
+  context "@post1 has 1 down vote and -1 point, @post2 has 1 up vote, 1 down vote and 0 point" do
+    it "verify @post1 counters" do
+      @post1.up_votes_count.should == 0
+      @post1.down_votes_count.should == 1
+      @post1.votes_count.should == 1
+      @post1.votes_point.should == -1
+    end
+    
+    it "verify @post2 counters" do
+      @post2.up_votes_count.should == 1
+      @post2.down_votes_count.should == 1
+      @post2.votes_count.should == 2
+      @post2.votes_point.should == 0
+    end    
+  end
+  
+  context "user1 unvote on comment" do
+    before(:all) do
+      @user1.unvote(@comment)
+      Mongo::Voteable::Tasks.remake_stats
+      @comment.reload
+      @post2.reload
+    end
+    
+    it "" do      
+      @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
+  
+  context 'final' do
+    it "test remake stats" do
+      Mongo::Voteable::Tasks.remake_stats
+
+      @post1.up_votes_count.should == 0
+      @post1.down_votes_count.should == 1
+      @post1.votes_count.should == 1
+      @post1.votes_point.should == -1
+
+      @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    
+    end
+  end
+end

data/spec/voteable_mongo/voter_spec.rb

@@ -0,0 +1,150 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Mongo::Voter do
+  before :all do
+    @post1 = Post.create!(:title => 'post_1')
+    @post2 = Post.create!(:title => 'post_2')
+
+    @user1 = User.create!
+    @user2 = User.create!
+  end
+  
+  context "just created" do
+    it 'validates' do
+      Post.voted_by(@user1).should be_empty
+      Post.up_voted_by(@user1).should be_empty
+      Post.down_voted_by(@user1).should be_empty
+      @user1.voted?(@post1).should be_false
+      @user1.voted?(@post2).should be_false
+      
+      Post.voted_by(@user2).should be_empty
+      Post.up_voted_by(@user2).should be_empty
+      Post.down_voted_by(@user2).should be_empty
+      @user2.voted?(@post1).should be_false
+      @user2.voted?(@post2).should be_false
+    end
+    
+    it 'revote has no effect' do      
+      @user2.vote(:revote => true, :votee => @post2, :value => :down)
+      @post2.reload
+      
+      @post2.votes_count.should == 0
+      @post2.votes_point.should == 0
+    end
+  end
+  
+  context 'user1 vote up post1 the first time' do
+    before :all do    
+      @user1.vote(:revote => '', :votee_id => @post1.id, :votee_class => Post, :value => :up)
+      @post1.reload
+    end
+    
+    it 'validates' do
+      @post1.votes_count.should == 1
+      @post1.votes_point.should == 1
+
+      @user1.vote_value(@post1).should == :up
+      @user2.vote_value(:votee_class => Post, :votee_id => @post1.id).should be_nil
+      
+      @user1.should be_voted(@post1)
+      @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 ]
+      Post.down_voted_by(@user1).to_a.should be_empty
+      Post.voted_by(@user2).to_a.should be_empty
+      
+      User.up_voted_for(@post1).to_a.should == [ @user1 ]
+      User.down_voted_for(@post1).to_a.should be_empty
+      User.voted_for(@post1).to_a.should == [ @user1 ]
+    end
+    
+    it 'user1 vote post1 has no effect' do
+      @user1.vote(:votee => @post1, :value => :up)
+      @post1.reload
+      
+      @post1.votes_count.should == 1
+      @post1.votes_point.should == 1
+      
+      @post1.vote_value(@user1.id).should == :up
+    end
+  end
+  
+  context 'user2 vote down post1 the first time' do
+    before :all do
+      @user2.vote(:votee => @post1, :value => :down)
+      @post1.reload
+    end
+    
+    it 'validates' do
+      @post1.votes_count.should == 2
+      @post1.votes_point.should == 0
+      
+      @user1.vote_value(@post1).should == :up
+      @user2.vote_value(@post1).should == :down
+
+      Post.voted_by(@user1).to_a.should == [ @post1 ]
+      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).to_a.should == [ @user1 ]
+      User.down_voted_for(@post1).to_a.should == [ @user2 ]
+      User.voted_for(@post1).to_a.should == [ @user1, @user2 ]
+    end
+  end
+  
+  context 'user1 change vote on post1 from up to down' do
+    before :all do
+      @user1.vote(:votee => @post1, :value => :down)
+      @post1.reload
+    end
+    
+    it 'validates' do
+      @post1.votes_count.should == 2
+      @post1.votes_point.should == -2
+
+      @user1.vote_value(@post1).should == :down
+      @user2.vote_value(@post1).should == :down
+
+      Post.voted_by(@user1).to_a.should == [ @post1 ]
+      Post.voted_by(@user2).to_a.should == [ @post1 ]
+    end
+  end
+  
+  context 'user1 vote down post2 the first time' do
+    before :all do
+      @user1.vote(:new => 'abc', :votee => @post2, :value => :down)
+      @post2.reload
+    end
+    
+    it 'validates' do
+      @post2.votes_count.should == 1
+      @post2.votes_point.should == -1
+      
+      @user1.vote_value(@post2).should == :down
+      @user2.vote_value(@post2).should be_nil
+
+      Post.voted_by(@user1).to_a.should == [ @post1, @post2 ]
+    end
+  end
+  
+  context 'user1 change vote on post2 from down to up' do
+    before :all do
+      @user1.vote(:revote => 'abc', :votee => @post2, :value => :up)
+      @post2.reload
+    end
+    
+    it 'validates' do
+      @post2.votes_count.should == 1
+      @post2.votes_point.should == 1
+      
+      @user1.vote_value(@post2).should == :up
+      @user2.vote_value(@post2).should be_nil
+
+      Post.voted_by(@user1).size.should == 2
+      Post.voted_by(@user1).should be_include @post1
+      Post.voted_by(@user1).should be_include @post2
+    end
+  end  
+end

data/voteable_mongo.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'voteable_mongo/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'rs_voteable_mongo'
+  s.version     = VoteableMongo::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['RocketScience','Alex Nguyen']
+  s.email       = ['i@gleb.tv','alex@vinova.sg']
+  s.homepage    = 'https://github.com/rs-pro/voteable_mongo'
+  s.summary     = %q{Add up / down voting ability to Mongoid documents}
+  s.description = %q{Add up / down voting ability to Mongoid documents. Optimized for speed by using only ONE request to MongoDB to validate, update, and retrieve updated data.}
+
+  s.add_dependency "mongoid", [">= 3.0", "< 5.0"]
+  s.add_development_dependency 'rspec', '~> 2.14.1'
+  
+  s.rubyforge_project = 'voteable_mongo'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+end