thumbs_up 0.6.5 → 0.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11003465d42393c944f234e11e53ad2d772e4089
-  data.tar.gz: 6ad0d8e91290c87792123ea3337c714fc5f5ee16
+  metadata.gz: 8f277083bf3a45e1984b0a21b5887ba74fb470d7
+  data.tar.gz: 10be5d4e7609d85e34dc7a711d592138a18d12e2
 SHA512:
-  metadata.gz: fd79c8576b6e65baf65ac5da1921700ac5a07740a43b325f239c90dc4adc11f83480a48f1d3b49def1ff78983722d14609f3df219afa0f9fdd3ff25ce141cce1
-  data.tar.gz: 7029585f3bbe640e98469557c0bfd5088f7f379d8e403ca73428ddf7d3dc6accb66952a287fa41a88bf4db87002bdfd8814e6bff2499f23f89ac3ac6ffbaba50
+  metadata.gz: 30cc98da6527c4b2bd1f58dd31fb0d79ac2da493ae7d26b3d8f4221df04f374f964059ed9de23adaa2137f391d6b2f8022f6d5b667dd6ad2a3b14c10fc8500b8
+  data.tar.gz: 421ce7730d7fa9438919a9dabaf5542d0b0916bab00126c67f6c1a1892059cc809fcbe23c55d9d570f653ed2025d1b944ac754220234d2154f3cb9c3c97e691b

data/README.md

@@ -11,8 +11,8 @@ Allows an arbitrary number of entities (users, etc.) to vote on models.
 ### Mixins
 This plugin introduces three mixins to your recipe book:
 
-1. **acts\_as\_voteable** : Intended for content objects like Posts, Comments, etc.
-2. **acts\_as\_voter** : Intended for voting entities, like Users.
+1. **acts\_as\_voteable** : Intended for content objects like Posts, Comments, etc. * (See *Configuration* below for caveats)
+2. **acts\_as\_voter** : Intended for voting entities, like Users. * (See *Configuration* below for caveats)
 3. **has\_karma** : Adds some helpers to acts\_as\_voter models for calculating karma.
 
 ### Inspiration
@@ -31,6 +31,22 @@ Installation
     rails generate thumbs_up
     rake db:migrate
 
+Configuration
+=============
+
+The relationship setup by the acts_as_voteable and acts_as_voter mixins both default to `votes`.  This causes one to obscure the other if you have a single class that votes on other instances of the same class.  If you have this scenario:
+
+    class User < ActiveRecord::Base
+      acts_as_voter     # relationship :votes will be obscured by the same named relationship from acts_as_voteable :(
+      acts_as_voteable
+    end
+
+Configure alternate relationship names in an initializer at `config/initializers/thumbs_up.rb`:
+
+    ThumbsUp.configuration.voteable_relationship_name = :votes_on   # defaults to :votes
+    ThumbsUp.configuration.voter_relationship_name =    :votes_by   # defaults to :votes
+
+
 Usage
 =====
 
@@ -54,7 +70,9 @@ Usage
       # Each question has a submitter_id column that tracks the user who submitted it.
       # The option :weight value will be multiplied to any karma from that voteable model (defaults to 1).
       # You can track any voteable model.
-      has_karma(:questions, :as => :submitter, :weight => 0.5)
+      has_karma :questions, :as => :submitter, :weight => 0.5
+      # Karma by default is only calculated from upvotes. If you pass an array to the weight option, you can count downvotes as well (below, downvotes count for half as much karma against you):
+      has_karma :questions, :as => :submitter, :weight => [ 1, 0.5 ]
     end
 
     class Robot < ActiveRecord::Base

data/lib/acts_as_voteable.rb

@@ -65,24 +65,24 @@ module ThumbsUp
     module InstanceMethods
 
       # wraps the dynamic, configured, relationship name
-      def _votes_by
+      def _votes_on
         self.send(ThumbsUp.configuration[:voteable_relationship_name])
       end
 
       def votes_for
-        self._votes_by.where(:vote => true).count
+        self._votes_on.where(:vote => true).count
       end
 
       def votes_against
-        self._votes_by.where(:vote => false).count
+        self._votes_on.where(:vote => false).count
       end
 
       def percent_for
-        (votes_for.to_f * 100 / (self._votes_by.size + 0.0001)).round
+        (votes_for.to_f * 100 / (self._votes_on.size + 0.0001)).round
       end
 
       def percent_against
-        (votes_against.to_f * 100 / (self._votes_by.size + 0.0001)).round
+        (votes_against.to_f * 100 / (self._votes_on.size + 0.0001)).round
       end
 
       # You'll probably want to use this method to display how 'good' a particular voteable
@@ -97,7 +97,7 @@ module ThumbsUp
       # http://evanmiller.org/how-not-to-sort-by-average-rating.html
       def ci_plusminus(confidence = 0.95)
         require 'statistics2'
-        n = votes.size
+        n = self._votes_on.size
         if n == 0
           return 0
         end
@@ -107,19 +107,19 @@ module ThumbsUp
       end
 
       def votes_count
-        votes.size
+        _votes_on.size
       end
 
       def voters_who_voted
-        votes.map(&:voter).uniq
+        _votes_on.map(&:voter).uniq
       end
 
       def voters_who_voted_for
-          votes.where(:vote => true).map(&:voter).uniq
+          _votes_on.where(:vote => true).map(&:voter).uniq
       end
 
       def voters_who_voted_against
-          votes.where(:vote => false).map(&:voter).uniq
+          _votes_on.where(:vote => false).map(&:voter).uniq
       end
 
       def voted_by?(voter)

data/lib/acts_as_voter.rb

@@ -31,8 +31,8 @@ module ThumbsUp #:nodoc:
     module InstanceMethods
 
       # wraps the dynamic, configured, relationship name
-      def _votes_on
-        self.send(ThumbsUp.configuration[:voteable_relationship_name])
+      def _votes_by
+        self.send(ThumbsUp.configuration[:voter_relationship_name])
       end
 
       # Usage user.vote_count(:up)  # All +1 votes

data/lib/has_karma.rb

@@ -13,7 +13,7 @@ module ThumbsUp #:nodoc:
         include ThumbsUp::Karma::InstanceMethods
         extend  ThumbsUp::Karma::SingletonMethods
         self.karmic_objects ||= {}
-        self.karmic_objects[voteable_type.to_s.classify.constantize] = [ (options[:as] ? options[:as].to_s.foreign_key : self.name.foreign_key), (options[:weight] || 1).to_f ]
+        self.karmic_objects[voteable_type.to_s.classify.constantize] = [ (options[:as] ? options[:as].to_s.foreign_key : self.name.foreign_key), [ (options[:weight] || 1) ].flatten.map(&:to_f) ]
       end
     end
 
@@ -30,10 +30,16 @@ module ThumbsUp #:nodoc:
     module InstanceMethods
       def karma(options = {})
         self.class.base_class.karmic_objects.collect do |object, attr|
-          v = object.where(["#{Vote.table_name}.vote = ?", true]).where(["#{self.class.base_class.table_name}.#{self.class.base_class.primary_key} = ?", self.id])
+          v = object.where(["#{self.class.base_class.table_name}.#{self.class.base_class.primary_key} = ?", self.id])
           v = v.joins("INNER JOIN #{Vote.table_name} ON #{Vote.table_name}.voteable_type = '#{object.to_s}' AND #{Vote.table_name}.voteable_id = #{object.table_name}.#{object.primary_key}")
           v = v.joins("INNER JOIN #{self.class.base_class.table_name} ON #{self.class.base_class.table_name}.#{self.class.base_class.primary_key} = #{object.table_name}.#{attr[0]}")
-          (v.count.to_f * attr[1]).round
+          upvotes = v.where(["#{Vote.table_name}.vote = ?", true])
+          downvotes = v.where(["#{Vote.table_name}.vote = ?", false])
+          if attr[1].length == 1 # Only count upvotes, not downvotes.
+            (upvotes.count.to_f * attr[1].first).round
+          else
+            (upvotes.count.to_f * attr[1].first - downvotes.count.to_f * attr[1].last).round
+          end
         end.sum
       end
     end

data/lib/thumbs_up.rb

@@ -17,8 +17,8 @@ module ThumbsUp
     #
     # @example
     #   ThumbsUp.configure do |config|
-    #     config.voteable_relationship_name = :votes_by
-    #     config.voter_relationship_name    = :votes_on
+    #     config.voteable_relationship_name = :votes_on
+    #     config.voter_relationship_name    = :votes_by
     #   end
     def configure
       yield(configuration)

data/lib/thumbs_up/version.rb

@@ -1,3 +1,3 @@
 module ThumbsUp
-	VERSION = '0.6.5'
+	VERSION = '0.6.6'
 end

data/test/test_helper.rb

@@ -89,6 +89,24 @@ ActiveRecord::Schema.define do
     t.string  :name
     t.string  :description
   end
+
+  create_table :user_customs, :force => true do |t|
+    t.string :name
+    t.timestamps
+  end
+
+  create_table :item_customs, :force => true do |t|
+    t.integer :user_id
+    t.string  :name
+    t.string  :description
+  end
+
+  create_table :other_item_customs, :force => true do |t|
+    t.integer :user_id
+    t.string  :name
+    t.string  :description
+  end
+
 end
 
 require 'thumbs_up'
@@ -110,20 +128,61 @@ class Vote < ActiveRecord::Base
 end
 
 class Item < ActiveRecord::Base
+  # This is default, however because the setting is app-wide, and changed elsewhere, we need to be explicit
+  ThumbsUp.configuration.voteable_relationship_name = :votes
+  ThumbsUp.configuration.voter_relationship_name = :votes
   acts_as_voteable
   belongs_to :user
 end
 
 class OtherItem < ActiveRecord::Base
+  # This is default, however because the setting is app-wide, and changed elsewhere, we need to be explicit
+  ThumbsUp.configuration.voteable_relationship_name = :votes
+  ThumbsUp.configuration.voter_relationship_name = :votes
   acts_as_voteable
   belongs_to :user
 end
 
 class User < ActiveRecord::Base
+  # This is default, however because the setting is app-wide, and changed elsewhere, we need to be explicit
+  ThumbsUp.configuration.voteable_relationship_name = :votes
+  ThumbsUp.configuration.voter_relationship_name = :votes
   acts_as_voter
   has_many :items
   has_karma(:items)
 end
 
+class ItemCustom < ActiveRecord::Base
+  ThumbsUp.configuration.voteable_relationship_name = :votes_on
+  ThumbsUp.configuration.voter_relationship_name = :votes_by
+  acts_as_voteable
+  belongs_to :user
+end
+
+class OtherItemCustom < ActiveRecord::Base
+  ThumbsUp.configuration.voteable_relationship_name = :votes_on
+  ThumbsUp.configuration.voter_relationship_name = :votes_by
+  acts_as_voteable
+  belongs_to :user
+end
+
+class UserCustom < ActiveRecord::Base
+  ThumbsUp.configuration.voteable_relationship_name = :votes_on
+  ThumbsUp.configuration.voter_relationship_name = :votes_by
+  acts_as_voter
+  has_many :items
+  has_karma :items
+
+  def self.weighted_has_karma
+    self.karmic_objects = nil
+    has_karma :items, :weight => [ 10, 15 ]
+  end
+
+  def self.upvote_only_has_karma
+    self.karmic_objects = nil
+    has_karma :items, :weight => 1.3
+  end
+end
+
 class Test::Unit::TestCase
 end

data/test/thumbs_up_test.rb

@@ -8,6 +8,10 @@ class TestThumbsUp < Test::Unit::TestCase
   end
 
   def test_acts_as_voter_instance_methods
+    # Because these are set in several places we need to ensure the defaults are set here.
+    ThumbsUp.configuration.voteable_relationship_name = :votes
+    ThumbsUp.configuration.voter_relationship_name = :votes
+
     user_for = User.create(:name => 'david')
     user_against = User.create(:name => 'brady')
     item = Item.create(:name => 'XBOX', :description => 'XBOX console')
@@ -79,6 +83,10 @@ class TestThumbsUp < Test::Unit::TestCase
   end
 
   def test_acts_as_voteable_instance_methods
+    # Because these are set in several places we need to ensure the defaults are set here.
+    ThumbsUp.configuration.voteable_relationship_name = :votes
+    ThumbsUp.configuration.voter_relationship_name = :votes
+
     item = Item.create(:name => 'XBOX', :description => 'XBOX console')
 
     assert_equal 0, item.ci_plusminus
@@ -138,6 +146,139 @@ class TestThumbsUp < Test::Unit::TestCase
     assert_equal false, item.voted_by?(non_voting_user)
   end
 
+  def test_acts_as_voter_configuration
+    ThumbsUp.configuration.voteable_relationship_name = :votes_on
+    ThumbsUp.configuration.voter_relationship_name = :votes_by
+
+    user_for = UserCustom.create(:name => 'david')
+    user_against = UserCustom.create(:name => 'brady')
+    item = ItemCustom.create(:name => 'XBOX', :description => 'XBOX console')
+
+    # We have changed the name of the relationship, so `votes` is not defined.
+    assert_raises(NoMethodError) do
+      user_for.votes
+    end
+
+    assert_not_nil user_for.vote_for(item)
+    assert_raises(ActiveRecord::RecordInvalid) do
+      user_for.vote_for(item)
+    end
+    assert_equal true, user_for.voted_for?(item)
+    assert_equal false, user_for.voted_against?(item)
+    assert_equal true, user_for.voted_on?(item)
+    assert_equal 1, user_for.vote_count
+    assert_equal 1, user_for.vote_count(:up)
+    assert_equal 0, user_for.vote_count(:down)
+    assert_equal true, user_for.voted_which_way?(item, :up)
+    assert_equal false, user_for.voted_which_way?(item, :down)
+    assert_equal 1, user_for.votes_by.where(:voteable_type => 'ItemCustom').count
+    assert_equal 0, user_for.votes_by.where(:voteable_type => 'AnotherItem').count
+    assert_raises(ArgumentError) do
+      user_for.voted_which_way?(item, :foo)
+    end
+
+    assert_not_nil user_against.vote_against(item)
+    assert_raises(ActiveRecord::RecordInvalid) do
+      user_against.vote_against(item)
+    end
+    assert_equal false, user_against.voted_for?(item)
+    assert_equal true, user_against.voted_against?(item)
+    assert_equal true, user_against.voted_on?(item)
+    assert_equal 1, user_against.vote_count
+    assert_equal 0, user_against.vote_count(:up)
+    assert_equal 1, user_against.vote_count(:down)
+    assert_equal false, user_against.voted_which_way?(item, :up)
+    assert_equal true, user_against.voted_which_way?(item, :down)
+    assert_raises(ArgumentError) do
+      user_against.voted_which_way?(item, :foo)
+    end
+
+    assert_not_nil user_against.vote_exclusively_for(item)
+    assert_equal true, user_against.voted_for?(item)
+
+    assert_not_nil user_for.vote_exclusively_against(item)
+    assert_equal true, user_for.voted_against?(item)
+
+    user_for.unvote_for(item)
+    assert_equal 0, user_for.vote_count
+
+    user_against.unvote_for(item)
+    assert_equal 0, user_against.vote_count
+
+    assert_raises(ArgumentError) do
+      user_for.vote(item, {:direction => :foo})
+    end
+  end
+
+  def test_acts_as_voteable_configuration
+    ThumbsUp.configuration.voteable_relationship_name = :votes_on
+    ThumbsUp.configuration.voter_relationship_name = :votes_by
+
+    item = ItemCustom.create(:name => 'XBOX', :description => 'XBOX console')
+
+    assert_equal 0, item.ci_plusminus
+
+    user_for = UserCustom.create(:name => 'david')
+    another_user_for = UserCustom.create(:name => 'name')
+    user_against = UserCustom.create(:name => 'brady')
+    another_user_against = UserCustom.create(:name => 'name')
+
+    # We have changed the name of the relationship, so `votes` is not defined.
+    assert_raises(NoMethodError) do
+      item.votes
+    end
+
+    user_for.vote_for(item)
+    another_user_for.vote_for(item)
+    # Use #reload to force reloading of votes from the database,
+    # otherwise these tests fail after "assert_equal 0, item.ci_plusminus" caches
+    # the votes. We hack this as caching is the correct behavious, per-request,
+    # in production.
+    item.reload
+
+    assert_equal 2, item.votes_for
+    assert_equal 0, item.votes_against
+    assert_equal 2, item.plusminus
+    assert_in_delta 0.34, item.ci_plusminus, 0.01
+
+    user_against.vote_against(item)
+
+    assert_equal 1, item.votes_against
+    assert_equal 1, item.plusminus
+    assert_in_delta 0.20, item.ci_plusminus, 0.01
+
+    assert_equal 3, item.votes_count
+
+    assert_equal 67, item.percent_for
+    assert_equal 33, item.percent_against
+
+    voters_who_voted = item.voters_who_voted
+    assert_equal 3, voters_who_voted.size
+    assert voters_who_voted.include?(user_for)
+    assert voters_who_voted.include?(another_user_for)
+    assert voters_who_voted.include?(user_against)
+
+    voters_who_voted_for = item.voters_who_voted_for
+    assert_equal 2, voters_who_voted_for.size
+    assert voters_who_voted_for.include?(user_for)
+    assert voters_who_voted_for.include?(another_user_for)
+
+    another_user_against.vote_against(item)
+
+    voters_who_voted_against = item.voters_who_voted_against
+    assert_equal 2, voters_who_voted_against.size
+    assert voters_who_voted_against.include?(user_against)
+    assert voters_who_voted_against.include?(another_user_against)
+
+    non_voting_user = UserCustom.create(:name => 'voteable_configuration')
+
+    assert_equal true, item.voted_by?(user_for)
+    assert_equal true, item.voted_by?(another_user_for)
+    assert_equal true, item.voted_by?(user_against)
+    assert_equal false, item.voted_by?(non_voting_user)
+  end
+
+  # Duplicated method name, why?
   def test_tally_empty
     item = Item.create(:name => 'XBOX', :description => 'XBOX console')
     # COUNT(#{Vote.table_name}.id) is equivalent to aliased column `vote_count` - Postgres
@@ -399,6 +540,28 @@ class TestThumbsUp < Test::Unit::TestCase
     assert_equal 0, users[1].karma
   end
 
+  def test_karma_with_upvote_weights
+    User.upvote_only_has_karma
+    users = (0..1).map{ |u| User.create(:name => "User #{u}") }
+    items = (0..1).map{ |u| users[0].items.create(:name => "Item #{u}", :description => "Item #{u}") }
+    users.each{ |u| items.each { |i| u.vote_for(i) } }
+
+    assert_equal (4 * 1.3).round, users[0].karma
+    assert_equal 0, users[1].karma
+  end
+
+  def test_karma_with_both_upvote_and_downvote_weights
+    User.weighted_has_karma
+    for_users = (0..1).map{ |u| User.create(:name => "For User #{u}") }
+    against_users = (0..2).map{ |u| User.create(:name => "Against User #{u}") }
+    items = (0..1).map{ |u| for_users[0].items.create(:name => "Item #{u}", :description => "Item #{u}") }
+    for_users.each{ |u| items.each { |i| u.vote_for(i) } }
+    against_users.each{ |u| items.each { |i| u.vote_against(i) } }
+
+    assert_equal 2 * (10 * 2 - 15 * 3).round, for_users[0].karma
+    assert_equal 0, for_users[1].karma
+  end
+
   def test_plusminus_tally_scopes_by_voteable_type
     user = User.create(:name => 'david')
     item = Item.create(:name => 'XBOX', :description => 'XBOX console')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thumbs_up
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.6.6
 platform: ruby
 authors:
 - Brady Bouchard
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-05 00:00:00.000000000 Z
+date: 2013-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord