acts_as_votable 0.1.3 → 0.2.0

data/Gemfile.lock

@@ -1,87 +1,98 @@
 PATH
   remote: .
   specs:
-    acts_as_votable (0.1.3)
+    acts_as_votable (0.2.0)
       rails (>= 3.0.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    abstract (1.0.0)
-    actionmailer (3.0.9)
-      actionpack (= 3.0.9)
-      mail (~> 2.2.19)
-    actionpack (3.0.9)
-      activemodel (= 3.0.9)
-      activesupport (= 3.0.9)
-      builder (~> 2.1.2)
-      erubis (~> 2.6.6)
-      i18n (~> 0.5.0)
-      rack (~> 1.2.1)
-      rack-mount (~> 0.6.14)
-      rack-test (~> 0.5.7)
-      tzinfo (~> 0.3.23)
-    activemodel (3.0.9)
-      activesupport (= 3.0.9)
-      builder (~> 2.1.2)
-      i18n (~> 0.5.0)
-    activerecord (3.0.9)
-      activemodel (= 3.0.9)
-      activesupport (= 3.0.9)
-      arel (~> 2.0.10)
-      tzinfo (~> 0.3.23)
-    activeresource (3.0.9)
-      activemodel (= 3.0.9)
-      activesupport (= 3.0.9)
-    activesupport (3.0.9)
-    arel (2.0.10)
-    builder (2.1.2)
-    diff-lcs (1.1.2)
-    erubis (2.6.6)
-      abstract (>= 1.0.0)
-    i18n (0.5.0)
-    mail (2.2.19)
-      activesupport (>= 2.3.6)
+    actionmailer (3.2.3)
+      actionpack (= 3.2.3)
+      mail (~> 2.4.4)
+    actionpack (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.2)
+    activemodel (3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+    activerecord (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    journey (1.0.3)
+    json (1.6.6)
+    mail (2.4.4)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.16)
-    polyglot (0.3.2)
-    rack (1.2.3)
-    rack-mount (0.6.14)
-      rack (>= 1.0.0)
-    rack-test (0.5.7)
+    mime-types (1.18)
+    multi_json (1.2.0)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
       rack (>= 1.0)
-    rails (3.0.9)
-      actionmailer (= 3.0.9)
-      actionpack (= 3.0.9)
-      activerecord (= 3.0.9)
-      activeresource (= 3.0.9)
-      activesupport (= 3.0.9)
+    rails (3.2.3)
+      actionmailer (= 3.2.3)
+      actionpack (= 3.2.3)
+      activerecord (= 3.2.3)
+      activeresource (= 3.2.3)
+      activesupport (= 3.2.3)
       bundler (~> 1.0)
-      railties (= 3.0.9)
-    railties (3.0.9)
-      actionpack (= 3.0.9)
-      activesupport (= 3.0.9)
+      railties (= 3.2.3)
+    railties (3.2.3)
+      actionpack (= 3.2.3)
+      activesupport (= 3.2.3)
+      rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
-      thor (~> 0.14.4)
-    rake (0.9.2)
-    rdoc (3.8)
-    rspec (2.3.0)
-      rspec-core (~> 2.3.0)
-      rspec-expectations (~> 2.3.0)
-      rspec-mocks (~> 2.3.0)
-    rspec-core (2.3.1)
-    rspec-expectations (2.3.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.3.0)
-    sqlite3 (1.3.3)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    sprockets (2.1.2)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.5)
     thor (0.14.6)
+    tilt (1.3.3)
     treetop (1.4.10)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.29)
+    tzinfo (0.3.33)
 
 PLATFORMS
   ruby

data/README.markdown

@@ -77,7 +77,7 @@ Revisiting the previous example of code.
     # negative votes
     @post.downvote_from @user2
     @post.vote :voter => @user2, :vote => 'bad'
-    
+
     # tally them up!
     @post.votes.size # => 5
     @post.likes.size # => 3
@@ -85,6 +85,33 @@ Revisiting the previous example of code.
     @post.dislikes.size # => 2
     @post.downvotes.size # => 2
 
+Active Record scopes are provided to make life easier.
+
+    @post.votes.up.by_type(User)
+    @post.votes.down
+    @user1.votes.up
+    @user1.votes.down
+    @user1.votes.up.by_type(Post)
+
+Once scoping is complete, you can also trigger a get for the
+voter/votable
+
+    @post.votes.up.by_type(User).voters
+    @post.votes.down.by_type(User).voters
+
+    @user.votes.up.for_type(Post).votables
+    @user.votes.up.votables
+
+You can also 'unvote' a model to remove a previous vote.
+
+    @post.liked_by @user1
+    @post.unlike_by @user1
+
+    @post.disliked_by @user1
+    @post.undisliked_by @user1
+
+Unvoting works for both positive and negative votes.
+
 ### The Voter
 
 You can have your voters ``acts_as_voter`` to provide some reserve functionality.

data/lib/acts_as_votable/version.rb

@@ -1,3 +1,3 @@
 module ActsAsVotable
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/acts_as_votable/votable.rb

@@ -26,13 +26,20 @@ module ActsAsVotable
 
         :down_votes => [
           :false_votes, :downs, :downvotes, :dislikes, :negatives
+        ],
+        :unvote => [
+          :unliked_by, :undisliked_by
         ]
-
       }
 
       base.class_eval do
 
         belongs_to :votable, :polymorphic => true
+        has_many   :votes, :class_name => "ActsAsVotable::Vote", :as => :votable do
+          def voters
+            includes(:voter).map(&:voter)
+          end
+        end
 
         aliases.each do |method, links|
           links.each do |new_method|
@@ -70,12 +77,12 @@ module ActsAsVotable
       end
 
       # find the vote
-      votes = find_votes({
+      _votes_ = find_votes({
         :voter_id => options[:voter].id,
         :voter_type => options[:voter].class.name
       })
 
-      if votes.count == 0
+      if _votes_.count == 0
         # this voter has never voted
         vote = ActsAsVotable::Vote.new(
           :votable => self,
@@ -83,7 +90,7 @@ module ActsAsVotable
         )
       else
         # this voter is potentially changing his vote
-        vote = votes.first
+        vote = _votes_.first
       end
 
       last_update = vote.updated_at
@@ -101,6 +108,17 @@ module ActsAsVotable
 
     end
 
+    def unvote args = {}
+      return false if args[:voter].nil?
+      _votes_ = find_votes(:voter_id => args[:voter].id, :voter_type => args[:voter].class.name)
+
+      return true if _votes_.size == 0
+      _votes_.each(&:destroy)
+      update_cached_votes
+      self.vote_registered = false if votes.count == 0
+      return true
+    end
+
     def vote_up voter
       self.vote :voter => voter, :vote => true
     end
@@ -133,9 +151,8 @@ module ActsAsVotable
 
     # results
     def find_votes extra_conditions = {}
-      ActsAsVotable::Vote.find(:all, :conditions => default_conditions.merge(extra_conditions))
+      votes.where(extra_conditions)
     end
-    alias :votes :find_votes
 
     def up_votes
       find_votes(:vote_flag => true)
@@ -151,27 +168,27 @@ module ActsAsVotable
       if !skip_cache && self.respond_to?(:cached_votes_total)
         return self.send(:cached_votes_total)
       end
-      find_votes.size
+      find_votes.count
     end
 
     def count_votes_up skip_cache = false
       if !skip_cache && self.respond_to?(:cached_votes_up)
         return self.send(:cached_votes_up)
       end
-      up_votes.size
+      up_votes.count
     end
 
     def count_votes_down skip_cache = false
       if !skip_cache && self.respond_to?(:cached_votes_down)
         return self.send(:cached_votes_down)
       end
-      down_votes.size
+      down_votes.count
     end
 
     # voters
     def voted_on_by? voter
       votes = find_votes :voter_id => voter.id, :voter_type => voter.class.name
-      votes.size > 0
+      votes.count > 0
     end
 
   end

data/lib/acts_as_votable/vote.rb

@@ -13,6 +13,11 @@ module ActsAsVotable
     belongs_to :votable, :polymorphic => true
     belongs_to :voter, :polymorphic => true
 
+    scope :up, where(:vote_flag => true)
+    scope :down, where(:vote_flag => false)
+    scope :for_type, lambda{ |klass| where(:votable_type => klass) }
+    scope :by_type,  lambda{ |klass| where(:voter_type => klass) }
+
     validates_presence_of :votable_id
     validates_presence_of :voter_id
 

data/lib/acts_as_votable/voter.rb

@@ -5,13 +5,19 @@ module ActsAsVotable
 
       # allow user to define these
       aliases = {
-        :vote_up_for => [:likes, :upvotes, :up_votes],
-        :vote_down_for => [:dislikes, :downvotes, :down_votes]
+        :vote_up_for   => [:likes, :upvotes, :up_votes],
+        :vote_down_for => [:dislikes, :downvotes, :down_votes],
+        :unvote_for    => [:unlike, :undislike]
       }
 
       base.class_eval do
 
         belongs_to :voter, :polymorphic => true
+        has_many :votes, :class_name => "ActsAsVotable::Vote", :as => :voter do
+          def votables
+            includes(:votable).map(&:votable)
+          end
+        end
 
         aliases.each do |method, links|
           links.each do |new_method|
@@ -23,19 +29,12 @@ module ActsAsVotable
 
     end
 
-    def default_conditions
-      {
-        :voter_id => self.id,
-        :voter_type => self.class.name
-      }
-    end
-
     # voting
     def vote args
       args[:votable].vote args.merge({:voter => self})
     end
 
-    def vote_up_for model
+    def vote_up_for model=nil
       vote :votable => model, :vote => true
     end
 
@@ -43,6 +42,10 @@ module ActsAsVotable
       vote :votable => model, :vote => false
     end
 
+    def unvote_for model
+      model.unvote :voter => self
+    end
+
     # results
     def voted_on? votable
       votes = find_votes(:votable_id => votable.id, :votable_type => votable.class.name)
@@ -58,9 +61,8 @@ module ActsAsVotable
     alias :voted_as_when_voted_for :voted_as_when_voting_on
 
     def find_votes extra_conditions = {}
-      ActsAsVotable::Vote.find(:all, :conditions => default_conditions.merge(extra_conditions))
+      votes.where(extra_conditions)
     end
-    alias :votes :find_votes
 
     def find_up_votes
       find_votes :vote_flag => true
@@ -82,6 +84,5 @@ module ActsAsVotable
       find_votes_for_class klass, :vote_flag => false
     end
 
- 
   end
 end

data/spec/votable_spec.rb

@@ -14,7 +14,7 @@ describe ActsAsVotable::Votable do
   it "should be votable" do
     Votable.should be_votable
   end
- 
+
   describe "voting on a votable object" do
 
     before(:each) do
@@ -24,7 +24,7 @@ describe ActsAsVotable::Votable do
 
       @voter2 = Voter.new(:name => 'a new person')
       @voter2.save
-      
+
       @votable = Votable.new(:name => 'a voting model')
       @votable.save
     end
@@ -37,7 +37,7 @@ describe ActsAsVotable::Votable do
       @votable.vote :voter => @voter, :vote => 'yes'
       @votable.votes.size.should == 1
     end
-    
+
     it "should have one vote when voted on twice by the same person" do
       @votable.vote :voter => @voter, :vote => 'yes'
       @votable.vote :voter => @voter, :vote => 'no'
@@ -87,7 +87,7 @@ describe ActsAsVotable::Votable do
       @votable.vote :voter => @voter, :vote => 'yes'
       @votable.vote_registered?.should be false
     end
-    
+
     it "should count the vote as registered if the voter has voted and the vote has changed" do
       @votable.vote :voter => @voter, :vote => true
       @votable.vote :voter => @voter, :vote => 'dislike'
@@ -99,10 +99,35 @@ describe ActsAsVotable::Votable do
       @votable.voted_on_by?(@voter).should be true
     end
 
+    it "should unvote a positive vote" do
+      @votable.vote :voter => @voter
+      @votable.unvote :voter => @voter
+      @votable.find_votes.count.should == 0
+    end
+
+    it "should set the votable to unregistered after unvoting" do
+      @votable.vote :voter => @voter
+      @votable.unvote :voter => @voter
+      @votable.vote_registered?.should be false
+    end
+
+    it "should unvote a negative vote" do
+      @votable.vote :voter => @voter, :vote => 'no'
+      @votable.unvote :voter => @voter
+      @votable.find_votes.count.should == 0
+    end
+
+    it "should unvote only the from a single voter" do
+      @votable.vote :voter => @voter
+      @votable.vote :voter => @voter2
+      @votable.unvote :voter => @voter
+      @votable.find_votes.count.should == 1
+    end
+
     it "should be contained to instances" do
       votable2 = Votable.new(:name => '2nd votable')
       votable2.save
-      
+
       @votable.vote :voter => @voter, :vote => false
       votable2.vote :voter => @voter, :vote => true
       votable2.vote :voter => @voter, :vote => true
@@ -135,6 +160,18 @@ describe ActsAsVotable::Votable do
         @votable_cache.cached_votes_total.should == 1
       end
 
+      it "should update cached total votes when a vote up is removed" do
+        @votable_cache.vote :voter => @voter, :vote => 'true'
+        @votable_cache.unvote :voter => @voter
+        @votable_cache.cached_votes_total.should == 0
+      end
+
+      it "should update cached total votes when a vote down is removed" do
+        @votable_cache.vote :voter => @voter, :vote => 'false'
+        @votable_cache.unvote :voter => @voter
+        @votable_cache.cached_votes_total.should == 0
+      end
+
       it "should update cached up votes if there is an up vote column" do
         @votable_cache.cached_votes_up = 50
         @votable_cache.vote :voter => @voter
@@ -148,6 +185,18 @@ describe ActsAsVotable::Votable do
         @votable_cache.cached_votes_down.should == 1
       end
 
+      it "should update cached up votes when a vote up is removed" do
+        @votable_cache.vote :voter => @voter, :vote => 'true'
+        @votable_cache.unvote :voter => @voter
+        @votable_cache.cached_votes_up.should == 0
+      end
+
+      it "should update cached down votes when a vote down is removed" do
+        @votable_cache.vote :voter => @voter, :vote => 'false'
+        @votable_cache.unvote :voter => @voter
+        @votable_cache.cached_votes_down.should == 0
+      end
+
       it "should select from cached total votes if there a total column" do
         @votable_cache.vote :voter => @voter
         @votable_cache.cached_votes_total = 50

data/spec/voter_spec.rb

@@ -14,7 +14,7 @@ describe ActsAsVotable::Voter do
   it "should be a voter" do
     Votable.should be_votable
   end
- 
+
   describe "voting by a voter" do
 
     before(:each) do
@@ -24,7 +24,7 @@ describe ActsAsVotable::Voter do
 
       @voter2 = Voter.new(:name => 'a new person')
       @voter2.save
-      
+
       @votable = Votable.new(:name => 'a voting model')
       @votable.save
 
@@ -63,44 +63,59 @@ describe ActsAsVotable::Voter do
     it "should allow the voter to vote up a model" do
       @voter.vote_up_for @votable
       @votable.up_votes.first.voter.should == @voter
+      @votable.votes.up.first.voter.should == @voter
     end
 
     it "should allow the voter to vote down a model" do
       @voter.vote_down_for @votable
       @votable.down_votes.first.voter.should == @voter
+      @votable.votes.down.first.voter.should == @voter
+    end
+
+    it "should allow the voter to unvote a model" do
+      @voter.vote_up_for @votable
+      @voter.unvote_for @votable
+      @votable.find_votes.size.should == 0
+      @votable.votes.count.should == 0
     end
 
     it "should get all of the voters votes" do
       @voter.vote_up_for @votable
       @voter.find_votes.size.should == 1
+      @voter.votes.up.count.should == 1
     end
 
     it "should get all of the voters up votes" do
       @voter.vote_up_for @votable
       @voter.find_up_votes.size.should == 1
+      @voter.votes.up.count.should == 1
     end
 
     it "should get all of the voters down votes" do
       @voter.vote_down_for @votable
       @voter.find_down_votes.size.should == 1
+      @voter.votes.down.count.should == 1
     end
 
     it "should get all of the votes votes for a class" do
       @votable.vote :voter => @voter
       @votable2.vote :voter => @voter, :vote => false
       @voter.find_votes_for_class(Votable).size.should == 2
+      @voter.votes.for_type(Votable).count.should == 2
     end
 
     it "should get all of the voters up votes for a class" do
       @votable.vote :voter => @voter
       @votable2.vote :voter => @voter, :vote => false
       @voter.find_up_votes_for_class(Votable).size.should == 1
+      @voter.votes.up.for_type(Votable).count.should == 1
     end
 
     it "should get all of the voters down votes for a class" do
       @votable.vote :voter => @voter
       @votable2.vote :voter => @voter, :vote => false
       @voter.find_down_votes_for_class(Votable).size.should == 1
+      @voter.votes.down.for_type(Votable).count.should == 1
     end
 
     it "should be contained to instances" do
@@ -111,6 +126,4 @@ describe ActsAsVotable::Voter do
     end
 
   end
-
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_votable
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-30 00:00:00.000000000Z
+date: 2012-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &16691480 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16691480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &16690620 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16690620
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &16689540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +53,12 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *16689540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 description: Rails gem to allowing records to be votable
 email:
 - ryanto
@@ -85,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -862519095556043161
+      hash: 2055289200548922413
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -94,10 +109,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -862519095556043161
+      hash: 2055289200548922413
 requirements: []
 rubyforge_project: acts_as_votable
-rubygems_version: 1.8.6
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Rails gem to allowing records to be votable