redmine_crm 0.0.8 → 0.0.10

data/lib/redmine_crm/version.rb

@@ -1,3 +1,3 @@
 module RedmineCrm
-  VERSION = "0.0.8"
+  VERSION = "0.0.10"
 end

data/lib/redmine_crm/votable.rb

@@ -0,0 +1,334 @@
+require 'redmine_crm/helpers/vote_helper'
+
+module RedmineCrm
+  module ActsAsVotable
+    module Votable
+
+      include ActsAsVotable::Helpers::Words
+
+      def self.included base
+
+        # allow the user to define these himself
+        aliases = {
+
+          :vote_up => [
+            :up_by, :upvote_by, :like_by, :liked_by,
+            :up_from, :upvote_from, :upvote_by, :like_from, :liked_from, :vote_from
+          ],
+
+          :vote_down => [
+            :down_by, :downvote_by, :dislike_by, :disliked_by,
+            :down_from, :downvote_from, :downvote_by, :dislike_by, :disliked_by
+          ],
+
+          :get_up_votes => [
+            :get_true_votes, :get_ups, :get_upvotes, :get_likes, :get_positives, :get_for_votes,
+          ],
+
+          :get_down_votes => [
+            :get_false_votes, :get_downs, :get_downvotes, :get_dislikes, :get_negatives
+          ],
+          :unvote_by => [
+            :unvote_up, :unvote_down, :unliked_by, :undisliked_by
+          ]
+        }
+
+        base.class_eval do
+          has_many :votes_for, :class_name => 'RedmineCrm::ActsAsVotable::Vote', :as => :votable, :dependent => :destroy do
+            def voters
+              includes(:voter).map(&:voter)
+            end
+          end
+
+          aliases.each do |method, links|
+            links.each do |new_method|
+              alias_method(new_method, method)
+            end
+          end
+
+        end
+      end
+
+      attr_accessor :vote_registered
+
+      def vote_registered?
+        return self.vote_registered
+      end
+
+      def default_conditions
+        {
+          :votable_id => self.id,
+          :votable_type => self.class.base_class.name.to_s
+        }
+      end
+
+      # voting
+      def vote_by args = {}
+
+        options = {
+          :vote => true,
+          :vote_scope => nil
+        }.merge(args)
+
+        self.vote_registered = false
+
+        if options[:voter].nil?
+          return false
+        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
+        })
+
+        if _votes_.count == 0 or options[:duplicate]
+          # this voter has never voted
+          vote = RedmineCrm::ActsAsVotable::Vote.new(
+            :votable => self,
+            :voter => options[:voter],
+            :vote_scope => options[:vote_scope]
+          )
+        else
+          # this voter is potentially changing his vote
+          vote = _votes_.last
+        end
+
+        last_update = vote.updated_at
+
+        vote.vote_flag = votable_words.meaning_of(options[:vote])
+
+        #Allowing for a vote_weight to be associated with every vote. Could change with every voter object
+        vote.vote_weight = (options[:vote_weight].to_i if options[:vote_weight].present?) || 1
+
+        if vote.save
+          self.vote_registered = true if last_update != vote.updated_at
+          update_cached_votes options[:vote_scope]
+          return true
+        else
+          self.vote_registered = false
+          return false
+        end
+
+      end
+
+      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)
+
+        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]
+      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
+
+      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
+
+      # 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 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
+
+        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
+
+      end
+
+
+      # results
+      def find_votes_for extra_conditions = {}
+        votes_for.where(extra_conditions)
+      end
+
+      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 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
+
+
+      # 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(scope_or_empty_hash(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
+      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
+      end
+
+      def weighted_average skip_cache = false, vote_scope = nil
+        if !skip_cache && self.respond_to?(scope_cache_field :cached_weighted_average, vote_scope)
+          return self.send(scope_cache_field :cached_weighted_average, vote_scope)
+        end
+
+        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
+
+      # voters
+      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
+end

data/lib/redmine_crm/vote.rb

@@ -0,0 +1,30 @@
+require 'redmine_crm/helpers/vote_helper'
+
+module RedmineCrm
+  module ActsAsVotable
+    class Vote < ActiveRecord::Base
+
+      include Helpers::Words
+
+      if defined?(ProtectedAttributes) || ::ActiveRecord::VERSION::MAJOR < 4
+        attr_accessible :votable_id, :votable_type,
+          :voter_id, :voter_type,
+          :votable, :voter,
+          :vote_flag, :vote_scope
+      end
+
+      belongs_to :votable, :polymorphic => true
+      belongs_to :voter, :polymorphic => true
+
+      scope :up, lambda{ where(:vote_flag => true) }
+      scope :down, lambda{ where(:vote_flag => false) }
+      scope :for_type, lambda{ |klass| where(:votable_type => klass) }
+      scope :by_type,  lambda{ |klass| where(:voter_type => klass) }
+
+      validates_presence_of :votable_id
+      validates_presence_of :voter_id
+
+    end
+
+  end
+end

data/lib/redmine_crm/voter.rb

@@ -0,0 +1,136 @@
+module RedmineCrm
+  module ActsAsVotable
+    module Voter
+
+      def self.included(base)
+
+        # allow user to define these
+        aliases = {
+          :vote_up_for    => [:likes, :upvotes, :up_votes],
+          :vote_down_for  => [:dislikes, :downvotes, :down_votes],
+          :unvote_for     => [:unlike, :undislike],
+          :voted_on?      => [:voted_for?],
+          :voted_up_on?   => [:voted_up_for?, :liked?],
+          :voted_down_on? => [:voted_down_for?, :disliked?],
+          :voted_as_when_voting_on => [:voted_as_when_voted_on, :voted_as_when_voting_for, :voted_as_when_voted_for],
+          :find_up_voted_items   => [:find_liked_items],
+          :find_down_voted_items => [:find_disliked_items]
+        }
+
+        base.class_eval do
+
+          has_many :votes, :class_name => 'RedmineCrm::ActsAsVotable::Vote', :as => :voter, :dependent => :destroy do
+            def votables
+              includes(:votable).map(&:votable)
+            end
+          end
+
+          aliases.each do |method, links|
+            links.each do |new_method|
+              alias_method(new_method, method)
+            end
+          end
+
+        end
+
+      end
+
+      # voting
+      def vote args
+        args[:votable].vote_by args.merge({:voter => self})
+      end
+
+      def vote_up_for model=nil, args={}
+        vote :votable => model, :vote_scope => args[:vote_scope], :vote => true
+      end
+
+      def vote_down_for model=nil, args={}
+        vote :votable => model, :vote_scope => args[:vote_scope], :vote => false
+      end
+
+      def unvote_for model, args={}
+        model.unvote :voter => self, :vote_scope => args[:vote_scope]
+      end
+
+      # results
+      def voted_on? votable, args={}
+        votes = find_votes(:votable_id => votable.id, :votable_type => votable.class.base_class.name,
+                           :vote_scope => args[:vote_scope])
+        votes.size > 0
+      end
+
+      def voted_up_on? votable, args={}
+        votes = find_votes(:votable_id => votable.id, :votable_type => votable.class.base_class.name,
+                           :vote_scope => args[:vote_scope], :vote_flag => true)
+        votes.size > 0
+      end
+
+      def voted_down_on? votable, args={}
+        votes = find_votes(:votable_id => votable.id, :votable_type => votable.class.base_class.name,
+                           :vote_scope => args[:vote_scope], :vote_flag => false)
+        votes.size > 0
+      end
+
+      def voted_as_when_voting_on votable, args={}
+        vote = find_votes(:votable_id => votable.id, :votable_type => votable.class.base_class.name,
+                           :vote_scope => args[:vote_scope]).select(:vote_flag).last
+        return nil unless vote
+        return vote.vote_flag
+      end
+
+      def find_votes extra_conditions = {}
+        votes.where(extra_conditions)
+      end
+
+      def find_up_votes args={}
+        find_votes :vote_flag => true, :vote_scope => args[:vote_scope]
+      end
+
+      def find_down_votes args={}
+        find_votes :vote_flag => false, :vote_scope => args[:vote_scope]
+      end
+
+      def find_votes_for_class klass, extra_conditions = {}
+        find_votes extra_conditions.merge({:votable_type => klass.name})
+      end
+
+      def find_up_votes_for_class klass, args={}
+        find_votes_for_class klass, :vote_flag => true, :vote_scope => args[:vote_scope]
+      end
+
+      def find_down_votes_for_class klass, args={}
+        find_votes_for_class klass, :vote_flag => false, :vote_scope => args[:vote_scope]
+      end
+
+      # Including polymporphic relations for eager loading
+      def include_objects
+        ActsAsVotable::Vote.includes(:votable)
+      end
+
+      def find_voted_items extra_conditions = {}
+        options = extra_conditions.merge :voter_id => id, :voter_type => self.class.base_class.name
+        include_objects.where(options).collect(&:votable)
+      end
+
+      def find_up_voted_items extra_conditions = {}
+        find_voted_items extra_conditions.merge(:vote_flag => true)
+      end
+
+      def find_down_voted_items extra_conditions = {}
+        find_voted_items extra_conditions.merge(:vote_flag => false)
+      end
+
+      def get_voted klass, extra_conditions = {}
+        klass.joins(:votes_for).merge find_votes(extra_conditions)
+      end
+
+      def get_up_voted klass
+        klass.joins(:votes_for).merge find_up_votes
+      end
+
+      def get_down_voted klass
+        klass.joins(:votes_for).merge find_down_votes
+      end
+    end
+  end
+end