voter_love 0.0.4 → 0.0.5

data/.gitignore

@@ -4,4 +4,5 @@ log/*.log
 pkg/
 test/dummy/db/*.sqlite3
 test/dummy/log/*.log
-test/dummy/tmp/
+test/dummy/tmp/
+*.gem

data/README.rdoc

@@ -1,3 +1,55 @@
 = Voter Love
 
-An easy to use Rails 3.1 voting Gem
+A simple, easy to use Rails 3.1 voting Gem.
+
+== Installation
+
+add the voter_love gem to your Gemfile:
+
+  gem 'voter_love'
+  
+create and generate the voter_love migration:
+  
+  rails generate voter_love
+  
+you will then need to add up_votes and down_votes columns to your User (voter) and Object (e.g. links) (votable) migrations:
+  
+  add_column :users, :up_votes, :integer, :null => false, :default => 0
+  add_column :users, :down_votes, :integer, :null => false, :default => 0
+  add_column :links, :up_votes, :integer, :null => false, :default => 0
+  add_column :links, :down_votes, :integer, :null => false, :default => 0
+  
+== Usage
+
+Turn your objects (e.g. links) into a votable model:
+
+  class Link < ActiveRecord::Base
+    acts_as_votable
+  end
+  
+Turn your users (or any other model) into a voter model:
+
+  class User < ActiveRecord::Base
+    acts_as_voter
+  end
+  
+To vote for an object (with an error raised if user already voted on the object):
+
+  user.up_vote(link)
+  user.down_vote(link)
+  
+To vote for an object (and ignore the vote if the user has already voted on the object):
+
+  user.up_vote!(link)
+  user.down_vote!(link)
+  
+Total score (up votes - down votes)
+  
+  link.score
+
+  
+  
+  
+  
+
+  

data/Rakefile

@@ -1,28 +1,7 @@
-#!/usr/bin/env rake
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-begin
-  require 'rdoc/task'
-rescue LoadError
-  require 'rdoc/rdoc'
-  require 'rake/rdoctask'
-  RDoc::Task = Rake::RDocTask
-end
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'VoterLove'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
+require 'bundler'
 Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task :default => :spec

data/lib/generators/voter_love/voter_love_generator.rb

@@ -4,7 +4,7 @@ require 'rails/generators/active_record'
 class VoterLoveGenerator < Rails::Generators::Base
   include Rails::Generators::Migration
 
-  desc "Generates a migration for the Vote model"
+  desc "Generates a migration for the Votes model"
 
   def self.source_root
     @source_root ||= File.dirname(__FILE__) + '/templates'

data/lib/tasks/voter_love_tasks.rake

@@ -1,4 +1,4 @@
 # desc "Explaining what the task does"
 # task :voter_love do
 #   # Task goes here
-# end
+# end

data/lib/voter_love/version.rb

@@ -1,3 +1,3 @@
 module VoterLove
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/voter_love/votable.rb

@@ -3,7 +3,7 @@ module VoterLove
     extend ActiveSupport::Concern
 
     included do
-      has_many :votes, :class_name => "VoterLove::Votes", :as => :votable
+      has_many :votes, :class_name => "VoterLove::Vote", :as => :votable
     end
 
     module ClassMethods

data/lib/voter_love/votes.rb

@@ -1,5 +1,5 @@
 module VoterLove
-  class Votes < ActiveRecord::Base
+  class Vote < ActiveRecord::Base
     attr_accessible :votable, :voter, :up_vote
     
     belongs_to :votable, :polymorphic => true

data/spec/lib/voter_love_spec.rb

@@ -2,11 +2,11 @@ require File.expand_path('../../spec_helper', __FILE__)
 
 describe "Voter Love" do
   before(:each) do
-    @votable = VotableModel.create(:name => "Votable 1")
-    @voter = VoterModel.create(:name => "Voter 1")
+    @votable = VotableModel.create(:name => "votable a")
+    @voter = VoterModel.create(:name => "voter b")
   end
 
-  it "should create a votable instance" do
+  it "should be votable" do
     @votable.class.should == VotableModel
     @votable.class.votable?.should == true
   end
@@ -18,11 +18,11 @@ describe "Voter Love" do
 
   it "should get correct vote summary" do
     @voter.up_vote(@votable).should == true
-    @votable.votes.should == 1
+    @votable.score.should == 1
     @voter.down_vote(@votable).should == true
-    @votable.votes.should == -1
+    @votable.score.should == -1
     @voter.unvote(@votable).should == true
-    @votable.votes.should == 0
+    @votable.score.should == 0
   end
 
   it "votable should have up vote votes" do
@@ -67,10 +67,10 @@ describe "Voter Love" do
     end
 
     it "should create a voting" do
-      VoterLove::Votes.count.should == 0
+      VoterLove::Vote.count.should == 0
       @voter.up_vote(@votable)
-      VoterLove::Votes.count.should == 1
-      voting = VoterLove::Votes.first
+      VoterLove::Vote.count.should == 1
+      voting = VoterLove::Vote.first
       voting.votable.should == @votable
       voting.voter.should == @voter
       voting.up_vote.should == true
@@ -95,15 +95,15 @@ describe "Voter Love" do
       @votable.down_votes.should == 1
       @voter.up_votes.should == 0
       @voter.down_votes.should == 1
-      VoterLove::Votes.count.should == 1
-      VoterLove::Votes.first.up_vote.should be_false
+      VoterLove::Vote.count.should == 1
+      VoterLove::Vote.first.up_vote.should be_false
       @voter.up_vote(@votable)
       @votable.up_votes.should == 1
       @votable.down_votes.should == 0
       @voter.up_votes.should == 1
       @voter.down_votes.should == 0
-      VoterLove::Votes.count.should == 1
-      VoterLove::Votes.first.up_vote.should be_true
+      VoterLove::Vote.count.should == 1
+      VoterLove::Vote.first.up_vote.should be_true
     end
 
     it "should allow up votes from different voters" do
@@ -111,7 +111,7 @@ describe "Voter Love" do
       @voter.up_vote(@votable)
       @voter2.up_vote(@votable)
       @votable.up_votes.should == 2
-      VoterLove::Votes.count.should == 2
+      VoterLove::Vote.count.should == 2
     end
 
     it "should raise an error for an invalid votable" do
@@ -141,10 +141,10 @@ describe "Voter Love" do
     end
 
     it "should create a voting" do
-      VoterLove::Votes.count.should == 0
+      VoterLove::Vote.count.should == 0
       @voter.down_vote(@votable)
-      VoterLove::Votes.count.should == 1
-      voting = VoterLove::Votes.first
+      VoterLove::Vote.count.should == 1
+      voting = VoterLove::Vote.first
       voting.votable.should == @votable
       voting.voter.should == @voter
       voting.up_vote.should == false
@@ -160,7 +160,7 @@ describe "Voter Love" do
       lambda {
         @voter.down_vote!(@votable).should == false
       }.should_not raise_error(VoterLove::Exceptions::AlreadyVotedError)
-      VoterLove::Votes.count.should == 1
+      VoterLove::Vote.count.should == 1
     end
 
     it "should change an up vote to a down vote" do
@@ -169,15 +169,15 @@ describe "Voter Love" do
       @votable.down_votes.should == 0
       @voter.up_votes.should == 1
       @voter.down_votes.should == 0
-      VoterLove::Votes.count.should == 1
-      VoterLove::Votes.first.up_vote.should be_true
+      VoterLove::Vote.count.should == 1
+      VoterLove::Vote.first.up_vote.should be_true
       @voter.down_vote(@votable)
       @votable.up_votes.should == 0
       @votable.down_votes.should == 1
       @voter.up_votes.should == 0
       @voter.down_votes.should == 1
-      VoterLove::Votes.count.should == 1
-      VoterLove::Votes.first.up_vote.should be_false
+      VoterLove::Vote.count.should == 1
+      VoterLove::Vote.first.up_vote.should be_false
     end
 
     it "should allow down votes from different voters" do
@@ -185,7 +185,7 @@ describe "Voter Love" do
       @voter.down_vote(@votable)
       @voter2.down_vote(@votable)
       @votable.down_votes.should == 2
-      VoterLove::Votes.count.should == 2
+      VoterLove::Vote.count.should == 2
     end
 
     it "should raise an error for an invalid votable" do
@@ -200,37 +200,4 @@ describe "Voter Love" do
       @voter.down_voted?(@votable).should be_true
     end
   end
-
-  describe "unvote" do
-    it "should decrease the up votes if up voted before" do
-      @voter.up_vote(@votable)
-      @votable.up_votes.should == 1
-      @voter.up_votes.should == 1
-      @voter.unvote(@votable)
-      @votable.up_votes.should == 0
-      @voter.up_votes.should == 0
-    end
-
-    it "should remove the voting" do
-      @voter.up_vote(@votable)
-      VoterLove::Votes.count.should == 1
-      @voter.unvote(@votable)
-      VoterLove::Votes.count.should == 0
-    end
-
-    it "should raise an error if voter didn't vote for the votable" do
-      lambda { @voter.unvote(@votable) }.should raise_error(VoterLove::Exceptions::NotVotedError)
-    end
-
-    it "should not raise error if voter didn't vote for the votable and unvote! is called" do
-      lambda {
-        @voter.unvote!(@votable).should == false
-      }.should_not raise_error(VoterLove::Exceptions::NotVotedError)
-    end
-
-    it "should raise an error for an invalid votable" do
-      invalid_votable = InvalidVotableModel.create
-      lambda { @voter.unvote(invalid_votable) }.should raise_error(VoterLove::Exceptions::InvalidVotableError)
-    end
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: voter_love
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-18 00:00:00.000000000Z
+date: 2011-10-22 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2166491860 !ruby/object:Gem::Requirement
+  requirement: &2158069260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2166491860
+  version_requirements: *2158069260
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &2166491360 !ruby/object:Gem::Requirement
+  requirement: &2158068760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2166491360
+  version_requirements: *2158068760
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2166490900 !ruby/object:Gem::Requirement
+  requirement: &2158068300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2166490900
+  version_requirements: *2158068300
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: &2166490440 !ruby/object:Gem::Requirement
+  requirement: &2158067840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -54,10 +54,10 @@ dependencies:
         version: 0.6.7
   type: :development
   prerelease: false
-  version_requirements: *2166490440
+  version_requirements: *2158067840
 - !ruby/object:Gem::Dependency
   name: sqlite3-ruby
-  requirement: &2166489980 !ruby/object:Gem::Requirement
+  requirement: &2158067380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.3.0
   type: :development
   prerelease: false
-  version_requirements: *2166489980
+  version_requirements: *2158067380
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2166489520 !ruby/object:Gem::Requirement
+  requirement: &2158066920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 2.5.0
   type: :development
   prerelease: false
-  version_requirements: *2166489520
+  version_requirements: *2158066920
 - !ruby/object:Gem::Dependency
   name: generator_spec
-  requirement: &2166489060 !ruby/object:Gem::Requirement
+  requirement: &2158066460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,7 +87,7 @@ dependencies:
         version: 0.8.2
   type: :development
   prerelease: false
-  version_requirements: *2166489060
+  version_requirements: *2158066460
 description: The voter_love Gem allows users to easily vote on objects
 email:
 - karlgusner@gmail.com