acts_as_votable 0.10.0 → 0.13.0

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,19 @@ 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.rubyforge_project = "acts_as_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.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.6"
+  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_bot", "~> 4.8"
 end

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/rails_4.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "4.2.11"
+
+gemspec path: "../"

data/gemfiles/rails_5.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "5.0.6"
+
+gemspec path: "../"

data/gemfiles/rails_5_1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "5.1.7"
+
+gemspec path: "../"

data/gemfiles/rails_5_2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "5.2.4"
+
+gemspec path: "../"

data/gemfiles/rails_6.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "6.0.3"
+gem "sqlite3", "~> 1.4"
+
+gemspec path: "../"

data/gemfiles/rails_6_1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "6.1.0"
+gem "sqlite3", "~> 1.4"
+
+gemspec path: "../"

data/gemfiles/rails_6_rc1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "6.0.0.rc1"
+gem "sqlite3", "~> 1.4"
+
+gemspec path: "../"

data/lib/acts_as_votable.rb

@@ -1,21 +1,21 @@
-require 'active_record'
-require 'active_support/inflector'
+# frozen_string_literal: true
+
+require "active_record"
+require "active_support/inflector"
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
 module ActsAsVotable
-
   if defined?(ActiveRecord::Base)
-    require 'acts_as_votable/extenders/votable'
-    require 'acts_as_votable/extenders/voter'
-    require 'acts_as_votable/vote'
+    require "acts_as_votable/extenders/votable"
+    require "acts_as_votable/extenders/voter"
+    require "acts_as_votable/vote"
     ActiveRecord::Base.extend ActsAsVotable::Extenders::Votable
     ActiveRecord::Base.extend ActsAsVotable::Extenders::Voter
   end
-
 end
 
-require 'acts_as_votable/extenders/controller'
+require "acts_as_votable/extenders/controller"
 ActiveSupport.on_load(:action_controller) do
   include ActsAsVotable::Extenders::Controller
-end
+end

data/lib/acts_as_votable/cacheable.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+module ActsAsVotable
+  module Cacheable
+    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_total
+        "cached_weighted_#{vote_scope}_total"
+      when :cached_weighted_total=
+        "cached_weighted_#{vote_scope}_total="
+      when :cached_weighted_score
+        "cached_weighted_#{vote_scope}_score"
+      when :cached_weighted_score=
+        "cached_weighted_#{vote_scope}_score="
+      when :cached_weighted_average
+        "cached_weighted_#{vote_scope}_average"
+      when :cached_weighted_average=
+        "cached_weighted_#{vote_scope}_average="
+      end
+    end
+
+    def update_cached_votes(vote_scope = nil)
+      updates = {}
+
+      if self.respond_to?(:cached_votes_total=)
+        updates[:cached_votes_total] = count_votes_total(true)
+      end
+
+      if self.respond_to?(:cached_votes_up=)
+        updates[:cached_votes_up] = count_votes_up(true)
+      end
+
+      if self.respond_to?(:cached_votes_down=)
+        updates[:cached_votes_down] = count_votes_down(true)
+      end
+
+      if self.respond_to?(:cached_votes_score=)
+        updates[:cached_votes_score] = (
+          (updates[:cached_votes_up] || count_votes_up(true)) -
+          (updates[:cached_votes_down] || count_votes_down(true))
+        )
+      end
+
+      if self.respond_to?(:cached_weighted_total=)
+        updates[:cached_weighted_total] = weighted_total(true)
+      end
+
+      if self.respond_to?(:cached_weighted_score=)
+        updates[:cached_weighted_score] = weighted_score(true)
+      end
+
+      if self.respond_to?(:cached_weighted_average=)
+        updates[:cached_weighted_average] = weighted_average(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_total=, vote_scope)
+          updates[scope_cache_field :cached_weighted_total, vote_scope] = weighted_total(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
+
+        if self.respond_to?(scope_cache_field :cached_weighted_average=, vote_scope)
+          updates[scope_cache_field :cached_weighted_average, vote_scope] = weighted_average(true, vote_scope)
+        end
+      end
+
+      self.send(acts_as_votable_options[:cacheable_strategy], updates) if updates.size > 0
+    end
+
+    # counting
+    def count_votes_total(skip_cache = false, vote_scope = nil)
+      from_cache(skip_cache, :cached_votes_total, vote_scope) do
+        find_votes_for(scope_or_empty_hash(vote_scope)).count
+      end
+    end
+
+    def count_votes_up(skip_cache = false, vote_scope = nil)
+      from_cache(skip_cache, :cached_votes_up, vote_scope) do
+        get_up_votes(vote_scope: vote_scope).count
+      end
+    end
+
+    def count_votes_down(skip_cache = false, vote_scope = nil)
+      from_cache(skip_cache, :cached_votes_down, vote_scope) do
+        get_down_votes(vote_scope: vote_scope).count
+      end
+    end
+
+    def count_votes_score(skip_cache = false, vote_scope = nil)
+      from_cache(skip_cache, :cached_votes_score, vote_scope) do
+        ups = count_votes_up(true, vote_scope)
+        downs = count_votes_down(true, vote_scope)
+        ups - downs
+      end
+    end
+
+    def weighted_total(skip_cache = false, vote_scope = nil)
+      from_cache(skip_cache, :cached_weighted_total, vote_scope) do
+        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
+    end
+
+    def weighted_score(skip_cache = false, vote_scope = nil)
+      from_cache(skip_cache, :cached_weighted_score, vote_scope) do
+        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
+    end
+
+    def weighted_average(skip_cache = false, vote_scope = nil)
+      from_cache(skip_cache, :cached_weighted_average, vote_scope) do
+        count = count_votes_total(skip_cache, vote_scope).to_i
+        if count > 0
+          weighted_score(skip_cache, vote_scope).to_f / count
+        else
+          0.0
+        end
+      end
+    end
+
+    private
+
+    def from_cache(skip_cache, cached_method, vote_scope)
+      if !skip_cache && respond_to?(scope_cache_field(cached_method, vote_scope))
+        send(scope_cache_field(cached_method, vote_scope))
+      else
+        yield
+      end
+    end
+  end
+end

data/lib/acts_as_votable/extenders/controller.rb

@@ -1,19 +1,18 @@
+# frozen_string_literal: true
+
 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/extenders/votable.rb

@@ -1,25 +1,36 @@
+# frozen_string_literal: true
+
 module ActsAsVotable
   module Extenders
-
     module Votable
+      ALLOWED_CACHEABLE_STRATEGIES = %i[update update_columns]
 
       def votable?
         false
       end
 
-      def acts_as_votable
-        require 'acts_as_votable/votable'
+      def acts_as_votable(args = {})
+        require "acts_as_votable/votable"
         include ActsAsVotable::Votable
 
+        if args.key?(:cacheable_strategy) && !ALLOWED_CACHEABLE_STRATEGIES.include?(args[:cacheable_strategy])
+          raise ArgumentError, args[:cacheable_strategy]
+        end
+
+        define_method :acts_as_votable_options do
+          self.class.instance_variable_get("@acts_as_votable_options")
+        end
+
         class_eval do
+          @acts_as_votable_options = {
+            cacheable_strategy: :update
+          }.merge(args)
+
           def self.votable?
             true
           end
         end
-
       end
-
     end
-
   end
 end

data/lib/acts_as_votable/extenders/voter.rb

@@ -1,14 +1,14 @@
+# frozen_string_literal: true
+
 module ActsAsVotable
   module Extenders
-
     module Voter
-
       def voter?
         false
       end
 
-      def acts_as_voter(*args)
-        require 'acts_as_votable/voter'
+      def acts_as_voter(*_args)
+        require "acts_as_votable/voter"
         include ActsAsVotable::Voter
 
         class_eval do
@@ -16,9 +16,7 @@ module ActsAsVotable
             true
           end
         end
-
       end
-
     end
   end
 end

data/lib/acts_as_votable/helpers/words.rb

@@ -1,36 +1,33 @@
-module ActsAsVotable::Helpers
+# frozen_string_literal: true
 
-  # this helper provides methods that help find what words are 
+module ActsAsVotable::Helpers
+  # this helper provides methods that help find what words are
   # up votes and what words are down votes
   #
-  # It can be called 
+  # It can be called
   #
   # votable_object.votable_words.that_mean_true
   #
   module Words
-
     def votable_words
       VotableWords
     end
-
   end
 
   class VotableWords
-
     def self.that_mean_true
-      ['up', 'upvote', 'like', 'liked', 'positive', 'yes', 'good', 'true', 1, true]
+      ["up", "upvote", "like", "liked", "positive", "yes", "good", "agree", "true", 1, true]
     end
 
     def self.that_mean_false
-      ['down', 'downvote', 'dislike', 'disliked', 'negative', 'no', 'bad', 'false', 0, false]
+      ["down", "downvote", "dislike", "disliked", "negative", "no", "bad", "disagree", "false", 0, false]
     end
 
     # check is word is a true or bad vote
     # if the word is unknown, then it counts it as a true/good
     # vote.  this exists to allow all voting to be good by default
-    def self.meaning_of word
+    def self.meaning_of(word)
       !that_mean_false.include?(word)
     end
-
   end
 end