acts_as_votable 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2beddd83fe6f3062fdfb1599953b34d942f6ac8
-  data.tar.gz: 8bfb3b0bb95722935fb3eb315da58c619f583921
+  metadata.gz: ec62f24bb2a85474f561c476a47007e333dae16f
+  data.tar.gz: ab88ccd51c8d63225b05b7f6443056cd0defe2a5
 SHA512:
-  metadata.gz: cbe9cba192df3d698531c14a10f8340b78642cd51288b582b064384ea48931345900c74a499598b541ca2662230d262be6acc0f26d2db9a3763539140ec08683
-  data.tar.gz: 03948b37befab6d39cd621b63d6e32cb2404b4850f2d5b2e2bece1674bcbaa13bcc4aff7e023f30aeff3330c809fdf9eb28b7d28d5ae6d6685c287c5167a90c1
+  metadata.gz: be0133a6030a9c0d83a6753b82360c100ed998a608f98829fd97bc4cbbf27f61990fb1bbc9eac9b9b46b0d4d7e122556e3fce47eb59eb7bf5d42a71a1f895512
+  data.tar.gz: ec1ee10e398a40bb5b20a568265334194e29ca8b05b75a8e8f8c87076e9d187f72225124704af321ffa3b615853906b51daf96a4837074f97bdda4cbe27a28a2

data/.gitignore

@@ -1,6 +1,9 @@
-pkg/*
-*.gem
-.bundle
-nbproject/*
-Gemfile.lock
-bin
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,121 @@
+AllCops:
+  TargetRubyVersion: 2.2
+  # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
+  # to ignore them, so only the ones explicitly set in this file are enabled.
+  DisabledByDefault: true
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Do not use braces for hash literals when they are the last argument of a
+# method call.
+Style/BracesAroundHashParameters:
+  Enabled: true
+  EnforcedStyle: context_dependent
+
+# Align `when` with `case`.
+Layout/CaseIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+Layout/FirstParameterIndentation:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+    Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+# Detect hard tabs, no hard tabs.
+Layout/Tab:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Layout/TrailingBlankLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+Style/UnneededPercentQ:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Lint/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true

data/.travis.yml

@@ -1,25 +1,14 @@
 language: ruby
+
+cache: bundler
+
 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"
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
+
+gemfile:
+  - gemfiles/rails_4.gemfile
+  - gemfiles/rails_5.gemfile
+  - gemfiles/rails_5_1.gemfile
+

data/Appraisals

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+appraise "rails-4" do
+  gem "rails", "4.2.9"
+end
+
+appraise "rails-5" do
+  gem "rails", "5.0.5"
+end
+
+appraise "rails-5-1" do
+  gem "rails", "5.1.4"
+end

data/Gemfile

@@ -1,17 +1,6 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+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,6 +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)
+[![Code Climate](https://codeclimate.com/github/ryanto/acts_as_votable.png)](https://codeclimate.com/github/ryanto/acts_as_votable)
 
 Acts As Votable is a Ruby Gem specifically written for Rails/ActiveRecord models.
 The main goals of this gem are:
@@ -15,14 +16,13 @@ The main goals of this gem are:
 
 ### 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
+* Ruby 2.2.0, 2.3.0 and 2.4.0
 * Rails 4.0, 4.1+
+* Rails 5.0, 5.1
 
 ### Install
 
-Just add the following to your Gemfile.
+Just add the following to your Gemfile to install the latest release.
 
 ```ruby
 gem 'acts_as_votable', '~> 0.10.0'
@@ -96,10 +96,12 @@ Revisiting the previous example of code.
 
 # tally them up!
 @post.votes_for.size # => 5
+@post.weighted_total => 5
 @post.get_likes.size # => 3
 @post.get_upvotes.size # => 3
 @post.get_dislikes.size # => 2
 @post.get_downvotes.size # => 2
+@post.weighted_score => 1
 ```
 
 Active Record scopes are provided to make life easier.
@@ -109,7 +111,7 @@ Active Record scopes are provided to make life easier.
 @post.votes_for.down
 @user1.votes.up
 @user1.votes.down
-@user1.votes.up.by_type(Post)
+@user1.votes.up.for_type(Post)
 ```
 
 Once scoping is complete, you can also trigger a get for the
@@ -137,7 +139,7 @@ Unvoting works for both positive and negative votes.
 
 ### Examples with scopes
 
-You can add an scope to your vote
+You can add a scope to your vote
 
 ```ruby
 # positive votes
@@ -215,9 +217,9 @@ check how the voter voted by using ``voted_as_when_voted_for``.
 @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, user liked it
+@user.voted_as_when_voted_for @comment2 # => false, user didnt like it
+@user.voted_as_when_voted_for @comment3 # => nil, user has yet to vote
 ```
 
 You can also check whether the voter has voted up or down.
@@ -317,12 +319,14 @@ class AddCachedVotesToPosts < ActiveRecord::Migration
     add_column :posts, :cached_votes_down, :integer, :default => 0
     add_column :posts, :cached_weighted_score, :integer, :default => 0
     add_column :posts, :cached_weighted_total, :integer, :default => 0
+    add_column :posts, :cached_weighted_average, :float, :default => 0.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
     add_index  :posts, :cached_weighted_total
+    add_index  :posts, :cached_weighted_average
 
     # Uncomment this line to force caching of existing votes
     # Post.find_each(&:update_cached_votes)
@@ -335,10 +339,74 @@ class AddCachedVotesToPosts < ActiveRecord::Migration
     remove_column :posts, :cached_votes_down
     remove_column :posts, :cached_weighted_score
     remove_column :posts, :cached_weighted_total
+    remove_column :posts, :cached_weighted_average
   end
 end
 ```
 
+If you have a scope for your vote, let's say `subscribe`, your migration will be slightly different like below:
+
+```ruby
+class AddCachedVotesToPosts < ActiveRecord::Migration
+  def self.up
+    add_column :posts, :cached_scoped_subscribe_votes_total, :integer, :default => 0
+    add_column :posts, :cached_scoped_subscribe_votes_score, :integer, :default => 0
+    add_column :posts, :cached_scoped_subscribe_votes_up, :integer, :default => 0
+    add_column :posts, :cached_scoped_subscribe_votes_down, :integer, :default => 0
+    add_column :posts, :cached_weighted_subscribe_score, :integer, :default => 0
+    add_column :posts, :cached_weighted_subscribe_total, :integer, :default => 0
+    add_column :posts, :cached_weighted_subscribe_average, :float, :default => 0.0
+    add_index  :posts, :cached_scoped_subscribe_votes_total
+    add_index  :posts, :cached_scoped_subscribe_votes_score
+    add_index  :posts, :cached_scoped_subscribe_votes_up
+    add_index  :posts, :cached_scoped_subscribe_votes_down
+    add_index  :posts, :cached_weighted_subscribe_score
+    add_index  :posts, :cached_weighted_subscribe_total
+    add_index  :posts, :cached_weighted_subscribe_average
+  end
+
+  def self.down
+    remove_column :posts, :cached_scoped_subscribe_votes_total
+    remove_column :posts, :cached_scoped_subscribe_votes_score
+    remove_column :posts, :cached_scoped_subscribe_votes_up
+    remove_column :posts, :cached_scoped_subscribe_votes_down
+    remove_column :posts, :cached_weighted_subscribe_score
+    remove_column :posts, :cached_weighted_subscribe_total
+    remove_column :posts, :cached_weighted_subscribe_average
+  end
+end
+```
+
+`cached_weighted_average` can be helpful for a rating system, e.g.: 
+
+Order by average rating:
+
+```ruby
+Post.order(:cached_weighted_average => :desc)
+```
+
+Display average rating:
+
+```erb
+<%= post.weighted_average.round(2) %> / 5
+<!-- 3.5 / 5 -->
+```
+## updated_at at Votable model
+
+You can control whether `updated_at` column of votable model will be touched or
+not by passing `cacheable_strategy` option to `acts_as_votable` method.
+
+By default, `update_attributes` strategy is used. Pass `:update_columns` as
+`cacheable_strategy` if you don't want to touch model's `updated_at` column.
+```ruby
+class Post < ActiveRecord::Base
+  acts_as_votable cacheable_strategy: :update_columns
+end
+```
+
+NOTE: this option does not work for ActiveRecord < 3.1
+
+
 ## Testing
 
 All tests follow the RSpec format and are located in the spec directory.
@@ -352,7 +420,7 @@ rake spec
 
 ### Fixes for votable voter model  
 
-In version 0.8.0, there is bugs for a model that is both votable and voter.  
+In version 0.8.0, there are 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,
@@ -370,7 +438,7 @@ Some name-conflicting methods are renamed:
 Acts as votable is released under the [MIT
 License](http://www.opensource.org/licenses/MIT).
 
-## TODO
+## Next steps
 
 - Pass in a block of options when creating acts_as.  Allow for things
   like disabling the aliasing
@@ -379,8 +447,7 @@ License](http://www.opensource.org/licenses/MIT).
 that the user likes, while `@user.likes @model` will cast a vote for @model by
 @user.
 
-
 - 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.
+'true/false'. Need to come up with guidelines for naming these methods.
 
 - Create more aliases. Specifically for counting votes and finding votes.

data/Rakefile

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

data/acts_as_votable.gemspec

@@ -1,4 +1,6 @@
 # -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
 $:.push File.expand_path("../lib", __FILE__)
 require "acts_as_votable/version"
 
@@ -9,16 +11,21 @@ Gem::Specification.new do |s|
   s.authors     = ["Ryan"]
   s.email       = ["ryanto"]
   s.homepage    = "http://rubygems.org/gems/acts_as_votable"
-  s.summary     = %q{Rails gem to allowing records to be votable}
-  s.description = %q{Rails gem to allowing records to be votable}
+  s.summary     = "Rails gem to allowing records to be votable"
+  s.description = "Rails gem to allowing records to be votable"
+  s.license     = "MIT"
 
   s.rubyforge_project = "acts_as_votable"
 
   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.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", '1.3.7'
+  s.add_development_dependency "rspec", "~> 3.6"
+  s.add_development_dependency "sqlite3", "~> 1.3"
+  s.add_development_dependency "rubocop", "~> 0.49.1"
+  s.add_development_dependency "simplecov", "~> 0.15.0"
+  s.add_development_dependency "appraisal", "~> 2.2"
+  s.add_development_dependency "factory_girl", "~> 4.8"
 end