yeshoua_crm 1.0.0

data/lib/yeshoua_crm/acts_as_taggable/tagging.rb

@@ -0,0 +1,16 @@
+module YeshouaCrm
+  module ActsAsTaggable #:nodoc:
+    class Tagging < ActiveRecord::Base #:nodoc:
+      belongs_to :tag
+      belongs_to :taggable, :polymorphic => true
+
+      after_destroy :destroy_tag_if_unused
+
+      private
+
+      def destroy_tag_if_unused
+        tag.destroy if Tag.destroy_unused && tag.taggings.count.zero?
+      end
+    end
+  end
+end

data/lib/yeshoua_crm/acts_as_viewed/rcrm_acts_as_viewed.rb

@@ -0,0 +1,274 @@
+# Copyright (c) 2008 Damian Martinelli
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+module YeshouaCrm
+  module ActsAsViewed #:nodoc:
+    # == acts_as_viewed
+    # Adds views count capabilities to any ActiveRecord object.
+    # It has the ability to work with objects that have or don't special fields to keep a tally of the
+    # viewings for each object.
+    # In addition it will by default use the User model as the viewer object and keep the viewings per-user.
+    # It can be configured to use another class.
+    # The IP address are used to not repeat views from the same ip. Only one view are count by user or IP.
+    #
+    # Special methods are provided to create the viewings table and if needed, to add the special fields needed
+    # to keep per-objects viewings fast for access to viewed objects. Can be easily used in migrations.
+    #
+    # == Example of usage:
+    #
+    #   class Video < ActiveRecord::Base
+    #     acts_as_viewed
+    #   end
+    #
+    #   In a controller:
+    #
+    #   bill = User.find_by_name 'bill'
+    #   batman = Video.find_by_title 'Batman'
+    #   toystory  = Video.find_by_title 'Toy Story'
+    #
+    #   batman.view request.remote_addr, bill
+    #   toystory.view  request.remote_addr, bill
+    #
+    #   batman.view_count     # => 1
+    #
+    #
+    module Viewed
+      class ViewedError < RuntimeError; end
+
+      def self.included(base) #:nodoc:
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        # Make the model viewable.
+        # The Viewing model, holding the details of the viewings, will be created dynamically if it doesn't exist.
+        #
+        # * Adds a <tt>has_many :viewings</tt> association to the model for easy retrieval of the detailed viewings.
+        # * Adds a <tt>has_many :viewers</tt> association to the object.
+        # * Adds a <tt>has_many :viewings</tt> associations to the viewer class.
+        #
+        # === Options
+        # * <tt>:viewing_class</tt> -
+        #   class of the model used for the viewings. Defaults to Viewing. This class will be dynamically created if not already defined.
+        #   If the class is predefined, it must have in it the following definitions:
+        #   <tt>belongs_to :viewed, :polymorphic => true</tt>
+        #   <tt>belongs_to :viewer, :class_name => 'User', :foreign_key => :viewer_id</tt> replace user with the viewer class if needed.
+        # * <tt>:viewer_class</tt> -
+        #   class of the model that creates the viewing.
+        #   Defaults to User This class will NOT be created, so it must be defined in the app.
+        #   Use the IP address to prevent multiple viewings from the same client.
+        #
+        def rcrm_acts_as_viewed(options = {})
+          # don't allow multiple calls
+          return if self.included_modules.include?(ActsAsViewed::Viewed::ViewMethods)
+          send :include, ActsAsViewed::Viewed::ViewMethods
+
+          # Create the model for ratings if it doesn't yet exist
+          viewing_class = options[:viewing_class] || 'Viewing'
+          viewer_class  = options[:viewer_class]  || 'User'
+
+          unless Object.const_defined?(viewing_class)
+            Object.class_eval <<-EOV
+              class #{viewing_class} < ActiveRecord::Base
+                belongs_to :viewed, :polymorphic => true
+                belongs_to :viewer, :class_name => #{viewer_class}, :foreign_key => :viewer_id
+              end
+            EOV
+          end
+
+          # Rails < 3
+          # write_inheritable_attribute( :acts_as_viewed_options ,
+          #                                { :viewing_class => viewing_class,
+          #                                  :viewer_class => viewer_class } )
+          # class_inheritable_reader :acts_as_viewed_options
+
+          # Rails >= 3
+          class_attribute :acts_as_viewed_options
+          self.acts_as_viewed_options = { :viewing_class => viewing_class,
+                                          :viewer_class => viewer_class }
+          class_eval do
+            has_many :viewings, :as => :viewed, :dependent => :delete_all, :class_name => viewing_class.to_s
+            has_many(:viewers, :through => :viewings, :class_name => viewer_class.to_s)
+
+            before_create :init_viewing_fields
+          end
+
+          # Add to the User (or whatever the viewer is) a has_many viewings
+          viewer_as_class = viewer_class.constantize
+          return if viewer_as_class.instance_methods.include?('find_in_viewings')
+          viewer_as_class.class_eval <<-EOS
+            has_many :viewings, :foreign_key => :viewer_id, :class_name => #{viewing_class.to_s}
+          EOS
+        end
+      end
+
+      module ViewMethods
+        def self.included(base) #:nodoc:
+          base.extend ClassMethods
+        end
+
+        # Is this object viewed already?
+        def viewed?
+          return (!self.views.nil? && self.views > 0) if attributes.has_key? 'views'
+          !viewings.first.nil?
+        end
+
+        # Get the number of viewings for this object based on the views field,
+        # or with a SQL query if the viewed objects doesn't have the views field
+        def view_count
+          return ("#{self.total_views}(#{self.views})" || 0) if attributes.has_key? 'views'
+          viewings.count
+        end
+
+        # Change views count (total_views and views) if it's existing in object
+        # If options[:only_total] == true count of unique views doesn't change
+        def increase_views_count(options)
+          if attributes.has_key?('views') && attributes.has_key?('total_views')
+            target = self
+            target.views = ((target.views || 0) + 1) unless options[:only_total]
+            target.total_views = ((target.total_views || 0) + 1)
+            target.record_timestamps = false
+            target.save(:validate => false, :touch => false)
+          end
+        end
+
+        # View the object with or without a viewer - create new or update as needed
+        #
+        # * <tt>ip</tt> - the viewer ip
+        # * <tt>viewer</tt> - an object of the viewer class. Must be valid and with an id to be used. Or nil
+        def view(ip, viewer = nil)
+          # Sanity checks for the parameters
+          viewing_class = acts_as_viewed_options[:viewing_class].constantize
+          if viewer && !(acts_as_viewed_options[:viewer_class].constantize === viewer)
+            raise ViewedError, "the viewer object must be the one used when defining acts_as_viewed (or a descendent of it). other objects are not acceptable"
+          end
+
+          viewing_class.transaction do
+            if !viewed_by? ip, viewer
+              view = viewing_class.new
+              view.viewer_id = viewer.id if viewer && !viewer.id.nil?
+              view.ip = ip
+              viewings << view
+              view.save
+              increase_views_count(:only_total => false)
+            else
+              increase_views_count(:only_total => true)
+            end
+            true
+          end
+        end
+
+        # Check if an item was already viewed by the given viewer
+        def viewed_by?(ip, viewer = nil)
+          if viewer && !viewer.nil? && !(acts_as_viewed_options[:viewer_class].constantize === viewer)
+            raise ViewedError, "the viewer object must be the one used when defining acts_as_viewed (or a descendent of it). other objects are not acceptable"
+          end
+          if viewer && !viewer.id.nil? && !viewer.anonymous?
+            return viewings.where("viewer_id = '#{viewer.id}'").any?
+          else
+            return viewings.where("ip = '#{ip}'").any?
+          end
+        end
+
+        private
+
+        def init_viewing_fields #:nodoc:
+          self.views ||= 0 if attributes.has_key?('views')
+        end
+      end
+
+      module ClassMethods
+        # Generate the viewings columns on a table, to be used when creating the table
+        # in a migration. This is the preferred way to do in a migration that creates
+        # new tables as it will make it as part of the table creation, and not generate
+        # ALTER TABLE calls after the fact
+        def generate_viewings_columns(table)
+          table.column :views, :integer # uniq views
+          table.column :total_views, :integer
+        end
+
+        # Create the needed columns for acts_as_viewed.
+        # To be used during migration, but can also be used in other places.
+        def add_viewings_columns
+          if !self.content_columns.find { |c| 'views' == c.name }
+            self.connection.add_column table_name, :views, :integer, :default => '0'
+            self.connection.add_column table_name, :total_views, :integer, :default => '0'
+            self.reset_column_information
+          end
+        end
+
+        # Remove the acts_as_viewed specific columns added with add_viewings_columns
+        # To be used during migration, but can also be used in other places
+        def remove_viewings_columns
+          if self.content_columns.find { |c| 'views' == c.name }
+            self.connection.remove_column table_name, :views
+            self.connection.remove_column table_name, :total_views
+            self.reset_column_information
+          end
+        end
+
+        # Create the viewings table
+        # === Options hash:
+        # * <tt>:table_name</tt> - use a table name other than viewings
+        # To be used during migration, but can also be used in other places
+        def create_viewings_table(options = {})
+          name = options[:table_name] || :viewings
+          if !self.connection.table_exists?(name)
+            self.connection.create_table(name) do |t|
+              t.column :viewer_id,   :integer
+              t.column :viewed_id,   :integer
+              t.column :viewed_type, :string
+              t.column :ip, :string, :limit => '24'
+              t.column :created_at, :datetime
+            end
+
+            self.connection.add_index(name, :viewer_id)
+            self.connection.add_index(name, [:viewed_type, :viewed_id])
+          end
+        end
+
+        # Drop the viewings table.
+        # === Options hash:
+        # * <tt>:table_name</tt> - the name of the viewings table, defaults to viewings
+        # To be used during migration, but can also be used in other places
+        def drop_viewings_table(options = {})
+          name = options[:table_name] || :viewings
+          if self.connection.table_exists?(name)
+            self.connection.drop_table(name)
+          end
+        end
+
+        # Find all viewings for a specific viewer.
+        def find_viewed_by(viewer)
+          viewing_class = acts_as_viewed_options[:viewing_class].constantize
+          if !(acts_as_viewed_options[:viewer_class].constantize === viewer)
+            raise ViewedError, "The viewer object must be the one used when defining acts_as_viewed (or a descendent of it). other objects are not acceptable"
+          end
+          raise ViewedError, 'Viewer must be a valid and existing object' if viewer.nil? || viewer.id.nil?
+          raise ViewedError, 'Viewer must be a valid viewer' if !viewing_class.column_names.include?('viewer_id')
+          conds = ['viewed_type = ? AND viewer_id = ?', self.name, viewer.id]
+          acts_as_viewed_options[:viewing_class].constantize.where(conds).collect { |r| r.viewed_type.constantize.find_by_id r.viewed.id }
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, YeshouaCrm::ActsAsViewed::Viewed

data/lib/yeshoua_crm/acts_as_votable/rcrm_acts_as_votable.rb

@@ -0,0 +1,80 @@
+require 'active_record'
+
+module YeshouaCrm
+  module ActsAsVotable #:nodoc:
+    module Votable #:nodoc:
+      def votable?
+        false
+      end
+
+      def rcrm_acts_as_votable
+        require 'yeshoua_crm/acts_as_votable/votable'
+        include YeshouaCrm::ActsAsVotable::Votable
+
+        class_eval do
+          def self.votable?
+            true
+          end
+        end
+      end
+
+      def create_index(table_name, column_name)
+        return if self.connection.index_exists?(table_name, column_name)
+
+        self.connection.add_index table_name, column_name
+      end
+
+      def create_votable_table(options = {})
+        votes_name_table = options[:votes] || :votes
+
+        if !self.connection.table_exists?(votes_name_table)
+          self.connection.create_table(votes_name_table) do |t|
+            t.references :votable, :polymorphic => true
+            t.references :voter, :polymorphic => true
+
+            t.column :vote_flag, :boolean
+            t.column :vote_scope, :string
+            t.column :vote_weight, :integer
+            t.column :vote_ip, :string
+
+            t.timestamps
+          end
+        else #if table exists - check existence of separate columns
+          fields = {
+            :votable_id => :integer,
+            :votable_type => :string,
+            :voter_id => :integer,
+            :voter_type => :string,
+            :vote_flag => :boolean,
+            :vote_scope => :string,
+            :vote_weight => :integer,
+            :vote_ip => :string
+          }
+          fields.each do |name, type|
+            if !self.connection.column_exists?(votes_name_table, name)
+              self.connection.add_column(votes_name_table, name, type)
+            end
+          end
+
+        end
+
+        if self.parent::VERSION::MAJOR < 4
+          create_index votes_name_table, [:votable_id, :votable_type, :vote_ip]
+          create_index votes_name_table, [:voter_id, :voter_type, :vote_ip]
+        end
+
+        create_index votes_name_table, [:voter_id, :voter_type, :vote_scope]
+        create_index votes_name_table, [:votable_id, :votable_type, :vote_scope]
+        create_index votes_name_table, [:voter_type, :vote_scope, :vote_ip]
+        create_index votes_name_table, [:votable_type, :vote_scope, :vote_ip]
+      end
+
+      def drop_votable_table(options = {})
+        votes_name_table = options[:votes] || :votes
+        if self.connection.table_exists?(votes_name_table)
+          self.connection.drop_table votes_name_table
+        end
+      end
+    end
+  end
+end

data/lib/yeshoua_crm/acts_as_votable/rcrm_acts_as_voter.rb

@@ -0,0 +1,20 @@
+module YeshouaCrm
+  module ActsAsVotable
+    module Voter
+      def voter?
+        false
+      end
+
+      def rcrm_acts_as_voter(*args)
+        require 'yeshoua_crm/acts_as_votable/voter'
+        include YeshouaCrm::ActsAsVotable::Voter
+
+        class_eval do
+          def self.voter?
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yeshoua_crm/acts_as_votable/votable.rb

@@ -0,0 +1,323 @@
+require 'yeshoua_crm/helpers/vote_helper'
+
+module YeshouaCrm
+  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 => 'YeshouaCrm::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?
+        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
+
+        return false if options[:voter].nil?
+
+        # find the vote
+        vote_conditions = { :vote_scope => options[:vote_scope], :voter_type => options[:voter].class.base_class.name }
+        vote_conditions.merge!(options[:vote_by_ip] ? { :vote_ip => options[:vote_ip] } : { :voter_id => options[:voter].id} )
+        votes_for = find_votes_for(vote_conditions)
+
+        if votes_for.count == 0 || options[:duplicate]
+          # this voter has never voted
+          vote_params = { :votable => self, :voter => options[:voter], :vote_scope => options[:vote_scope] }
+          vote_params[:vote_ip] = options[:vote_ip] if options[:vote_ip]
+          vote = YeshouaCrm::ActsAsVotable::Vote.new(vote_params)
+        else
+          # this voter is potentially changing his vote
+          vote = votes_for.last
+        end
+
+        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
+
+        return false if vote.invalid?
+
+        self.vote_registered = vote.changed?
+        vote.save!(validate: false)
+        update_cached_votes(options[:vote_scope])
+        vote
+      end
+
+      def unvote(args = {})
+        return false if (!args[:vote_by_ip] && args[:voter].nil?) || (args[:vote_by_ip] && args[:vote_ip].nil?)
+        vote_conditions = { :vote_scope => args[:vote_scope], :voter_type => args[:voter].class.base_class.name }
+        vote_conditions.merge!(args[:vote_by_ip] ? { :vote_ip => args[:vote_ip] } : { :voter_id => args[:voter].id})
+        votes_for = find_votes_for(vote_conditions)
+
+        return true if votes_for.empty?
+        votes_for.each(&:destroy)
+        update_cached_votes args[:vote_scope]
+        self.vote_registered = false if votes_for.count == 0
+        true
+      end
+
+      def vote_up(voter, options={})
+        self.vote_by :voter => voter, :vote => true,
+                     :vote_scope => options[:vote_scope], :vote_weight => options[:vote_weight], :vote_ip => options[:vote_ip],
+                     :vote_by_ip => options[:vote_by_ip]
+      end
+
+      def vote_down(voter, options={})
+        self.vote_by :voter => voter, :vote => false,
+                     :vote_scope => options[:vote_scope], :vote_weight => options[:vote_weight], :vote_ip => options[:vote_ip],
+                     :vote_by_ip => options[:vote_by_ip]
+      end
+
+      def unvote_by(voter, options = {})
+        # Does not need vote_weight since the votes_for are anyway getting destroyed
+        self.unvote :voter => voter, :vote_scope => options[:vote_scope], :vote_ip => options[:vote_ip],
+                    :vote_by_ip => options[:vote_by_ip]
+      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
+        self.record_timestamps = false
+        if (::ActiveRecord::VERSION::MAJOR == 3) && (::ActiveRecord::VERSION::MINOR != 0)
+          self.update_attributes(updates, :without_protection => true) if !updates.empty?
+        else
+          self.update_attributes(updates) if !updates.empty?
+        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