merit 1.6.1 → 1.6.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d0a820341d6408878856c250741dc432cf69e87
+  data.tar.gz: 5c62d13ececa1fbc100635867a24f1ede459ea7b
+SHA512:
+  metadata.gz: 8701d647ca74706f02beabb79392e7e35015719b05aef83476a97ae2f86810bace21184065bf1aed45a6f08b40ace8a94e5957a04cd743162e158f0ee433f4b4
+  data.tar.gz: 321f7574c41b967a5e13af373f387b48b47cc7817397b5777d1c84ef75192edaa97de25cd96ca87b370e2783d59872636fac5fcc1b319a7d5d5a909d02ce70c3

data/Gemfile

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

data/README.md

@@ -1,4 +1,6 @@
-# Merit Gem: Reputation rules (badges, points and rankings) for Rails applications
+# Merit
+Merit is a reputation Ruby gem that supports Badges, Points, and Rankings.
+
 
 ![Merit gem](http://i567.photobucket.com/albums/ss118/DeuceBigglebags/th_nspot26_300.jpg)
 
@@ -11,36 +13,61 @@
 2. Run `rails g merit:install`
 3. Run `rails g merit MODEL_NAME` (e.g. `user`)
 4. Run `rake db:migrate`
-5. Define badges you will use in `config/initializers/merit.rb`
+5. Define badges in `config/initializers/merit.rb`
 6. Configure reputation rules for your application in `app/models/merit/*`
 
 ---
 
-# 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`:
+# Badges
+## Creating Badges
+Create badges in `config/initializers/merit.rb`
 
-`grant_on` accepts:
+`Merit::Badge.create!` takes a hash describing the badge:
+* `:id` integer (reqired)
+* `:name` this is how you reference the badge (required)
+* `:level` (optional)
+* `:description` (optional)
+* `:custom_fields` hash of anything else you want associated with the badge (optional)
 
-* `'controller#action'` string (similar to Rails routes)
-* `:badge` for badge name
-* `:level` for badge level
-* `:to` method name over target_object which obtains object(s) 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
-    expected values
+### Example
+```ruby
+Merit::Badge.create! ({
+  id: 1,
+  name: "Yearling",
+  description: "Active member for a year",
+  custom_fields: { difficulty: :silver }
+})
+```
 
-## Examples
+## Defining Badge Rules
+Badges can be automatically given to any resource in your application based on rules and conditions you create.
+Badges can also have levels, and be permanent or temporary (A temporary badge is revoked when the conditions of the badge are no longer met).
+
+Badge rules / conditions are defined in `app/models/merit/badge_rules.rb` `initialize` block by calling `grant_on` with the following parameters:
+
+* `'controller#action'` a string similar to Rails routes
+* `:badge` corresponds to the `:name` of the badge
+* `:level` corresponds to the `:level` of the badge
+* `:to` the object's field to give the badge to
+  * If you are putting badges on the related user then this field is probably
+    `:user`.
+  * Needs a variable named `@model` in the associated controller action, like
+    `@post` for `posts_controller.rb` or `@comment` for `comments_controller.rb`.
+    Implementation note: Merit finds the object with following snippet:
+    `instance_variable_get(:"@#{controller_name.singularize}")`.
+* `:model_name` define the controller's name if it's different from
+  the model's (e.g. `RegistrationsController` for the `User` model).
+* `:multiple` whether or not the badge may be granted multiple times. `false` by default.
+* `:temporary` whether or not the badge should be revoked if the condition no
+  longer holds. `false` -badges are kept for ever- by default.
+* `&block` can be one of the following:
+  * empty / not included: always grant the badge
+  * a block which evaluates to boolean. It recieves the target object as
+    parameter (e.g. `@post` if you're working with a PostsController action).
+  * a block with a hash composed of methods to run on the target object and
+    expected method return values
+
+### Examples
 
 ```ruby
 # app/models/merit/badge_rules.rb
@@ -49,10 +76,12 @@ grant_on 'comments#vote', badge: 'relevant-commenter', to: :user do |comment|
 end
 
 grant_on ['users#create', 'users#update'], badge: 'autobiographer', temporary: true do |user|
-  user.name.present? && user.address.present?
+  user.name.present? && user.email.present?
 end
 ```
 
+## Other Badge Actions
+
 ```ruby
 # Check granted badges
 current_user.badges # Returns an array of badges
@@ -69,7 +98,7 @@ Badge.last_granted
 # List 20 badge grants in the last week
 Badge.last_granted(since_date: 1.week.ago, limit: 20)
 
-# Get related entries of a given badge (unreleased)
+# Get related entries of a given badge
 Badge.find(1).users
 ```
 
@@ -85,6 +114,9 @@ action user or to the method(s) defined in the `:to` option. Define rules on
 
 * `: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?)
+* `:model_name` (optional) to specify the model name if it cannot be guessed from the controller.
+  (e.g. `model_name: 'User'` for `RegistrationsController`, or
+        `model_name: 'Comment'` for `Api::CommentsController`)
 * `&block`
   * empty (always scores)
   * a block which evaluates to boolean (recieves target object as parameter)
@@ -167,6 +199,7 @@ end
 
 # To-do list
 
+* Finish Observer implementation for `Judge`.
 * Move level from meritable model into Sash
 * `ActivityLog` should replace `add_points` `log` parameter
 * FIXMES and TODOS.

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

@@ -4,7 +4,7 @@ module Merit
 
     has_many :activity_logs, class_name: Merit::ActivityLog
 
-    if Rails.version < '4'
+    unless defined?(ActionController::StrongParameters)
       attr_accessible :user_id, :action_method, :action_value, :had_errors,
         :target_model, :target_id, :processed, :log
     end

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

@@ -5,7 +5,7 @@ module Merit
     belongs_to :action, class_name: Merit::Action
     belongs_to :related_change, polymorphic: true
 
-    if Rails.version < '4'
+    unless defined?(ActionController::StrongParameters)
       attr_accessible :action_id, :related_change, :description, :created_at
     end
   end

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

@@ -5,7 +5,7 @@ module Merit
       class_name: Merit::ActivityLog,
       as: :related_change
 
-    if Rails.version < '4'
+    unless defined?(ActionController::StrongParameters)
       attr_accessible :badge_id
     end
 

data/lib/merit/rules_points_methods.rb

@@ -15,6 +15,7 @@ module Merit
         rule.score = points
         rule.to    = to
         rule.block = block
+        rule.model_name = options[:model_name] if options[:model_name]
 
         actions.each do |action|
           defined_rules[action] ||= []

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.6.1'
+  s.version     = '1.6.2'
   s.authors     = ["Tute Costa"]
   s.email       = 'tutecosta@gmail.com'
 
@@ -13,10 +13,8 @@ Gem::Specification.new do |s|
   s.add_dependency 'ambry',  '~> 0.3.0'
   s.add_development_dependency 'rails', '~> 3.2.0'
   s.add_development_dependency 'sqlite3'
-  s.add_development_dependency 'haml'
   s.add_development_dependency 'capybara'
   s.add_development_dependency 'simplecov'
-  s.add_development_dependency 'minitest'
-  s.add_development_dependency 'minitest-spec'
+  s.add_development_dependency 'minitest-rails'
   s.add_development_dependency 'mocha', '0.13.3'
 end

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

@@ -0,0 +1,5 @@
+class Api::CommentsController < ApplicationController
+  def show
+    render json: {}
+  end
+end

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

@@ -3,7 +3,7 @@ class Comment < ActiveRecord::Base
 
   belongs_to :user
 
-  if Rails.version < '4'
+  unless defined?(ActionController::StrongParameters)
     attr_accessible :name, :comment, :user_id, :votes
   end
 

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

@@ -16,6 +16,9 @@ module Merit
       # Points to voted user
       score 5, to: :user, on: 'comments#vote'
 
+      # Example rule for using model_name in the case of namespaced controllers
+      score 1, to: :user, model_name: 'Comment', on: 'api/comments#show'
+
       score 20, on: [
         'comments#create',
         'registrations#update'

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

@@ -3,7 +3,7 @@ class User < ActiveRecord::Base
 
   has_many :comments
 
-  if Rails.version < '4'
+  unless defined?(ActionController::StrongParameters)
     attr_accessible :name
   end
 

data/test/dummy/config/routes.rb

@@ -4,6 +4,7 @@ Dummy::Application.routes.draw do
   end
   namespace :api do
     get '/users' => 'users#index'
+    resources :comments, only: [:show]
   end
   resources :users, :except => :update
   resources :registrations, :only => :update, :as => :registrations_user

data/test/integration/navigation_test.rb

@@ -227,6 +227,15 @@ class NavigationTest < ActiveSupport::IntegrationCase
     comment_2.reload.points.must_be :==, 2
   end
 
+  test 'api/comments#show should grant 1 point to user' do
+    user = User.create(name: 'test-user')
+    assert_equal 0, user.points
+    comment = user.comments.create!(name: 'test-comment', comment: 'comment body')
+
+    visit "/api/comments/#{comment.id}"
+    assert_equal 1, user.points
+  end
+
   def badges_by_name(user, name)
     user.reload.badges.select{|b| b.name == name }
   end

data/test/test_helper.rb

@@ -1,37 +1,31 @@
 # Configure Rails Envinronment
-ENV["RAILS_ENV"] = "test"
+ENV['RAILS_ENV'] = 'test'
 RUBYOPT="-w $RUBYOPT"
 
-require 'simplecov'
-SimpleCov.adapters.define 'rubygem' do
-  # Add app to Merit group
-  # https://github.com/colszowka/simplecov/pull/104
-  add_group 'Merit', 'lib'
-  add_group 'DummyApp', 'test/dummy'
-  add_filter 'test/dummy/config/initializers'
+if ENV["COVERAGE"]
+  require 'simplecov'
+  SimpleCov.adapters.define 'rubygem' do
+    # Add app to Merit group
+    # https://github.com/colszowka/simplecov/pull/104
+    add_group 'Merit', 'lib'
+    add_group 'DummyApp', 'test/dummy'
+    add_filter 'test/dummy/config/initializers'
+  end
+  SimpleCov.start 'rubygem'
 end
-SimpleCov.start 'rubygem' if ENV["COVERAGE"]
 
-require File.expand_path("../dummy/config/environment.rb",  __FILE__)
 
-require "rails/test_help"
-
-ActionMailer::Base.delivery_method = :test
-ActionMailer::Base.perform_deliveries = true
-ActionMailer::Base.default_url_options[:host] = "test.com"
+require File.expand_path('../dummy/config/environment.rb', __FILE__)
+require 'rails/test_help'
+require 'minitest/rails'
 
 Rails.backtrace_cleaner.remove_silencers!
 
 # Configure capybara for integration testing
-require "capybara/rails"
+require 'capybara/rails'
 Capybara.default_driver   = :rack_test
 Capybara.default_selector = :css
 
-require 'minitest/spec'
-require 'minitest/autorun'
-require 'minitest/mock'
-require 'mocha/setup'
-
 ActiveRecord::Migrator.migrate File.expand_path("../dummy/db/migrate/", __FILE__)
 
 # Load support files

data/test/unit/merit_unit_test.rb

@@ -54,11 +54,11 @@ class MeritUnitTest < ActiveSupport::TestCase
     sash_2.add_points(5); sash_2.add_points(5)
 
     # Test method options
-    assert_equal Merit::Score.top_scored(table_name: :sashes),
-      [{'sash_id'=>sash_1.id, 'sum_points'=>20, 0=>1, 1=>20},
-       {'sash_id'=>sash_2.id, 'sum_points'=>10, 0=>2, 1=>10}]
-    assert_equal Merit::Score.top_scored(table_name: :sashes, limit: 1),
-      [{'sash_id'=>sash_1.id, 'sum_points'=>20, 0=>1, 1=>20}]
+    assert_equal [{'sash_id'=>sash_1.id, 'sum_points'=>20, 0=>1, 1=>20},
+      {'sash_id'=>sash_2.id, 'sum_points'=>10, 0=>2, 1=>10}],
+      Merit::Score.top_scored(table_name: :sashes)
+    assert_equal  [{'sash_id'=>sash_1.id, 'sum_points'=>20, 0=>1, 1=>20}],
+      Merit::Score.top_scored(table_name: :sashes, limit: 1)
   end
 
   test 'unknown ranking raises exception' do

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: merit
 version: !ruby/object:Gem::Version
-  version: 1.6.1
-  prerelease: 
+  version: 1.6.2
 platform: ruby
 authors:
 - Tute Costa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-04 00:00:00.000000000 Z
+date: 2013-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ambry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,103 +41,62 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: haml
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-spec
+  name: minitest-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -150,7 +104,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -261,6 +214,7 @@ files:
 - test/dummy-mongoid/script/rails
 - test/dummy/Rakefile
 - test/dummy/app/controllers/admin/users_controller.rb
+- test/dummy/app/controllers/api/comments_controller.rb
 - test/dummy/app/controllers/api/users_controller.rb
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/controllers/comments_controller.rb
@@ -334,27 +288,26 @@ files:
 - test/unit/target_finder_test.rb
 homepage: http://github.com/tute/merit
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: General reputation Rails engine.
 test_files: []
 has_rdoc: