merit 0.2.4 → 0.2.5

data/README.markdown

@@ -0,0 +1,154 @@
+# Merit Gem: Reputation rules (badges, points and rankings) for Rails applications
+
+![Merit](http://i567.photobucket.com/albums/ss118/DeuceBigglebags/th_nspot26_300.jpg)
+
+
+# Installation
+
+1. Add 'merit' 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>
+5. Configure reputation rules for your application
+
+---
+
+# Defining badge rules
+
+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>: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>
+  * 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
+    expected values
+
+## Examples
+
+    grant_on 'comments#vote', :badge => 'relevant-commenter', :to => :user do
+      { :votes => 5 }
+    end
+
+    grant_on ['users#create', 'users#update'], :badge => 'autobiographer', :temporary => true do |user|
+      user.name.present? && user.address.present?
+    end
+
+---
+
+# Defining point rules
+
+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>:
+
+## Examples
+
+    score 10, :on => [
+      'users#update'
+    ]
+
+    score 15, :on => 'reviews#create', :to => [:reviewer, :reviewed]
+
+    score 20, :on => [
+      'comments#create',
+      'photos#create'
+    ]
+
+---
+
+# Defining rank rules
+
+Rankings are very similar to badges. They give "badges" which have a hierarchy
+defined by <tt>level</tt>'s lexicografical order (greater is better). If a
+rank is granted, lower level ranks are taken off. 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>:
+
+<tt>set_rank</tt> accepts:
+
+* <tt>badge_name</tt> name of this ranking
+* <tt>:level</tt> ranking level (greater is better)
+* <tt>:to</tt> model or scope to check if new rankings apply
+
+Check for rules on a rake task executed in background like:
+
+    task :cron => :environment do
+      MeritRankRules.new.check_rank_rules
+    end
+
+
+## Examples
+
+    set_rank :stars, :level => 2, :to => Commiter.active do |commiter|
+      commiter.branches > 1 && commiter.followers >= 10
+    end
+
+    set_rank :stars, :level => 3, :to => Commiter.active do |commiter|
+      commiter.branches > 2 && commiter.followers >= 20
+    end
+
+---
+
+# Grant manually
+
+You may also add badges/rank "by hand" from controller actions:
+
+    Badge.find(3).grant_to(current_user)
+
+---
+
+# Upgrade to 0.2.0
+
+Added <tt>had_errors</tt> boolean attribute to <tt>merit_actions</tt> table.
+
+---
+
+# Test application
+
+To run tests follow:
+
+    cd test/dummy
+    rails g merit:install # Next n's for not overriding already defined rules
+    n
+    n
+    n
+    rails g merit user
+    rake db:migrate ; rake db:seed
+    cd ../.. ; rake test
+
+---
+
+# To-do list
+
+* Ranking should not be badges, so .badges doesn't return them (2-stars
+  shouldn't be badge).
+* <tt>grep -r 'FIXME\|TODO' .</tt>
+* :value parameter (for star voting for example) should be configurable
+  (depends on params[:value] on the controller).
+* Make fixtures for integration testing (now creating objects on test file!).
+
+---
+
+# Contributors
+
+* [A4bandas media](https://github.com/a4bandas)
+* [Juan Schwindt](https://github.com/jschwindt)
+* [Eric Knudtson](https://github.com/ek)

data/lib/merit/controller_extensions.rb

@@ -10,7 +10,7 @@ module Merit
         point_rules = ::MeritPointRules.new
         if badge_rules.defined_rules[action].present? || point_rules.actions_to_point[action].present?
           target_id = params[:id]
-          # TODO: target_object should be configurable (now it's singularized controller name) // Should be using model_name? Only for badges now
+          # TODO: target_object should be configurable (now it's singularized controller name)
           target_object = instance_variable_get(:"@#{controller_name.singularize}")
           unless target_id =~ /^[0-9]+$/ # id nil, or string (friendly_id)?
             target_id = target_object.try(:id)

data/lib/merit/rules_points.rb

@@ -11,7 +11,10 @@ module Merit
       options[:to] ||= [:action_user]
       targets = options[:to].kind_of?(Array) ? options[:to] : [options[:to]]
       actions.each do |action|
-        actions_to_point[action] = { to: targets, score: points }
+        actions_to_point[action] = {
+          :to => targets,
+          :score => points
+        }
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: merit
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-09 00:00:00.000000000 Z
+date: 2012-02-29 00:00:00.000000000 Z
 dependencies: []
 description: General reputation Rails engine.
 email: tutecosta@gmail.com
@@ -45,7 +45,7 @@ files:
 - MIT-LICENSE
 - Rakefile
 - Gemfile
-- README.rdoc
+- README.markdown
 homepage: 
 licenses: []
 post_install_message: 

data/README.rdoc

@@ -1,136 +0,0 @@
-= Merit Rails Gem
-
-Define reputation for users and data on your application.
-
-http://i567.photobucket.com/albums/ss118/DeuceBigglebags/th_nspot26_300.jpg
-
-
-= Installation
-
-1. Add 'merit' to your Gemfile
-2. Run +rails+ +g+ +merit+:+install+
-3. Run +rails+ +g+ +merit+ +MODEL_NAME+
-4. Run +rake+ +db+:+migrate+
-5. Configure reputation rules for your application
-
-
-= Defining badge rules
-
-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 +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 user to badge.
-* :+model_name+ (string): when controller's name differs from the model being
-  worked (like RegistrationsController for User model).
-* :+temporary+ (boolean): if the condition doesn't hold and the receiver had
-  the badge, it gets removed. +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
-    expected values
-
-== Examples
-
-    grant_on 'comments#vote', :badge => 'relevant-commenter', :to => :user do
-      { :votes => 5 }
-    end
-
-    grant_on ['users#create', 'users#update'], :badge => 'autobiographer', :temporary => true do |user|
-      user.name.present? && user.address.present?
-    end
-
-
-= Defining point rules
-
-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 (or array of methods) defined in the +:to+ option.
-
-Define rules on +app/models/merit_point_rules.rb+:
-
-== Examples
-
-    score 10, :on => [
-      'users#update'
-    ]
-
-    score 15, :on => 'reviews#create', :to => [:reviewer, :reviewed]
-
-    score 20, :on => [
-      'comments#create',
-      'photos#create'
-    ]
-
-
-= Defining rank rules
-
-Rankings are very similar to badges. They give "badges" which have a hierarchy
-defined by +level+'s lexicografical order (greater is better). If a rank is
-granted, lower level ranks are taken off. 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 +app/models/merit_rank_rules.rb+:
-
-+set_rank+ accepts:
-* +badge_name+ name of this ranking
-* :+level+ ranking level (greater is better)
-* :+to+ model or scope to check if new rankings apply
-
-Check for rules on a rake task executed in background like:
-    task :cron => :environment do
-      MeritRankRules.new.check_rank_rules
-    end
-
-
-== Examples
-
-    set_rank :stars, :level => 2, :to => Commiter.active do |commiter|
-      commiter.branches > 1 && commiter.followers >= 10
-    end
-
-    set_rank :stars, :level => 3, :to => Commiter.active do |commiter|
-      commiter.branches > 2 && commiter.followers >= 20
-    end
-
-
-= Grant manually
-
-You may also add badges/rank "by hand" from controller actions:
-   Badge.find(3).grant_to(current_user)
-
-
-= Upgrade to 0.2.0
-
-Added +had_errors+ boolean attribute to +merit_actions+ table.
-
-
-= Test application
-
-To run the test application inside this gem follow:
-  cd test/dummy
-  rails g merit:install
-  rails g merit user
-  rake db:migrate ; rake db:seed
-  rails s
-
-
-= To-do list
-
-* Test points granting with different options.
-* Test model_name attribute for badge_rules.
-* Add model_name option on rank and point rules.
-* Ranking should not be badges, so .badges doesn't return them (2-stars shouldn't be badge).
-* grep -r 'FIXME\|TODO' .
-* :value parameter (for star voting for example) should be configurable (depends
-  on params[:value] on the controller).
-* Make fixtures for integration testing (now creating objects on test file!).