thumbs_up 0.3.2 → 0.4

data/.gitignore

@@ -1,2 +1,3 @@
 *.gem
 pkg/*
+Gemfile.lock

data/README.markdown

@@ -65,7 +65,7 @@ Usage
     voter.vote(voteable, vote) 	# Adds either a +1 or -1 vote: vote => true (+1), vote => false (-1)
 
     voter.vote_exclusively_for(voteable)	# Removes any previous votes by that particular voter, and votes for.
-    voter.vote_exclusively_for(voteable)	# Removes any previous votes by that particular voter, and votes against.
+    voter.vote_exclusively_against(voteable)	# Removes any previous votes by that particular voter, and votes against.
 
 ### Querying votes
 
@@ -98,6 +98,21 @@ This will select the Items with between 1 and 10,000 votes, the votes having bee
     :at_least    - Item must have at least X votes
     :at_most     - Item may not have more than X votes
 
+##### Tallying Rank
+
+Similar to tallying votes, but this will actually return voteable object collections based on a rating 
+system where up votes and down votes get equal rating.  For Instance, a voteable with 3 upvotes and 2 
+downvotes will have a rating in this instance of 1.
+
+##### Rank_Tally Options:
+    :start_at    - Restrict the votes to those created after a certain time
+    :end_at      - Restrict the votes to those created before a certain time
+    :conditions  - A piece of SQL conditions to add to the query
+    :limit       - The maximum number of voteables to return
+    :ascending   - Boolean Default false.  If specified true, results will be returned in ascending order (from bottom up)
+    :at_least    - Item must have at least X votes
+    :at_most     - Item may not have more than X votes
+
 #### Lower level queries
 
     positiveVoteCount = voteable.votes_for
@@ -123,6 +138,9 @@ ThumbsUp by default only allows one vote per user. This can be changed by removi
 
     add_index :votes, ["voter_id", "voter_type", "voteable_id", "voteable_type"], :unique => true, :name => "uniq_one_vote_only"
 
+You can also use `--unique-voting false` when running the generator command:
+
+    rails generate thumbs_up --unique-voting false
 
 Credits
 =======

data/Rakefile

@@ -1,19 +1,50 @@
 # encoding: UTF-8
 require 'rubygems'
-require 'rake'
+require 'bundler'
 
 begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "thumbs_up"
-    gem.summary = "Voting for ActiveRecord with multiple vote sources and karma calculation."
-    gem.description = "ThumbsUp provides dead-simple voting capabilities to ActiveRecord models with karma calculation, a la stackoverflow.com."
-    gem.email = "brady@ldawn.com"
-    gem.homepage = "http://github.com/brady8/thumbs_up"
-    gem.authors = ["Brady Bouchard", "Peter Jackson", "Cosmin Radoi", "Bence Nagy", "Rob Maddox", "Wojciech Wnętrzak"]
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "thumbs_up"
+  gem.summary = "Voting for ActiveRecord with multiple vote sources and karma calculation."
+  gem.description = "ThumbsUp provides dead-simple voting capabilities to ActiveRecord models with karma calculation, a la stackoverflow.com."
+  gem.email = "brady@ldawn.com"
+  gem.homepage = "http://github.com/brady8/thumbs_up"
+  gem.authors = ["Brady Bouchard", "Peter Jackson", "Cosmin Radoi", "Bence Nagy", "Rob Maddox", "Wojciech Wnętrzak"]
+  # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "leaderboard #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task :default => :test

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.4

data/lib/acts_as_voteable.rb

@@ -15,6 +15,60 @@ module ThumbsUp
     end
 
     module SingletonMethods
+      
+      # The point of this function is to return rankings based on the difference between up and down votes
+      # assuming equal weighting (i.e. a user with 1 up vote and 1 down vote has a Vote_Total of 0. 
+      # First the votes table is joined twiced so that the Vote_Total can be calculated for every ID
+      # Then this table is joined against the specific table passed to this function to allow for 
+      # ranking of the items within that table based on the difference between up and down votes.
+            # Options:
+      #  :start_at    - Restrict the votes to those created after a certain time
+      #  :end_at      - Restrict the votes to those created before a certain time
+      #  :conditions  - A piece of SQL conditions to add to the query
+      #  :limit       - The maximum number of voteables to return
+      #  :ascending   - Default false - normal order DESC (i.e. highest rank to lowest)
+      #  :at_least    - Item must have at least X votes
+      #  :at_most     - Item may not have more than X votes
+      def rank_tally(*args)
+	options = args.extract_options!
+	
+	tsub0 = Vote
+	tsub0 = tsub0.where("vote = ?", false)
+	tsub0 = tsub0.where("voteable_type = ?", self.name)
+	tsub0 = tsub0.group("voteable_id")
+	tsub0 = tsub0.select("DISTINCT voteable_id, COUNT(vote) as Votes_Against")
+	
+	tsub1 = Vote
+	tsub1 = tsub1.where("vote = ?", true)
+	tsub1 = tsub1.where("voteable_type = ?", self.name)
+	tsub1 = tsub1.group("voteable_id")
+	tsub1 = tsub1.select("DISTINCT voteable_id, COUNT(vote) as Votes_For")
+	
+	t = self.joins("LEFT OUTER JOIN (SELECT DISTINCT #{Vote.table_name}.*, 
+	  (COALESCE(vfor.Votes_For, 0)-COALESCE(against.Votes_Against, 0)) AS Vote_Total
+	    FROM (#{Vote.table_name} LEFT JOIN
+	      (#{tsub0.to_sql}) AS against ON #{Vote.table_name}.voteable_id = against.voteable_id)
+	    LEFT JOIN 
+	      (#{tsub1.to_sql}) as vfor ON #{Vote.table_name}.voteable_id = vfor.voteable_id) 
+	    AS joined_#{Vote.table_name} ON #{self.table_name}.#{self.primary_key} = 
+	      joined_#{Vote.table_name}.voteable_id")
+	
+	t = t.where("joined_#{Vote.table_name}.voteable_type = '#{self.name}'")
+	t = t.group("joined_#{Vote.table_name}.voteable_id, joined_#{Vote.table_name}.Vote_Total, #{column_names_for_tally}")
+        t = t.limit(options[:limit]) if options[:limit]
+        t = t.where("joined_#{Vote.table_name}.created_at >= ?", options[:start_at]) if options[:start_at]
+        t = t.where("joined_#{Vote.table_name}.created_at <= ?", options[:end_at]) if options[:end_at]
+        t = t.where(options[:conditions]) if options[:conditions]
+        t = options[:ascending] ? t.order("joined_#{Vote.table_name}.Vote_Total")
+	                                  : t.order("joined_#{Vote.table_name}.Vote_Total DESC")
+			  
+        t = t.having(["COUNT(joined_#{Vote.table_name}.voteable_id) > 0",
+	        (options[:at_least] ? "joined_votes.Vote_Total >= #{sanitize(options[:at_least])}" : nil),
+		(options[:at_most] ? "joined_votes.Vote_Total <= #{sanitize(options[:at_most])}" : nil)
+		].compact.join(' AND '))
+	
+	t.select("#{self.table_name}.*, joined_#{Vote.table_name}.Vote_Total")
+      end
 
       # Calculate the vote counts for all voteables of my type.
       # This method returns all voteables with at least one vote.

data/lib/acts_as_voter.rb

@@ -75,7 +75,7 @@ module ThumbsUp #:nodoc:
       end
 
       def vote(voteable, options = {})
-        raise ArgumentError "you must specify :up or :down in order to vote" unless options[:direction] && [:up, :down].include?(options[:direction].to_sym)
+        raise ArgumentError, "you must specify :up or :down in order to vote" unless options[:direction] && [:up, :down].include?(options[:direction].to_sym)
         if options[:exclusive]
           self.clear_votes(voteable)
         end

data/lib/generators/thumbs_up/templates/migration.rb

@@ -12,8 +12,10 @@ class ThumbsUpMigration < ActiveRecord::Migration
     add_index :votes, [:voter_id, :voter_type]
     add_index :votes, [:voteable_id, :voteable_type]
 
-    # Comment out the line below to allow multiple votes per voter on a single entity.
+<% if options[:unique_voting] == true %>
+    # Comment out the line below to allow multiple votes per voter on a single entity.  
     add_index :votes, [:voter_id, :voter_type, :voteable_id, :voteable_type], :unique => true, :name => 'fk_one_vote_per_user_per_entity'
+<% end %>
   end
 
   def self.down

data/lib/generators/thumbs_up/templates/vote.rb

@@ -10,7 +10,8 @@ class Vote < ActiveRecord::Base
 
   attr_accessible :vote, :voter, :voteable
 
+<% if options[:unique_voting] == true %>
   # Comment out the line below to allow multiple votes per user.
   validates_uniqueness_of :voteable_id, :scope => [:voteable_type, :voter_type, :voter_id]
-
+<% end %>
 end

data/lib/generators/thumbs_up/thumbs_up_generator.rb

@@ -5,6 +5,8 @@ class ThumbsUpGenerator < Rails::Generators::Base
   include Rails::Generators::Migration
 
   source_root File.expand_path('../templates', __FILE__)
+  
+  class_option :unique_voting, :type => :boolean, :default => true, :desc => 'Do you want only one vote allowed per voter? (default: true)'
 
   # Implement the required interface for Rails::Generators::Migration.
   def self.next_migration_number(dirname) #:nodoc:

data/rails/init.rb

@@ -3,8 +3,8 @@ RAILS_DEFAULT_LOGGER.info "** thumbs_up: setting up load paths **"
 %w{ models controllers helpers }.each do |dir|
   path = File.join(File.dirname(__FILE__) , 'lib', dir)
   $LOAD_PATH << path
-  ActiveSupport::Dependencies.load_paths << path
-  ActiveSupport::Dependencies.load_once_paths.delete(path)
+  ActiveSupport::Dependencies.autoload_paths << path
+  ActiveSupport::Dependencies.autoload_once_paths.delete(path)
 end
 
-require 'thumbs_up'
+require 'thumbs_up'

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: thumbs_up
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  - 2
-  version: 0.3.2
+  prerelease: 
+  version: "0.4"
 platform: ruby
 authors: 
 - Brady Bouchard
@@ -19,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-16 00:00:00 -07:00
+date: 2011-04-01 00:00:00 +10:00
 default_executable: 
 dependencies: []
 
@@ -61,21 +57,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
 summary: Voting for ActiveRecord with multiple vote sources and karma calculation.