merit 0.7.1 → 0.8.0

data/Gemfile

@@ -1,2 +1,7 @@
 source "http://rubygems.org"
+
+# TODO: Why do we need them here if they are in .gemspec?
+gem 'bson_ext'
+gem 'mongoid', '2.4.8'
+
 gemspec

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    merit (0.7.1)
-      ambry
+    merit (0.8.0)
+      ambry (~> 0.3.0)
 
 GEM
   remote: http://rubygems.org/
@@ -37,6 +37,9 @@ GEM
     addressable (2.2.7)
     ambry (0.3.0)
     arel (3.0.2)
+    bson (1.6.2)
+    bson_ext (1.6.2)
+      bson (~> 1.6.2)
     builder (3.0.0)
     capybara (1.1.2)
       mime-types (>= 1.16)
@@ -61,6 +64,12 @@ GEM
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.18)
+    mongo (1.6.2)
+      bson (~> 1.6.2)
+    mongoid (2.4.8)
+      activemodel (~> 3.1)
+      mongo (~> 1.3)
+      tzinfo (~> 0.3.22)
     multi_json (1.3.2)
     nokogiri (1.5.2)
     polyglot (0.3.3)
@@ -118,9 +127,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  bson_ext
   capybara
   haml
   merit!
+  mongoid (= 2.4.8)
   rails (~> 3.2.3)
   simplecov
   sqlite3

data/README.md

@@ -5,12 +5,18 @@
 [![Build Status](https://secure.travis-ci.org/tute/merit.png?branch=master)](http://travis-ci.org/tute/merit)
 
 
+# Requirements
+
+* ActiveRecord or Mongoid
+
 # Installation
 
-1. Add <tt>gem 'merit'</tt> to your Gemfile
-2. Run <tt>rails g merit:install</tt>
-3. Run <tt>rails g merit MODEL_NAME</tt>
-4. Run <tt>rake db:migrate</tt>
+1. Add `gem 'merit'` to your `Gemfile`
+2. Run `rails g merit:install`
+3. Run `rails g merit MODEL_NAME`
+4.
+  * ActiveRecord: Run `rake db:migrate`
+  * Mongoid: Set `config.orm = :mongoid` in `config/initializers/merit.rb`
 5. Configure reputation rules for your application
 
 ---
@@ -19,21 +25,21 @@
 
 You may give badges to any resource on your application if some condition
 holds. Badges may have levels, and may be temporary. Define rules on
-<tt>app/models/merit_badge_rules.rb</tt>:
-
-<tt>grant_on</tt> accepts:
-
-* <tt>'controller#action'</tt> string (similar to Rails routes)
-* <tt>:badge</tt> for badge name
-* <tt>:level</tt> for badge level
-* <tt>:to</tt> method name over target_object which obtains object to badge
-* <tt>:model_name</tt> (string) define controller's name if it differs from
-  the model (like <tt>RegistrationsController</tt> for <tt>User</tt> model).
-* <tt>:multiple</tt> (boolean) badge may be granted multiple times
-* <tt>:temporary</tt> (boolean) if the receiver had the badge but the
-  condition doesn't hold anymore, remove it. <tt>false</tt> by default (badges
-  are kept forever).
-* <tt>&block</tt>
+`app/models/merit_badge_rules.rb`:
+
+`grant_on` accepts:
+
+* `'controller#action'` string (similar to Rails routes)
+* `:badge` for badge name
+* `:level` for badge level
+* `:to` method name over target_object which obtains object to badge
+* `:model_name` (string) define controller's name if it differs from
+  the model (like `RegistrationsController` for `User` model).
+* `:multiple` (boolean) badge may be granted multiple times
+* `:temporary` (boolean) if the receiver had the badge but the condition
+  doesn't hold anymore, remove it. `false` by default (badges are kept
+  forever).
+* `&block`
   * empty (always grants)
   * a block which evaluates to boolean (recieves target object as parameter)
   * a block with a hash composed of methods to run on the target object with
@@ -41,19 +47,24 @@ holds. Badges may have levels, and may be temporary. Define rules on
 
 ## Examples
 
-    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|
-      user.name.present? && user.address.present?
-    end
+```ruby
+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|
+  user.name.present? && user.address.present?
+end
+```
 
 ## Grant manually
 
 You may also grant badges "by hand":
 
-    Badge.find(3).grant_to(current_user)
+```ruby
+Badge.find(3).grant_to(current_user)
+```
 
 ---
 
@@ -61,21 +72,23 @@ You may also grant badges "by hand":
 
 Points are a simple integer value which are given to "meritable" resources.
 They are given on actions-triggered, either to the action user or to the
-method(s) defined in the <tt>:to</tt> option. Define rules on
-<tt>app/models/merit_point_rules.rb</tt>:
+method(s) defined in the `:to` option. Define rules on
+`app/models/merit_point_rules.rb`:
 
 ## Examples
 
-    score 10, :on => [
-      'users#update'
-    ]
+```ruby
+score 10, :on => [
+  'users#update'
+]
 
-    score 15, :on => 'reviews#create', :to => [:reviewer, :reviewed]
+score 15, :on => 'reviews#create', :to => [:reviewer, :reviewed]
 
-    score 20, :on => [
-      'comments#create',
-      'photos#create'
-    ]
+score 20, :on => [
+  'comments#create',
+  'photos#create'
+]
+```
 
 ---
 
@@ -84,42 +97,48 @@ method(s) defined in the <tt>:to</tt> option. Define rules on
 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.
 
-Define rules on <tt>app/models/merit_rank_rules.rb</tt>:
+Define rules on `app/models/merit_rank_rules.rb`:
 
-<tt>set_rank</tt> accepts:
+`set_rank` accepts:
 
-* <tt>:level</tt> ranking level (greater is better)
-* <tt>:to</tt> model or scope to check if new rankings apply
-* <tt>:level_name</tt> attribute name (default is empty and results in
-  '<tt>level</tt>' attribute, if set it's appended like
-  '<tt>level_#{level_name}</tt>')
+* `:level` ranking level (greater is better)
+* `:to` model or scope to check if new rankings apply
+* `:level_name` attribute name (default is empty and results in
+  '`level`' attribute, if set it's appended like
+  '`level_#{level_name}`')
 
 Check for rules on a rake task executed in background like:
 
-    task :cron => :environment do
-      Merit::RankRules.new.check_rank_rules
-    end
+```ruby
+task :cron => :environment do
+  Merit::RankRules.new.check_rank_rules
+end
+```
 
 
 ## Examples
 
-    set_rank :level => 2, :to => Commiter.active do |commiter|
-      commiter.branches > 1 && commiter.followers >= 10
-    end
+```ruby
+set_rank :level => 2, :to => Commiter.active do |commiter|
+  commiter.branches > 1 && commiter.followers >= 10
+end
 
-    set_rank :level => 3, :to => Commiter.active do |commiter|
-      commiter.branches > 2 && commiter.followers >= 20
-    end
+set_rank :level => 3, :to => Commiter.active do |commiter|
+  commiter.branches > 2 && commiter.followers >= 20
+end
+```
 
 ---
 
 # To-do list
 
+* Can infer params[:id] = instance_variable.id in create actions, for having
+  the object in the rule method parameter, so we don't need it in controllers.
 * add an error handler for inexistent badges.
 * rails g merit MODEL_NAME shouldn't create general migrations again.
 * Abstract User (rule.rb#51 for instance) into a Merit option.
 * Should namespace app/models into Merit module.
-* rescue ActiveRecord::... should depend on ORM used (MongoMapper?)
+* rescue ActiveRecord::... should depend on ORM used
 * Why 1.8.7 tests are not passing?
 * :value parameter (for star voting for example) should be configurable
   (depends on params[:value] on the controller).

data/TESTING.txt

@@ -1,11 +1,16 @@
 cd test/dummy
-rails g merit:install # Next n's for not overriding already defined rules
+rails g merit:install # n's for not overriding already defined badges & rules
+n
 n
 n
 n
 rails g merit user
 rake db:migrate ; rake db:seed
+
 # see it in the browser
 rails server
+
 # or run tests
-cd ../.. ; rake test
+cd ../..
+rake test
+ORM=mongoid rake test

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

@@ -3,7 +3,7 @@ Merit.setup do |config|
   # Check rules on each request or in background
   # config.checks_on_each_request = true
 
-  # Define ORM. Could be :active_record (default) and :mongo_mapper
+  # Define ORM. Could be :active_record (default) and :mongo_mapper and :mongoid
   # config.orm = :active_record
 end
 

data/lib/merit.rb

@@ -21,9 +21,10 @@ module Merit
 
   class Engine < Rails::Engine
     initializer 'merit.controller' do |app|
-      # Merit.orm now set
       if Merit.orm == :active_record
+        require "merit/models/#{Merit.orm}/sash"
         require "merit/models/#{Merit.orm}/badges_sash"
+      elsif Merit.orm == :mongoid
         require "merit/models/#{Merit.orm}/sash"
       end
 

data/lib/merit/controller_extensions.rb

@@ -25,7 +25,7 @@ module Merit
             :had_errors    => target_object.try(:errors).try(:present?),
             :target_model  => controller_name,
             :target_id     => target_id
-          )
+          ).id
 
           # Check rules in after_filter?
           if Merit.checks_on_each_request
@@ -37,7 +37,7 @@ module Merit
               granted = log.split('|').select{|log| log =~ /badge_granted_to_action_user/ }
               granted.each do |badge|
                 badge_id = badge.split(':').last.to_i
-                flash[:merit] = t('merit.flashs.badge_granted', badge: Badge.find(badge_id).name)
+                flash[:merit] = t('merit.flashs.badge_granted', :badge => Badge.find(badge_id).name)
               end
             end
           end

data/lib/merit/model_additions.rb

@@ -10,6 +10,10 @@ module Merit
         key :sash_id, String
         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
       end
     end
   end
@@ -21,8 +25,8 @@ module Merit
 
   # Create sash if doesn't have
   def create_sash_if_none
-    if sash.nil?
-      self.sash = Sash.new
+    if self.sash.blank?
+      self.sash = Sash.create
       self.save(:validate => false)
     end
   end
@@ -34,3 +38,6 @@ end
 if Object.const_defined?('MongoMapper')
   MongoMapper::Document.plugin Merit
 end
+if Object.const_defined?('Mongoid')
+  Mongoid::Document.send :include, Merit
+end

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

@@ -8,5 +8,6 @@ class MeritAction
   key :target_model, String
   key :target_id, String
   key :processed, Boolean, :default => false
+  key :log, String
   timestamps!
 end

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

@@ -0,0 +1,13 @@
+class MeritAction
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  belongs_to :user
+  field :action_method
+  field :action_value, :type => Integer
+  field :had_errors, :type => Boolean
+
+  belongs_to :target, :polymorphic => true
+  field :processed, :type => Boolean, :default => false
+  field :log
+end

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

@@ -0,0 +1,14 @@
+class Sash
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :badge_ids, :type => Array, :default => []
+
+  def add_badge(badge_id)
+    self.push(:badge_ids, badge_id)
+  end
+
+  def rm_badge(badge_id)
+    self.pull(:badge_ids, badge_id)
+  end
+end

data/lib/merit/rule.rb

@@ -9,7 +9,7 @@ module Merit
     def applies?(target_obj = nil)
       return true if block.nil? # no block given: always true
 
-      case block.parameters.count
+      case block.arity
       when 1 # Expects target object
         if target_obj.present?
           return block.call(target_obj)
@@ -72,7 +72,9 @@ module Merit
       if @badge.nil?
         badges = Badge.by_name(badge_name)
         badges = badges.by_level(level) unless level.nil?
-        @badge = badges.first
+        if !(@badge = badges.first)
+          raise "No badge '#{badge_name}'#{level.nil? ? '' : " with level #level"} found. Define it in 'config/initializers/merit.rb'."
+        end
       end
       @badge
     end

data/lib/merit/rules_rank.rb

@@ -28,7 +28,12 @@ module Merit
         level_and_rules = level_and_rules.sort
         level_and_rules.each do |level, rule|
           begin
-            scoped_model.where("#{rule.level_name} < #{level}").each do |obj|
+            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
@@ -45,4 +50,4 @@ module Merit
       @defined_rules ||= {}
     end
   end
-end
+end

data/merit.gemspec

@@ -4,13 +4,16 @@ 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     = "0.7.1"
+  s.version     = "0.8.0"
   s.authors     = ["Tute Costa"]
   s.email       = 'tutecosta@gmail.com'
-  s.add_dependency 'ambry'
+  s.add_dependency 'ambry',  '~> 0.3.0'
   s.add_development_dependency 'rails', '~> 3.2.3'
   s.add_development_dependency 'sqlite3'
   s.add_development_dependency 'haml'
   s.add_development_dependency 'capybara'
   s.add_development_dependency 'simplecov'
+  # Testing with Mongoid
+  s.add_development_dependency 'bson_ext'
+  s.add_development_dependency 'mongoid', '~> 2.0.0'
 end

data/test/dummy-mongoid/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+DummyMongoid::Application.load_tasks

data/test/dummy-mongoid/app/controllers/application_controller.rb

@@ -0,0 +1,7 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+
+  def current_user
+    @current_user ||= User.first
+  end
+end