merit 1.2.1 → 1.2.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    merit (1.2.1)
+    merit (1.2.2)
       ambry (~> 0.3.0)
 
 GEM

data/README.md

@@ -42,6 +42,7 @@ holds. Badges may have levels, and may be temporary. Define rules on
 ## Examples
 
 ```ruby
+# app/models/merit/badge_rules.rb
 grant_on 'comments#vote', :badge => 'relevant-commenter', :to => :user do |comment|
   comment.votes.count == 5
 end
@@ -51,23 +52,12 @@ grant_on ['users#create', 'users#update'], :badge => 'autobiographer', :temporar
 end
 ```
 
-### Check granted badges
-
 ```ruby
+# Check granted badges
 current_user.badges # Returns an array of badges
-```
-
-### Grant manually
-
-You may also grant badges "by hand":
 
-```ruby
+# Grant or remove manually
 current_user.add_badge(badge.id)
-```
-
-Similarly you can remove badges that have been granted:
-
-```ruby
 current_user.rm_badge(badge.id)
 ```
 
@@ -90,6 +80,7 @@ action user or to the method(s) defined in the `:to` option. Define rules on
 ## Examples
 
 ```ruby
+# app/models/merit/point_rules.rb
 score 10, :to => :post_creator, :on => 'comments#create' do |comment|
   comment.title.present?
 end
@@ -102,19 +93,12 @@ score 20, :on => [
 score 15, :on => 'reviews#create', :to => [:reviewer, :reviewed]
 ```
 
-### Check awarded points
-
 ```ruby
+# Check awarded points
 current_user.points # Returns an integer
-```
-
-### Score manually
 
-You may also change user points "by hand":
-
-```ruby
+# Score manually
 current_user.add_points(20, 'Optional log message')
-
 current_user.substract_points(10)
 ```
 
@@ -159,4 +143,5 @@ end
 
 # To-do list
 
+* Improve model_additions with http://blog.8thlight.com/josh-cheek/2012/02/03/modules-called-they-want-their-integrity-back.html
 * Should namespace Badge, BadgesSash and Sash into Merit module.

data/app/models/merit/action.rb

@@ -17,7 +17,7 @@ module Merit
     attr_accessible :user_id, :action_method, :action_value, :had_errors,
       :target_model, :target_id, :processed, :log
 
-    def self.check_unprocessed_rules
+    def self.check_unprocessed
       where(:processed => false).map &:check_all_rules
     end
 

data/lib/generators/active_record/install_generator.rb

@@ -4,16 +4,12 @@ module ActiveRecord
   module Generators
     class InstallGenerator < Rails::Generators::Base
       include Rails::Generators::Migration
+
       source_root File.expand_path('../templates', __FILE__)
       desc "add active_record merit migrations for the root objects"
 
       def self.next_migration_number(path)
-        unless @prev_migration_nr
-          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
-        else
-          @prev_migration_nr += 1
-        end
-        @prev_migration_nr.to_s
+        ActiveRecord::Generators::Base.next_migration_number(path)
       end
 
       def copy_migrations_and_model

data/lib/generators/active_record/merit_generator.rb

@@ -4,16 +4,12 @@ module ActiveRecord
   module Generators
     class MeritGenerator < ActiveRecord::Generators::Base
       include Rails::Generators::Migration
+
       source_root File.expand_path('../templates', __FILE__)
       desc "add active_record merit migrations"
 
       def self.next_migration_number(path)
-        unless @prev_migration_nr
-          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
-        else
-          @prev_migration_nr += 1
-        end
-        @prev_migration_nr.to_s
+        ActiveRecord::Generators::Base.next_migration_number(path)
       end
 
       def copy_migrations_and_model

data/lib/merit.rb

@@ -35,6 +35,7 @@ module Merit
   end
 
   class BadgeNotFound < Exception; end
+  class RankAttributeNotDefined < Exception; end
 
   class Engine < Rails::Engine
     config.app_generators.orm Merit.orm
@@ -50,8 +51,13 @@ module Merit
 
       ActiveSupport.on_load(:action_controller) do
         # Load application defined rules on application boot up
-        ::Merit::AppBadgeRules = ::Merit::BadgeRules.new.defined_rules
-        ::Merit::AppPointRules = ::Merit::PointRules.new.defined_rules
+        # Test if constant exists (doesn't while installing/generating files)
+        if defined? '::Merit::BadgeRules'
+          ::Merit::AppBadgeRules = ::Merit::BadgeRules.new.defined_rules
+        end
+        if defined? '::Merit::PointRules'
+          ::Merit::AppPointRules = ::Merit::PointRules.new.defined_rules
+        end
 
         include Merit::ControllerExtensions
       end

data/lib/merit/controller_extensions.rb

@@ -5,25 +5,26 @@ module Merit
   module ControllerExtensions
     def self.included(base)
       base.after_filter do |controller|
-        return unless rules_defined?
-
-        Merit::Action.create(
-          :user_id       => send(Merit.current_user_method).try(:id),
-          :action_method => action_name,
-          :action_value  => params[:value],
-          :had_errors    => had_errors?,
-          :target_model  => controller_path,
-          :target_id     => target_id
-        ).id
-
-        if Merit.checks_on_each_request
-          Merit::Action.check_unprocessed_rules
+        if rules_defined?
+          log_merit_action
+          Merit::Action.check_unprocessed if Merit.checks_on_each_request
         end
       end
     end
 
     private
 
+    def log_merit_action
+      Merit::Action.create(
+        :user_id       => send(Merit.current_user_method).try(:id),
+        :action_method => action_name,
+        :action_value  => params[:value],
+        :had_errors    => had_errors?,
+        :target_model  => controller_path,
+        :target_id     => target_id
+      ).id
+    end
+
     def rules_defined?
       action = "#{controller_path}\##{action_name}"
       AppBadgeRules[action].present? || AppPointRules[action].present?

data/lib/merit/model_additions.rb

@@ -9,6 +9,21 @@ module Merit
       # https://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/1079-belongs_to-dependent-destroy-should-destroy-self-before-assocation
       belongs_to :sash
 
+      merit_orm_specific_config
+
+      merit_delegate_methods_to_sash
+      merit_sash_initializer
+    end
+
+    # Delegate methods from meritable models to their sash
+    def merit_delegate_methods_to_sash
+      methods = %w(badge_ids badges points
+        add_badge rm_badge
+        add_points substract_points)
+      methods.each { |method| delegate method, to: :_sash }
+    end
+
+    def merit_orm_specific_config
       if Merit.orm == :mongo_mapper
         plugin Merit
         key :sash_id, String
@@ -22,19 +37,16 @@ module Merit
           where(:_id => id).first
         end
       end
+    end
 
-      # Delegate relationship methods from meritable models to their sash
-      # _sash initializes a sash if doesn't have one yet.
-      # From Rails 3.2 we can override association methods to do so
-      # transparently, but merit supports Rails ~> 3.0.0. See:
-      # http://blog.hasmanythrough.com/2012/1/20/modularized-association-methods-in-rails-3-2
-      %w(badge_ids badges points add_badge rm_badge add_points substract_points).each do |method|
-        delegate method, to: :_sash
-      end
+    # _sash initializes a sash if doesn't have one yet.
+    # From Rails 3.2 we can override association methods to do so
+    # transparently, but merit supports Rails ~> 3.0.0. See:
+    # http://blog.hasmanythrough.com/2012/1/20/modularized-association-methods-in-rails-3-2
+    def merit_sash_initializer
       define_method(:_sash) do
         if sash.nil?
-          self.sash = Sash.create
-          self.save(:validate => false)
+          self.update_attribute :sash_id, Sash.create.id
         end
         self.sash
       end

data/lib/merit/rules_rank_methods.rb

@@ -26,22 +26,8 @@ module Merit
     # Merit::RankRules.new.check_rank_rules
     def check_rank_rules
       defined_rules.each do |scoped_model, level_and_rules|
-        level_and_rules = level_and_rules.sort
-        level_and_rules.each do |level, rule|
-          begin
-            if Merit.orm == :mongoid
-              items = scoped_model.where(:"#{rule.level_name}".lt => level)
-            else
-              items = scoped_model.where("#{rule.level_name} < #{level}")
-            end
-            items.each do |obj|
-              if rule.applies?(obj)
-                obj.update_attribute rule.level_name, level
-              end
-            end
-          rescue ActiveRecord::StatementInvalid
-            Rails.logger.warn "[merit] Please add #{rule.level_name} column/attribute to #{scoped_model.new.class.name}"
-          end
+        level_and_rules.sort.each do |level, rule|
+          grant_when_applies(scoped_model, rule, level)
         end
       end
     end
@@ -50,5 +36,25 @@ module Merit
     def defined_rules
       @defined_rules ||= {}
     end
+
+    private
+
+    def grant_when_applies(scoped_model, rule, level)
+      scope_to_promote(scoped_model, rule.level_name, level).each do |object|
+        if rule.applies?(object)
+          object.update_attribute rule.level_name, level
+        end
+      end
+    rescue ActiveRecord::StatementInvalid => msg
+      raise RankAttributeNotDefined, "Add #{rule.level_name} column to #{scoped_model.new.class.name}\n[#{msg}]"
+    end
+
+    def scope_to_promote(scope, level_name, level)
+      if Merit.orm == :mongoid
+        scope.where(:"#{level_name}".lt => level)
+      else
+        scope.where("#{level_name} < #{level}")
+      end
+    end
   end
 end

data/merit.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |s|
   s.description = "Manage badges, points and rankings (reputation) of resources in a Rails application."
   s.homepage    = "http://github.com/tute/merit"
   s.files       = `git ls-files`.split("\n").reject{|f| f =~ /^\./ }
-  s.version     = '1.2.1'
+  s.version     = '1.2.2'
   s.authors     = ["Tute Costa"]
   s.email       = 'tutecosta@gmail.com'
   s.add_dependency 'ambry',  '~> 0.3.0'

data/test/dummy/app/models/merit/rank_rules.rb

@@ -21,4 +21,4 @@ module Merit
       end
     end
   end
-end
+end

data/test/merit_unit_test.rb

@@ -47,4 +47,17 @@ class MeritUnitTest < ActiveSupport::TestCase
     badge_sash.set_notified!
     assert badge_sash.notified_user
   end
+
+  test 'unknown ranking should raise merit exception' do
+    class WeirdRankRules
+      include Merit::RankRulesMethods
+      def initialize
+        set_rank :level => 1, :to => User, :level_name => :clown do |user|
+        end
+      end
+    end
+    assert_raises Merit::RankAttributeNotDefined do
+      WeirdRankRules.new.check_rank_rules
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: merit
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-13 00:00:00.000000000 Z
+date: 2013-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ambry
@@ -328,3 +328,4 @@ signing_key:
 specification_version: 3
 summary: General reputation Rails engine.
 test_files: []
+has_rdoc: