mongoid_rateable 0.2.3 → 0.3.0

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+*0.3.0*
+
+Removed RATING_RANGE constant.
+The RATING_RANGE constant is very inflexible. Much better with a class method, since
+it allows for reusability, definint the range in a module that is pulled into
+several classes etc.
+
+Instead this gem now includes several other config methods.

data/Gemfile

@@ -4,7 +4,7 @@ gem "mongoid", ">= 3.0"
 
 group :development do
   gem "bundler"
-  gem "jeweler", "~> 1.6.2"
+  gem "jeweler", ">= 1.6.2"
   gem "simplecov", '>= 0.4.0', :require => false
   gem "rdoc", ">= 0"
   gem "rspec", ">= 2.0.0"

data/Gemfile.lock

@@ -48,7 +48,7 @@ PLATFORMS
 DEPENDENCIES
   bundler
   database_cleaner
-  jeweler (~> 1.6.2)
+  jeweler (>= 1.6.2)
   mongoid (>= 3.0)
   rdoc
   rspec (>= 2.0.0)

data/README.rdoc

@@ -15,18 +15,42 @@ Add to Gemfile:
 
 == Getting Started
 
-Include the module in models where you want it:
+Include the module in models where you want it.
+There are many other configurtion variants available ;)
 
     class Post
       include Mongoid::Document
       include Mongoid::Rateable
 
-      RATING_RANGE = (1..5) # Optional (if you need restriction)
       ...
     end
 
-    class User
+or
+
+    class Post
       include Mongoid::Document
+      include Mongoid::Rateable
+
+      # class method
+      def self.rating_range
+        (1..5) # should always return the same range
+      end
+
+      # Optional restriction
+      rateable_by User
+
+      ...
+    end
+
+or
+
+    class Post
+      include Mongoid::Document
+      include Mongoid::Rateable
+
+      # macro
+      set_rating_range (1..5)
+      rateable_by User, Admin
       ...
     end
 
@@ -42,6 +66,9 @@ 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!
 
+    # Many users love this!
+    @post.rate 5, @users     # They LOVIN' it!
+
 Rates have weight (1 by defaut)
 
     @post.rate 5, @user, 3     # Rate @post with weight 3 (@user has high karma)

data/VERSION

@@ -1 +1 @@
-0.2.3
+0.3.0

data/lib/mongoid_rateable/rateable.rb

@@ -20,29 +20,117 @@ module Mongoid
       scope :highest_rated, ->(limit=10) { order_by([:rating, :desc]).limit(limit) }
     end
 
-    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
+    module ClassMethods
+      def rater_classes
+        @rater_classes ||= []
+      end
+
+      def valid_rater_class? clazz
+        return true if !rater_classes || rater_classes.empty?
+        rater_classes.include? clazz
+      end
+
+      def in_rating_range?(value)
+        range = rating_range if respond_to?(:rating_range)
+        range ? range.include?(value.to_i) : true
+      end      
+
+      # macro to create dynamic :rating_range class method!
+      # can now even take an Array and find the range of values!
+      def set_rating_range range = nil
+        raterange = case range
+        when Array
+          arr = range.sort
+          Range.new arr.first, arr.last
+        when Range
+          range
+        else
+          raise ArgumentError, "Must be a range, was: #{range}"
+        end
+
+        (class << self; self; end).send(:define_method, :rating_range) do
+          raterange
+        end
+      end
+
+      def rateable_by *clazzes
+        @rater_classes = []
+        clazzes.each do |clazz|
+          raise ArgumentError, "A rateable must be a class, was: #{clazz}" unless clazz.respond_to?(:new)
+          @rater_classes << clazz
+        end
+      end
+
+      def rate_config options = {}
+        set_rating_range options[:range]
+        rateable_by options[:raters]
+      end
+
+      def default_rater rater=nil, &block
+        case rater
+        when Symbol, String
+          define_method :default_rater do
+            self.send(rater) # fx to use owner or user relation
+          end
+        when nil
+          raise ArgumentError, "Must take symbol or block argument" unless block_defined?
+          define_method :default_rater do
+            self.instance_eval(&block)
+          end
+        end
+      end
+    end # class methods
+
+    def rate(mark, rater = nil, weight = 1)
+      case rater
+      when Array
+        rater.each{|rater| rate(mark, rater, weight)}
+      else 
+        if !rater
+          unless respond_to?(:default_rater)
+            raise ArgumentError, "No rater argument and no default_rater specified"
+          end
+          rater = default_rater 
+        end
+        validate_rater!(rater)
+        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
     end
 
     def unrate(rater)
-      unrate_without_rating_update(rater)
-      update_rating
+      case rater
+      when Array
+        rater.each{|rater| unrate(mark, rater, weight)}
+      else 
+        unrate_without_rating_update(rater)
+        update_rating
+      end
     end
 
     def rate_and_save(mark, rater, weight = 1)
-      rate(mark, rater, weight)
-      save
+      case rater
+      when Array
+        rater.each{|rater| rate_and_save(mark, rater, weight)}
+      else 
+        rate(mark, rater, weight)
+        save
+      end
     end
 
     def unrate_and_save(rater)
