merit 1.5.0 → 1.6.0

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

@@ -8,7 +8,7 @@ module Merit
     key :had_errors, Boolean
     key :target_model, String
     key :target_id, String
-    key :processed, Boolean, :default => false
+    key :processed, Boolean, default: false
     key :log, String
     timestamps!
   end

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

@@ -8,6 +8,7 @@ class Sash
     self.badge_ids << badge_id
     self.save
   end
+
   def rm_badge(badge_id)
     self.badge_ids -= [badge_id]
     self.save

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

@@ -5,11 +5,11 @@ module Merit
 
     belongs_to :user
     field :action_method
-    field :action_value, :type => Integer
-    field :had_errors, :type => Boolean
+    field :action_value, type: Integer
+    field :had_errors, type: Boolean
 
-    belongs_to :target, :polymorphic => true
-    field :processed, :type => Boolean, :default => false
+    belongs_to :target, polymorphic: true
+    field :processed, type: Boolean, default: false
     field :log
   end
 end

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

@@ -2,7 +2,7 @@ class Sash
   include Mongoid::Document
   include Mongoid::Timestamps
 
-  field :badge_ids, :type => Array, :default => []
+  field :badge_ids, type: Array, default: []
 
   def add_badge(badge_id)
     self.push(:badge_ids, badge_id)

data/lib/merit/observer.rb

@@ -0,0 +1,13 @@
+module Merit
+  # TODO: Observer is a misleading name, there's no way to register other
+  # observers yet
+  module Observer
+    def notify_observers(action_id, related_change, description = '')
+      ActivityLog.create(
+        action_id: action_id,
+        related_change: related_change,
+        description: description
+      )
+    end
+  end
+end

data/lib/merit/rule.rb

@@ -15,7 +15,7 @@ module Merit
         if target_obj.present?
           block.call(target_obj)
         else
-          Rails.logger.warn "[merit] no target_obj found on Rule#applies?"
+          Rails.logger.warn '[merit] no target_obj found on Rule#applies?'
           false
         end
       when 0

data/lib/merit/rules_badge_methods.rb

@@ -1,10 +1,10 @@
 module Merit
   module BadgeRulesMethods
     # Define rule for granting badges
-    def grant_on(action, *args, &block)
+    def grant_on(actions, *args, &block)
       options = args.extract_options!
 
-      actions = Array.wrap(action)
+      actions = Array.wrap(actions)
 
       rule = Rule.new
       rule.badge_name = options[:badge]

data/lib/merit/rules_matcher.rb

@@ -0,0 +1,24 @@
+module Merit
+  class RulesMatcher
+
+    def initialize(path, action_name)
+      @path = path
+      @action_name = action_name
+    end
+
+    def select_from(rules)
+      rules.select { |glob, _| entire_path =~ Regexp.new(glob) }.values.flatten
+    end
+
+    def any_matching?
+      select_from(AppBadgeRules).any? || select_from(AppPointRules).any?
+    end
+
+    private
+
+    def entire_path
+      @entire_path ||= [@path, @action_name].join('#')
+    end
+
+  end
+end

data/lib/merit/rules_rank_methods.rb

@@ -1,7 +1,7 @@
 module Merit
   # 5 stars is a common ranking use case. They are not given at specified
-  # actions like badges, you should define a cron job to test if ranks are to be
-  # granted.
+  # actions like badges, you should define a cron job to test if ranks are to
+  # be granted.
   #
   # +set_rank+ accepts:
   # * :+level+ ranking level (greater is better)
@@ -16,7 +16,11 @@ module Merit
 
       rule = Rule.new
       rule.block = block
-      rule.level_name = options[:level_name].present? ? "level_#{options[:level_name]}" : 'level'
+      if options[:level_name].present?
+        rule.level_name = "level_#{options[:level_name]}"
+      else
+        rule.level_name = 'level'
+      end
 
       defined_rules[options[:to]] ||= {}
       defined_rules[options[:to]].merge!({ options[:level] => rule })
@@ -41,12 +45,12 @@ module Merit
 
     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
+        next unless rule.applies?(object)
+        object.update_attribute rule.level_name, level
       end
-    rescue ActiveRecord::StatementInvalid => msg
-      raise RankAttributeNotDefined, "Add #{rule.level_name} column to #{scoped_model.new.class.name}\n[#{msg}]"
+    rescue ActiveRecord::StatementInvalid
+      str = "Add #{rule.level_name} column to #{scoped_model.class.name}"
+      raise RankAttributeNotDefined, str
     end
 
     def scope_to_promote(scope, level_name, level)

data/lib/merit/target_finder.rb

@@ -6,9 +6,12 @@ module Merit
 
     def find
       target = case rule.to
-               when :itself; base_target
-               when :action_user; action_user
-               else; other_target
+               when :itself then
+                 base_target
+               when :action_user then
+                 action_user
+               else
+                 other_target
                end
       Array.wrap(target)
     end
@@ -23,8 +26,8 @@ module Merit
       user = Merit.user_model.find_by_id action.user_id
       if user.nil?
         user_model = Merit.user_model
-        message = "[merit] no #{user_model} found with id #{action.user_id}"
-        Rails.logger.warn message
+        str = "[merit] no #{user_model} found with id #{action.user_id}"
+        Rails.logger.warn str
       end
       user
     end
@@ -32,10 +35,10 @@ module Merit
     def other_target
       base_target.send rule.to
     rescue NoMethodError
-      message = "[merit] NoMethodError on"
-      message << " `#{base_target.class.name}##{rule.to}`"
-      message << " (called from Merit::TargetFinder#other_target)"
-      Rails.logger.warn message
+      str = '[merit] NoMethodError on'
+      str << " `#{base_target.class.name}##{rule.to}`"
+      str << ' (called from Merit::TargetFinder#other_target)'
+      Rails.logger.warn str
     end
 
   end

data/merit.gemspec

@@ -4,14 +4,14 @@ 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.5.0'
+  s.version     = '1.6.0'
   s.authors     = ["Tute Costa"]
   s.email       = 'tutecosta@gmail.com'
 
   s.required_ruby_version = '>= 1.9.2'
 
   s.add_dependency 'ambry',  '~> 0.3.0'
-  s.add_development_dependency 'rails', '~> 3.2.3'
+  s.add_development_dependency 'rails', '~> 3.2.0'
   s.add_development_dependency 'sqlite3'
   s.add_development_dependency 'haml'
   s.add_development_dependency 'capybara'
@@ -19,7 +19,4 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'minitest'
   s.add_development_dependency 'minitest-spec'
   s.add_development_dependency 'mocha', '0.13.3'
-  # Testing with Mongoid
-  s.add_development_dependency 'bson_ext'
-  s.add_development_dependency 'mongoid', '~> 2.0.0'
 end

data/test/dummy/app/controllers/api/users_controller.rb

@@ -0,0 +1,5 @@
+class Api::UsersController < ApplicationController
+  def index
+    render json: User.all.to_json
+  end
+end

data/test/dummy/app/controllers/comments_controller.rb

@@ -1,38 +1,16 @@
 class CommentsController < ApplicationController
-  # GET /comments
-  # GET /comments.xml
   def index
     @comments = Comment.all
-
-    respond_to do |format|
-      format.html # index.html.erb
-      format.xml  { render :xml => @comments }
-    end
   end
 
-  # GET /comments/1
-  # GET /comments/1.xml
   def show
     @comment = Comment.find(params[:id])
-
-    respond_to do |format|
-      format.html # show.html.erb
-      format.xml  { render :xml => @comment }
-    end
   end
 
-  # GET /comments/new
-  # GET /comments/new.xml
   def new
     @comment = Comment.new
-
-    respond_to do |format|
-      format.html # new.html.erb
-      format.xml  { render :xml => @comment }
-    end
   end
 
-  # GET /comments/1/edit
   def edit
     @comment = Comment.find(params[:id])
   end
@@ -44,35 +22,21 @@ class CommentsController < ApplicationController
     redirect_to(comments_url, :notice => 'Vote added!')
   end
 
-  # POST /comments
-  # POST /comments.xml
   def create
-    @comment = Comment.new(params[:comment])
-
-    respond_to do |format|
-      if @comment.save
-        format.html { redirect_to(@comment, :notice => 'Comment was successfully created.') }
-        format.xml  { render :xml => @comment, :status => :created, :location => @comment }
-      else
-        format.html { render "new" }
-        format.xml  { render :xml => @comment.errors, :status => :unprocessable_entity }
-      end
+    @comment = Comment.new(comment_params)
+    if @comment.save
+      redirect_to(@comment, :notice => 'Comment was successfully created.')
+    else
+      render "new"
     end
   end
 
-  # PUT /comments/1
-  # PUT /comments/1.xml
   def update
     @comment = Comment.find(params[:id])
-
-    respond_to do |format|
-      if @comment.update_attributes(params[:comment])
-        format.html { redirect_to(@comment, :notice => 'Comment was successfully updated.') }
-        format.xml  { head :ok }
-      else
-        format.html { render "edit" }
-        format.xml  { render :xml => @comment.errors, :status => :unprocessable_entity }
-      end
+    if @comment.update_attributes(comment_params)
+      redirect_to(@comment, :notice => 'Comment was successfully updated.')
+    else
+      render "edit"
     end
   end
 
@@ -81,10 +45,12 @@ class CommentsController < ApplicationController
   def destroy
     @comment = Comment.find(params[:id])
     @comment.destroy
+    redirect_to(comments_url)
+  end
 
-    respond_to do |format|
-      format.html { redirect_to(comments_url) }
-      format.xml  { head :ok }
-    end
+  private
+
+  def comment_params
+    params.require(:comment).permit!
   end
 end

data/test/dummy/app/controllers/registrations_controller.rb

@@ -3,7 +3,7 @@ class RegistrationsController < ApplicationController
     @user = User.find(params[:id])
 
     respond_to do |format|
-      if @user.update_attributes(params[:user])
+      if @user.update_attributes(user_params)
         format.html { redirect_to(@user, :notice => 'User was successfully updated.') }
         format.xml  { head :ok }
       else
@@ -12,4 +12,10 @@ class RegistrationsController < ApplicationController
       end
     end
   end
+
+  private
+
+    def user_params
+      params.require(:user).permit!
+    end
 end

data/test/dummy/app/controllers/users_controller.rb

@@ -1,67 +1,38 @@
 class UsersController < ApplicationController
-  # GET /users
-  # GET /users.xml
   def index
     @users = User.all
-
-    respond_to do |format|
-      format.html # index.html.erb
-      format.xml  { render :xml => @users }
-    end
   end
 
-  # GET /users/1
-  # GET /users/1.xml
   def show
     @user = User.find(params[:id])
-
-    respond_to do |format|
-      format.html # show.html.erb
-      format.xml  { render :xml => @user }
-    end
   end
 
-  # GET /users/new
-  # GET /users/new.xml
   def new
     @user = User.new
-
-    respond_to do |format|
-      format.html # new.html.erb
-      format.xml  { render :xml => @user }
-    end
   end
 
-  # GET /users/1/edit
   def edit
     @user = User.find(params[:id])
   end
 
-  # POST /users
-  # POST /users.xml
   def create
-    @user = User.new(params[:user])
-
-    respond_to do |format|
-      if @user.save
-        format.html { redirect_to(@user, :notice => 'User was successfully created.') }
-        format.xml  { render :xml => @user, :status => :created, :location => @user }
-      else
-        format.html { render "new" }
-        format.xml  { render :xml => @user.errors, :status => :unprocessable_entity }
-      end
+    @user = User.new(user_params)
+    if @user.save
+      redirect_to(@user, :notice => 'User was successfully created.')
+    else
+      render "new"
     end
   end
 
-  # DELETE /users/1
-  # DELETE /users/1.xml
   def destroy
     @user = User.find(params[:id])
     @user.destroy
+    redirect_to(users_url)
+  end
 
-    respond_to do |format|
-      format.html { redirect_to(users_url) }
-      format.xml  { head :ok }
-    end
+  private
+
+  def user_params
+    params.require(:user).permit!
   end
 end

data/test/dummy/app/models/comment.rb

@@ -3,7 +3,9 @@ class Comment < ActiveRecord::Base
 
   belongs_to :user
 
-  attr_accessible :name, :comment, :user_id, :votes
+  if Rails.version < '4'
+    attr_accessible :name, :comment, :user_id, :votes
+  end
 
   validates :name, :comment, :user_id, :presence => true
 

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

@@ -2,7 +2,7 @@
 # * Nothing (always grants)
 # * A block which evaluates to boolean (recieves the object as parameter)
 # * A block with a hash composed of methods to run on the target object with
-#   expected values (+:votes => 5+ for instance).
+#   expected values (+votes: 5+ for instance).
 #
 # +grant_on+ can have a +:to+ method name, which called over the target object
 # should retrieve the object to badge (could be +:user+, +:self+, +:follower+,
@@ -22,33 +22,36 @@ module Merit
       # If it creates user, grant badge
       # Should be "current_user" after registration for badge to be granted.
       # Example rule with block with no parameters
-      grant_on 'users#create', :badge => 'just-registered', :to => :itself do
+      grant_on 'users#create', badge: 'just-registered', to: :itself do
         true
       end
 
       # Example rule for multiple badge granting
-      grant_on 'users#index', :badge => 'gossip', :multiple => true
+      grant_on 'users#index', badge: 'gossip', multiple: true
 
       # Example rule for badge granting in namespaced controllers
-      grant_on 'admin/users#index', :badge => 'visited_admin'
+      grant_on 'admin/users#index', badge: 'visited_admin'
+
+      # Example rule for testing badge granting in differently namespaced controllers.
+      grant_on '.*users#index', badge: 'wildcard_badge', multiple: true
 
       # If it has 10 comments, grant commenter-10 badge
-      grant_on 'comments#create', :badge => 'commenter', :level => 10 do |comment|
+      grant_on 'comments#create', badge: 'commenter', level: 10 do |comment|
         comment.user.comments.count >= 10
       end
       # Testing badge granting in more than one rule per action with different targets
-      grant_on 'comments#create', :badge => 'has_commenter_friend', :to => :friend do |comment|
+      grant_on 'comments#create', badge: 'has_commenter_friend', to: :friend do |comment|
         comment.user.comments.count >= 10
       end
 
       # If it has at least 10 votes, grant relevant-commenter badge
-      grant_on 'comments#vote', :badge => 'relevant-commenter', :to => :user do |comment|
+      grant_on 'comments#vote', badge: 'relevant-commenter', to: :user do |comment|
         comment.votes >= 10
       end
 
       # Changes his name by one wider than 4 chars (arbitrary ruby code and custom model_name)
       # This badge is temporary (user may lose it)
-      grant_on 'registrations#update', :badge => 'autobiographer', :temporary => true, :model_name => 'User' do |user|
+      grant_on 'registrations#update', badge: 'autobiographer', temporary: true, model_name: 'User' do |user|
         user.name.length > 4
       end
     end