mongoid_rateable 0.1.5 → 0.1.6

data/Gemfile.lock

@@ -1,30 +1,34 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.0.9)
-      activesupport (= 3.0.9)
-      builder (~> 2.1.2)
-      i18n (~> 0.5.0)
-    activesupport (3.0.9)
-    bson (1.3.1)
-    bson_ext (1.3.1)
-    builder (2.1.2)
+    activemodel (3.1.0)
+      activesupport (= 3.1.0)
+      bcrypt-ruby (~> 3.0.0)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activesupport (3.1.0)
+      multi_json (~> 1.0)
+    bcrypt-ruby (3.0.1)
+    bson (1.4.0)
+    bson_ext (1.4.0)
+    builder (3.0.0)
     database_cleaner (0.6.7)
-    diff-lcs (1.1.2)
+    diff-lcs (1.1.3)
     git (1.2.5)
-    i18n (0.5.0)
+    i18n (0.6.0)
     jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
     mongo (1.3.1)
       bson (>= 1.3.1)
-    mongoid (2.1.5)
+    mongoid (2.2.1)
       activemodel (~> 3.0)
-      mongo (~> 1.3)
+      mongo (>= 1.3, < 1.4)
       tzinfo (~> 0.3.22)
+    multi_json (1.0.3)
     rake (0.9.2)
-    rdoc (3.9.1)
+    rdoc (3.9.4)
     rspec (2.6.0)
       rspec-core (~> 2.6.0)
       rspec-expectations (~> 2.6.0)
@@ -33,9 +37,10 @@ GEM
     rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.6.0)
-    simplecov (0.4.2)
-      simplecov-html (~> 0.4.4)
-    simplecov-html (0.4.5)
+    simplecov (0.5.3)
+      multi_json (~> 1.0.3)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
     tzinfo (0.3.29)
 
 PLATFORMS

data/README.rdoc

@@ -37,6 +37,11 @@ You can rate by passing an integer and a rater model to the "rate" method:
     @post.rate 5, @user     # I LOVE this!
     @post.rate -10, @user   # Delete it from the Internet!
 
+Rates have weight (1 by defaut)
+
+    @post.rate 5, @user, 3     # Rate @post with weight 3 (@user has high karma)
+    @post.rate 3, @user, 1     # Rate @post with weight 1 (@user has low karma)
+
 You can unrate by using "unrate" method:
 
     @post.unrate @user
@@ -60,13 +65,17 @@ And if someone rated it:
 
     @post.rated?            # True if it rated by someone
 
-You can also get a tally of the number of votes cast:
+You can also get a tally of the number of rates cast:
 
     @post.rate_count        # Just one so far!
 
-You can get the average rating:
+You can get a total weight of post rates:
+
+    @post.rate_weight        # Just one so far!
+
+And you can get the average rating:
 
-    @post.rating            # rates / raters.count
+    @post.rating            # rates / rate_weight
 
 == Scopes
 

data/TODO

@@ -2,5 +2,4 @@ improve speed (http://cookbook.mongodb.org/patterns/votes/)
 rate embedded (indexes?!)
 add random values to specs
 add task for rating update
-add bayesian_rating ( https://github.com/mepatterson/acts_as_mongo_rateable )
-add weight to rating
+add bayesian_rating ( https://github.com/mepatterson/acts_as_mongo_rateable )

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.1.6

data/lib/mongoid_rateable/rateable.rb

@@ -5,6 +5,7 @@ module Mongoid
 		included do
 			field :rates, :type => Integer, :default => 0
 			field :rating, :type => Float, :default => nil
+			field :weighted_rate_count, :type => Integer, :default => 0
 
 			embeds_many :rating_marks, :as => :rateable
 
@@ -24,12 +25,14 @@ module Mongoid
 
 		module InstanceMethods
 
-			def rate(mark, rater)
-				validate_rating!(mark)
-				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
+			def rate(mark, rater, weight = 1)
+ 				validate_rating!(mark)
+ 				unrate_without_rating_update(rater)
+ 				total_mark = mark.to_i*weight.to_i
+ 				self.rates += total_mark
+ 				self.rating_marks.new(:rater_id => rater.id, :mark => mark, :rater_class => rater.class.to_s, :weight => weight)
+				self.weighted_rate_count += weight
+ 				update_rating
 			end
 
 			def unrate(rater)
@@ -37,8 +40,8 @@ module Mongoid
 				update_rating
 			end
 
-			def rate_and_save(mark, rater)
-				rate(mark, rater)
+			def rate_and_save(mark, rater, weight = 1)
+				rate(mark, rater, weight)
 				save
 			end
 
@@ -65,7 +68,12 @@ module Mongoid
 			end
 
 			def rate_count
-				rating_marks.size
+				self.rating_marks.size
+			end
+
+			def rate_weight
+				check_weighted_rate_count
+				read_attribute(:weighted_rate_count)
 			end
 
 			protected
@@ -79,14 +87,26 @@ module Mongoid
 			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
+					weight = (rmark.weight ||= 1)
+					total_mark = rmark.mark.to_i*weight.to_i
+					self.rates -= total_mark
+					self.weighted_rate_count -= weight
 					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)
+				check_weighted_rate_count
+				rt = (self.rates.to_f / self.weighted_rate_count.to_f) unless self.rating_marks.blank?
+ 				write_attribute(:rating, rt)
+			end
+
+			def check_weighted_rate_count
+				#migration from old version
+				wrc = read_attribute(:weighted_rate_count).to_i
+				if (wrc==0 && rate_count!=0)
+					write_attribute(:weighted_rate_count, self.rating_marks.size)
+				end
 			end
 
 		end

data/lib/mongoid_rateable/rating.rb

@@ -4,4 +4,5 @@ class RatingMark
 	field :mark, :type => Integer
 	field :rater_class, :type => String
 	field :rater_id, :type => BSON::ObjectId
+	field :weight, :type => Integer, :default => 1
 end

data/mongoid_rateable.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongoid_rateable}
-  s.version = "0.1.5"
+  s.version = "0.1.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Peter Savichev (proton)}]
-  s.date = %q{2011-08-20}
+  s.date = %q{2011-09-27}
   s.description = %q{Provides fields and methods for the rating manipulation on Mongoid documents.}
   s.email = %q{psavichev@gmail.com}
   s.extra_rdoc_files = [

data/spec/rateable_spec.rb

@@ -40,6 +40,10 @@ describe Post do
         @post.rate 1, @sally
         @post.rates.should eql 2
       end
+      it "should track weighted #rates properly" do
+        @post.rate 1, @alice, 4
+        @post.rates.should eql 5
+      end
 
       it "should limit #rates by user properly" do
         @post.rate 5, @bob
@@ -56,14 +60,14 @@ describe Post do
 
       #TODO: Rewrite for random values
       describe "when using negative values" do
-        it "should work properly for -1" do
-          @post.rate -1, @sally
-          @post.rates.should eql 0
-        end
-        it "should work properly for -2" do
+        it "should work properly for -3" do
           @post.rate -3, @sally
           @post.rates.should eql -2
         end
+        it "should work properly for -1 with weight 3" do
+          @post.rate -1, @sally, 3
+          @post.rates.should eql -2
+        end
       end
     end
 
@@ -186,7 +190,7 @@ describe Post do
 
   describe "#rate_and_save" do
     before (:each) do
-      @post.rate_and_save 8, @bob
+      @post.rate_and_save 8, @bob, 2
       @post.rate_and_save -10, @sally
       @finded_post = Post.where(:name => "Announcement").first
     end
@@ -205,31 +209,35 @@ describe Post do
 			end
     end
 
-    it "should have #rates equal -2" do
-			@finded_post.rates.should eql -2
+    it "should have #rates equal 6" do
+			@finded_post.rates.should eql 6
     end
 
     it "should have #rate_count equal 2" do
 			@finded_post.rate_count.should eql 2
     end
 
-    it "should have #rating equal -1.0" do
-			@finded_post.rating.should eql -1.0
+    it "should have #rate_weight equal 3" do
+			@finded_post.rate_weight.should eql 3
+    end
+
+    it "should have #rating equal 2.0" do
+			@finded_post.rating.should eql 2.0
     end
 
     describe "#unrate_and_save" do
 			before (:each) do
-				@post.unrate_and_save @sally
+				@post.unrate_and_save @bob
 				@finded_post = Post.where(:name => "Announcement").first
 			end
 
 			describe "#rated?" do
-				it "should be #rated? by Bob" do
-					@finded_post.rated_by?(@bob).should be_true
+				it "should be #rated? by Sally" do
+					@finded_post.rated_by?(@sally).should be_true
 				end
 
-				it "should be not #rated? by Sally" do
-					@finded_post.rated_by?(@sally).should be_false
+				it "should be not #rated? by Bob" do
+					@finded_post.rated_by?(@bob).should be_false
 				end
 
 				it "should be #rated?" do
@@ -237,16 +245,20 @@ describe Post do
 				end
 			end
 
-			it "should have #rates equal 8" do
-				@finded_post.rates.should eql 8
+			it "should have #rates equal -10" do
+				@finded_post.rates.should eql -10
 			end
 
 			it "should have #rate_count equal 1" do
 				@finded_post.rate_count.should eql 1
 			end
 
-			it "should have #rating equal 8.0" do
-				@finded_post.rating.should eql 8.0
+			it "should have #rate_weight equal 1" do
+				@finded_post.rate_weight.should eql 1
+			end
+
+			it "should have #rating equal -10.0" do
+				@finded_post.rating.should eql -10.0
 			end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_rateable
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-20 00:00:00.000000000Z
+date: 2011-09-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &80263240 !ruby/object:Gem::Requirement
+  requirement: &89686630 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *80263240
+  version_requirements: *89686630
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &80262940 !ruby/object:Gem::Requirement
+  requirement: &89686300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *80262940
+  version_requirements: *89686300
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &80262640 !ruby/object:Gem::Requirement
+  requirement: &89685960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *80262640
+  version_requirements: *89685960
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &80262310 !ruby/object:Gem::Requirement
+  requirement: &89685640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.6.2
   type: :development
   prerelease: false
-  version_requirements: *80262310
+  version_requirements: *89685640
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &80261990 !ruby/object:Gem::Requirement
+  requirement: &89685310 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 0.4.0
   type: :development
   prerelease: false
-  version_requirements: *80261990
+  version_requirements: *89685310
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &80261710 !ruby/object:Gem::Requirement
+  requirement: &89685000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *80261710
+  version_requirements: *89685000
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &80261420 !ruby/object:Gem::Requirement
+  requirement: &89684700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: 2.0.0
   type: :development
   prerelease: false
-  version_requirements: *80261420
+  version_requirements: *89684700
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: &80261110 !ruby/object:Gem::Requirement
+  requirement: &89684390 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *80261110
+  version_requirements: *89684390
 description: Provides fields and methods for the rating manipulation on Mongoid documents.
 email: psavichev@gmail.com
 executables: []
@@ -141,7 +141,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -505441169
+      hash: 137369441
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: