thumbs_up 0.5.3 → 0.5.4

data/Gemfile

@@ -1 +1,2 @@
-gemspec
+source 'http://rubygems.org'
+gemspec

data/README.md

@@ -1,6 +1,8 @@
 ThumbsUp
 =======
 
+[![Build Status](https://secure.travis-ci.org/bouchard/thumbs_up.png)](http://travis-ci.org/bouchard/thumbs_up)
+
 **Note: Version 0.5.x is a breaking change for #plusminus_tally and #tally, with > 50% speedups.**
 
 A ridiculously straightforward and simple package 'o' code to enable voting in your application, a la stackoverflow.com, etc.
@@ -98,15 +100,16 @@ This will select the Items with less than 10 votes, the votes having been cast w
 
 **You most likely want to use this over the normal tally**
 
-This is similar to tallying votes, but this will return voteable object collections based on the sum of the differences between up and down votes (ups are +1, downs are -1). For Instance, a voteable with 3 upvotes and 2 downvotes will have a plusminus of 1.
+This is similar to tallying votes, but this will return voteable object collections based on the sum of the differences between up and down votes (ups are +1, downs are -1). For Instance, a voteable with 3 upvotes and 2 downvotes will have a plusminus_tally of 1.
 
-    @items = Item.plusminus_tally.limit(10).where('created_at > ?', 2.days.ago).having('plusminus > 10')
+    @items = Item.plusminus_tally.limit(10).where('created_at > ?', 2.days.ago).having('plusminus_tally > 10')
 
 #### Lower level queries
 
     positiveVoteCount = voteable.votes_for
     negativeVoteCount = voteable.votes_against
-    plusminus         = voteable.plusminus  # Votes for, minus votes against.
+    # Votes for minus votes against. If you want more than a few model instances' worth, use `plusminus_tally` instead.
+    plusminus         = voteable.plusminus
 
 	voter.voted_for?(voteable) # True if the voter voted for this object.
 	voter.vote_count(:up | :down | :all) # returns the count of +1, -1, or all votes

data/lib/acts_as_voteable.rb

@@ -20,12 +20,18 @@ module ThumbsUp
       # This returns an Arel relation, so you can add conditions as you like chained on to
       # this method call.
       # i.e. Posts.tally.where('votes.created_at > ?', 2.days.ago)
-      def plusminus_tally
+      # You can also have the upvotes and downvotes returned separately in the same query:
+      # Post.plusminus_tally(:separate_updown => true)
+      def plusminus_tally(params = {})
         t = self.joins("LEFT OUTER JOIN #{Vote.table_name} ON #{self.table_name}.id = #{Vote.table_name}.voteable_id")
-        t = t.order("plusminus DESC")
+        t = t.order("plusminus_tally DESC")
         t = t.group("#{self.table_name}.id")
         t = t.select("#{self.table_name}.*")
-        t = t.select("SUM(CASE CAST(#{Vote.table_name}.vote AS UNSIGNED) WHEN 1 THEN 1 WHEN 0 THEN -1 ELSE 0 END) AS plusminus")
+        t = t.select("SUM(CASE CAST(#{Vote.table_name}.vote AS UNSIGNED) WHEN 1 THEN 1 WHEN 0 THEN -1 ELSE 0 END) AS plusminus_tally")
+        if params[:separate_updown]
+          t = t.select("SUM(CASE CAST(#{Vote.table_name}.vote AS UNSIGNED) WHEN 1 THEN 1 WHEN 0 THEN 0 ELSE 0 END) AS up")
+          t = t.select("SUM(CASE CAST(#{Vote.table_name}.vote AS UNSIGNED) WHEN 1 THEN 0 WHEN 0 THEN 1 ELSE 0 END) AS down")
+        end
         t = t.select("COUNT(#{Vote.table_name}.id) AS vote_count")
       end
 
@@ -72,16 +78,31 @@ module ThumbsUp
 
       # You'll probably want to use this method to display how 'good' a particular voteable
       # is, and/or sort based on it.
+      # If you're using this for a lot of voteables, then you'd best use the #plusminus_tally
+      # method above.
       def plusminus
-        votes_for - votes_against
+        respond_to?(:plusminus_tally) ? plusminus_tally : (votes_for - votes_against)
+      end
+
+      # The lower bound of a Wilson Score with a default confidence interval of 95%. Gives a more accurate representation of average rating (plusminus) based on the number of positive ratings and total ratings.
+      # http://evanmiller.org/how-not-to-sort-by-average-rating.html
+      def ci_plusminus(confidence = 0.95)
+        require 'statistics2'
+        n = votes.size
+        if n == 0
+          return 0
+        end
+        z = Statistics2.pnormaldist(1 - (1 - confidence) / 2)
+        phat = 1.0 * votes_for / n
+        (phat + z * z / (2 * n) - z * Math.sqrt((phat * (1 - phat) + z * z / (4 * n)) / n)) / (1 + z * z / n)
       end
 
       def votes_count
-        self.votes.size
+        votes.size
       end
 
       def voters_who_voted
-        self.votes.map(&:voter).uniq
+        votes.map(&:voter).uniq
       end
 
       def voted_by?(voter)

data/lib/thumbs_up/version.rb

@@ -1,3 +1,3 @@
 module ThumbsUp
-	VERSION = '0.5.3'
+	VERSION = '0.5.4'
 end

data/test/test_helper.rb

@@ -7,13 +7,21 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'active_record'
 
-config = {
-  :adapter => 'mysql2',
-  :database => 'thumbs_up_test',
-  :username => 'test',
-  :password => 'test',
-  :socket => '/tmp/mysql.sock'
-}
+if ENV['TRAVIS']
+  config = {
+    :adapter => 'mysql2',
+    :database => 'thumbs_up_test',
+    :username => 'root'
+  }
+else
+  config = {
+    :adapter => 'mysql2',
+    :database => 'thumbs_up_test',
+    :username => 'test',
+    :password => 'test',
+    :socket => '/tmp/mysql.sock'
+  }
+end
 
 ActiveRecord::Base.establish_connection(config)
 ActiveRecord::Base.connection.drop_database config[:database] rescue nil

data/test/thumbs_up_test.rb

@@ -73,11 +73,13 @@ class TestThumbsUp < Test::Unit::TestCase
     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
 
@@ -154,6 +156,18 @@ class TestThumbsUp < Test::Unit::TestCase
     assert_equal 2, Item.tally.where('created_at > ?', 3.days.ago).where('created_at < ?', 4.days.from_now).length
   end
 
+  def test_tally_count
+    Item.tally.except(:order).count
+  end
+
+  def test_tally_any
+    Item.tally.except(:order).any?
+  end
+
+  def test_tally_empty
+    Item.tally.except(:order).empty?
+  end
+
   def test_plusminus_tally_not_empty_without_conditions
     item = Item.create(:name => 'XBOX', :description => 'XBOX console')
     assert_equal 1, Item.plusminus_tally.length
@@ -271,10 +285,22 @@ class TestThumbsUp < Test::Unit::TestCase
     assert_not_nil user.vote_for(item_for)
     assert_not_nil user.vote_against(item_against)
 
-    assert_equal item_for, Item.plusminus_tally.reorder('plusminus ASC')[1]
-    assert_equal item_against, Item.plusminus_tally.reorder('plusminus ASC')[0]
+    assert_equal item_for, Item.plusminus_tally.reorder('plusminus_tally ASC')[1]
+    assert_equal item_against, Item.plusminus_tally.reorder('plusminus_tally ASC')[0]
   end
-  
+
+  def test_plusminus_tally_count
+    Item.plusminus_tally.except(:order).count
+  end
+
+  def test_plusminus_tally_any
+    Item.plusminus_tally.except(:order).any?
+  end
+
+  def test_plusminus_tally_empty
+    Item.plusminus_tally.except(:order).empty?
+  end
+
   def test_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}") }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thumbs_up
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
   prerelease: 
 platform: ruby
 authors:
@@ -14,11 +14,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-05 00:00:00.000000000 Z
+date: 2012-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70260724487840 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -26,10 +26,31 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70260724487840
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: statistics2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70260724487260 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -37,10 +58,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70260724487260
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70260724486740 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -48,10 +74,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70260724486740
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mysql2
-  requirement: &70260724502580 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -59,10 +90,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70260724502580
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70260724501960 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -70,7 +106,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70260724501960
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ThumbsUp provides dead-simple voting capabilities to ActiveRecord models
   with karma calculation, a la stackoverflow.com.
 email:
@@ -95,7 +136,7 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-homepage: http://github.com/brady8/thumbs_up
+homepage: http://github.com/bouchard/thumbs_up
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -109,7 +150,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4476845312579799296
+      hash: 557327561442508507
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -118,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.7.0
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Voting for ActiveRecord with multiple vote sources and karma calculation.