merit 1.5.0 → 1.6.0

data/Gemfile

@@ -1,3 +1,15 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
+
+version = ENV['RAILS_VERSION'] || '3.2'
+
+rails = case version
+when 'master'
+  { github: 'rails/rails' }
+else
+  gem 'strong_parameters'
+  "~> #{version}.0"
+end
+
+gem 'rails', rails

data/README.md

@@ -44,11 +44,11 @@ holds. Badges may have levels, and may be temporary. Define rules on
 
 ```ruby
 # app/models/merit/badge_rules.rb
-grant_on 'comments#vote', :badge => 'relevant-commenter', :to => :user do |comment|
+grant_on 'comments#vote', badge: 'relevant-commenter', to: :user do |comment|
   comment.votes.count == 5
 end
 
-grant_on ['users#create', 'users#update'], :badge => 'autobiographer', :temporary => true do |user|
+grant_on ['users#create', 'users#update'], badge: 'autobiographer', temporary: true do |user|
   user.name.present? && user.address.present?
 end
 ```
@@ -93,16 +93,16 @@ action user or to the method(s) defined in the `:to` option. Define rules on
 
 ```ruby
 # app/models/merit/point_rules.rb
-score 10, :to => :post_creator, :on => 'comments#create' do |comment|
+score 10, to: :post_creator, on: 'comments#create' do |comment|
   comment.title.present?
 end
 
-score 20, :on => [
+score 20, on: [
   'comments#create',
   'photos#create'
 ]
 
-score 15, :on => 'reviews#create', :to => [:reviewer, :reviewed]
+score 15, on: 'reviews#create', to: [:reviewer, :reviewed]
 ```
 
 ```ruby
@@ -146,7 +146,7 @@ Define rules on `app/models/merit/rank_rules.rb`:
 Check for rules on a rake task executed in background like:
 
 ```ruby
-task :cron => :environment do
+task cron: :environment do
   Merit::RankRules.new.check_rank_rules
 end
 ```
@@ -155,12 +155,12 @@ end
 ## Examples
 
 ```ruby
-set_rank :level => 2, :to => Commiter.active do |commiter|
-  commiter.branches > 1 && commiter.followers >= 10
+set_rank level: 2, to: Committer.active do |committer|
+  committer.branches > 1 && committer.followers >= 10
 end
 
-set_rank :level => 3, :to => Commiter.active do |commiter|
-  commiter.branches > 2 && commiter.followers >= 20
+set_rank level: 3, to: Committer.active do |committer|
+  committer.branches > 2 && committer.followers >= 20
 end
 ```
 

data/UPGRADING.md

@@ -1,5 +1,19 @@
 # Upgrading
 
+## 1.6.0
+
+* Rails 4 ready.
+* Adds ability to wildcard controllers like:
+```ruby
+grant_on '.*search#index', badge: 'searcher', multiple: true
+```
+* Allows custom fields to be defined on badges [97c998f]. Example:
+  Merit::Badge.create!({
+    id: 1,
+    name: 'best-unicorn',
+    custom_fields: { category: 'fantasy' }
+  })
+
 ## 1.5.0
 
 * Adds `Merit::ActivityLog` join model between `Merit::Action` and

data/app/models/merit/action.rb

@@ -15,7 +15,7 @@ require_dependency "merit/models/#{Merit.orm}/merit/action"
 module Merit
   class Action
     def self.check_unprocessed
-      where(:processed => false).map &:check_all_rules
+      where(processed: false).map &:check_all_rules
     end
 
     # Check rules defined for a merit_action
@@ -23,17 +23,15 @@ module Merit
       processed!
       return if had_errors
 
-      badge_rules = ::Merit::AppBadgeRules[action_str] || []
-      point_rules = ::Merit::AppPointRules[action_str] || []
-      check_rules badge_rules, :badges
-      check_rules point_rules, :points
+      check_rules rules_matcher.select_from(AppBadgeRules), :badges
+      check_rules rules_matcher.select_from(AppPointRules), :points
     end
 
     private
 
     def check_rules(rules_array, badges_or_points)
       rules_array.each do |rule|
-        judge = Judge.new sashes_to_badge(rule), rule, :action => self
+        judge = Judge.new sashes_to_badge(rule), rule, action: self
         judge.send :"apply_#{badges_or_points}"
       end
     end
@@ -43,14 +41,15 @@ module Merit
       SashFinder.find(rule, self)
     end
 
-    def action_str
-      "#{target_model}\##{action_method}"
-    end
-
     # Mark merit_action as processed
     def processed!
       self.processed = true
       self.save
     end
+
+    def rules_matcher
+      @rules_matcher ||= ::Merit::RulesMatcher.new(target_model, action_method)
+    end
+
   end
 end

data/app/models/merit/badge.rb

@@ -6,7 +6,7 @@ module Merit
     extend Ambry::Model
     extend Ambry::ActiveModel
 
-    field :id, :name, :level, :image, :description
+    field :id, :name, :level, :image, :description, :custom_fields
 
     validates_presence_of :id, :name
     validates_uniqueness_of :id
@@ -14,13 +14,15 @@ module Merit
     filters do
       def find_by_id(ids)
         ids = Array.wrap(ids)
-        find{|b| ids.include? b[:id] }
+        find { |b| ids.include? b[:id] }
       end
+
       def by_name(name)
-        find{|b| b.name == name.to_s }
+        find { |b| b.name == name.to_s }
       end
+
       def by_level(level)
-        find{|b| b.level.to_s == level.to_s }
+        find { |b| b.level.to_s == level.to_s }
       end
     end
 
@@ -28,8 +30,9 @@ module Merit
       def find_by_name_and_level(name, level)
         badges = Badge.by_name(name)
         badges = badges.by_level(level) unless level.nil?
-        if !(badge = badges.first)
-          raise ::Merit::BadgeNotFound, "No badge '#{name}'#{level.nil? ? '' : " with level #{level}"} found. Define it in 'config/initializers/merit.rb'."
+        if (badge = badges.first).nil?
+          str = "No badge '#{name}' found. Define it in initializers/merit.rb"
+          raise ::Merit::BadgeNotFound, str
         end
         badge
       end

data/lib/generators/merit/templates/merit.rb

@@ -15,6 +15,10 @@ end
 
 # Create application badges (uses https://github.com/norman/ambry)
 # Merit::Badge.create!({
-#   :id => 1,
-#   :name => 'just-registered'
+#   id: 1,
+#   name: 'just-registered'
+# }, {
+#   id: 2,
+#   name: 'best-unicorn',
+#   custom_fields: { category: 'fantasy' }
 # })

data/lib/merit.rb

@@ -2,6 +2,7 @@ require 'merit/rule'
 require 'merit/rules_badge_methods'
 require 'merit/rules_points_methods'
 require 'merit/rules_rank_methods'
+require 'merit/rules_matcher'
 require 'merit/controller_extensions'
 require 'merit/model_additions'
 require 'merit/judge'
@@ -20,7 +21,7 @@ module Merit
 
   # Define user_model_name
   mattr_accessor :user_model_name
-  @@user_model_name = "User"
+  @@user_model_name = 'User'
   def self.user_model
     @@user_model_name.constantize
   end
@@ -50,7 +51,7 @@ module Merit
         require 'merit/models/active_record/merit/sash'
         require 'merit/models/active_record/merit/score'
       elsif Merit.orm == :mongoid
-        require "merit/models/mongoid/sash"
+        require 'merit/models/mongoid/sash'
       end
 
       ActiveSupport.on_load(:action_controller) do

data/lib/merit/controller_extensions.rb

@@ -26,8 +26,7 @@ module Merit
     end
 
     def rules_defined?
-      action = "#{controller_path}\##{action_name}"
-      AppBadgeRules[action].present? || AppPointRules[action].present?
+      RulesMatcher.new(controller_path, action_name).any_matching?
     end
 
     def had_errors?
@@ -37,18 +36,20 @@ module Merit
     def target_object
       target_obj = instance_variable_get(:"@#{controller_name.singularize}")
       if target_obj.nil?
-        Rails.logger.warn("[merit] No object found, maybe you need a '@#{controller_name.singularize}' variable in '#{controller_path}_controller'?")
+        str = '[merit] No object found, maybe you need a ' +
+          "'@#{controller_name.singularize}' variable in " +
+          "'#{controller_path}_controller'?"
+        Rails.logger.warn str
       end
       target_obj
     end
 
     def target_id
-      target_id = params[:id] || target_object.try(:id)
-      # If params[:id] is a string (slug, using friendly_id for instance)
-      # then object exists but can't store params[:id] as the foreign key.
-      # Then we grab object's id.
-      if target_object && (target_id.nil? || !(target_id.to_s =~ /^[0-9]+$/))
-        target_id = target_object.id
+      target_id = target_object.try(:id)
+      # If target_id is nil
+      # then use params[:id].
+      if target_id.nil? && params[:id].to_s =~ /^[0-9]+$/
+        target_id = params[:id]
       end
       target_id
     end

data/lib/merit/judge.rb

@@ -1,5 +1,10 @@
+require_relative 'observer'
+
 module Merit
   class Judge
+
+    include Observer
+
     def initialize(sashes, rule, options = {})
       @sashes = sashes
       @rule = rule
@@ -21,11 +26,8 @@ module Merit
     def apply_points
       return unless rule_applies?
       @sashes.each do |sash|
-        points = sash.add_points @rule.score
-        ActivityLog.create(
-          action_id: @action.id,
-          related_change: points
-        )
+        point = sash.add_points @rule.score
+        notify_observers(@action.id, point)
       end
     end
 
@@ -35,22 +37,14 @@ module Merit
       @sashes.each do |sash|
         next unless new_or_multiple?(sash)
         badge_sash = sash.add_badge badge.id
-        ActivityLog.create(
-          action_id: @action.id,
-          related_change: badge_sash,
-          description: 'granted'
-        )
+        notify_observers(@action.id, badge_sash, 'granted')
       end
     end
 
     def remove_badges
       @sashes.each do |sash|
         badge_sash = sash.rm_badge badge.id
-        ActivityLog.create(
-          action_id: @action.id,
-          related_change: badge_sash,
-          description: 'removed'
-        )
+        notify_observers(@action.id, badge_sash, 'removed')
       end
     end
 

data/lib/merit/model_additions.rb

@@ -5,7 +5,7 @@ module Merit
     def has_merit(options = {})
       # MeritableModel#sash_id is more stable than Sash#meritable_model_id
       # That's why MeritableModel belongs_to Sash. Can't use
-      # :dependent => destroy as it may raise FK constraint exceptions. See:
+      # dependent: destroy as it may raise FK constraint exceptions. See:
       # https://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/1079-belongs_to-dependent-destroy-should-destroy-self-before-assocation
       belongs_to :sash, class_name: 'Merit::Sash'
 
@@ -27,14 +27,14 @@ module Merit
       if Merit.orm == :mongo_mapper
         plugin Merit
         key :sash_id, String
-        key :points, Integer, :default => 0
-        key :level, Integer, :default => 0
+        key :points, Integer, default: 0
+        key :level, Integer, default: 0
       elsif Merit.orm == :mongoid
         field :sash_id
-        field :points, :type => Integer, :default => 0
-        field :level, :type => Integer, :default => 0
+        field :points, type: Integer, default: 0
+        field :level, type: Integer, default: 0
         def find_by_id(id)
-          where(:_id => id).first
+          where(_id: id).first
         end
       end
     end

data/lib/merit/models/active_record/merit/action.rb

@@ -4,7 +4,9 @@ module Merit
 
     has_many :activity_logs, class_name: Merit::ActivityLog
 
-    attr_accessible :user_id, :action_method, :action_value, :had_errors,
-      :target_model, :target_id, :processed, :log
+    if Rails.version < '4'
+      attr_accessible :user_id, :action_method, :action_value, :had_errors,
+        :target_model, :target_id, :processed, :log
+    end
   end
 end

data/lib/merit/models/active_record/merit/activity_log.rb

@@ -5,6 +5,8 @@ module Merit
     belongs_to :action, class_name: Merit::Action
     belongs_to :related_change, polymorphic: true
 
-    attr_accessible :action_id, :related_change, :description, :created_at
+    if Rails.version < '4'
+      attr_accessible :action_id, :related_change, :description, :created_at
+    end
   end
 end

data/lib/merit/models/active_record/merit/badges_sash.rb

@@ -1,9 +1,13 @@
 module Merit
   class BadgesSash < ActiveRecord::Base
     belongs_to :sash
-    has_many :activity_logs, class_name: Merit::ActivityLog, as: :related_change
+    has_many :activity_logs,
+      class_name: Merit::ActivityLog,
+      as: :related_change
 
-    attr_accessible :badge_id
+    if Rails.version < '4'
+      attr_accessible :badge_id
+    end
 
     def self.last_granted(options = {})
       options[:since_date] ||= 1.month.ago

data/lib/merit/models/active_record/merit/sash.rb

@@ -6,13 +6,13 @@ module Merit
   # It's existence make join models like badges_users and scores_users
   # unnecessary. It should be transparent at the application.
   class Sash < ActiveRecord::Base
-    has_many :badges_sashes, :dependent => :destroy
-    has_many :scores, :dependent => :destroy, :class_name => 'Merit::Score'
+    has_many :badges_sashes, dependent: :destroy
+    has_many :scores, dependent: :destroy, class_name: 'Merit::Score'
 
     after_create :create_scores
 
     def badges
-      badge_ids.collect { |b_id| Badge.find(b_id) }
+      badge_ids.map { |id| Badge.find id }
     end
 
     def badge_ids
@@ -30,19 +30,19 @@ module Merit
     end
 
 
-    def points(category = 'default')
-      scores.where(:category => category).first.points
+    def points(category = :default)
+      scores.where(category: category).first.points
     end
 
-    def add_points(num_points, log = 'Manually granted through `add_points`', category = 'default')
+    def add_points(num_points, log = 'Manually granted', category = :default)
       point = Merit::Score::Point.new
       point.log = log
       point.num_points = num_points
-      self.scores.where(:category => category).first.score_points << point
+      self.scores.where(category: category).first.score_points << point
       point
     end
 
-    def substract_points(num_points, log = 'Manually granted through `add_points`', category = 'default')
+    def substract_points(num_points, log = 'Manually granted', category = :default)
       add_points -num_points, log, category
     end
 

data/lib/merit/models/active_record/merit/score.rb

@@ -2,7 +2,9 @@ module Merit
   class Score < ActiveRecord::Base
     self.table_name = :merit_scores
     belongs_to :sash
-    has_many :score_points, :dependent => :destroy, class_name: 'Merit::Score::Point'
+    has_many :score_points,
+      dependent: :destroy,
+      class_name: 'Merit::Score::Point'
 
     # Meant to display a leaderboard. Accepts options :table_name (users by
     # default), :since_date (1.month.ago by default) and :limit (10 by
@@ -43,8 +45,10 @@ SQL
     end
 
     class Point < ActiveRecord::Base
-      belongs_to :score, :class_name => 'Merit::Score'
-      has_many :activity_logs, class_name: Merit::ActivityLog, as: :related_change
+      belongs_to :score, class_name: 'Merit::Score'
+      has_many :activity_logs,
+        class_name: Merit::ActivityLog,
+        as: :related_change
     end
   end
 end