merit 1.0.0 → 1.0.1

data/Gemfile.lock

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

data/README.md

@@ -45,7 +45,6 @@ holds. Badges may have levels, and may be temporary. Define rules on
 
 ## Examples
 
-
 ```ruby
 grant_on 'comments#vote', :badge => 'relevant-commenter', :to => :user do |comment|
   comment.votes.count == 5
@@ -74,28 +73,41 @@ Badge.find(3).delete_from(current_user)
 
 # 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 `:to` option. Define rules on
+Points are given to "meritable" resources on actions-triggered, either to the
+action user or to the method(s) defined in the `:to` option. Define rules on
 `app/models/merit/point_rules.rb`:
 
+`score` accepts:
+
+* `:on` action as string or array of strings (similar to Rails routes)
+* `:to` method(s) to send to the target_object (who should be scored?)
+* `&block`
+  * empty (always scores)
+  * a block which evaluates to boolean (recieves target object as parameter)
+
 ## Examples
 
 ```ruby
-score 10, :to => :post_creator, :on => 'comments#create'
+score 10, :to => :post_creator, :on => 'comments#create' do |comment|
+  comment.title.present?
+end
 
 score 20, :on => [
   'comments#create',
   'photos#create'
 ]
+
+score 15, :on => 'reviews#create', :to => [:reviewer, :reviewed]
 ```
 
-`:to` method(s) work as in badge rules: they are sent to the target_object.
-In the following example, after a review gets created both `review.reviewer`
-and `review.reviewed` are granted 15 points:
+## Score manually
+
+You may also change user points "by hand":
 
 ```ruby
-score 15, :on => 'reviews#create', :to => [:reviewer, :reviewed]
+current_user.add_points(20, 'Optional log message')
+
+current_user.substract_points(10)
 ```
 
 ---
@@ -146,4 +158,3 @@ end
 * :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!).
-* Rules should be cached? Calling *Rules.new more than once

data/UPGRADING.md

@@ -1,5 +1,9 @@
 # Upgrading
 
+## to 1.0.1
+
+Adds Merit::Point#created_at attribute.
+
 ## to 1.0.0
 
 Points granting history is now logged.

data/lib/generators/active_record/templates/create_scores_and_points.rb

@@ -9,6 +9,7 @@ class CreateScoresAndPoints < ActiveRecord::Migration
       t.references :score
       t.integer :num_points, :default => 0
       t.string :log
+      t.datetime :created_at
     end
   end
 

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

@@ -1,16 +1,19 @@
 # Points are a simple integer value which are given to "meritable" resources
-# according to rules in +app/models/merit_point_rules.rb+. They are given on
+# according to rules in +app/models/merit/point_rules.rb+. They are given on
 # actions-triggered, either to the action user or to the method (or array of
 # methods) defined in the +:to+ option.
+#
+# 'score' method may accept a block which evaluates to boolean
+# (recieves the object as parameter)
 
 module Merit
   class PointRules
     include Merit::PointRulesMethods
 
     def initialize
-      # score 10, :on => [
-      #   'users#update'
-      # ]
+      # score 10, :on => 'users#update' do
+      #   user.name.present?
+      # end
       #
       # score 15, :on => 'reviews#create', :to => [:reviewer, :reviewed]
       #

data/lib/merit/rules_badge.rb

@@ -1,6 +1,6 @@
 module Merit
   # La configuración para especificar cuándo aplicar cada badge va en
-  # app/models/merit_rules.rb, con la siguiente sintaxis:
+  # app/models/merit/badge_rules.rb, con la siguiente sintaxis:
   #
   #   grant_on 'users#create', :badge => 'just', :level => 'registered' do
   #     # Nothing, or code block which evaluates to boolean

data/lib/merit/rules_points.rb

@@ -1,6 +1,6 @@
 module Merit
   # Points are a simple integer value which are given to "meritable" resources
-  # according to rules in +app/models/merit_point_rules.rb+. They are given on
+  # according to rules in +app/models/merit/point_rules.rb+. They are given on
   # actions-triggered.
   module PointRulesMethods
     # Define rules on certaing actions for giving points

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.0.0'
+  s.version     = '1.0.1'
   s.authors     = ["Tute Costa"]
   s.email       = 'tutecosta@gmail.com'
   s.add_dependency 'ambry',  '~> 0.3.0'

data/test/dummy-mongoid/app/models/merit/point_rules.rb

@@ -1,5 +1,5 @@
 # Points are a simple integer value which are given to "meritable" resources
-# according to rules in +app/models/merit_point_rules.rb+. They are given on
+# according to rules in +app/models/merit/point_rules.rb+. They are given on
 # actions-triggered.
 
 module Merit

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

@@ -1,5 +1,5 @@
 # Points are a simple integer value which are given to "meritable" resources
-# according to rules in +app/models/merit_point_rules.rb+. They are given on
+# according to rules in +app/models/merit/point_rules.rb+. They are given on
 # actions-triggered.
 
 module Merit

data/test/dummy/db/migrate/20121013174256_create_scores_and_points.rb

@@ -9,6 +9,7 @@ class CreateScoresAndPoints < ActiveRecord::Migration
       t.references :score
       t.integer :num_points, :default => 0
       t.string :log
+      t.datetime :created_at
     end
   end
 

data/test/dummy/db/schema.rb

@@ -47,9 +47,10 @@ ActiveRecord::Schema.define(:version => 20121013174256) do
   end
 
   create_table "merit_score_points", :force => true do |t|
-    t.integer "score_id"
-    t.integer "num_points", :default => 0
-    t.string  "log"
+    t.integer  "score_id"
+    t.integer  "num_points", :default => 0
+    t.string   "log"
+    t.datetime "created_at"
   end
 
   create_table "merit_scores", :force => true do |t|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: merit
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors: