acts_as_votable 0.5.0 → 0.9.0

checksums.yaml

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

data/.gitignore

@@ -2,4 +2,5 @@ pkg/*
 *.gem
 .bundle
 nbproject/*
+Gemfile.lock
 bin

data/.travis.yml

@@ -0,0 +1,25 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 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"
+    - 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/Gemfile

@@ -1,4 +1,17 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in acts_as_votable.gemspec
 gemspec
+
+rails_version = ENV['RAILS_VERSION'] || 'default'
+
+rails = case rails_version
+when 'master'
+  { :github => 'rails/rails'}
+when 'default'
+  '~> 3.2.0'
+else
+  "~> #{rails_version}"
+end
+
+gem 'rails', rails

data/README.markdown

@@ -1,5 +1,7 @@
 # Acts As Votable (aka Acts As Likeable)
 
+[![Build Status](https://travis-ci.org/ryanto/acts_as_votable.png)](https://travis-ci.org/ryanto/acts_as_votable)
+
 Acts As Votable is a Ruby Gem specifically written for Rails/ActiveRecord models.
 The main goals of this gem are:
 
@@ -11,11 +13,20 @@ The main goals of this gem are:
 
 ## Installation
 
-### Rails 3+
+### 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.
 
-    gem 'acts_as_votable', '~> 0.5.0'
+```ruby
+gem 'acts_as_votable', '~> 0.9.0'
+```
 
 And follow that up with a ``bundle install``.
 
@@ -35,81 +46,92 @@ caching section of this document for more information.
 
 ### Votable Models
 
-    class Post < ActiveRecord::Base
-      acts_as_votable
-    end
+```ruby
+class Post < ActiveRecord::Base
+  acts_as_votable
+end
 
-    @post = Post.new(:name => 'my post!')
-    @post.save
+@post = Post.new(:name => 'my post!')
+@post.save
 
-    @post.liked_by @user
-    @post.votes.size # => 1
+@post.liked_by @user
+@post.votes_for.size # => 1
+```
 
 ### Like/Dislike Yes/No Up/Down
 
 Here are some voting examples.  All of these calls are valid and acceptable.  The
 more natural calls are the first few examples.
 
-    @post.liked_by @user1
-    @post.downvote_from @user2
-    @post.vote :voter => @user3
-    @post.vote :voter => @user4, :vote => 'bad'
-    @post.vote :voter => @user5, :vote => 'like'
+```ruby
+@post.liked_by @user1
+@post.downvote_from @user2
+@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`.
 
-By default all votes are positive, so @user3 has cast a 'good' vote for @post.
+`@user1`, `@user3`, and `@user5` all voted in favor of `@post`.
 
-@user1, @user3, and @user5 all voted in favor of @post.
-
-@user2 and @user4 on the other had has voted against @post.
+`@user2` and `@user4` on the other had has voted against `@post`.
 
 
 Just about any word works for casting a vote in favor or against post.  Up/Down,
-Like/Dislike, Positive/Negative... the list goes on-and-on.  Boolean flags ``true`` and
-``false`` are also applicable.
+Like/Dislike, Positive/Negative... the list goes on-and-on.  Boolean flags `true` and
+`false` are also applicable.
 
 Revisiting the previous example of code.
 
-    # positive votes
-    @post.liked_by @user1
-    @post.vote :voter => @user3
-    @post.vote :voter => @user5, :vote => 'like'
+```ruby
+# positive votes
+@post.liked_by @user1
+@post.vote_by :voter => @user3
+@post.vote_by :voter => @user5, :vote => 'like'
 
-    # negative votes
-    @post.downvote_from @user2
-    @post.vote :voter => @user2, :vote => 'bad'
+# negative votes
+@post.downvote_from @user2
+@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
+# tally them up!
+@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.
 
-    @post.votes.up.by_type(User)
-    @post.votes.down
-    @user1.votes.up
-    @user1.votes.down
-    @user1.votes.up.by_type(Post)
+```ruby
+@post.votes_for.up.by_type(User)
+@post.votes_for.down
+@user1.votes.up
+@user1.votes.down
+@user1.votes.up.by_type(Post)
+```
 
 Once scoping is complete, you can also trigger a get for the
 voter/votable
 
-    @post.votes.up.by_type(User).voters
-    @post.votes.down.by_type(User).voters
+```ruby
+@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
+@user.votes.up.for_type(Post).votables
+@user.votes.up.votables
+```
 
 You can also 'unvote' a model to remove a previous vote.
 
-    @post.liked_by @user1
-    @post.unliked_by @user1
+```ruby
+@post.liked_by @user1
+@post.unliked_by @user1
 
-    @post.disliked_by @user1
-    @post.undisliked_by @user1
+@post.disliked_by @user1
+@post.undisliked_by @user1
+```
 
 Unvoting works for both positive and negative votes.
 
@@ -117,124 +139,168 @@ Unvoting works for both positive and negative votes.
 
 You can add an scope to your vote
 
-    # 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'
-
-    # negative votes
-    @post.downvote_from @user2, :vote_scope => 'rank'
-    @post.vote :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
-
-    # 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.votes.size # => 2
-    @post.find_votes(:vote_scope => 'week').size # => 1
-    @post.find_votes(:vote_scope => 'month').size # => 1
+```ruby
+# positive votes
+@post.liked_by @user1, :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_by :voter => @user2, :vote => 'bad', :vote_scope => 'rank'
+
+# tally them up!
+@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_by :voter => @user1, :vote_scope => 'week'
+@post.vote_by :voter => @user1, :vote_scope => 'month'
+
+@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
+
+You can add weight to your vote. The default value is 1.
+
+```ruby
+# positive votes
+@post.liked_by @user1, :vote_weight => 1
+@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_by :voter => @user2, :vote => 'bad', :vote_scope => 'rank', :vote_weight => 3
+
+# tally them up!
+@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
 
-You can have your voters ``acts_as_voter`` to provide some reserve functionality.
+You can have your voters `acts_as_voter` to provide some reserve functionality.
 
-    class User < ActiveRecord::Base
-      acts_as_voter
-    end
+```ruby
+class User < ActiveRecord::Base
+  acts_as_voter
+end
 
-    @user.likes @article
+@user.likes @article
 
-    @article.votes.size # => 1
-    @article.likes.size # => 1
-    @article.dislikes.size # => 0
+@article.votes.size # => 1
+@article.likes.size # => 1
+@article.dislikes.size # => 0
+```
 
 To check if a voter has voted on a model, you can use ``voted_for?``.  You can
 check how the voter voted by using ``voted_as_when_voted_for``.
 
-    @user.likes @comment1
-    @user.up_votes @comment2
-    # user has not voted on @comment3
+```ruby
+@user.likes @comment1
+@user.up_votes @comment2
+# user has not voted on @comment3
 
-    @user.voted_for? @comment1 # => true
-    @user.voted_for? @comment2 # => true
-    @user.voted_for? @comment3 # => false
+@user.voted_for? @comment1 # => true
+@user.voted_for? @comment2 # => true
+@user.voted_for? @comment3 # => false
 
-    @user.voted_as_when_voted_for @comment1 # => true, he liked it
-    @user.voted_as_when_voted_for @comment2 # => false, he didnt like it
-    @user.voted_as_when_voted_for @comment3 # => nil, he has yet to vote
+@user.voted_as_when_voted_for @comment1 # => true, he liked it
+@user.voted_as_when_voted_for @comment2 # => false, he didnt like it
+@user.voted_as_when_voted_for @comment3 # => nil, he has yet to vote
+```
 
 You can also check whether the voter has voted up or down.
 
-    @user.likes @comment1
-    @user.dislikes @comment2
-    # user has not voted on @comment3
+```ruby
+@user.likes @comment1
+@user.dislikes @comment2
+# user has not voted on @comment3
 
-    @user.voted_up_on? @comment1 # => true
-    @user.voted_down_on? @comment1 # => false
+@user.voted_up_on? @comment1 # => true
+@user.voted_down_on? @comment1 # => false
 
-    @user.voted_down_on? @comment2 # => true
-    @user.voted_up_on? @comment2 # => false
+@user.voted_down_on? @comment2 # => true
+@user.voted_up_on? @comment2 # => false
 
-    @user.voted_up_on? @comment3 # => false
-    @user.voted_down_on? @comment3 # => false
+@user.voted_up_on? @comment3 # => false
+@user.voted_down_on? @comment3 # => false
+```
 
-Aliases for methods ``voted_up_on?`` and ``voted_down_on?`` are: ``voted_up_for?``, ``voted_down_for?``, ``liked?`` and ``disliked?``.
+Aliases for methods `voted_up_on?` and `voted_down_on?` are: `voted_up_for?`, `voted_down_for?`, `liked?` and `disliked?`.
 
 Also, you can obtain a list of all the objects a user has voted for.
 This returns the actual objects instead of instances of the Vote model.
 All objects are eager loaded
 
-    @user.find_voted_items
+```ruby
+@user.find_voted_items
 
-    @user.find_up_voted_items
-    @user.find_liked_items
+@user.find_up_voted_items
+@user.find_liked_items
 
-    @user.find_down_voted_items
-    @user.find_disliked_items
+@user.find_down_voted_items
+@user.find_disliked_items
+```
 
 Members of an individual model that a user has voted for can also be
 displayed. The result is an ActiveRecord Relation.
 
-    @user.get_voted Comment
+```ruby
+@user.get_voted Comment
 
-    @user.get_up_voted Comment
+@user.get_up_voted Comment
 
-    @user.get_down_voted Comment
+@user.get_down_voted Comment
+```
 
 ### Registered Votes
 
 Voters can only vote once per model.  In this example the 2nd vote does not count
-because @user has already voted for @shoe.
+because `@user` has already voted for `@shoe`.
 
-    @user.likes @shoe
-    @user.likes @shoe
+```ruby
+@user.likes @shoe
+@user.likes @shoe
 
-    @shoe.votes # => 1
-    @shoe.likes # => 1
+@shoe.votes # => 1
+@shoe.likes # => 1
+```
 
-To check if a vote counted, or registered, use vote_registered? on your model
+To check if a vote counted, or registered, use `vote_registered?` on your model
 after voting.  For example:
 
-    @hat.liked_by @user
-    @hat.vote_registered? # => true
+```ruby
+@hat.liked_by @user
+@hat.vote_registered? # => true
+
+@hat.liked_by => @user
+@hat.vote_registered? # => false, because @user has already voted this way
 
-    @hat.liked_by => @user
-    @hat.vote_registered? # => false, because @user has already voted this way
+@hat.disliked_by @user
+@hat.vote_registered? # => true, because user changed their vote
 
-    @hat.disliked_by @user
-    @hat.vote_registered? # => true, because user changed their vote
+@hat.votes.size # => 1
+@hat.positives.size # => 0
+@hat.negatives.size # => 1
+```
 
-    @hat.votes.size # => 1
-    @hat.positives.size # => 0
-    @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_by voter: @user, :duplicate => true
+```
 
 ## Caching
 
@@ -242,40 +308,74 @@ To speed up perform you can add cache columns to your votable model's table.  Th
 columns will automatically be updated after each vote.  For example, if we wanted
 to speed up @post we would use the following migration:
 
-    class AddCachedVotesToPosts < ActiveRecord::Migration
-      def self.up
-        add_column :posts, :cached_votes_total, :integer, :default => 0
-        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_index  :posts, :cached_votes_total
-        add_index  :posts, :cached_votes_score
-        add_index  :posts, :cached_votes_up
-        add_index  :posts, :cached_votes_down
-      end
-
-      def self.down
-        remove_column :posts, :cached_votes_total
-        remove_column :posts, :cached_votes_score
-        remove_column :posts, :cached_votes_up
-        remove_column :posts, :cached_votes_down
-      end
-    end
+```ruby
+class AddCachedVotesToPosts < ActiveRecord::Migration
+  def self.up
+    add_column :posts, :cached_votes_total, :integer, :default => 0
+    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
+    remove_column :posts, :cached_votes_total
+    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
+```
 
 ## Testing
 
-All tests follow the RSpec format and are located in the spec directory
+All tests follow the RSpec format and are located in the spec directory.
+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
+License](http://www.opensource.org/licenses/MIT).
 
 ## TODO
 
 - Pass in a block of options when creating acts_as.  Allow for things
   like disabling the aliasing
 
-- Smarter language syntax.  Example: ``@user.likes`` will return all of the votables
-that the user likes, while ``@user.likes @model`` will cast a vote for @model by
+- Smarter language syntax.  Example: `@user.likes` will return all of the votables
+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/Rakefile

@@ -1,2 +1,10 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Default: run specs.'
+task :default => :spec

data/acts_as_votable.gemspec

@@ -19,11 +19,6 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-
-
   s.add_development_dependency "rspec"
-  s.add_development_dependency "sqlite3"
-
-  s.add_dependency "rails", '>=3.0.0'
-
+  s.add_development_dependency "sqlite3", '1.3.7'
 end

data/lib/acts_as_votable/extenders/controller.rb

@@ -0,0 +1,19 @@
+module ActsAsVotable
+  module Extenders
+
+    module Controller
+
+      def voter_params(params_object = params[:vote])
+        params_object.permit(:votable_id, :votable_type,
+          :voter_id, :voter_type,
+          :votable, :voter,
+          :vote_flag, :vote_scope)
+      end
+      
+      def votable_params(params_object = params[:vote])
+        params_object.permit(:vote_registered)
+      end
+      
+    end
+  end
+end

data/lib/acts_as_votable/version.rb

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