aflatter-vote_fu 0.0.11

data/CHANGELOG.markdown

@@ -0,0 +1,31 @@
+2009-02-11
+==========
+* Merge in xlash's bugfix for PostgreSQL and his has\_karma patch for multi-model support. 
+
+2008-12-02
+==========
+* Merge in maddox's README typo fix and his ActiveSupport.Dependency patch
+* Merge in nagybence's updates that make the code usable as a Gem in addition to being a Rails plugin. 
+* Thanks for the bugfixes and proofreading, nagybence and maddox!
+* Updated the gemplugin support to be compatible with maddox and nagybence's changes. 
+* Added details on the MyQuotable reference application. 
+
+2008-07-20
+==========
+* Protect against mass assignment misvotes using attr\_accessible
+* Update acts\_as mixins to use self.class.name instead of the deprecated self.type.name
+
+2008-07-15
+==========
+* Added examples directory
+* Changed this file to markdown format for GitHub goodness
+* Added a commented out unique index in the migration generator for "one person, one vote"
+* Removed votes\_controller.rb from lib/ and moved to examples
+
+2008-07-10
+==========
+
+* Added a generator class for the migration. 
+* Implemented rails/init.rb
+* Implemented capability to use any model as the initiator of votes.
+* Implemented acts\_as\_voter methods.

data/MIT-LICENSE

@@ -0,0 +1,43 @@
+Copyright (c) 2008 Peter Jackson (peteonrails.com)
+
+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.
+
+Major portions of this package were adapted from ActsAsVoteable, which is subject to the same license. Here is the original copyright notice for ActsAsVoteable:
+
+Copyright (c) 2006 Cosmin Radoi
+
+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.

data/README.markdown

@@ -0,0 +1,220 @@
+vote_fu
+=======
+
+Allows an arbitrary number of entites (including Users) 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. 
+3. **has\_karma**  : Intended for voting entities, or other objects that own the things you're voting on.
+
+### Inspiration
+
+This plugin started as an adaptation / update of act\_as\_voteable. It has grown different from that plugin in several ways: 
+
+1. You can specify the model name that initiates votes. 
+2. You can, with a little tuning, have more than one entity type vote on more than one model type. 
+3. Adds "acts\_as\_voter" behavior to the initiator of votes.
+4. Introduces some newer Rails features like named\_scope and :polymorphic keywords
+5. Adds "has\_karma" mixin for identifying key content contributors
+
+Installation
+============
+Use either the plugin or the gem installation method depending on your preference. If you're not sure, the plugin method is simpler. Whichever you choose, create the migration afterward and run it to create the required model.
+
+### Via plugin
+    ./script/plugin install git://github.com/peteonrails/vote_fu.git 
+
+### Via gem
+Add the following to your application's environment.rb:
+    config.gem "peteonrails-vote_fu", :lib => 'vote_fu', :source => 'http://gems.github.com'
+
+Install the gem:
+    rake gems:install
+
+### Create vote_fu migration
+Create a new rails migration using your new vote_fu generator (Note: "VoteableModel" is the name of the model on which you would like votes to be cast, e.g. Comment):
+    ./script/generate vote_fu VoteableModel
+
+Run the migration:
+    rake db:migrate
+
+Usage
+=====
+
+## Getting Started
+
+### Make your ActiveRecord model act as voteable.
+
+
+    class Model < ActiveRecord::Base
+ 	  acts_as_voteable
+    end
+
+
+### Make your ActiveRecord model(s) that vote act as voter.
+
+    class User < ActiveRecord::Base
+ 	  acts_as_voter
+    end
+
+    class Robot < ActiveRecord::Base
+   	  acts_as_voter
+    end
+
+### To cast a vote for a Model you can do the following:
+
+#### Shorthand syntax
+	voter.vote_for(voteable)     # Adds a +1 vote
+	voter.vote_against(voteable) # Adds a -1 vote
+	voter.vote(voteable, t_or_f) # Adds either +1 or -1 vote true => +1, false => -1
+	
+#### ActsAsVoteable syntax
+The old acts\_as\_voteable syntax is still supported:
+
+    vote = Vote.new(:vote => true)
+    m    = Model.find(params[:id])
+    m.votes    << vote
+    user.votes << vote
+
+### Querying votes
+
+#### Tallying Votes
+
+You can easily retrieve voteable object collections based on the properties of their votes:	
+
+    @items = Item.tally(
+      {  :at_least => 1, 
+          :at_most => 10000,  
+          :start_at => 2.weeks.ago,
+          :end_at => 1.day.ago,
+          :limit => 10,
+          :order => "items.name desc"
+      })
+
+This will select the Items with between 1 and 10,000 votes, the votes having been cast within the last two weeks (not including today), then display the 10 last items in an alphabetical list.
+
+##### 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
+    :order       - A piece of SQL to order by. Eg 'votes.count desc' or 'voteable.created_at desc'
+    :at_least    - Item must have at least X votes
+    :at_most     - Item may not have more than X votes
+
+#### Lower level queries
+ActiveRecord models that act as voteable can be queried for the positive votes, negative votes, and a total vote count by using the votes\_for, votes\_against, and votes\_count methods respectively. Here is an example:
+
+    positiveVoteCount = m.votes_for
+    negativeVoteCount = m.votes_against
+    totalVoteCount    = m.votes_count
+
+And because the Vote Fu plugin will add the has_many votes relationship to your model you can always get all the votes by using the votes property:
+
+    allVotes = m.votes
+
+The mixin also provides these methods: 
+
+    voter.voted_for?(voteable)  # True if the voter voted for this object. 
+	voter.vote_count([true|false|"all"]) # returns the count of +1, -1, or all votes 
+
+	voteable.voted_by?(voter) # True if the voter voted for this object. 
+	@voters = voteable.voters_who_voted
+
+
+#### Named Scopes
+
+The Vote model has several named scopes you can use to find vote details: 
+
+    @pete_votes = Vote.for_voter(pete)
+    @post_votes = Vote.for_voteable(post)
+    @recent_votes = Vote.recent(1.day.ago)
+    @descending_votes = Vote.descending
+
+You can chain these together to make interesting queries: 
+
+    # Show all of Pete's recent votes for a certain Post, in descending order (newest first)
+    @pete_recent_votes_on_post = Vote.for_voter(pete).for_voteable(post).recent(7.days.ago).descending
+
+### Experimental: Voteable Object Owner Karma
+I have just introduced the "has\_karma" mixin to this package. It aims to assign a karma score to the owners of voteable objects. This is designed to allow you to see which users are submitting the most highly voted content. Currently, karma is only "positive". That is, +1 votes add to karma, but -1 votes do not detract from it. 
+
+    class User 
+      has_many :posts
+      has_karma :posts
+    end
+    
+    class Post
+      acts_as_voteable
+    end
+    
+    # in your view, you can then do this: 
+    Karma: <%= @user.karma %>
+  
+This feature is in alpha, but useful enough that I'm releasing it. 
+
+### One vote per user!
+If you want to limit your users to a single vote on each item, take a look in lib/vote.rb. 
+
+    # Uncomment this to limit users to a single vote on each item. 
+    # validates_uniqueness_of :voteable_id, :scope => [:voteable_type, :voter_type, :voter_id]
+
+And if you want that enforced at the database level, look in the generated migration for your voteable:
+
+    # If you want to enfore "One Person, One Vote" rules in the database, uncomment the index below
+    # add_index :votes, ["voter_id", "voter_type", "voteable_id", "voteable_type"], :unique => true, :name => "uniq_one_vote_only"
+
+### Example Application
+
+There is now a reference application available. Due to overwhelming demand for example 
+code and kickstart guides, I have open-sourced MyQuotable.com in order to provide an 
+easy-to-follow example of how to use VoteFu with RESTful Authentication, JRails, and 
+other popular plugins. To get the example code: 
+
+    git clone git://github.com/peteonrails/myquotable.git
+
+There will be a screencast coming soon too. Contact me if you want to help.
+
+Consideration
+=============
+If you like this software and use it, please consider recommending me on Working With Rails. 
+
+I don't want donations: a simple up-vote would make my day. My profile is: [http://www.workingwithrails.com/person/12521-peter-jackson][4]
+
+To go directly to the "Recommend Me" screen: [http://www.workingwithrails.com/recommendation/new/person/12521-peter-jackson][5]
+
+
+Credits
+=======
+
+#### Contributors
+
+* Bence Nagy, Budapest, Hungary
+* Jon Maddox, Richmond, Virginia, USA
+
+#### Other works
+
+[Juixe  - The original ActsAsVoteable plugin inspired this code.][1]
+
+[Xelipe - This plugin is heavily influenced by Acts As Commentable.][2]
+
+[1]: http://www.juixe.com/techknow/index.php/2006/06/24/acts-as-voteable-rails-plugin/
+[2]: http://github.com/jackdempsey/acts_as_commentable/tree/master
+
+More
+====
+
+Support: [Use my blog for support.][6]
+
+
+[Documentation from the original acts\_as\_voteable plugin][3]
+
+[3]: http://www.juixe.com/techknow/index.php/2006/06/24/acts-as-voteable-rails-plugin/
+[4]: http://www.workingwithrails.com/person/12521-peter-jackson
+[5]: http://www.workingwithrails.com/recommendation/new/person/12521-peter-jackson
+[6]: http://blog.peteonrails.com
+
+Copyright (c) 2008 Peter Jackson, released under the MIT license

data/examples/routes.rb

@@ -0,0 +1,7 @@
+
+map.resources :users do |user|
+  user.resources :votes
+  user.resources :voteable do |mv|
+    mv.resources :votes
+  end
+end

data/examples/users_controller.rb

@@ -0,0 +1,76 @@
+# I usually use the user class from restful_authentication as my principle voter class
+# There are generally no changes required to support voting in this controller. 
+
+class UsersController < ApplicationController
+  # Be sure to include AuthenticationSystem in Application Controller instead
+  include AuthenticatedSystem
+  
+  # Protect these actions behind an admin login
+  before_filter :admin_required, :only => [:suspend, :unsuspend, :destroy, :purge]
+  before_filter :find_user, :only => [:suspend, :unsuspend, :destroy, :purge, :show]
+
+  before_filter :login_required, :only => [:index]
+
+  # render new.html.erb
+  def new
+  end
+
+  # GET /users/:id
+  def show
+  end
+  
+
+  def create
+    cookies.delete :auth_token
+    @user = User.new(params[:user])
+    @user.register! if @user.valid?
+    if @user.errors.empty?
+      self.current_user.forget_me if logged_in?
+      cookies.delete :auth_token
+      reset_session
+      flash[:notice] = "Thanks for signing up!"
+    else
+      render :action => 'new'
+    end
+  end
+
+  def activate
+    unless params[:activation_code].blank?
+      self.current_user = User.find_by_activation_code(params[:activation_code])
+      if logged_in? && !current_user.active?
+        current_user.activate!
+        flash[:notice] = "Signup complete!"
+        redirect_back_or_default('/')
+      else
+        flash[:error] = "Sorry, we couldn't find that activation code. Please cut and paste your activation code into the space at left."
+      end
+    end
+    # render activate.html.erb    
+  end
+
+  def suspend
+    @user.suspend! 
+    redirect_to users_path
+  end
+
+  def unsuspend
+    @user.unsuspend! 
+    redirect_to users_path
+  end
+
+  def destroy
+    @user.delete!
+    redirect_to users_path
+  end
+
+  def purge
+    @user.destroy
+    redirect_to users_path
+  end
+
+protected
+  def find_user
+    @user = User.find(params[:id])
+  end
+
+end

data/examples/voteable.html.erb

@@ -0,0 +1,8 @@
+<div id="voteable_<%= @voteable.id %>">
+
+		..... Show some fields .....
+
+	<div id="votes_<%= @voteable.id %>">
+		<%= render :partial => "votes/voteable_vote", :locals => {:voteable => @voteable} %>
+	</div>
+</div>

data/examples/voteable.rb

@@ -0,0 +1,10 @@
+class Voteable < ActiveRecord::Base
+
+  belongs_to :user
+  
+  acts_as_voteable
+  
+  named_scope :descending, :order => "created_at DESC"
+
+  
+end

data/examples/voteables_controller.rb

@@ -0,0 +1,117 @@
+# This example controller assumes you are using the User class from restful_authentication
+# and a nested voteable resource. See routes.rb
+
+
+class VoteablesController < ApplicationController
+
+  before_filter :find_user
+  before_filter :login_required, :only => [:new, :edit, :destroy, :create, :update]
+  before_filter :must_own_voteable, :only => [:edit, :destroy, :update]
+
+  # GET /users/:id/voteables
+  # GET /users/:id/voteables.xml
+  def index
+    @voteable = Voteable.descending
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xml  { render :xml => @voteables }
+    end
+  end
+
+  # GET /users/:id/voteables/1
+  # GET /users/:id/voteables/1.xml
+  def show
+    @voteable = Voteable.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.xml  { render :xml => @voteable }
+    end
+  end
+
+  # GET /users/:id/voteables/new
+  # GET /users/:id/voteables/new.xml
+  def new
+    @voteable = Voteable.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.xml  { render :xml => @voteable }
+    end
+  end
+
+  # GET /users/:id/voteables/1/edit
+  def edit 
+    @voteable ||= Voteable.find(params[:id])
+  end
+
+  # POST /users/:id/voteables
+  # POST /users/:id/voteables.xml
+  def create
+    @voteable = Voteable.new(params[:voteable])
+    @voteable.user = current_user
+    
+    respond_to do |format|
+      if @voteable.save
+        flash[:notice] = 'Voteable was successfully saved.'
+        format.html { redirect_to([@user, @voteable]) }
+        format.xml  { render :xml => @voteable, :status => :created, :location => @voteable }
+      else
+        format.html { render :action => "new" }
+        format.xml  { render :xml => @voteable.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /users/:id/voteable/1
+  # PUT /users/:id/voteable/1.xml
+  def update
+    @voteable = Voteable.find(params[:id])
+    
+    respond_to do |format|
+      if @quote.update_attributes(params[:voteable])
+        flash[:notice] = 'Voteable was successfully updated.'
+        format.html { redirect_to([@user, @voteable]) }
+        format.xml  { head :ok }
+      else
+        format.html { render :action => "edit" }
+        format.xml  { render :xml => @voteable.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /users/:id/voteable/1
+  # DELETE /users/:id/voteable/1.xml
+  def destroy
+    @voteable = Voteable.find(params[:id])
+    @voteable.destroy
+
+    respond_to do |format|
+      format.html { redirect_to(user_voteables_url) }
+      format.xml  { head :ok }
+    end
+  end
+  
+  private
+  def find_user 
+    @user = User.find(params[:user_id])
+  end
+    
+  def must_own_voteable
+    @voteable ||= Voteable.find(params[:id])
+    @voteable.user == current_user || ownership_violation
+  end
+  
+  def ownership_violation
+    respond_to do |format|
+      flash[:notice] = 'You cannot edit or delete voteable that you do not own!'
+      format.html do
+        redirect_to user_path(current_user)
+      end
+    end
+  end
+  
+  
+  
+end

data/examples/votes/_voteable_vote.html.erb

@@ -0,0 +1,23 @@
+<% 
+	# You can't vote if it is your quote, 
+	# you are not logged in, 
+	# or you have already voted on this item
+	
+	unless quote.user == current_user ||
+	!logged_in? ||
+	current_user.voted_on?(@voteable)
+%>
+
+	<%= link_to_remote "Up", 
+		:url => user_voteable_votes_path(voteable.user, voteable, :vote => :true, :format => :rjs), 
+		:method => :post
+	%> 
+	/
+	<%= link_to_remote "Down", 
+		:url => user_voteable_votes_path(voteable.user, voteable, :vote => :false, :format => :rjs), 
+		:method => :post
+ 	%> 
+
+<% end %>
+
+Votes: <%= voteable.votes_for - voteable.votes_against %>

data/examples/votes/create.rjs

@@ -0,0 +1 @@
+page.replace_html "votes_#{@voteable.id}", :partial => "voteable_vote", :locals => {:voteable => @voteable}

data/examples/votes_controller.rb

@@ -0,0 +1,110 @@
+# An example controller for "votes" that are nested resources under users. See examples/routes.rb
+
+class VotesController < ApplicationController
+
+  # First, figure out our nested scope. User or Voteable? 
+  before_filter :find_votes_for_my_scope, :only => [:index]
+     
+  before_filter :login_required, :only => [:new, :edit, :destroy, :create, :update]
+  before_filter :must_own_vote,  :only => [:edit, :destroy, :update]
+  before_filter :not_allowed,    :only => [:edit, :update, :new]
+
+  # GET /users/:user_id/votes/
+  # GET /users/:user_id/votes.xml
+  # GET /users/:user_id/voteables/:voteable_id/votes/
+  # GET /users/:user_id/voteables/:voteable_id/votes.xml
+  def index
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xml  { render :xml => @votes }
+    end
+  end
+
+  # GET /users/:user_id/votes/1
+  # GET /users/:user_id/votes/1.xml
+  # GET /users/:user_id/voteables/:voteable_id/votes/1
+  # GET /users/:user_id/voteables/:voteable_id/1.xml
+  def show
+    @voteable = Vote.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.xml  { render :xml => @vote }
+    end
+  end
+
+  # GET /users/:id/votes/new      
+  # GET /users/:id/votes/new.xml  
+  # GET /users/:id/votes/new      
+  # GET /users/:id/votes/new.xml  
+  def new
+    # Not generally used. Most people want to vote via AJAX calls.
+  end
+
+  # GET /users/:id/votes/1/edit
+  def edit
+    # Not generally used. Most people don't want to allow editing of votes.
+  end
+
+  # POST /users/:user_id/voteables/:voteable_id/votes
+  # POST /users/:user_id/voteables/:voteable_id/votes.xml
+  def create
+    @voteable = Voteable.find(params[:quote_id])
+    
+    respond_to do |format|
+      if current_user.vote(@voteable, params[:vote])
+        format.rjs  { render :action => "create", :vote => @vote }
+        format.html { redirect_to([@voteable.user, @voteable]) }
+        format.xml  { render :xml => @voteable, :status => :created, :location => @voteable }
+      else
+        format.rjs  { render :action => "error" }
+        format.html { render :action => "new" }
+        format.xml  { render :xml => @vote.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /users/:id/votes/1
+  # PUT /users/:id/votes/1.xml
+  def update
+    # Not generally used
+  end
+  
+  # DELETE /users/:id/votes/1
+  # DELETE /users/:id/votes/1.xml
+  def destroy
+    @vote = Vote.find(params[:id])
+    @vote.destroy
+
+    respond_to do |format|
+      format.html { redirect_to(user_votes_url) }
+      format.xml  { head :ok }
+    end
+  end
+
+  private
+  def find_votes_for_my_scope
+    if params[:voteable_id]
+      @votes = Vote.for_voteable(Voteable.find(params[:voteable_id])).descending
+    elsif params[:user_id]
+      @votes = Vote.for_voter(User.find(params[:user_id])).descending         
+    else  
+      @votes = []
+    end
+  end
+
+  def must_own_vote
+    @vote ||= Vote.find(params[:id])
+    @vote.user == current_user || ownership_violation
+  end
+
+  def ownership_violation
+    respond_to do |format|
+      flash[:notice] = 'You cannot edit or delete votes that you do not own!'
+      format.html do
+        redirect_to user_path(current_user)
+      end
+    end
+  end
+
+end

data/generators/vote_fu/templates/migration.rb

@@ -0,0 +1,21 @@
+class VoteFuMigration < ActiveRecord::Migration
+  def self.up
+    create_table :votes, :force => true do |t|
+      t.boolean    :vote, :default => false
+      t.references :voteable, :polymorphic => true, :null => false
+      t.references :voter,    :polymorphic => true
+      t.timestamps      
+    end
+
+    add_index :votes, ["voter_id", "voter_type"],       :name => "fk_voters"
+    add_index :votes, ["voteable_id", "voteable_type"], :name => "fk_voteables"
+
+    # If you want to enfore "One Person, One Vote" rules in the database, uncomment the index below
+    # add_index :votes, ["voter_id", "voter_type", "voteable_id", "voteable_type"], :unique => true, :name => "uniq_one_vote_only"
+  end
+
+  def self.down
+    drop_table :votes
+  end
+
+end

data/generators/vote_fu/vote_fu_generator.rb

@@ -0,0 +1,8 @@
+class VoteFuGenerator < Rails::Generator::Base 
+
+  def manifest 
+    record do |m| 
+      m.migration_template 'migration.rb', 'db/migrate', :migration_file_name => 'vote_fu_migration'
+    end 
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'vote_fu'

data/lib/acts_as_voteable.rb

@@ -0,0 +1,114 @@
+# ActsAsVoteable
+module Juixe
+  module Acts #:nodoc:
+    module Voteable #:nodoc:
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def acts_as_voteable
+          has_many :votes, :as => :voteable, :dependent => :nullify
+
+          include Juixe::Acts::Voteable::InstanceMethods
+          extend  Juixe::Acts::Voteable::SingletonMethods
+        end        
+      end
+      
+      # This module contains class methods
+      module SingletonMethods
+        
+        # Calculate the vote counts for all voteables of my type.
+        def tally(options = {})
+          find(:all, options_for_tally(options.merge({:order =>"count DESC" })))
+        end
+
+        # 
+        # 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
+        #  :order       - A piece of SQL to order by. Eg 'votes.count desc' or 'voteable.created_at desc'
+        #  :at_least    - Item must have at least X votes
+        #  :at_most     - Item may not have more than X votes
+        def options_for_tally (options = {})
+            options.assert_valid_keys :start_at, :end_at, :conditions, :at_least, :at_most, :order, :limit
+
+            scope = scope(:find)
+            start_at = sanitize_sql(["#{Vote.table_name}.created_at >= ?", options.delete(:start_at)]) if options[:start_at]
+            end_at = sanitize_sql(["#{Vote.table_name}.created_at <= ?", options.delete(:end_at)]) if options[:end_at]
+
+            type_and_context = "#{Vote.table_name}.voteable_type = #{quote_value(base_class.name)}"
+
+            conditions = [
+              type_and_context,
+              options[:conditions],
+              start_at,
+              end_at
+            ]
+
+            conditions = conditions.compact.join(' AND ')
+            conditions = merge_conditions(conditions, scope[:conditions]) if scope
+
+            joins = ["LEFT OUTER JOIN #{Vote.table_name} ON #{table_name}.#{primary_key} = #{Vote.table_name}.voteable_id"]
+            joins << scope[:joins] if scope && scope[:joins]
+            at_least  = sanitize_sql(["COUNT(#{Vote.table_name}.id) >= ?", options.delete(:at_least)]) if options[:at_least]
+            at_most   = sanitize_sql(["COUNT(#{Vote.table_name}.id) <= ?", options.delete(:at_most)]) if options[:at_most]
+            having    = [at_least, at_most].compact.join(' AND ')
+            group_by  = "#{Vote.table_name}.voteable_id HAVING COUNT(#{Vote.table_name}.id) > 0"
+            group_by << " AND #{having}" unless having.blank?
+
+            { :select     => "#{table_name}.*, COUNT(#{Vote.table_name}.id) AS count", 
+              :joins      => joins.join(" "),
+              :conditions => conditions,
+              :group      => group_by
+            }.update(options)          
+        end
+      end
+      
+      # This module contains instance methods
+      module InstanceMethods
+        def votes_for
+          Vote.count(:all, :conditions => [
+            "voteable_id = ? AND voteable_type = ? AND vote = ?",
+            id, self.class.name, true
+          ])
+        end
+        
+        def votes_against
+          Vote.count(:all, :conditions => [
+            "voteable_id = ? AND voteable_type = ? AND vote = ?",
+            id, self.class.name, false
+          ])
+        end
+        
+        # Same as voteable.votes.size
+        def votes_count
+          self.votes.size
+        end
+        
+        def voters_who_voted
+          voters = []
+          self.votes.each { |v|
+            voters << v.voter
+          }
+          voters
+        end
+        
+        def voted_by?(voter)
+          rtn = false
+          if voter
+            self.votes.each { |v|
+              rtn = true if (voter.id == v.voter_id && voter.class.name == v.voter_type)
+            }
+          end
+          rtn
+        end
+        
+        
+      end
+    end
+  end
+end

data/lib/acts_as_voter.rb

@@ -0,0 +1,75 @@
+# ActsAsVoter
+module PeteOnRails
+  module Acts #:nodoc:
+    module Voter #:nodoc:
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def acts_as_voter
+          has_many :votes, :as => :voter, :dependent => :nullify  # If a voting entity is deleted, keep the votes. 
+          include PeteOnRails::Acts::Voter::InstanceMethods
+          extend  PeteOnRails::Acts::Voter::SingletonMethods
+        end
+      end
+      
+      # This module contains class methods
+      module SingletonMethods
+      end
+      
+      # This module contains instance methods
+      module InstanceMethods
+        
+        # Usage user.vote_count(true)  # All +1 votes
+        #       user.vote_count(false) # All -1 votes
+        #       user.vote_count()      # All votes
+        
+        def vote_count(for_or_against = "all")
+          where = (for_or_against == "all") ? 
+            ["voter_id = ? AND voter_type = ?", id, self.class.name ] : 
+            ["voter_id = ? AND voter_type = ? AND vote = ?", id, self.class.name, for_or_against ]
+                        
+          Vote.count(:all, :conditions => where)
+
+        end
+                
+        def voted_for?(voteable)
+           0 < Vote.count(:all, :conditions => [
+                   "voter_id = ? AND voter_type = ? AND vote = ? AND voteable_id = ? AND voteable_type = ?",
+                   self.id, self.class.name, true, voteable.id, voteable.class.name
+                   ])
+         end
+
+         def voted_against?(voteable)
+           0 < Vote.count(:all, :conditions => [
+                   "voter_id = ? AND voter_type = ? AND vote = ? AND voteable_id = ? AND voteable_type = ?",
+                   self.id, self.class.name, false, voteable.id, voteable.class.name
+                   ])
+         end
+
+         def voted_on?(voteable)
+           0 < Vote.count(:all, :conditions => [
+                   "voter_id = ? AND voter_type = ? AND voteable_id = ? AND voteable_type = ?",
+                   self.id, self.class.name, voteable.id, voteable.class.name
+                   ])
+         end
+                
+        def vote_for(voteable)
+          self.vote(voteable, true)
+        end
+        
+        def vote_against(voteable)
+          self.vote(voteable, false)
+        end
+
+        def vote(voteable, vote)
+          vote = Vote.new(:vote => vote, :voteable => voteable, :voter => self)
+          vote.save
+        end
+
+      end
+    end
+  end
+end

data/lib/controllers/votes_controller.rb

@@ -0,0 +1,96 @@
+class VotesController < ApplicationController
+  # First, figure out our nested scope. User or vote?
+#  before_filter :find_my_scope
+  
+#  before_filter :find_user
+    
+#  before_filter :login_required, :only => [:new, :edit, :destroy, :create, :update]
+#  before_filter :must_own_vote,  :only => [:edit, :destroy, :update]
+
+
+  # GET /votes/
+  # GET /votes.xml
+  def index
+    @votes = Vote.descending
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xml  { render :xml => @votes }
+    end
+  end
+
+    # GET /votes/1
+    # GET /votes/1.xml
+    def show
+      @vote = Vote.find(params[:id])
+
+      respond_to do |format|
+        format.html # show.html.erb
+        format.xml  { render :xml => @vote }
+      end
+    end
+
+    # GET /votes/new
+    # GET /votes/new.xml
+    def new
+      @vote = Vote.new
+
+      respond_to do |format|
+        format.html # new.html.erb
+        format.xml  { render :xml => @vote }
+      end
+    end
+
+    # GET /votes/1/edit
+    def edit
+      @vote ||= Vote.find(params[:id])
+    end
+
+    # POST /votes
+    # POST /votes.xml
+    def create
+      @vote = Vote.new(params[:vote])
+      @vote.user = current_user
+
+      respond_to do |format|
+        if @vote.save
+          flash[:notice] = 'Vote was successfully saved.'
+          format.html { redirect_to([@user, @vote]) }
+          format.xml  { render :xml => @vote, :status => :created, :location => @vote }
+        else
+          format.html { render :action => "new" }
+          format.xml  { render :xml => @vote.errors, :status => :unprocessable_entity }
+        end
+      end
+    end
+
+    # PUT /votes/1
+    # PUT /votes/1.xml
+    def update
+      @vote = Vote.find(params[:id])
+
+      respond_to do |format|
+        if @vote.update_attributes(params[:vote])
+          flash[:notice] = 'Vote was successfully updated.'
+          format.html { redirect_to([@user, @vote]) }
+          format.xml  { head :ok }
+        else
+          format.html { render :action => "edit" }
+          format.xml  { render :xml => @vote.errors, :status => :unprocessable_entity }
+        end
+      end
+    end
+
+    # DELETE /votes/1
+    # DELETE /votes/1.xml
+    def destroy
+      @vote = Vote.find(params[:id])
+      @vote.destroy
+
+      respond_to do |format|
+        format.html { redirect_to(user_votes_url) }
+        format.xml  { head :ok }
+      end
+    end
+
+end

data/lib/has_karma.rb

@@ -0,0 +1,68 @@
+# Has Karma
+
+module PeteOnRails
+  module VoteFu #:nodoc:
+    module Karma #:nodoc:
+
+      def self.included(base)
+        base.extend ClassMethods
+        class << base
+          attr_accessor :karmatic_objects
+        end
+      end
+
+      module ClassMethods
+        def has_karma(voteable_type)
+          self.class_eval <<-RUBY
+            def karma_voteable
+              #{voteable_type.to_s.classify}
+            end
+          RUBY
+          include PeteOnRails::VoteFu::Karma::InstanceMethods
+          extend  PeteOnRails::VoteFu::Karma::SingletonMethods
+          if self.karmatic_objects.nil?
+            self.karmatic_objects = [eval(voteable_type.to_s.classify)]
+          else
+            self.karmatic_objects.push(eval(voteable_type.to_s.classify))
+          end
+        end
+      end
+      
+      # This module contains class methods
+      module SingletonMethods
+        
+        ## Not yet implemented. Don't use it!
+        # Find the most popular users
+        def find_most_karmic
+          find(:all)
+        end
+                      
+      end
+      
+      # This module contains instance methods
+      module InstanceMethods
+        def karma(options = {})
+          #FIXME cannot have 2 models imapcting the karma simultaneously
+          # count the total number of votes on all of the voteable objects that are related to this object
+          #2009-01-30 GuillaumeNM The following line is not SQLite3 compatible, because boolean are stored as 'f' or 't', not '1', or '0'
+          #self.karma_voteable.sum(:vote, options_for_karma(options))
+          #self.karma_voteable.find(:all, options_for_karma(options)).length
+          karma_value = 0
+          self.class.karmatic_objects.each do |object|
+            karma_value += object.find(:all, options_for_karma(object, options)).length
+          end
+          return karma_value
+        end
+        
+        def options_for_karma (object, options = {})
+            #GuillaumeNM : 2009-01-30 Adding condition for SQLite3
+            conditions = ["u.id = ? AND vote = ?" , self[:id] , true]
+            joins = ["inner join votes v on #{object.table_name}.id = v.voteable_id", "inner join #{self.class.table_name} u on u.id = #{object.name.tableize}.#{self.class.name.foreign_key}"]
+            { :joins => joins.join(" "), :conditions => conditions }.update(options)          
+        end
+        
+      end
+      
+    end
+  end
+end

data/lib/models/vote.rb

@@ -0,0 +1,17 @@
+class Vote < ActiveRecord::Base
+
+  named_scope :for_voter,    lambda { |*args| {:conditions => ["voter_id = ? AND voter_type = ?", args.first.id, args.first.type.name]} }
+  named_scope :for_voteable, lambda { |*args| {:conditions => ["voteable_id = ? AND voteable_type = ?", args.first.id, args.first.type.name]} }
+  named_scope :recent,       lambda { |*args| {:conditions => ["created_at > ?", (args.first || 2.weeks.ago).to_s(:db)]} }
+  named_scope :descending, :order => "created_at DESC"
+
+  # NOTE: Votes belong to the "voteable" interface, and also to voters
+  belongs_to :voteable, :polymorphic => true
+  belongs_to :voter,    :polymorphic => true
+  
+  attr_accessible :vote, :voter, :voteable
+
+  # Uncomment this to limit users to a single vote on each item. 
+  # validates_uniqueness_of :voteable_id, :scope => [:voteable_type, :voter_type, :voter_id]
+
+end

data/lib/vote_fu.rb

@@ -0,0 +1,9 @@
+require 'acts_as_voteable'
+require 'acts_as_voter'
+require 'has_karma'
+require 'models/vote.rb'
+
+ActiveRecord::Base.send(:include, Juixe::Acts::Voteable)
+ActiveRecord::Base.send(:include, PeteOnRails::Acts::Voter)
+ActiveRecord::Base.send(:include, PeteOnRails::VoteFu::Karma)
+RAILS_DEFAULT_LOGGER.info "** vote_fu: initialized properly."

data/rails/init.rb

@@ -0,0 +1,10 @@
+RAILS_DEFAULT_LOGGER.info "** vote_fu: 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)
+end
+
+require 'vote_fu'

data/test/vote_fu_test.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+
+class VoteFuTest < Test::Unit::TestCase
+  # Replace this with your real tests.
+  def test_this_plugin
+    flunk
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: aflatter-vote_fu
+version: !ruby/object:Gem::Version 
+  version: 0.0.11
+platform: ruby
+authors: 
+- Peter Jackson
+- Cosmin Radoi
+- Bence Nagy
+- Rob Maddox
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-11 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: VoteFu provides the ability to have multiple voting entities on an arbitrary number of models in ActiveRecord.
+email: pete@peteonrails.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- CHANGELOG.markdown
+- MIT-LICENSE
+- README.markdown
+- generators/vote_fu/vote_fu_generator.rb
+- generators/vote_fu/templates/migration.rb
+- init.rb
+- lib/vote_fu.rb
+- lib/acts_as_voteable.rb
+- lib/acts_as_voter.rb
+- lib/has_karma.rb
+- lib/models/vote.rb
+- lib/controllers/votes_controller.rb
+- test/vote_fu_test.rb
+- examples/votes_controller.rb
+- examples/users_controller.rb
+- examples/voteables_controller.rb
+- examples/voteable.rb
+- examples/voteable.html.erb
+- examples/votes/_voteable_vote.html.erb
+- examples/votes/create.rjs
+- examples/routes.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://blog.peteonrails.com/vote-fu
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Voting for ActiveRecord with multiple vote sources and advanced features.
+test_files: []
+