-      unrate(rater)
-      save
+      case rater
+      when Array
+        rater.each{|rater| unrate_and_save(mark, rater, weight)}
+      else 
+        unrate(rater)
+        save
+      end
     end
 
     def rated?
@@ -50,7 +138,12 @@ module Mongoid
     end
 
     def rated_by?(rater)
-      self.rating_marks.where(:rater_id => rater.id, :rater_class => rater.class.to_s).count == 1
+      case rater
+      when Array
+        rater.each{|rater| rated_by(mark, rater, weight)}
+      else       
+        self.rating_marks.where(:rater_id => rater.id, :rater_class => rater.class.to_s).count == 1
+      end
     end
 
     def rating
@@ -87,9 +180,15 @@ module Mongoid
 
     protected
 
+    def validate_rater!(rater)
+      unless self.class.valid_rater_class?(rater.class)
+        raise ArgumentError, "Not a valid rater: #{rater.class}, must be of one of #{self.class.rater_classes}"
+      end
+    end
+
     def validate_rating!(value)
-      if (defined? self.class::RATING_RANGE) and (range = self.class::RATING_RANGE) and !range.include?(value.to_i)
-        raise ArgumentError, "Rating not in range #{range}. Rating provided was #{value}."
+      if !self.class.in_rating_range?(value)
+        raise ArgumentError, "Rating not in range #{self.class.rating_range}. Rating provided was #{value}."
       end
     end
 

data/mongoid_rateable.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "mongoid_rateable"
-  s.version = "0.2.3"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Peter Savichev (proton)"]
-  s.date = "2012-09-29"
+  s.date = "2012-11-03"
   s.description = "Provides fields and methods for the rating manipulation on Mongoid documents."
   s.email = "psavichev@gmail.com"
   s.extra_rdoc_files = [
@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".rspec",
     ".rvmrc",
+    "CHANGELOG.md",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
@@ -51,7 +52,7 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<mongoid>, [">= 3.0"])
       s.add_development_dependency(%q<bundler>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.6.2"])
       s.add_development_dependency(%q<simplecov>, [">= 0.4.0"])
       s.add_development_dependency(%q<rdoc>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 2.0.0"])
@@ -59,7 +60,7 @@ Gem::Specification.new do |s|
     else
       s.add_dependency(%q<mongoid>, [">= 3.0"])
       s.add_dependency(%q<bundler>, [">= 0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_dependency(%q<jeweler>, [">= 1.6.2"])
       s.add_dependency(%q<simplecov>, [">= 0.4.0"])
       s.add_dependency(%q<rdoc>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 2.0.0"])
@@ -68,7 +69,7 @@ Gem::Specification.new do |s|
   else
     s.add_dependency(%q<mongoid>, [">= 3.0"])
     s.add_dependency(%q<bundler>, [">= 0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+    s.add_dependency(%q<jeweler>, [">= 1.6.2"])
     s.add_dependency(%q<simplecov>, [">= 0.4.0"])
     s.add_dependency(%q<rdoc>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 2.0.0"])

data/spec/models/article.rb

@@ -2,7 +2,7 @@ class Article
   include Mongoid::Document
   include Mongoid::Rateable
 
-  RATING_RANGE = (1..5)
+  set_rating_range (1..5)
 
   field :name
 

data/spec/models/comment.rb

@@ -2,7 +2,7 @@ class Comment
   include Mongoid::Document
   include Mongoid::Rateable
 
-  RATING_RANGE = (-5..7)
+  set_rating_range (-5..7)
 
   embedded_in :post
 

data/spec/rateable_spec.rb

@@ -57,11 +57,11 @@ describe Post do
 				@post.rates.should eql 5
 			end
 
-			it "should not raise exception if rate_value in RATING_RANGE" do
+			it "should not raise exception if rate_value in rating range" do
 				lambda { @article.rate 1, @sally }.should_not raise_error
 			end
 
-			it "should raise exception if rate_value not in RATING_RANGE" do
+			it "should raise exception if rate_value not in rating range" do
 				lambda { @article.rate 7, @sally }.should raise_error(ArgumentError)
 			end
 
@@ -510,11 +510,11 @@ describe Comment do
 				@comment1.rates.should eql 5
 			end
 
-			it "should not raise exception if rate_value in RATING_RANGE" do
+			it "should not raise exception if rate_value in rating range" do
 				lambda { @comment1.rate 1, @sally }.should_not raise_error
 			end
 
-			it "should raise exception if rate_value not in RATING_RANGE" do
+			it "should raise exception if rate_value not in rating range" do
 				lambda { @comment1.rate 9, @sally }.should raise_error(ArgumentError)
 			end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_rateable
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-29 00:00:00.000000000 Z
+date: 2012-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -48,7 +48,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.6.2
   type: :development
@@ -56,7 +56,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.6.2
 - !ruby/object:Gem::Dependency
@@ -134,6 +134,7 @@ extra_rdoc_files:
 files:
 - .rspec
 - .rvmrc
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -167,7 +168,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -684544659
+      hash: 527634735
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: