voterable 0.0.4 → 0.0.5

data/lib/voterable/version.rb

@@ -1,3 +1,3 @@
 module Voterable # :nodoc:
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/voterable/vote.rb

@@ -3,10 +3,8 @@ module Voterable
    # A vote object represents a vote made on a voteable object by a voter
    # 
    # Example:
-   # == Vote.vote = :up
-   # => :up
-   # == Vote.vote
-   # => :up
+   #  Vote.vote = :up # => :up
+   #  Vote.vote       # => :up
    # 
    # A vote belongs_to both a Voterable::Voter and a Voterable::Voteable
    #

data/lib/voterable/voteable.rb

@@ -82,10 +82,12 @@ module Voterable
          page = ( hsh[:page].to_i >= 1 ? hsh[:page].to_i : 1 ) 
          skip_count = (page-1)*hsh[:limit]
 
+         sorted = nil
+
          case hsh[:period]
          when :latest
             # return self.order_by(:created_at, :desc).page(hsh[:page]).per(hsh[:limit])
-            return self.order_by(:created_at, :desc).skip(skip_count).limit(hsh[:limit])
+            sorted = self.order_by(:created_at, :desc).skip(skip_count).limit(hsh[:limit])
          when :all_time
             index = '0.'
          when :year
@@ -98,10 +100,10 @@ module Voterable
             index = '4.'
          end
 
-         string = "tallys." + index + hsh[:tally_type].to_s
-
-         #self.order_by(string,:desc).page(hsh[:page]).per(hsh[:limit]) #.where(:tallys.exists => true)
-         sorted = self.order_by(string,:desc).skip(skip_count).limit(hsh[:limit]) #.where(:tallys.exists => true)
+         unless sorted
+            string = "tallys." + index + hsh[:tally_type].to_s
+            sorted = self.order_by(string,:desc).skip(skip_count).limit(hsh[:limit]) #.where(:tallys.exists => true)
+         end
 
          # Array into the class and add necessary methods for pagination
          sorted.instance_variable_set("@current_page", page)
@@ -131,7 +133,9 @@ module Voterable
 
       # Vote the voteable thing up or down 
       #
-      # @parma [ vtr ] voter object that will be doing the voting
+      # @parma [ Voterable::Voter ] voter Voter that will be doing the voting
+      # @param [ Symbol ] value Value of the vote, either :up or :down
+      #
       # @return [ vote ] vote that was cast
       def vote(vtr, value)
 

data/lib/voterable/voter.rb

@@ -15,15 +15,22 @@ module Voterable
 
       field :reputation,    :type => Integer, default: 0
 
+      # Vote on voteable thing
+      #
+      # @example Current user voting on an emoticon
+      #   current_user.vote(emoticon, :up)
+      # 
+      # @param [ Voterable::Voteable ] voteable The thing that is being voted on
+      # @param [ Symbol ] value The vote value either :up or :down
       def vote(voteable, value)
          voteable.vote(self, value)
       end
 
       ##
       # Retuns the number of votes cast by user
-      # Example:
-      #   >> a_voter.vote_count([1.days_in_seconds, 5.days_in_seconds])
-      #   => 10
+      # @example:
+      #   a_voter.vote_count([1.days_in_seconds, 5.days_in_seconds])
+      #   10
       # Arguments:
       #   period: (array) time between which votes are counted, going backwards from now
       #           
@@ -34,6 +41,11 @@ module Voterable
          self.votes.where(:updated_at.lte => time_2).and(:updated_at.gte => time_1).count
       end
 
+      # Recalculates user's reputation 
+      #
+      # @example recalculating a current_user's reputation
+      #   current_user.calculate_reputation
+      #
       def calculate_reputation
          #Contributed things
          # sum = self.things.count + self.things.count 

data/spec/voteable_spec.rb

@@ -8,9 +8,9 @@ describe Voterable::Voteable do #:nodoc: all
 
       before(:each) do
          @voter = Factory(:voter)
-         @third  = Factory.create(:voteable, :point => -1)
-         @first  = Factory.create(:voteable, :point => 99)
-         @second = Factory.create(:voteable) #Should Assume 0 points
+         @third  = Factory.create(:voteable, :point => -1, :created_at => 2)
+         @first  = Factory.create(:voteable, :point => 99, :created_at => 1)
+         @second = Factory.create(:voteable, :created_at => 0) #Should Assume 0 points
       end
 
       it{@third.point.should  == -1}
@@ -34,6 +34,14 @@ describe Voterable::Voteable do #:nodoc: all
          it{@all[2].should == @third}
       end
 
+      context "when sorting by latest" do
+         before{@all = Voteable.sort_by(:period => :latest)}
+
+         it{@all[0].should == @third}
+         it{@all[1].should == @first}
+         it{@all[2].should == @second}
+      end
+
       describe "checking for correct pagination" do
          
          before(:each) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: voterable
 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-12-09 00:00:00.000000000Z
+date: 2011-12-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &70274674400260 !ruby/object:Gem::Requirement
+  requirement: &70137966354900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -21,10 +21,10 @@ dependencies:
         version: 2.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *70274674400260
+  version_requirements: *70137966354900
 - !ruby/object:Gem::Dependency
   name: bson
-  requirement: &70274674399620 !ruby/object:Gem::Requirement
+  requirement: &70137966354280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -32,10 +32,10 @@ dependencies:
         version: 1.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *70274674399620
+  version_requirements: *70137966354280
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &70274674399020 !ruby/object:Gem::Requirement
+  requirement: &70137966353740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -43,10 +43,10 @@ dependencies:
         version: 1.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *70274674399020
+  version_requirements: *70137966353740
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70274674398520 !ruby/object:Gem::Requirement
+  requirement: &70137966353360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70274674398520
+  version_requirements: *70137966353360
 - !ruby/object:Gem::Dependency
   name: factory_girl
-  requirement: &70274674397840 !ruby/object:Gem::Requirement
+  requirement: &70137966352800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 2.1.0
   type: :development
   prerelease: false
-  version_requirements: *70274674397840
+  version_requirements: *70137966352800
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70274674397300 !ruby/object:Gem::Requirement
+  requirement: &70137966352320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70274674397300
+  version_requirements: *70137966352320
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70274674396640 !ruby/object:Gem::Requirement
+  requirement: &70137966351580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70274674396640
+  version_requirements: *70137966351580
 - !ruby/object:Gem::Dependency
   name: guard-spork
-  requirement: &70274674396020 !ruby/object:Gem::Requirement
+  requirement: &70137966349520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70274674396020
+  version_requirements: *70137966349520
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: &70274674395420 !ruby/object:Gem::Requirement
+  requirement: &70137966347960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70274674395420
+  version_requirements: *70137966347960
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70274674389380 !ruby/object:Gem::Requirement
+  requirement: &70137966345920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70274674389380
+  version_requirements: *70137966345920
 - !ruby/object:Gem::Dependency
   name: growl
-  requirement: &70274674388880 !ruby/object:Gem::Requirement
+  requirement: &70137966344500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70274674388880
+  version_requirements: *70137966344500
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70274674387240 !ruby/object:Gem::Requirement
+  requirement: &70137966343960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,7 +142,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70274674387240
+  version_requirements: *70137966343960
 description: Hackish implementaiton of voting on of voteable objects by a voter
 email:
 - benguest@gmail.com