acts_as_votable 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a69a2b257a2491f945b09323a74472bdfb80c1f7
-  data.tar.gz: 64a63524853816cb82a01adfe3f5b7abc536889b
+  metadata.gz: dbab821eaed3208a063e8bcd39f67a4e28fb79b0
+  data.tar.gz: d788852ccc01167a02a0b5a8d09b76d4cb13b212
 SHA512:
-  metadata.gz: 41be950836d6d092d91dd0fb2ad75a84bfb6c6d7db910d4b5c92c7e945bae1e47ccf839992104b8781b46f3e8a203fa1d34a3c78acf7eb8b613e5784926822c3
-  data.tar.gz: 4a02b443a7cf410a8d114180a04cb7ca872334de4f0809047f4c8081a56a44ea5cd44f6dba098043fb20d99701b41febd2e60efb347f882325b9b1e6d47b7751
+  metadata.gz: d8323034cb58bd685120c2ef882ffe06f0a94c5c7d503207d83e4bcac52d9d8e83d8aedd3d04c230225ca1a6f2816a6e2a298271032afb65584cac79df2a02f1
+  data.tar.gz: 252fe90880661cefb906365409fd77da3853cafb3ca71633187ffe64ecdf17dee9abfa8ba06ac6f70841cfd7b402dcb700cc7beec87eb9d3492360fba5de31fd

data/README.markdown

@@ -158,6 +158,27 @@ You can add an scope to your vote
 @post.find_votes(:vote_scope => 'week').size # => 1
 @post.find_votes(:vote_scope => 'month').size # => 1
 ```
+### Adding weights to your votes
+
+You can add weight to your vote. The default value is 1.
+
+```ruby
+# positive votes
+@post.liked_by @user1, :vote_weight => 1
+@post.vote :voter => @user3, :vote_weight => 2
+@post.vote :voter => @user5, :vote => 'like', :vote_scope => 'rank', :vote_weight => 3
+
+# negative votes
+@post.downvote_from @user2, :vote_scope => 'rank', :vote_weight => 1
+@post.vote :voter => @user2, :vote => 'bad', :vote_scope => 'rank', :vote_weight => 3
+
+# tally them up!
+@post.find_votes(:vote_scope => 'rank').sum(:vote_weight) # => 6
+@post.likes(:vote_scope => 'rank').sum(:vote_weight) # => 6
+@post.upvotes(:vote_scope => 'rank').sum(:vote_weight) # => 6
+@post.dislikes(:vote_scope => 'rank').sum(:vote_weight) # => 4
+@post.downvotes(:vote_scope => 'rank').sum(:vote_weight) # => 4
+```
 
 ### The Voter
 
@@ -267,6 +288,13 @@ after voting.  For example:
 @hat.negatives.size # => 1
 ```
 
+To permit duplicates entries of a same voter, use option duplicate. Also notice that this
+will limit some other methods that didn't deal with multiples votes, in this case, the last vote will be considered.
+
+```ruby
+@hat.vote voter: @user, :duplicate => true
+```
+
 ## Caching
 
 To speed up perform you can add cache columns to your votable model's table.  These
@@ -280,10 +308,15 @@ class AddCachedVotesToPosts < ActiveRecord::Migration
     add_column :posts, :cached_votes_score, :integer, :default => 0
     add_column :posts, :cached_votes_up, :integer, :default => 0
     add_column :posts, :cached_votes_down, :integer, :default => 0
+    add_column :posts, :cached_weighted_score, :integer, :default => 0
     add_index  :posts, :cached_votes_total
     add_index  :posts, :cached_votes_score
     add_index  :posts, :cached_votes_up
     add_index  :posts, :cached_votes_down
+    add_index  :posts, :cached_weighted_score
+
+    # Uncomment this line to force caching of existing votes
+    # Post.find_each(&:update_cached_votes)
   end
 
   def self.down
@@ -291,6 +324,7 @@ class AddCachedVotesToPosts < ActiveRecord::Migration
     remove_column :posts, :cached_votes_score
     remove_column :posts, :cached_votes_up
     remove_column :posts, :cached_votes_down
+    remove_column  :posts, :cached_weighted_score
   end
 end
 ```

data/lib/acts_as_votable/version.rb

@@ -1,3 +1,3 @@
 module ActsAsVotable
-  VERSION = "0.7.1"
+  VERSION = "0.8.0"
 end

data/lib/acts_as_votable/votable.rb

@@ -6,13 +6,13 @@ module ActsAsVotable
     include Helpers::Words
 
     def self.included base
- 
-      # allow the user to define these himself 
+
+      # allow the user to define these himself
       aliases = {
 
         :vote_up => [
-          :up_by, :upvote_by, :like_by, :liked_by, :vote_by, 
-          :up_from, :upvote_from, :upvote_by, :like_from, :liked_from, :vote_from 
+          :up_by, :upvote_by, :like_by, :liked_by, :vote_by,
+          :up_from, :upvote_from, :upvote_by, :like_from, :liked_from, :vote_from
         ],
 
         :vote_down => [
@@ -33,7 +33,7 @@ module ActsAsVotable
       }
 
       base.class_eval do
-        has_many :votes, :class_name => "ActsAsVotable::Vote", :as => :votable do
+        has_many :votes, :class_name => 'ActsAsVotable::Vote', :as => :votable, :dependent => :destroy do
           def voters
             includes(:voter).map(&:voter)
           end
@@ -82,16 +82,18 @@ module ActsAsVotable
         :voter_type => options[:voter].class.name
       })
 
-      if _votes_.count == 0
+      if _votes_.count == 0 or options[:duplicate]
         # this voter has never voted
         vote = ActsAsVotable::Vote.new(
           :votable => self,
           :voter => options[:voter],
           :vote_scope => options[:vote_scope]
         )
+        #Allowing for a vote_weight to be associated with every vote. Could change with every voter object
+        vote.vote_weight = options.fetch(:vote_weight, 1).to_i
       else
         # this voter is potentially changing his vote
-        vote = _votes_.first
+        vote = _votes_.last
       end
 
       last_update = vote.updated_at
@@ -100,7 +102,7 @@ module ActsAsVotable
 
       if vote.save
         self.vote_registered = true if last_update != vote.updated_at
-        update_cached_votes
+        update_cached_votes options[:vote_scope]
         return true
       else
         self.vote_registered = false
@@ -115,25 +117,52 @@ module ActsAsVotable
 
       return true if _votes_.size == 0
       _votes_.each(&:destroy)
-      update_cached_votes
+      update_cached_votes args[:vote_scope]
       self.vote_registered = false if votes.count == 0
       return true
     end
 
     def vote_up voter, options={}
-      self.vote :voter => voter, :vote => true, :vote_scope => options[:vote_scope]
+      self.vote :voter => voter, :vote => true, :vote_scope => options[:vote_scope], :vote_weight => options[:vote_weight]
     end
 
     def vote_down voter, options={}
-      self.vote :voter => voter, :vote => false, :vote_scope => options[:vote_scope]
+      self.vote :voter => voter, :vote => false, :vote_scope => options[:vote_scope], :vote_weight => options[:vote_weight]
     end
 
     def unvote_for  voter, options = {}
-      self.unvote :voter => voter, :vote_scope => options[:vote_scope]
+      self.unvote :voter => voter, :vote_scope => options[:vote_scope] #Does not need vote_weight since the votes are anyway getting destroyed
+    end
+
+    def scope_cache_field field, vote_scope
+      return field if vote_scope.nil?
+
+      case field
+      when :cached_votes_total=
+        "cached_scoped_#{vote_scope}_votes_total="
+      when :cached_votes_total
+        "cached_scoped_#{vote_scope}_votes_total"
+      when :cached_votes_up=
+        "cached_scoped_#{vote_scope}_votes_up="
+      when :cached_votes_up
+        "cached_scoped_#{vote_scope}_votes_up"
+      when :cached_votes_down=
+        "cached_scoped_#{vote_scope}_votes_down="
+      when :cached_votes_down
+        "cached_scoped_#{vote_scope}_votes_down"
+      when :cached_votes_score=
+        "cached_scoped_#{vote_scope}_votes_score="
+      when :cached_votes_score
+        "cached_scoped_#{vote_scope}_votes_score"
+      when :cached_weighted_scope
+        "cached_weighted_#{vote_scope}_score"
+      when :cached_weighted_score=
+        "cached_weighted_#{vote_scope}_score="
+      end
     end
 
     # caching
-    def update_cached_votes
+    def update_cached_votes vote_scope = nil
 
       updates = {}
 
@@ -156,6 +185,35 @@ module ActsAsVotable
         )
       end
 
+      if self.respond_to?(:cached_weighted_score=)
+        updates[:cached_weighted_score] = weighted_score(true)
+      end
+
+      if vote_scope
+        if self.respond_to?(scope_cache_field :cached_votes_total=, vote_scope)
+          updates[scope_cache_field :cached_votes_total, vote_scope] = count_votes_total(true, vote_scope)
+        end
+
+        if self.respond_to?(scope_cache_field :cached_votes_up=, vote_scope)
+          updates[scope_cache_field :cached_votes_up, vote_scope] = count_votes_up(true, vote_scope)
+        end
+
+        if self.respond_to?(scope_cache_field :cached_votes_down=, vote_scope)
+          updates[scope_cache_field :cached_votes_down, vote_scope] = count_votes_down(true, vote_scope)
+        end
+
+        if self.respond_to?(scope_cache_field :cached_weighted_score=, vote_scope)
+          updates[scope_cache_field :cached_weighted_score, vote_scope] = weighted_score(true, vote_scope)
+        end
+
+        if self.respond_to?(scope_cache_field :cached_votes_score=, vote_scope)
+          updates[scope_cache_field :cached_votes_score, vote_scope] = (
+            (updates[scope_cache_field :cached_votes_up, vote_scope] || count_votes_up(true, vote_scope)) -
+            (updates[scope_cache_field :cached_votes_down, vote_scope] || count_votes_down(true, vote_scope))
+          )
+        end
+      end
+
       if (::ActiveRecord::VERSION::MAJOR == 3) && (::ActiveRecord::VERSION::MINOR != 0)
         self.update_attributes(updates, :without_protection => true) if updates.size > 0
       else
@@ -180,25 +238,34 @@ module ActsAsVotable
 
 
     # counting
-    def count_votes_total skip_cache = false
-      if !skip_cache && self.respond_to?(:cached_votes_total)
-        return self.send(:cached_votes_total)
+    def count_votes_total skip_cache = false, vote_scope = nil
+      if !skip_cache && self.respond_to?(scope_cache_field :cached_votes_total, vote_scope)
+        return self.send(scope_cache_field :cached_votes_total, vote_scope)
+      end
+      find_votes(:vote_scope => vote_scope).count
+    end
+
+    def count_votes_up skip_cache = false, vote_scope = nil
+      if !skip_cache && self.respond_to?(scope_cache_field :cached_votes_up, vote_scope)
+        return self.send(scope_cache_field :cached_votes_up, vote_scope)
       end
-      find_votes.count
+      up_votes(:vote_scope => vote_scope).count
     end
 
-    def count_votes_up skip_cache = false
-      if !skip_cache && self.respond_to?(:cached_votes_up)
-        return self.send(:cached_votes_up)
+    def count_votes_down skip_cache = false, vote_scope = nil
+      if !skip_cache && self.respond_to?(scope_cache_field :cached_votes_down, vote_scope)
+        return self.send(scope_cache_field :cached_votes_down, vote_scope)
       end
-      up_votes.count
+      down_votes(:vote_scope => vote_scope).count
     end
 
-    def count_votes_down skip_cache = false
-      if !skip_cache && self.respond_to?(:cached_votes_down)
-        return self.send(:cached_votes_down)
+    def weighted_score skip_cache = false, vote_scope = nil
+      if !skip_cache && self.respond_to?(scope_cache_field :cached_weighted_score, vote_scope)
+        return self.send(scope_cache_field :cached_weighted_score, vote_scope)
       end
-      down_votes.count
+      ups = up_votes(:vote_scope => vote_scope).sum(:vote_weight)
+      downs = down_votes(:vote_scope => vote_scope).sum(:vote_weight)
+      ups - downs
     end
 
     # voters

data/lib/acts_as_votable/voter.rb

@@ -18,7 +18,7 @@ module ActsAsVotable
 
       base.class_eval do
 
-        has_many :votes, :class_name => "ActsAsVotable::Vote", :as => :voter do
+        has_many :votes, :class_name => 'ActsAsVotable::Vote', :as => :voter, :dependent => :destroy do
           def votables
             includes(:votable).map(&:votable)
           end
@@ -71,10 +71,10 @@ module ActsAsVotable
     end
 
     def voted_as_when_voting_on votable, args={}
-      votes = find_votes(:votable_id => votable.id, :votable_type => votable.class.name,
-                         :vote_scope => args[:vote_scope])
-      return nil if votes.size == 0
-      return votes.first.vote_flag
+      vote = find_votes(:votable_id => votable.id, :votable_type => votable.class.name,
+                         :vote_scope => args[:vote_scope]).select(:vote_flag).last
+      return nil unless vote
+      return vote.vote_flag
     end
 
     def find_votes extra_conditions = {}

data/lib/generators/acts_as_votable/migration/templates/active_record/migration.rb

@@ -7,6 +7,7 @@ class ActsAsVotableMigration < ActiveRecord::Migration
 
       t.boolean :vote_flag
       t.string :vote_scope
+      t.integer :vote_weight
 
       t.timestamps
     end

data/spec/spec_helper.rb

@@ -11,6 +11,7 @@ ActiveRecord::Schema.define(:version => 1) do
 
     t.boolean :vote_flag
     t.string :vote_scope
+    t.integer :vote_weight
 
     t.timestamps
   end
@@ -52,6 +53,13 @@ ActiveRecord::Schema.define(:version => 1) do
     t.integer :cached_votes_score
     t.integer :cached_votes_up
     t.integer :cached_votes_down
+    t.integer :cached_weighted_score
+
+    t.integer :cached_scoped_test_votes_total
+    t.integer :cached_scoped_test_votes_score
+    t.integer :cached_scoped_test_votes_up
+    t.integer :cached_scoped_test_votes_down
+    t.integer :cached_scoped_weighted_score
   end
 
 end

data/spec/votable_spec.rb

@@ -44,6 +44,12 @@ describe ActsAsVotable::Votable do
       @votable.votes.size.should == 1
     end
 
+    it "should have two votes when voted on twice by the same person with duplicate paramenter" do
+      @votable.vote :voter => @voter, :vote => 'yes'
+      @votable.vote :voter => @voter, :vote => 'no', :duplicate => true
+      @votable.votes.size.should == 2
+    end
+
     it "should have one scoped vote when voting under an scope" do
       @votable.vote :voter => @voter, :vote => 'yes', :vote_scope => 'rank'
       @votable.find_votes(:vote_scope => 'rank').size.should == 1
@@ -219,6 +225,30 @@ describe ActsAsVotable::Votable do
         @votable_cache.cached_votes_score.should == 0
       end
 
+      it "should update cached weighted score if there is a weighted score column" do
+        @votable_cache.cached_weighted_score = 50
+        @votable_cache.vote :voter => @voter
+        @votable_cache.cached_weighted_score.should == 1
+        @votable_cache.vote :voter => @voter2, :vote => 'false'
+        @votable_cache.cached_weighted_score.should == 0
+        @votable_cache.vote :voter => @voter, :vote => 'false'
+        @votable_cache.cached_weighted_score.should == -2
+      end
+
+      it "should update cached weighted score votes when a vote up is removed" do
+        @votable_cache.vote :voter => @voter, :vote => 'true', :vote_weight => 3
+        @votable_cache.cached_weighted_score.should == 3
+        @votable_cache.unvote :voter => @voter
+        @votable_cache.cached_weighted_score.should == 0
+      end
+
+      it "should update cached weighted score votes when a vote down is removed" do
+        @votable_cache.vote :voter => @voter, :vote => 'false', :vote_weight => 4
+        @votable_cache.cached_weighted_score.should == -4
+        @votable_cache.unvote :voter => @voter
+        @votable_cache.cached_weighted_score.should == 0
+      end
+
       it "should update cached up votes if there is an up vote column" do
         @votable_cache.cached_votes_up = 50
         @votable_cache.vote :voter => @voter
@@ -262,6 +292,113 @@ describe ActsAsVotable::Votable do
         @votable_cache.count_votes_down.should == 50
       end
 
+      it "should select from cached weighted score if there is a weighted score column" do
+        @votable_cache.vote :voter => @voter, :vote => 'false'
+        @votable_cache.cached_weighted_score = 50
+        @votable_cache.weighted_score.should == 50
+      end
+
+    end
+
+    describe "with scoped cached votes" do
+
+      before(:each) do
+        clean_database
+        @voter = Voter.new(:name => 'i can vote!')
+        @voter.save
+
+        @votable = Votable.new(:name => 'a voting model without a cache')
+        @votable.save
+
+        @votable_cache = VotableCache.new(:name => 'voting model with cache')
+        @votable_cache.save
+      end
+
+      it "should update cached total votes if there is a total column" do
+        @votable_cache.cached_scoped_test_votes_total = 50
+        @votable_cache.vote :voter => @voter, :vote_scope => "test"
+        @votable_cache.cached_scoped_test_votes_total.should == 1
+      end
+
+      it "should update cached total votes when a vote up is removed" do
+        @votable_cache.vote :voter => @voter, :vote => 'true', :vote_scope => "test"
+        @votable_cache.unvote :voter => @voter, :vote_scope => "test"
+        @votable_cache.cached_scoped_test_votes_total.should == 0
+      end
+
+      it "should update cached total votes when a vote down is removed" do
+        @votable_cache.vote :voter => @voter, :vote => 'false', :vote_scope => "test"
+        @votable_cache.unvote :voter => @voter, :vote_scope => "test"
+        @votable_cache.cached_scoped_test_votes_total.should == 0
+      end
+
+      it "should update cached score votes if there is a score column" do
+        @votable_cache.cached_scoped_test_votes_score = 50
+        @votable_cache.vote :voter => @voter, :vote_scope => "test"
+        @votable_cache.cached_scoped_test_votes_score.should == 1
+        @votable_cache.vote :voter => @voter2, :vote => 'false', :vote_scope => "test"
+        @votable_cache.cached_scoped_test_votes_score.should == 0
+        @votable_cache.vote :voter => @voter, :vote => 'false', :vote_scope => "test"
+        @votable_cache.cached_scoped_test_votes_score.should == -2
+      end
+
+      it "should update cached score votes when a vote up is removed" do
+        @votable_cache.vote :voter => @voter, :vote => 'true', :vote_scope => "test"
+        @votable_cache.cached_scoped_test_votes_score.should == 1
+        @votable_cache.unvote :voter => @voter, :vote_scope => "test"
+        @votable_cache.cached_scoped_test_votes_score.should == 0
+      end
+
+      it "should update cached score votes when a vote down is removed" do
+        @votable_cache.vote :voter => @voter, :vote => 'false', :vote_scope => "test"
+        @votable_cache.cached_scoped_test_votes_score.should == -1
+        @votable_cache.unvote :voter => @voter, :vote_scope => "test"
+        @votable_cache.cached_scoped_test_votes_score.should == 0
+      end
+
+      it "should update cached up votes if there is an up vote column" do
+        @votable_cache.cached_scoped_test_votes_up = 50
+        @votable_cache.vote :voter => @voter, :vote_scope => "test"
+        @votable_cache.vote :voter => @voter, :vote_scope => "test"
+        @votable_cache.cached_scoped_test_votes_up.should == 1
+      end
+
+      it "should update cached down votes if there is a down vote column" do
+        @votable_cache.cached_scoped_test_votes_down = 50
+        @votable_cache.vote :voter => @voter, :vote => 'false', :vote_scope => "test"
+        @votable_cache.cached_scoped_test_votes_down.should == 1
+      end
+
+      it "should update cached up votes when a vote up is removed" do
+        @votable_cache.vote :voter => @voter, :vote => 'true', :vote_scope => "test"
+        @votable_cache.unvote :voter => @voter, :vote_scope => "test"
+        @votable_cache.cached_scoped_test_votes_up.should == 0
+      end
+
+      it "should update cached down votes when a vote down is removed" do
+        @votable_cache.vote :voter => @voter, :vote => 'false', :vote_scope => "test"
+        @votable_cache.unvote :voter => @voter, :vote_scope => "test"
+        @votable_cache.cached_scoped_test_votes_down.should == 0
+      end
+
+      it "should select from cached total votes if there a total column" do
+        @votable_cache.vote :voter => @voter, :vote_scope => "test"
+        @votable_cache.cached_scoped_test_votes_total = 50
+        @votable_cache.count_votes_total(false, "test").should == 50
+      end
+
+      it "should select from cached up votes if there is an up vote column" do
+        @votable_cache.vote :voter => @voter, :vote_scope => "test"
+        @votable_cache.cached_scoped_test_votes_up = 50
+        @votable_cache.count_votes_up(false, "test").should == 50
+      end
+
+      it "should select from cached down votes if there is a down vote column" do
+        @votable_cache.vote :voter => @voter, :vote => 'false', :vote_scope => "test"
+        @votable_cache.cached_scoped_test_votes_down = 50
+        @votable_cache.count_votes_down(false, "test").should == 50
+      end
+
     end
 
     describe "sti models" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_votable
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Ryan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-24 00:00:00.000000000 Z
+date: 2013-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -89,8 +89,4 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Rails gem to allowing records to be votable
-test_files:
-- spec/spec_helper.rb
-- spec/votable_spec.rb
-- spec/voter_spec.rb
-- spec/words_spec.rb
+test_files: []