acts_as_votable 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dbab821eaed3208a063e8bcd39f67a4e28fb79b0
-  data.tar.gz: d788852ccc01167a02a0b5a8d09b76d4cb13b212
+  metadata.gz: 7b8402806ab189425b71b1d24d2081123e6bffc1
+  data.tar.gz: 48de253feb1e0df3ef42cd798faaaf8f91f36b47
 SHA512:
-  metadata.gz: d8323034cb58bd685120c2ef882ffe06f0a94c5c7d503207d83e4bcac52d9d8e83d8aedd3d04c230225ca1a6f2816a6e2a298271032afb65584cac79df2a02f1
-  data.tar.gz: 252fe90880661cefb906365409fd77da3853cafb3ca71633187ffe64ecdf17dee9abfa8ba06ac6f70841cfd7b402dcb700cc7beec87eb9d3492360fba5de31fd
+  metadata.gz: 7189eeb6505d6394bb090d58618d23ee13e36e6512f0416a15bf984c489e0775952680b748cadc054bd4948260184ac4a457ef6dee3b34f279561245adb2213e
+  data.tar.gz: 0fd78166628e72e3c77b8b5c8b8ba0028aa3069afb217816324c470ce6cc0c5a809431fcf47a800e440bbcb49020778e54f6f082698321357ded582081f488b0

data/.travis.yml

@@ -4,14 +4,22 @@ rvm:
   - 1.9.2
   - 1.9.3
   - 2.0.0
+  - 2.1.0
 env:
   - "RAILS_VERSION=3.0.0"
   - "RAILS_VERSION=3.1.0"
   - "RAILS_VERSION=3.2.0"
   - "RAILS_VERSION=4.0.0"
+  - "RAILS_VERSION=4.1.0"
 matrix:
   exclude:
     - rvm: 1.8.7
       env: "RAILS_VERSION=4.0.0"
     - rvm: 1.9.2
-      env: "RAILS_VERSION=4.0.0"
+      env: "RAILS_VERSION=4.0.0"
+    - rvm: 1.8.7
+      env: "RAILS_VERSION=4.1.0"
+    - rvm: 1.9.2
+      env: "RAILS_VERSION=4.1.0"
+    - rvm: 1.9.3
+      env: "RAILS_VERSION=4.1.0"

data/README.markdown

@@ -13,12 +13,19 @@ The main goals of this gem are:
 
 ## Installation
 
-### Rails 3.0, 3.1, 3.2, and 4.0+
+### Supported Ruby and Rails versions
+
+* Ruby 1.8.7, 1.9.2, 1.9.3
+* Ruby 2.0.0, 2.1.0
+* Rails 3.0, 3.1, 3.2
+* Rails 4.0, 4.1+
+
+### Install
 
 Just add the following to your Gemfile.
 
 ```ruby
-gem 'acts_as_votable', '~> 0.7.1'
+gem 'acts_as_votable', '~> 0.9.0'
 ```
 
 And follow that up with a ``bundle install``.
@@ -48,7 +55,7 @@ end
 @post.save
 
 @post.liked_by @user
-@post.votes.size # => 1
+@post.votes_for.size # => 1
 ```
 
 ### Like/Dislike Yes/No Up/Down
@@ -59,9 +66,9 @@ more natural calls are the first few examples.
 ```ruby
 @post.liked_by @user1
 @post.downvote_from @user2
-@post.vote :voter => @user3
-@post.vote :voter => @user4, :vote => 'bad'
-@post.vote :voter => @user5, :vote => 'like'
+@post.vote_by :voter => @user3
+@post.vote_by :voter => @user4, :vote => 'bad'
+@post.vote_by :voter => @user5, :vote => 'like'
 ```
 
 By default all votes are positive, so `@user3` has cast a 'good' vote for `@post`.
@@ -80,26 +87,26 @@ Revisiting the previous example of code.
 ```ruby
 # positive votes
 @post.liked_by @user1
-@post.vote :voter => @user3
-@post.vote :voter => @user5, :vote => 'like'
+@post.vote_by :voter => @user3
+@post.vote_by :voter => @user5, :vote => 'like'
 
 # negative votes
 @post.downvote_from @user2
-@post.vote :voter => @user2, :vote => 'bad'
+@post.vote_by :voter => @user2, :vote => 'bad'
 
 # tally them up!
-@post.votes.size # => 5
-@post.likes.size # => 3
-@post.upvotes.size # => 3
-@post.dislikes.size # => 2
-@post.downvotes.size # => 2
+@post.votes_for.size # => 5
+@post.get_likes.size # => 3
+@post.get_upvotes.size # => 3
+@post.get_dislikes.size # => 2
+@post.get_downvotes.size # => 2
 ```
 
 Active Record scopes are provided to make life easier.
 
 ```ruby
-@post.votes.up.by_type(User)
-@post.votes.down
+@post.votes_for.up.by_type(User)
+@post.votes_for.down
 @user1.votes.up
 @user1.votes.down
 @user1.votes.up.by_type(Post)
@@ -109,8 +116,8 @@ Once scoping is complete, you can also trigger a get for the
 voter/votable
 
 ```ruby
-@post.votes.up.by_type(User).voters
-@post.votes.down.by_type(User).voters
+@post.votes_for.up.by_type(User).voters
+@post.votes_for.down.by_type(User).voters
 
 @user.votes.up.for_type(Post).votables
 @user.votes.up.votables
@@ -135,28 +142,28 @@ You can add an scope to your vote
 ```ruby
 # positive votes
 @post.liked_by @user1, :vote_scope => 'rank'
-@post.vote :voter => @user3, :vote_scope => 'rank'
-@post.vote :voter => @user5, :vote => 'like', :vote_scope => 'rank'
+@post.vote_by :voter => @user3, :vote_scope => 'rank'
+@post.vote_by :voter => @user5, :vote => 'like', :vote_scope => 'rank'
 
 # negative votes
 @post.downvote_from @user2, :vote_scope => 'rank'
-@post.vote :voter => @user2, :vote => 'bad', :vote_scope => 'rank'
+@post.vote_by :voter => @user2, :vote => 'bad', :vote_scope => 'rank'
 
 # tally them up!
-@post.find_votes(:vote_scope => 'rank').size # => 5
-@post.likes(:vote_scope => 'rank').size # => 3
-@post.upvotes(:vote_scope => 'rank').size # => 3
-@post.dislikes(:vote_scope => 'rank').size # => 2
-@post.downvotes(:vote_scope => 'rank').size # => 2
+@post.find_votes_for(:vote_scope => 'rank').size # => 5
+@post.get_likes(:vote_scope => 'rank').size # => 3
+@post.get_upvotes(:vote_scope => 'rank').size # => 3
+@post.get_dislikes(:vote_scope => 'rank').size # => 2
+@post.get_downvotes(:vote_scope => 'rank').size # => 2
 
 # votable model can be voted under different scopes
 # by the same user
-@post.vote :voter => @user1, :vote_scope => 'week'
-@post.vote :voter => @user1, :vote_scope => 'month'
+@post.vote_by :voter => @user1, :vote_scope => 'week'
+@post.vote_by :voter => @user1, :vote_scope => 'month'
 
-@post.votes.size # => 2
-@post.find_votes(:vote_scope => 'week').size # => 1
-@post.find_votes(:vote_scope => 'month').size # => 1
+@post.votes_for.size # => 2
+@post.find_votes_for(:vote_scope => 'week').size # => 1
+@post.find_votes_for(:vote_scope => 'month').size # => 1
 ```
 ### Adding weights to your votes
 
@@ -165,19 +172,19 @@ 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
+@post.vote_by :voter => @user3, :vote_weight => 2
+@post.vote_by :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
+@post.vote_by :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
+@post.find_votes_for(:vote_scope => 'rank').sum(:vote_weight) # => 6
+@post.get_likes(:vote_scope => 'rank').sum(:vote_weight) # => 6
+@post.get_upvotes(:vote_scope => 'rank').sum(:vote_weight) # => 6
+@post.get_dislikes(:vote_scope => 'rank').sum(:vote_weight) # => 4
+@post.get_downvotes(:vote_scope => 'rank').sum(:vote_weight) # => 4
 ```
 
 ### The Voter
@@ -292,7 +299,7 @@ To permit duplicates entries of a same voter, use option duplicate. Also notice
 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
+@hat.vote_by voter: @user, :duplicate => true
 ```
 
 ## Caching
@@ -338,6 +345,23 @@ They can be run with:
 rake spec
 ```
 
+## Changes  
+
+### Fixes for votable voter model  
+
+In version 0.8.0, there is bugs for a model that is both votable and voter.  
+Some name-conflicting methods are renamed:
++ Renamed Votable.votes to votes_for  
++ Renamed Votable.vote to vote_by,
++ Removed Votable.vote_by alias (was an alias for :vote_up)
++ Renamed Votable.unvote_for to unvote_by
++ Renamed Votable.find_votes to find_votes_for
++ Renamed Votable.up_votes to get_upvotes 
+  + and its aliases :get_true_votes, :get_ups, :get_upvotes, :get_likes, :get_positives, :get_for_votes
++ Renamed Votable.down_votes to get_downvotes 
+  + and its aliases :get_false_votes, :get_downs, :get_downvotes, :get_dislikes, :get_negatives
+
+
 ## License
 
 Acts as votable is released under the [MIT
@@ -352,7 +376,6 @@ License](http://www.opensource.org/licenses/MIT).
 that the user likes, while `@user.likes @model` will cast a vote for @model by
 @user.
 
-- Need to test a model that is votable as well as a voter
 
 - The aliased methods are referred to by using the terms 'up/down' and/or
 'true/false'.  Need to come up with guidelines for naming these methods.

data/lib/acts_as_votable/version.rb

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

data/lib/acts_as_votable/votable.rb

@@ -11,7 +11,7 @@ module ActsAsVotable
       aliases = {
 
         :vote_up => [
-          :up_by, :upvote_by, :like_by, :liked_by, :vote_by,
+          :up_by, :upvote_by, :like_by, :liked_by, 
           :up_from, :upvote_from, :upvote_by, :like_from, :liked_from, :vote_from
         ],
 
@@ -20,20 +20,20 @@ module ActsAsVotable
           :down_from, :downvote_from, :downvote_by, :dislike_by, :disliked_by
         ],
 
-        :up_votes => [
-          :true_votes, :ups, :upvotes, :likes, :positives, :for_votes,
+        :get_up_votes => [
+          :get_true_votes, :get_ups, :get_upvotes, :get_likes, :get_positives, :get_for_votes,
         ],
 
-        :down_votes => [
-          :false_votes, :downs, :downvotes, :dislikes, :negatives
+        :get_down_votes => [
+          :get_false_votes, :get_downs, :get_downvotes, :get_dislikes, :get_negatives
         ],
-        :unvote_for => [
+        :unvote_by => [
           :unvote_up, :unvote_down, :unliked_by, :undisliked_by
         ]
       }
 
       base.class_eval do
-        has_many :votes, :class_name => 'ActsAsVotable::Vote', :as => :votable, :dependent => :destroy do
+        has_many :votes_for, :class_name => 'ActsAsVotable::Vote', :as => :votable, :dependent => :destroy do
           def voters
             includes(:voter).map(&:voter)
           end
@@ -62,7 +62,7 @@ module ActsAsVotable
     end
 
     # voting
-    def vote args = {}
+    def vote_by args = {}
 
       options = {
         :vote => true,
@@ -76,7 +76,7 @@ module ActsAsVotable
       end
 
       # find the vote
-      _votes_ = find_votes({
+      _votes_ = find_votes_for({
         :voter_id => options[:voter].id,
         :vote_scope => options[:vote_scope],
         :voter_type => options[:voter].class.name
@@ -89,8 +89,6 @@ module ActsAsVotable
           :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_.last
@@ -100,6 +98,9 @@ module ActsAsVotable
 
       vote.vote_flag = votable_words.meaning_of(options[:vote])
 
+      #Allowing for a vote_weight to be associated with every vote. Could change with every voter object
+      vote.vote_weight = (options[:vote_weight].to_i if options[:vote_weight].present?) || 1
+
       if vote.save
         self.vote_registered = true if last_update != vote.updated_at
         update_cached_votes options[:vote_scope]
@@ -113,25 +114,25 @@ module ActsAsVotable
 
     def unvote args = {}
       return false if args[:voter].nil?
-      _votes_ = find_votes(:voter_id => args[:voter].id, :vote_scope => args[:vote_scope], :voter_type => args[:voter].class.name)
+      _votes_ = find_votes_for(:voter_id => args[:voter].id, :vote_scope => args[:vote_scope], :voter_type => args[:voter].class.name)
 
       return true if _votes_.size == 0
       _votes_.each(&:destroy)
       update_cached_votes args[:vote_scope]
-      self.vote_registered = false if votes.count == 0
+      self.vote_registered = false if votes_for.count == 0
       return true
     end
 
     def vote_up voter, options={}
-      self.vote :voter => voter, :vote => true, :vote_scope => options[:vote_scope], :vote_weight => options[:vote_weight]
+      self.vote_by :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], :vote_weight => options[:vote_weight]
+      self.vote_by :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] #Does not need vote_weight since the votes are anyway getting destroyed
+    def unvote_by  voter, options = {}
+      self.unvote :voter => voter, :vote_scope => options[:vote_scope] #Does not need vote_weight since the votes_for are anyway getting destroyed
     end
 
     def scope_cache_field field, vote_scope
@@ -154,7 +155,7 @@ module ActsAsVotable
         "cached_scoped_#{vote_scope}_votes_score="
       when :cached_votes_score
         "cached_scoped_#{vote_scope}_votes_score"
-      when :cached_weighted_scope
+      when :cached_weighted_score
         "cached_weighted_#{vote_scope}_score"
       when :cached_weighted_score=
         "cached_weighted_#{vote_scope}_score="
@@ -224,16 +225,16 @@ module ActsAsVotable
 
 
     # results
-    def find_votes extra_conditions = {}
-      votes.where(extra_conditions)
+    def find_votes_for extra_conditions = {}
+      votes_for.where(extra_conditions)
     end
 
-    def up_votes options={}
-      find_votes(:vote_flag => true, :vote_scope => options[:vote_scope])
+    def get_up_votes options={}
+      find_votes_for(:vote_flag => true, :vote_scope => options[:vote_scope])
     end
 
-    def down_votes options={}
-      find_votes(:vote_flag => false, :vote_scope => options[:vote_scope])
+    def get_down_votes options={}
+      find_votes_for(:vote_flag => false, :vote_scope => options[:vote_scope])
     end
 
 
@@ -242,35 +243,35 @@ module ActsAsVotable
       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
+      find_votes_for(: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
-      up_votes(:vote_scope => vote_scope).count
+      get_up_votes(:vote_scope => vote_scope).count
     end
 
     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
-      down_votes(:vote_scope => vote_scope).count
+      get_down_votes(:vote_scope => vote_scope).count
     end
 
     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
-      ups = up_votes(:vote_scope => vote_scope).sum(:vote_weight)
-      downs = down_votes(:vote_scope => vote_scope).sum(:vote_weight)
+      ups = get_up_votes(:vote_scope => vote_scope).sum(:vote_weight)
+      downs = get_down_votes(:vote_scope => vote_scope).sum(:vote_weight)
       ups - downs
     end
 
     # voters
     def voted_on_by? voter
-      votes = find_votes :voter_id => voter.id, :voter_type => voter.class.name
+      votes = find_votes_for :voter_id => voter.id, :voter_type => voter.class.name
       votes.count > 0
     end
 

data/lib/acts_as_votable/voter.rb

@@ -36,7 +36,7 @@ module ActsAsVotable
 
     # voting
     def vote args
-      args[:votable].vote args.merge({:voter => self})
+      args[:votable].vote_by args.merge({:voter => self})
     end
 
     def vote_up_for model=nil, args={}
@@ -47,8 +47,8 @@ module ActsAsVotable
       vote :votable => model, :vote_scope => args[:vote_scope], :vote => false
     end
 
-    def unvote_for model
-      model.unvote :voter => self
+    def unvote_for model, args={}
+      model.unvote :voter => self, :vote_scope => args[:vote_scope]
     end
 
     # results
@@ -120,15 +120,15 @@ module ActsAsVotable
     end
 
     def get_voted klass, extra_conditions = {}
-      klass.joins(:votes).merge find_votes(extra_conditions)
+      klass.joins(:votes_for).merge find_votes(extra_conditions)
     end
 
     def get_up_voted klass
-      klass.joins(:votes).merge find_up_votes
+      klass.joins(:votes_for).merge find_up_votes
     end
 
     def get_down_voted klass
-      klass.joins(:votes).merge find_down_votes
+      klass.joins(:votes_for).merge find_down_votes
     end
   end
 end