mongoid_rateable 0.0.8 → 0.1.0

data/README.rdoc

@@ -52,11 +52,11 @@ Sure, you can rate and save in one fuction:
 
 You'll often want to know if a user already rated post.  Simple:
 
-    @post.rated? @user      # True if it rated by user
+    @post.rated_by? @user   # True if it rated by user
 
 And if someone rated it:
 
-    @post.rated?      # True if it rated by anyone
+    @post.rated?            # True if it rated by someone
 
 You can also get a tally of the number of votes cast:
 
@@ -64,7 +64,7 @@ You can also get a tally of the number of votes cast:
 
 You can get the average rating:
 
-    @post.rating      # rates / raters.count
+    @post.rating            # rates / raters.count
 
 == Contributing to Mongoid::Rateable
 

data/Rakefile

@@ -3,6 +3,7 @@
 require 'rubygems'
 require 'rake'
 require 'bundler'
+Bundler::GemHelper.install_tasks
 
 begin
   Bundler.setup(:default, :development)

data/TODO

@@ -1,5 +1,8 @@
-add method/scope most_voted(count), rated_between(,) to Rateable
+add method/scope most_voted(count), rated_between(3,5), rated_by(user) to Rateable
 add min/max rating
 store rate_count and average_rate as fields (need migration to migrate from other versions)
 improve speed (http://cookbook.mongodb.org/patterns/votes/)
-rate embedded (indexes?!)
+rate embedded (indexes?!)
+add random values to specs
+add task for rating update
+look at https://github.com/jasherai/acts-as-rated features

data/VERSION

@@ -1 +1 @@
-0.0.8
+0.1.0

data/lib/mongoid_rateable/rateable.rb

@@ -4,7 +4,11 @@ module Mongoid
 
 		included do
 			field :rates, :type => Integer, :default => 0
+			field :rating, :type => Float, :default => nil
+			field :rate_count, :type => Integer, :default => 0
+
 			embeds_many :rating_marks, :as => :rateable
+
 			index(
 				[
 					["rating_marks.rater_id"],
@@ -17,17 +21,15 @@ module Mongoid
 		module InstanceMethods
 
 			def rate(mark, rater)
-				unrate(rater)
+				unrate_without_rating_update(rater)
 				self.rates += mark.to_i
 				self.rating_marks.new(:rater_id => rater.id, :mark => mark, :rater_class => rater.class.to_s)
+				update_rating
 			end
 
 			def unrate(rater)
-				mark = self.rating_marks.where(:rater_id => rater.id, :rater_class => rater.class.to_s).first
-				if mark
-					self.rates -= mark.mark.to_i
-					mark.delete
-				end
+				unrate_without_rating_update(rater)
+				update_rating
 			end
 
 			def rate_and_save(mark, rater)
@@ -42,22 +44,46 @@ module Mongoid
 
 			def rated?(rater = nil)
 				if rater
-					self.rating_marks.where(:rater_id => rater.id, :rater_class => rater.class.to_s).count == 1
+					puts "Deprecated method, please use rated_by?"
+					rated_by?(rater)
 				else
-					!self.rating_marks.empty?
+					rate_count!=0
 				end
 			end
 
+			def rated_by?(rater)
+				self.rating_marks.where(:rater_id => rater.id, :rater_class => rater.class.to_s).count == 1
+			end
+
 			def rating
-				if self.rating_marks.blank?
-					nil
-				else
-					self.rates.to_f / self.rating_marks.size
-				end
+				read_attribute(:rating) || calculate_and_store_rating
 			end
 
 			def rate_count
-				self.rating_marks.size
+				rating_marks.size
+			end
+
+			private
+
+			def unrate_without_rating_update(rater)
+				rmark = self.rating_marks.where(:rater_id => rater.id, :rater_class => rater.class.to_s).first
+				if rmark
+					self.rates -= rmark.mark.to_i
+					rmark.delete
+				end
+			end
+
+			def update_rating
+ 				rt = (self.rates.to_f / self.rating_marks.size) unless self.rating_marks.blank?
+ 				write_attribute(:rating, rt)
+			end
+
+			def calculate_and_store_rating
+				unless self.rating_marks.empty?
+					update_rating
+					read_attribute(:rating)
+				end
+				nil
 			end
 
 		end

data/mongoid_rateable.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongoid_rateable}
-  s.version = "0.0.8"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Peter Savichev (proton)"]
-  s.date = %q{2011-06-30}
+  s.date = %q{2011-07-13}
   s.description = %q{Provides fields and methods for the manipulation of rates on Mongoid documents.}
   s.email = %q{psavichev@gmail.com}
   s.extra_rdoc_files = [

data/spec/rateable_spec.rb

@@ -70,20 +70,20 @@ describe Post do
       end
 
       describe "for Bob" do
-        specify { @post.rated?(@bob).should be_true }
+        specify { @post.rated_by?(@bob).should be_true }
       end
 
       describe "when rated by someone else" do
         before { @post.rate 1, @alice }
 
         describe "for Alice" do
-          specify { @post.rated?(@alice).should be_true }
+          specify { @post.rated_by?(@alice).should be_true }
         end
       end
 
       describe "when not rated by someone else" do
         describe "for Sally" do
-          specify { @post.rated?(@sally).should be_false }
+          specify { @post.rated_by?(@sally).should be_false }
         end
       end
     end
@@ -117,7 +117,7 @@ describe Post do
         @post.rating.should eql 2.5
       end
 
-      it "should average if the result is zero" do
+      it "should calculate the average rate if the result is zero" do
         @post.rate -1, @sally
         @post.rating.should eql 0.0
       end
@@ -154,17 +154,17 @@ describe Post do
       @finded_post = Post.where(:name => "Announcement").first
     end
 
-    describe "#rated?" do
+    describe "#rated_by?" do
       describe "for Bob" do
-        specify { @finded_post.rated?(@bob).should be_true }
+        specify { @finded_post.rated_by?(@bob).should be_true }
       end
 
       describe "for Sally" do
-        specify { @finded_post.rated?(@sally).should be_true }
+        specify { @finded_post.rated_by?(@sally).should be_true }
       end
 
       describe "for Alice" do
-        specify { @finded_post.rated?(@alice).should be_false}
+        specify { @finded_post.rated_by?(@alice).should be_false}
       end
     end
 
@@ -190,15 +190,15 @@ describe Post do
 
     describe "#rated?" do
 			it "should be #rated? by Bob" do
-				@finded_post.rated?(@bob).should be_true
+				@finded_post.rated_by?(@bob).should be_true
 			end
 
 			it "should be #rated? by Sally" do
-				@finded_post.rated?(@sally).should be_true
+				@finded_post.rated_by?(@sally).should be_true
 			end
 
 			it "should be not #rated? by Alice" do
-				@finded_post.rated?(@alice).should be_false
+				@finded_post.rated_by?(@alice).should be_false
 			end
     end
 
@@ -222,11 +222,11 @@ describe Post do
 
 			describe "#rated?" do
 				it "should be #rated? by Bob" do
-					@finded_post.rated?(@bob).should be_true
+					@finded_post.rated_by?(@bob).should be_true
 				end
 
 				it "should be not #rated? by Sally" do
-					@finded_post.rated?(@sally).should be_false
+					@finded_post.rated_by?(@sally).should be_false
 				end
 
 				it "should be #rated?" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_rateable
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-30 00:00:00.000000000 +04:00
+date: 2011-07-13 00:00:00.000000000 +04:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &77632090 !ruby/object:Gem::Requirement
+  requirement: &86246380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *77632090
+  version_requirements: *86246380
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &77631840 !ruby/object:Gem::Requirement
+  requirement: &86246140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *77631840
+  version_requirements: *86246140
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &77631580 !ruby/object:Gem::Requirement
+  requirement: &86245900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *77631580
+  version_requirements: *86245900
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &77631320 !ruby/object:Gem::Requirement
+  requirement: &86245660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: 1.6.2
   type: :development
   prerelease: false
-  version_requirements: *77631320
+  version_requirements: *86245660
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &77631060 !ruby/object:Gem::Requirement
+  requirement: &86245410 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: 0.4.0
   type: :development
   prerelease: false
-  version_requirements: *77631060
+  version_requirements: *86245410
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &77630810 !ruby/object:Gem::Requirement
+  requirement: &86245170 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *77630810
+  version_requirements: *86245170
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &77630570 !ruby/object:Gem::Requirement
+  requirement: &86244920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +88,10 @@ dependencies:
         version: 2.0.0
   type: :development
   prerelease: false
-  version_requirements: *77630570
+  version_requirements: *86244920
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: &77630320 !ruby/object:Gem::Requirement
+  requirement: &86244680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,7 +99,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *77630320
+  version_requirements: *86244680
 description: Provides fields and methods for the manipulation of rates on Mongoid
   documents.
 email: psavichev@gmail.com
@@ -143,7 +143,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1019547357
+      hash: 839326095
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: