acts_as_votable 0.10.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c2beddd83fe6f3062fdfb1599953b34d942f6ac8
-  data.tar.gz: 8bfb3b0bb95722935fb3eb315da58c619f583921
+SHA256:
+  metadata.gz: b1843c2e0892abc19c5ecc63dd48e38fe8d48e1cdb7affc3c90d67b0419725e1
+  data.tar.gz: b05a72a3a7310c362233e9d54301a695a03fb72c9fb6068b2fde8e58d1e238bb
 SHA512:
-  metadata.gz: cbe9cba192df3d698531c14a10f8340b78642cd51288b582b064384ea48931345900c74a499598b541ca2662230d262be6acc0f26d2db9a3763539140ec08683
-  data.tar.gz: 03948b37befab6d39cd621b63d6e32cb2404b4850f2d5b2e2bece1674bcbaa13bcc4aff7e023f30aeff3330c809fdf9eb28b7d28d5ae6d6685c287c5167a90c1
+  metadata.gz: a125832f11dd75fa540f90791b5bdc092b92ade7c2a34218947fa1621aae21487eb38d8664636d1113885bb878927805a10f0db5edb786c48a8339832859bd68
+  data.tar.gz: 23bb31cc323d1173f982b2d12895b834e26b1ede7a6293cc1343538140f2fe3f7f9c0c89daf4de4ea67d72a69b4b4bbca2c4ec53555500ec965f26ca8fb1f475

data/.github/workflows/main.yml

@@ -0,0 +1,44 @@
+name: CI
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+    branches:
+    - master
+
+jobs:
+  tests:
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu
+        ruby:
+          - 2.5
+          - 2.6
+          - 2.7
+        gemfile:
+          - gemfiles/rails_5_1.gemfile
+          - gemfiles/rails_5_2.gemfile
+          - gemfiles/rails_6.gemfile
+          - gemfiles/rails_6_1.gemfile
+        continue-on-error:
+          - false
+
+    env:
+      BUNDLE_GEMFILE: "${{ matrix.gemfile }}"
+    runs-on: ${{ matrix.os }}-latest
+    continue-on-error: ${{ matrix.continue-on-error }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Test
+        run: bundle exec rake spec
+
+# use this

data/.gitignore

@@ -1,6 +1,10 @@
-pkg/*
-*.gem
-.bundle
-nbproject/*
-Gemfile.lock
-bin
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/gemfiles/*.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/.ruby-version

@@ -0,0 +1 @@
+2.5.3

data/Appraisals

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+appraise "rails-4" do
+  gem "rails", "4.2.11"
+end
+
+appraise "rails-5-1" do
+  gem "rails", "5.1.7"
+end
+
+appraise "rails-5-2" do
+  gem "rails", "5.2.4"
+end
+
+appraise "rails-6" do
+  gem "rails", "6.0.3"
+  gem "sqlite3", "~> 1.4"
+end
+
+appraise "rails-6-1" do
+  gem "rails", "6.1.0"
+  gem "sqlite3", "~> 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 → README.md}

@@ -1,6 +1,6 @@
 # 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)
+![Build status](https://github.com/ryanto/acts_as_votable/workflows/CI/badge.svg)
 
 Acts As Votable is a Ruby Gem specifically written for Rails/ActiveRecord models.
 The main goals of this gem are:
@@ -15,17 +15,15 @@ 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
-* Rails 4.0, 4.1+
+* Ruby >= 2.3.0
+* Rails >= 4
 
 ### 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'
+gem 'acts_as_votable'
 ```
 
 And follow that up with a ``bundle install``.
@@ -36,7 +34,7 @@ Acts As Votable uses a votes table to store all voting information.  To
 generate and run the migration just use.
 
     rails generate acts_as_votable:migration
-    rake db:migrate
+    rails db:migrate
 
 You will get a performance increase by adding in cached columns to your model's
 tables.  You will have to do this manually through your own migrations.  See the
@@ -47,7 +45,7 @@ caching section of this document for more information.
 ### Votable Models
 
 ```ruby
-class Post < ActiveRecord::Base
+class Post < ApplicationRecord
   acts_as_votable
 end
 
@@ -96,10 +94,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 +109,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 +137,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
@@ -192,15 +192,15 @@ You can add weight to your vote. The default value is 1.
 You can have your voters `acts_as_voter` to provide some reserve functionality.
 
 ```ruby
-class User < ActiveRecord::Base
+class User < ApplicationRecord
   acts_as_voter
 end
 
 @user.likes @article
 
-@article.votes.size # => 1
-@article.likes.size # => 1
-@article.dislikes.size # => 0
+@article.votes_for.size # => 1
+@article.get_likes.size # => 1
+@article.get_dislikes.size # => 0
 ```
 
 To check if a voter has voted on a model, you can use ``voted_for?``.  You can
@@ -215,9 +215,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.
@@ -273,8 +273,8 @@ because `@user` has already voted for `@shoe`.
 @user.likes @shoe
 @user.likes @shoe
 
-@shoe.votes # => 1
-@shoe.likes # => 1
+@shoe.votes_for.size # => 1
+@shoe.get_likes.size # => 1
 ```
 
 To check if a vote counted, or registered, use `vote_registered?` on your model
@@ -290,9 +290,9 @@ after voting.  For example:
 @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_for.size # => 1
+@hat.get_positives.size # => 0
+@hat.get_negatives.size # => 1
 ```
 
 To permit duplicates entries of a same voter, use option duplicate. Also notice that this
@@ -310,35 +310,71 @@ to speed up @post we would use the following migration:
 
 ```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_column :posts, :cached_weighted_total, :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
-    add_index  :posts, :cached_weighted_total
+  def change
+    change_table :posts do |t|
+      t.integer :cached_votes_total, default: 0
+      t.integer :cached_votes_score, default: 0
+      t.integer :cached_votes_up, default: 0
+      t.integer :cached_votes_down, default: 0
+      t.integer :cached_weighted_score, default: 0
+      t.integer :cached_weighted_total, default: 0
+      t.float :cached_weighted_average, default: 0.0
+    end
 
     # Uncomment this line to force caching of existing votes
     # Post.find_each(&:update_cached_votes)
   end
+end
+```
+
+If you have a scope for your vote, let's say `subscribe`, your migration will be slightly different like below:
 
-  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
-    remove_column :posts, :cached_weighted_total
+```ruby
+class AddCachedVotesToPosts < ActiveRecord::Migration
+  def change
+    change_table :posts do |t|
+      t.integer :cached_scoped_subscribe_votes_total, default: 0
+      t.integer :cached_scoped_subscribe_votes_score, default: 0
+      t.integer :cached_scoped_subscribe_votes_up, default: 0
+      t.integer :cached_scoped_subscribe_votes_down, default: 0
+      t.integer :cached_weighted_subscribe_score, default: 0
+      t.integer :cached_weighted_subscribe_total, default: 0
+      t.float :cached_weighted_subscribe_average, default: 0.0
+    end
   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` strategy is used. Pass `:update_columns` as
+`cacheable_strategy` if you don't want to touch model's `updated_at` column.
+```ruby
+class Post < ApplicationRecord
+  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.
@@ -348,20 +384,20 @@ They can be run with:
 rake spec
 ```
 
-## Changes  
+## Changes
 
-### Fixes for votable voter model  
+### 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.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 
++ 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 
++ Renamed Votable.down_votes to get_downvotes
   + and its aliases :get_false_votes, :get_downs, :get_downvotes, :get_dislikes, :get_negatives
 
 
@@ -370,7 +406,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 +415,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.