acts_as_votable 0.10.0 → 0.11.0

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_attributes 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_attributes
+          }.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

data/lib/acts_as_votable/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActsAsVotable
-  VERSION = "0.10.0"
+  VERSION = "0.11.0"
 end

data/lib/acts_as_votable/votable.rb

@@ -1,39 +1,41 @@
-require 'acts_as_votable/helpers/words'
+# frozen_string_literal: true
+
+require "acts_as_votable/helpers/words"
+require "acts_as_votable/cacheable"
 
 module ActsAsVotable
   module Votable
-
     include Helpers::Words
+    include Cacheable
 
-    def self.included base
-
+    def self.included(base)
       # allow the user to define these himself
       aliases = {
 
-        :vote_up => [
-          :up_by, :upvote_by, :like_by, :liked_by, 
+        vote_up: [
+          :up_by, :upvote_by, :like_by, :liked_by,
           :up_from, :upvote_from, :upvote_by, :like_from, :liked_from, :vote_from
         ],
 
-        :vote_down => [
+        vote_down: [
           :down_by, :downvote_by, :dislike_by, :disliked_by,
           :down_from, :downvote_from, :downvote_by, :dislike_by, :disliked_by
         ],
 
-        :get_up_votes => [
+        get_up_votes: [
           :get_true_votes, :get_ups, :get_upvotes, :get_likes, :get_positives, :get_for_votes,
         ],
 
-        :get_down_votes => [
+        get_down_votes: [
           :get_false_votes, :get_downs, :get_downvotes, :get_dislikes, :get_negatives
         ],
-        :unvote_by => [
+        unvote_by: [
           :unvote_up, :unvote_down, :unliked_by, :undisliked_by
         ]
       }
 
       base.class_eval do
-        has_many :votes_for, :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
@@ -56,17 +58,16 @@ module ActsAsVotable
 
     def default_conditions
       {
-        :votable_id => self.id,
-        :votable_type => self.class.base_class.name.to_s
+        votable_id: self.id,
+        votable_type: self.class.base_class.name.to_s
       }
     end
 
     # voting
-    def vote_by args = {}
-
+    def vote_by(args = {})
       options = {
-        :vote => true,
-        :vote_scope => nil
+        vote: true,
+        vote_scope: nil
       }.merge(args)
 
       self.vote_registered = false
@@ -76,22 +77,20 @@ module ActsAsVotable
       end
 
       # find the vote
-      _votes_ = find_votes_for({
-        :voter_id => options[:voter].id,
-        :vote_scope => options[:vote_scope],
-        :voter_type => options[:voter].class.base_class.name
-      })
+      votes = find_votes_for(voter_id: options[:voter].id,
+        vote_scope: options[:vote_scope],
+        voter_type: options[:voter].class.base_class.name)
 
-      if _votes_.count == 0 or options[:duplicate]
+      if votes.count == (0) || options[:duplicate]
         # this voter has never voted
         vote = ActsAsVotable::Vote.new(
-          :votable => self,
-          :voter => options[:voter],
-          :vote_scope => options[:vote_scope]
+          votable: self,
+          voter: options[:voter],
+          vote_scope: options[:vote_scope]
         )
       else
         # this voter is potentially changing his vote
-        vote = _votes_.last
+        vote = votes.last
       end
 
       last_update = vote.updated_at
@@ -109,192 +108,56 @@ module ActsAsVotable
         self.vote_registered = false
         return false
       end
-
     end
 
-    def unvote args = {}
+    def unvote(args = {})
       return false if args[:voter].nil?
-      _votes_ = find_votes_for(:voter_id => args[:voter].id, :vote_scope => args[:vote_scope], :voter_type => args[:voter].class.base_class.name)
+      votes = find_votes_for(voter_id: args[:voter].id, vote_scope: args[:vote_scope], voter_type: args[:voter].class.base_class.name)
 
-      return true if _votes_.size == 0
-      _votes_.each(&:destroy)
+      return true if votes.size == 0
+      votes.each(&:destroy)
       update_cached_votes args[:vote_scope]
       self.vote_registered = false if votes_for.count == 0
       return true
     end
 
-    def vote_up voter, options={}
-      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_by :voter => voter, :vote => false, :vote_scope => options[:vote_scope], :vote_weight => options[:vote_weight]
+    def vote_up(voter, options = {})
+      self.vote_by voter: voter, vote: true, vote_scope: options[:vote_scope], vote_weight: options[:vote_weight]
     end
 
-    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
+    def vote_down(voter, options = {})
+      self.vote_by voter: voter, vote: false, vote_scope: options[:vote_scope], vote_weight: options[:vote_weight]
     end
 
-    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="
-      end
-    end
-
-    # caching
-    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 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
-      end
-
-      if (::ActiveRecord::VERSION::MAJOR == 3) && (::ActiveRecord::VERSION::MINOR != 0)
-        self.update_attributes(updates, :without_protection => true) if updates.size > 0
-      else
-        self.update_attributes(updates) if updates.size > 0
-      end
-
+    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
 
-
     # results
-    def find_votes_for extra_conditions = {}
+    def find_votes_for(extra_conditions = {})
       votes_for.where(extra_conditions)
     end
 
-    def get_up_votes options={}
-      find_votes_for(:vote_flag => true, :vote_scope => options[:vote_scope])
-    end
-
-    def get_down_votes options={}
-      find_votes_for(:vote_flag => false, :vote_scope => options[:vote_scope])
-    end
-
-
-    # counting
-    def count_votes_total skip_cache = false, vote_scope = nil
-      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_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
-      get_up_votes(:vote_scope => vote_scope).count
+    def get_up_votes(options = {})
+      vote_scope_hash = scope_or_empty_hash(options[:vote_scope])
+      find_votes_for({ vote_flag: true }.merge(vote_scope_hash))
     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
-      get_down_votes(:vote_scope => vote_scope).count
-    end
-
-    def weighted_total skip_cache = false, vote_scope = nil
-      if !skip_cache && self.respond_to?(scope_cache_field :cached_weighted_total, vote_scope)
-        return self.send(scope_cache_field :cached_weighted_total, vote_scope)
-      end
-      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
-
-    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 = get_up_votes(:vote_scope => vote_scope).sum(:vote_weight)
-      downs = get_down_votes(:vote_scope => vote_scope).sum(:vote_weight)
-      ups - downs
+    def get_down_votes(options = {})
+      vote_scope_hash = scope_or_empty_hash(options[:vote_scope])
+      find_votes_for({ vote_flag: false }.merge(vote_scope_hash))
     end
 
     # voters
-    def voted_on_by? voter
-      votes = find_votes_for :voter_id => voter.id, :voter_type => voter.class.base_class.name
+    def voted_on_by?(voter)
+      votes = find_votes_for voter_id: voter.id, voter_type: voter.class.base_class.name
       votes.count > 0
     end
 
+    private
+
+    def scope_or_empty_hash(vote_scope)
+      vote_scope ? { vote_scope: vote_scope } : {}
+    end
   end
 end