mongoid_rateable 0.3.0 → 0.3.1

data/CHANGELOG.md

@@ -3,8 +3,6 @@
 *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.
+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/README.rdoc

@@ -15,45 +15,44 @@ Add to Gemfile:
 
 == Getting Started
 
-Include the module in models where you want it.
-There are many other configurtion variants available ;)
+
+Simply use the `rateable` macro from any class that is a Mongoid Document. 
+
+This macro will include `Mongoid::Rateable` into the class and configure the rating functionality using the options hash. For any option not present, the default option value will be used.
 
     class Post
       include Mongoid::Document
-      include Mongoid::Rateable
 
-      ...
+      rateable range: (-5..7), raters: [User, Admin]
     end
 
-or
+You can also set the `default_rater`
 
     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
+      # will simply call the 'owner' method to find the default rater 
+      # if no rater given when rating
 
-      ...
+      rateable range: (-5..7), raters: [User, Admin], default_rater: 'owner'
     end
 
-or
-
     class Post
       include Mongoid::Document
-      include Mongoid::Rateable
 
-      # macro
-      set_rating_range (1..5)
-      rateable_by User, Admin
-      ...
+      # if given a block, this will be used as a dynamic way to find 
+      # the a rater in case no rater is passed in as the 2nd argument to
+      # the rate method
+
+      rateable range: (-5..7), raters: [User, Admin] do
+        # will by default be rated by the last user 
+        # who made a comment to this post!
+        comments.last.user
+      end
     end
 
+Note: For even more control over the configuration, see the `ClassMethods` module code in `rateable.rb`.
+
 == Cast Rates
 
 You can rate by passing an integer and a rater model to the "rate" method:

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/lib/mongoid_rateable.rb

@@ -1,3 +1,8 @@
 require 'mongoid_rateable/version'
 require 'mongoid_rateable/rateable'
-require 'mongoid_rateable/rating'
+require 'mongoid_rateable/rating'
+
+Mongoid::Document.send :include, Mongoid::Rateable::Ext
+
+
+

data/lib/mongoid_rateable/rateable.rb

@@ -2,6 +2,20 @@ module Mongoid
   module Rateable
     extend ActiveSupport::Concern
 
+    module Ext
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def rateable options = {}
+          class_eval do            
+            self.send :include, Mongoid::Rateable
+            puts "options: #{options}"
+            self.rate_config options
+          end
+        end
+      end
+    end
+
     included do
       field :rates, type: Integer, default: 0
       field :rating, type: Float, default: nil
@@ -44,6 +58,8 @@ module Mongoid
           Range.new arr.first, arr.last
         when Range
           range
+        when nil
+          (1..5)
         else
           raise ArgumentError, "Must be a range, was: #{range}"
         end
@@ -55,15 +71,17 @@ module Mongoid
 
       def rateable_by *clazzes
         @rater_classes = []
+        return if clazzes.compact.empty?
         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 = {}
+      def rate_config options = {}, &block
         set_rating_range options[:range]
         rateable_by options[:raters]
+        default_rater options[:default_rater], &block
       end
 
       def default_rater rater=nil, &block
@@ -73,10 +91,12 @@ module Mongoid
             self.send(rater) # fx to use owner or user relation
           end
         when nil
-          raise ArgumentError, "Must take symbol or block argument" unless block_defined?
+          return unless block_given?
           define_method :default_rater do
             self.instance_eval(&block)
           end
+        else
+          raise ArgumentError, "Must take symbol or block argument" 
         end
       end
     end # class methods

data/mongoid_rateable.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "mongoid_rateable"
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Peter Savichev (proton)"]
-  s.date = "2012-11-03"
+  s.date = "2012-12-07"
   s.description = "Provides fields and methods for the rating manipulation on Mongoid documents."
   s.email = "psavichev@gmail.com"
   s.extra_rdoc_files = [

data/spec/models/comment.rb

@@ -1,8 +1,7 @@
 class Comment
   include Mongoid::Document
-  include Mongoid::Rateable
 
-  set_rating_range (-5..7)
+  rateable range: (-5..7)
 
   embedded_in :post
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_rateable
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-03 00:00:00.000000000 Z
+date: 2012-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -168,7 +168,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 527634735
+      hash: -55772387
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: