merit 0.6.3 → 0.7.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    merit (0.6.3)
+    merit (0.7.0)
       ambry
 
 GEM
@@ -96,6 +96,10 @@ GEM
       libwebsocket (~> 0.1.3)
       multi_json (~> 1.0)
       rubyzip
+    simplecov (0.6.4)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
     sprockets (2.1.3)
       hike (~> 1.2)
       rack (~> 1.0)
@@ -118,4 +122,5 @@ DEPENDENCIES
   haml
   merit!
   rails (~> 3.2.3)
+  simplecov
   sqlite3

data/README.md

@@ -29,6 +29,7 @@ holds. Badges may have levels, and may be temporary. Define rules on
 * <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).
@@ -114,6 +115,7 @@ Check for rules on a rake task executed in background like:
 
 # To-do list
 
+* 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.

data/TESTING.txt

@@ -0,0 +1,11 @@
+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
+# see it in the browser
+rails server
+# or run tests
+cd ../.. ; rake test

data/app/models/badge.rb

@@ -27,12 +27,8 @@ class Badge
   def grant_to(object_or_sash)
     object_or_sash.create_sash_if_none unless object_or_sash.kind_of?(Sash)
     sash = object_or_sash.respond_to?(:sash) ? object_or_sash.sash : object_or_sash
-    if sash.badge_ids.include?(id)
-      return false
-    else
-      sash.add_badge(id)
-      return true
-    end
+    sash.add_badge(id)
+    return true
   end
 
   # Take out badge from sash

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  merit:
+    flashs:
+      badge_granted: "Congratulations! You've just earned '%{badge}' badge."

data/lib/merit/controller_extensions.rb

@@ -17,11 +17,10 @@ module Merit
           end
 
           # TODO: value should be configurable (now it's params[:value] set in the controller)
-          value = params[:value]
-          MeritAction.create(
+          merit_action_id = MeritAction.create(
             :user_id       => current_user.try(:id),
             :action_method => action_name,
-            :action_value  => value,
+            :action_value  => params[:value],
             :had_errors    => target_object.try(:errors).try(:present?),
             :target_model  => controller_name,
             :target_id     => target_id
@@ -30,6 +29,16 @@ module Merit
           # Check rules in after_filter?
           if Merit.checks_on_each_request
             badge_rules.check_new_actions
+
+            # Show flash msg?
+            if (log = MeritAction.find(merit_action_id).log)
+              # Badges granted to current_user
+              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)
+              end
+            end
           end
         end
       end

data/lib/merit/model_additions.rb

@@ -16,7 +16,7 @@ module Merit
 
   def badges
     create_sash_if_none
-    Badge.find_by_id(sash.badge_ids)
+    sash.badge_ids.collect{|b_id| Badge.find(b_id) }
   end
 
   # Create sash if doesn't have

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

@@ -13,7 +13,7 @@ class Sash < ActiveRecord::Base
   end
   def rm_badge(badge_id)
     badges_sashes = BadgesSash.where(:badge_id => badge_id, :sash_id => self.id)
-    # ActiveRecord::Relation#delete doesn't work with composite keys.
+    # ActiveRecord::Relation#delete|destroy(_all) doesn't work with composite keys.
     # Badge is not AR model (Ambry) so can't do self.badges.find(badge_id).delete
     badges_sash = badges_sashes.first
     badges_sashes.delete_all

data/lib/merit/rule.rb

@@ -3,7 +3,7 @@ module Merit
   # and a temporary option.
   # Could split this class between badges and rankings functionality
   class Rule
-    attr_accessor :badge_name, :level, :to, :temporary, :block, :model_name, :level_name
+    attr_accessor :badge_name, :level, :to, :multiple, :temporary, :block, :model_name, :level_name
 
     # Does this rule's condition block apply?
     def applies?(target_obj = nil)
@@ -22,7 +22,7 @@ module Merit
       end
     end
 
-    # Is this rule's badge temporary?
+    def multiple?; self.multiple; end
     def temporary?; self.temporary; end
 
     # Grant badge if rule applies. If it doesn't, and the badge is temporary,
@@ -34,12 +34,14 @@ module Merit
       end
 
       if applies? action.target_object(model_name)
-        if badge.grant_to(sash)
-          action.log!("badge_granted:#{badge.name}")
+        if !sash.badge_ids.include?(badge.id) || multiple?
+          badge.grant_to(sash)
+          to_action_user = (to.to_sym == :action_user ? '_to_action_user' : '')
+          action.log!("badge_granted#{to_action_user}:#{badge.id}")
         end
       elsif temporary?
         if badge.delete_from(sash)
-          action.log!("badge_removed:#{badge.name}")
+          action.log!("badge_removed:#{badge.id}")
         end
       end
     end

data/lib/merit/rules_badge.rb

@@ -40,6 +40,7 @@ module Merit
       rule.badge_name = options[:badge]
       rule.level      = options[:level]
       rule.to         = options[:to] || :action_user
+      rule.multiple   = options[:multiple] || false
       rule.temporary  = options[:temporary] || false
       rule.model_name = options[:model_name] || actions[0].split('#')[0]
       rule.block      = block

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     = "0.6.3"
+  s.version     = "0.7.0"
   s.authors     = ["Tute Costa"]
   s.email       = 'tutecosta@gmail.com'
   s.add_dependency 'ambry'
@@ -12,4 +12,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'sqlite3'
   s.add_development_dependency 'haml'
   s.add_development_dependency 'capybara'
+  s.add_development_dependency 'simplecov'
 end

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

@@ -21,7 +21,13 @@ module Merit
     def initialize
       # If it creates user, grant badge
       # Should be "current_user" after registration for badge to be granted.
-      grant_on 'users#create', :badge => 'just-registered', :to => :itself
+      # Example rule with block with no parameters
+      grant_on 'users#create', :badge => 'just-registered', :to => :itself do
+        Date.today > 1.year.ago.to_date
+      end
+
+      # Example rule for multiple badge granting
+      grant_on 'users#index', :badge => 'gossip', :multiple => true
 
       # If it has 10 comments, grant commenter-10 badge
       grant_on 'comments#create', :badge => 'commenter', :level => 10 do |comment|

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

@@ -6,6 +6,16 @@ class User < ActiveRecord::Base
   attr_accessible :name
 
   def show_badges
-    badges.collect{|b| "#{b.name.capitalize} (#{b.level})" }.join(', ')
+    create_sash_if_none
+    badges_uniq = Badge.find_by_id(sash.badge_ids)
+    badges_uniq.collect{|b| "#{b.name.capitalize}#{badge_status(b)}" }.join(', ')
+  end
+
+  def badge_status(badge)
+    status = []
+    count = badges.select{|b| b.name == badge.name }.count
+    status << "level: #{badge.level}" if badge.level
+    status << "x#{count}" if count > 1
+    status.present? ? " (#{status.join(', ')})" : ''
   end
 end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8" />
+  <title>Merit Dummy app</title>
+  <%= stylesheet_link_tag :all %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+  <h1><%= link_to 'Dummy app', '/' %></h1>
+
+  <% flash.each do |name, msg| %>
+    <%= content_tag :p, msg, :class => (name == 'error' ? 'error' : 'notice') %>
+  <% end %>
+
+  <%= yield %>
+
+  <ul>
+    <li><%= link_to 'Users', users_url %></li>
+    <li><%= link_to 'Comments', comments_url %></li>
+  </ul>
+</body>
+</html>

data/test/dummy/app/views/users/_form.html.erb

@@ -1,4 +1,4 @@
-<% obj = params[:action] == :new ? @user : [:registrations, @user] %>
+<% obj = params[:action] == 'new' ? @user : [:registrations, @user] %>
 <%= form_for obj do |f| %>
   <% if @user.errors.any? %>
     <div id="error_explanation">

data/test/dummy/config/initializers/merit.rb

@@ -29,6 +29,9 @@ badge_id = 0
 }, {
   :id => (badge_id = badge_id+1),
   :name => 'just-registered'
+}, {
+  :id => (badge_id = badge_id+1),
+  :name => 'gossip'
 }].each do |badge|
   Badge.create! badge
 end

data/test/integration/navigation_test.rb

@@ -1,15 +1,27 @@
 require 'test_helper'
 
 class NavigationTest < ActiveSupport::IntegrationCase
-  setup do
-    User.create(:name => 'test-user')
+  test 'user sign up should grant badge to itself' do
+    visit '/users/new'
+    fill_in 'Name', :with => 'Jack'
+    click_button('Create User')
+
+    user = User.where(:name => 'Jack').first
+    assert_equal [Badge.by_name('just-registered').first], user.badges.to_a
   end
 
-  test 'user workflow should grant some badges at some times' do
-    user = User.first
-    assert user.badges.empty?
+  test 'users#index should grant badge multiple times' do
+    user = User.create(:name => 'test-user')
+    visit '/users'
+    visit '/users'
+    visit '/users'
+    visit '/users'
+    assert_equal 4, User.first.badges.count
+  end
 
+  test 'user workflow should grant some badges at some times' do
     # Commented 9 times, no badges yet
+    user = User.create(:name => 'test-user')
     (1..9).each do |i|
       Comment.create(
         :name    => "Title #{i}",
@@ -65,7 +77,7 @@ class NavigationTest < ActiveSupport::IntegrationCase
   end
 
   test 'user workflow should add up points at some times' do
-    user = User.first
+    user = User.create(:name => 'test-user')
     assert_equal 0, user.points, 'User should start with 0 points'
 
     visit "/users/#{user.id}/edit"
@@ -96,7 +108,7 @@ class NavigationTest < ActiveSupport::IntegrationCase
   end
 
   test 'user workflow should grant levels at some times' do
-    user = User.first
+    user = User.create(:name => 'test-user')
     assert user.badges.empty?
 
     # Edit user's name by 2 chars name

data/test/merit_unit_test.rb

@@ -12,4 +12,11 @@ class MeritUnitTest < ActiveSupport::TestCase
     rule.block = lambda{|obj| obj.length >= 4 }
     assert rule.applies?(str), 'block should make rule apply'
   end
+
+  test "BadgeSash knows it's related badge" do
+    Badge.create(:id => 99, :name => 'test-badge')
+    badge_sash = BadgesSash.new
+    badge_sash.badge_id = 99
+    assert_equal Badge.find(99), badge_sash.badge
+  end
 end

data/test/test_helper.rb

@@ -1,5 +1,16 @@
 # Configure Rails Envinronment
 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'
+end
+SimpleCov.start 'rubygem' if ENV["COVERAGE"]
 
 require File.expand_path("../dummy/config/environment.rb",  __FILE__)
 require "rails/test_help"
@@ -19,4 +30,4 @@ Capybara.default_selector = :css
 ActiveRecord::Migrator.migrate File.expand_path("../dummy/db/migrate/", __FILE__)
 
 # Load support files
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: merit
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-28 00:00:00.000000000 Z
+date: 2012-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ambry
-  requirement: &70291939751160 !ruby/object:Gem::Requirement
+  requirement: &70355964823460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70291939751160
+  version_requirements: *70355964823460
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70291939744340 !ruby/object:Gem::Requirement
+  requirement: &70355964822720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 3.2.3
   type: :development
   prerelease: false
-  version_requirements: *70291939744340
+  version_requirements: *70355964822720
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70291939743780 !ruby/object:Gem::Requirement
+  requirement: &70355964822080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70291939743780
+  version_requirements: *70355964822080
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &70291939743320 !ruby/object:Gem::Requirement
+  requirement: &70355964821480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70291939743320
+  version_requirements: *70355964821480
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &70291939742900 !ruby/object:Gem::Requirement
+  requirement: &70355964821060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70291939742900
+  version_requirements: *70355964821060
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70355964820640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70355964820640
 description: Manage badges, points and rankings (reputation) of resources in a Rails
   application.
 email: tutecosta@gmail.com
@@ -78,9 +89,11 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- TESTING.txt
 - UPGRADING.md
 - app/models/badge.rb
 - app/models/merit_action.rb
+- config/locales/en.yml
 - lib/generators/active_record/merit_generator.rb
 - lib/generators/active_record/templates/add_fields_to_model.rb
 - lib/generators/active_record/templates/create_badges_sashes.rb
@@ -121,7 +134,7 @@ files:
 - test/dummy/app/views/comments/index.html.erb
 - test/dummy/app/views/comments/new.html.erb
 - test/dummy/app/views/comments/show.html.erb
-- test/dummy/app/views/layouts/application.html.haml
+- test/dummy/app/views/layouts/application.html.erb
 - test/dummy/app/views/users/_form.html.erb
 - test/dummy/app/views/users/edit.html.erb
 - test/dummy/app/views/users/index.html.erb

data/test/dummy/app/views/layouts/application.html.haml

@@ -1,18 +0,0 @@
-!!!
-%html
-  %head
-    %title Dummy
-    = stylesheet_link_tag :all
-    = javascript_include_tag :defaults
-    = csrf_meta_tag
-  %body
-    %h1= link_to 'Dummy app', '/'
-
-    - flash.each do |name, msg|
-      = content_tag :p, msg, :class => (name == 'error' ? 'error' : 'notice')
-
-    = yield
-
-    %ul
-      %li= link_to 'Users', users_url
-      %li= link_to 'Comments', comments_url