merit 0.5.0 → 0.6.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    merit (0.4.2)
+    merit (0.6.0)
       ambry
 
 GEM

data/README.md

@@ -96,7 +96,7 @@ Define rules on <tt>app/models/merit_rank_rules.rb</tt>:
 Check for rules on a rake task executed in background like:
 
     task :cron => :environment do
-      MeritRankRules.new.check_rank_rules
+      Merit::RankRules.new.check_rank_rules
     end
 
 
@@ -115,7 +115,6 @@ Check for rules on a rake task executed in background like:
 # To-do list
 
 * Abstract User (rule.rb#51 for instance) into a Merit option.
-* What happens if 'class MeritPointRules; include Merit::PointRules' is changed by 'module Merit::PointRules'?
 * Should namespace app/models into Merit module.
 * rescue ActiveRecord::... should depend on ORM used (MongoMapper?)
 * Why 1.8.7 tests are not passing?

data/UPGRADING.md

@@ -1,5 +1,20 @@
 # Upgrading
 
+## to 0.6.0
+
+<tt>MeritBadgeRules</tt>, <tt>MeritPointRules</tt> and <tt>MeritRankRules</tt>
+are now namespaced into Merit module. Move and change:
+
+<pre>
+app/models/merit_{badge|point|rank}_rules.rb -> app/models/merit/{badge|point|rank}_rules.rb
+</pre>
+<pre>
+-class Merit{Badge|Point|Rank}Rules
+-  include Merit::{Badge|Point|Rank}Rules
++module Merit
++  class {Badge|Point|Rank}Rules
+</pre>
+
 ## to 0.5.0
 
 Add <tt>log:string</tt> column to <tt>merit_actions</tt> table.

data/app/models/merit_action.rb

@@ -14,7 +14,7 @@ class MeritAction
       end
 
       # Check Point rules
-      actions_to_point = MeritPointRules.new.actions_to_point
+      actions_to_point = Merit::PointRules.new.actions_to_point
       if actions_to_point[action_name].present?
         point_rule = actions_to_point[action_name]
         point_rule[:to].each do |to|

data/lib/generators/merit/install_generator.rb

@@ -5,9 +5,9 @@ module Merit
       desc "Copy config and rules files"
       def copy_migrations_and_model
         template 'merit.rb', 'config/initializers/merit.rb'
-        template 'merit_badge_rules.rb', 'app/models/merit_badge_rules.rb'
-        template 'merit_point_rules.rb', 'app/models/merit_point_rules.rb'
-        template 'merit_rank_rules.rb', 'app/models/merit_rank_rules.rb'
+        template 'merit_badge_rules.rb', 'app/models/merit/badge_rules.rb'
+        template 'merit_point_rules.rb', 'app/models/merit/point_rules.rb'
+        template 'merit_rank_rules.rb', 'app/models/merit/rank_rules.rb'
       end
     end
   end

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

@@ -14,27 +14,27 @@
 # badge is granted, then it's removed. It's false by default (badges are kept
 # forever).
 
-class MeritBadgeRules
-  include Merit::BadgeRules
+module Merit
+  class BadgeRules
+    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
 
-  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
+      # If it has 10 comments, grant commenter-10 badge
+      # grant_on 'comments#create', :badge => 'commenter', :level => 10 do |comment|
+      #   comment.user.comments.count == 10
+      # end
 
-    # If it has 10 comments, grant commenter-10 badge
-    # grant_on 'comments#create', :badge => 'commenter', :level => 10 do |comment|
-    #   comment.user.comments.count == 10
-    # end
+      # If it has 5 votes, grant relevant-commenter badge
+      # grant_on 'comments#vote', :badge => 'relevant-commenter', :to => :user do |comment|
+      #   comment.votes.count == 5
+      # end
 
-    # If it has 5 votes, grant relevant-commenter badge
-    # grant_on 'comments#vote', :badge => 'relevant-commenter', :to => :user do |comment|
-    #   comment.votes.count == 5
-    # end
-
-    # Changes his name by one wider than 4 chars (arbitrary ruby code case)
-    # grant_on 'registrations#update', :badge => 'autobiographer', :temporary => true, :model_name => 'User' do |user|
-    #   user.name.length > 4
-    # end
+      # Changes his name by one wider than 4 chars (arbitrary ruby code case)
+      # grant_on 'registrations#update', :badge => 'autobiographer', :temporary => true, :model_name => 'User' do |user|
+      #   user.name.length > 4
+      # end
+    end
   end
-end
+end

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

@@ -3,19 +3,19 @@
 # actions-triggered, either to the action user or to the method (or array of
 # methods) defined in the +:to+ option.
 
-class MeritPointRules
-  include Merit::PointRules
-
-  def initialize
-    # score 10, :on => [
-    #   'users#update'
-    # ]
-    #
-    # score 15, :on => 'reviews#create', :to => [:reviewer, :reviewed]
-    #
-    # score 20, :on => [
-    #   'comments#create',
-    #   'photos#create'
-    # ]
+module Merit
+  class PointRules
+    def initialize
+      # score 10, :on => [
+      #   'users#update'
+      # ]
+      #
+      # score 15, :on => 'reviews#create', :to => [:reviewer, :reviewed]
+      #
+      # score 20, :on => [
+      #   'comments#create',
+      #   'photos#create'
+      # ]
+    end
   end
-end
+end

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

@@ -8,20 +8,20 @@
 # * :+level_name+ attribute name (default is empty and results in 'level'
 #   attribute, if set it's appended like 'level_#{level_name}')
 
-class MeritRankRules
-  include Merit::RankRules
-
-  def initialize
-    # set_rank :level => 1, :to => Commiter.active do |commiter|
-    #   commiter.repositories.count > 1 && commiter.followers >= 10
-    # end
-    #
-    # set_rank :level => 2, :to => Commiter.active do |commiter|
-    #   commiter.branches.count > 1 && commiter.followers >= 10
-    # end
-    #
-    # set_rank :level => 3, :to => Commiter.active do |commiter|
-    #   commiter.branches.count > 2 && commiter.followers >= 20
-    # end
+module Merit
+  class RankRules
+    def initialize
+      # set_rank :level => 1, :to => Commiter.active do |commiter|
+      #   commiter.repositories.count > 1 && commiter.followers >= 10
+      # end
+      #
+      # set_rank :level => 2, :to => Commiter.active do |commiter|
+      #   commiter.branches.count > 1 && commiter.followers >= 10
+      # end
+      #
+      # set_rank :level => 3, :to => Commiter.active do |commiter|
+      #   commiter.branches.count > 2 && commiter.followers >= 20
+      # end
+    end
   end
-end
+end

data/lib/merit/controller_extensions.rb

@@ -6,8 +6,8 @@ module Merit
     def self.included(base)
       base.after_filter do |controller|
         action      = "#{controller_name}\##{action_name}"
-        badge_rules = ::MeritBadgeRules.new
-        point_rules = ::MeritPointRules.new
+        badge_rules = BadgeRules.new
+        point_rules = PointRules.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)

data/lib/merit/rules_badge.rb

@@ -29,7 +29,7 @@ module Merit
   #
   # Luego chequea las condiciones sincronizadamente, o mediante un proceso en
   # background, por ejemplo cada 5 minutos (Merit::BadgeRules#check_new_actions).
-  module BadgeRules
+  class BadgeRules
     # Define rule for granting badges
     def grant_on(action, *args, &block)
       options = args.extract_options!

data/lib/merit/rules_points.rb

@@ -2,7 +2,7 @@ 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
   # actions-triggered.
-  module PointRules
+  class PointRules
     # Define rules on certaing actions for giving points
     def score(points, *args, &block)
       options = args.extract_options!

data/lib/merit/rules_rank.rb

@@ -8,7 +8,7 @@ module Merit
   # * :+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}')
-  module RankRules
+  class RankRules
     # Populates +defined_rules+ hash with following hierarchy:
     #   defined_rules[ModelToRank] = { levels => blocks }
     def set_rank(*args, &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.5.0"
+  s.version     = "0.6.0"
   s.authors     = ["Tute Costa"]
   s.email       = 'tutecosta@gmail.com'
   s.add_dependency 'ambry'

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

@@ -0,0 +1,41 @@
+# +grant_on+ accepts:
+# * Nothing (always grants)
+# * A block which evaluates to boolean (recieves the object as parameter)
+# * A block with a hash composed of methods to run on the target object with
+#   expected values (+:votes => 5+ for instance).
+#
+# +grant_on+ can have a +:to+ method name, which called over the target object
+# should retrieve the object to badge (could be +:user+, +:self+, +:follower+,
+# etc). If it's not defined merit will apply the badge to the user who
+# triggered the action (:action_user by default). If it's :itself, it badges
+# the created object (new user for instance).
+#
+# The :temporary option indicates that if the condition doesn't hold but the
+# badge is granted, then it's removed. It's false by default (badges are kept
+# forever).
+
+module Merit
+  class BadgeRules
+    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
+
+      # If it has 10 comments, grant commenter-10 badge
+      grant_on 'comments#create', :badge => 'commenter', :level => 10 do |comment|
+        comment.user.comments.count == 10
+      end
+
+      # If it has at least 10 votes, grant relevant-commenter badge
+      grant_on 'comments#vote', :badge => 'relevant-commenter', :to => :user do |comment|
+        comment.votes >= 10
+      end
+
+      # Changes his name by one wider than 4 chars (arbitrary ruby code and custom model_name)
+      # This badge is temporary (user may lose it)
+      grant_on 'registrations#update', :badge => 'autobiographer', :temporary => true, :model_name => 'User' do |user|
+        user.name.length > 4
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# 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
+# actions-triggered.
+
+module Merit
+  class PointRules
+    def initialize
+      score 5, :to => :user, :on => [
+        'comments#vote'
+      ]
+
+      score 20, :on => [
+        'comments#create',
+        'registrations#update'
+      ]
+    end
+  end
+end

data/test/dummy/app/models/{merit_rank_rules.rb → merit/rank_rules.rb}

@@ -8,14 +8,14 @@
 # * :+level_name+ attribute name (default is empty and results in 'level'
 #   attribute, if set it's appended like 'level_#{level_name}')
 
-class MeritRankRules
-  include Merit::RankRules
-
-  def initialize
-    # i stars for i chars name
-    (1..5).each do |i|
-      set_rank :level => i, :to => User do |user|
-        user.name.length == i
+module Merit
+  class RankRules
+    def initialize
+      # i stars for i chars name
+      (1..5).each do |i|
+        set_rank :level => i, :to => User do |user|
+          user.name.length == i
+        end
       end
     end
   end

data/test/integration/navigation_test.rb

@@ -106,7 +106,7 @@ class NavigationTest < ActiveSupport::IntegrationCase
 
     user = User.where(:name => 'ab').first
     assert_equal 0, user.level, "User level should be 0."
-    MeritRankRules.new.check_rank_rules
+    Merit::RankRules.new.check_rank_rules
     user.reload
     assert_equal 2, user.level, "User level should be 2."
 
@@ -116,7 +116,7 @@ class NavigationTest < ActiveSupport::IntegrationCase
     click_button('Update User')
 
     user = User.where(:name => 'a').first
-    MeritRankRules.new.check_rank_rules
+    Merit::RankRules.new.check_rank_rules
     user.reload
     assert_equal 2, user.level, "User level should be 2."
 
@@ -126,7 +126,7 @@ class NavigationTest < ActiveSupport::IntegrationCase
     click_button('Update User')
 
     user = User.where(:name => 'abcde').first
-    MeritRankRules.new.check_rank_rules
+    Merit::RankRules.new.check_rank_rules
     user.reload
     assert_equal 5, user.level, "User level should be 5."
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: merit
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ambry
-  requirement: &70296877186780 !ruby/object:Gem::Requirement
+  requirement: &70166979392500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70296877186780
+  version_requirements: *70166979392500
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70296877186260 !ruby/object:Gem::Requirement
+  requirement: &70166979391980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 3.0.10
   type: :development
   prerelease: false
-  version_requirements: *70296877186260
+  version_requirements: *70166979391980
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70296877185840 !ruby/object:Gem::Requirement
+  requirement: &70166979391560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70296877185840
+  version_requirements: *70166979391560
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &70296879096200 !ruby/object:Gem::Requirement
+  requirement: &70166981534740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70296879096200
+  version_requirements: *70166981534740
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &70296879094600 !ruby/object:Gem::Requirement
+  requirement: &70166981531180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70296879094600
+  version_requirements: *70166981531180
 description: Manage badges, points and rankings (reputation) of resources in a Rails
   application.
 email: tutecosta@gmail.com
@@ -112,9 +112,9 @@ files:
 - test/dummy/app/controllers/users_controller.rb
 - test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/models/comment.rb
-- test/dummy/app/models/merit_badge_rules.rb
-- test/dummy/app/models/merit_point_rules.rb
-- test/dummy/app/models/merit_rank_rules.rb
+- test/dummy/app/models/merit/badge_rules.rb
+- test/dummy/app/models/merit/point_rules.rb
+- test/dummy/app/models/merit/rank_rules.rb
 - test/dummy/app/models/user.rb
 - test/dummy/app/views/comments/_form.html.erb
 - test/dummy/app/views/comments/edit.html.erb

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

@@ -1,41 +0,0 @@
-# +grant_on+ accepts:
-# * Nothing (always grants)
-# * A block which evaluates to boolean (recieves the object as parameter)
-# * A block with a hash composed of methods to run on the target object with
-#   expected values (+:votes => 5+ for instance).
-#
-# +grant_on+ can have a +:to+ method name, which called over the target object
-# should retrieve the object to badge (could be +:user+, +:self+, +:follower+,
-# etc). If it's not defined merit will apply the badge to the user who
-# triggered the action (:action_user by default). If it's :itself, it badges
-# the created object (new user for instance).
-#
-# The :temporary option indicates that if the condition doesn't hold but the
-# badge is granted, then it's removed. It's false by default (badges are kept
-# forever).
-
-class MeritBadgeRules
-  include Merit::BadgeRules
-
-  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
-
-    # If it has 10 comments, grant commenter-10 badge
-    grant_on 'comments#create', :badge => 'commenter', :level => 10 do |comment|
-      comment.user.comments.count == 10
-    end
-
-    # If it has at least 10 votes, grant relevant-commenter badge
-    grant_on 'comments#vote', :badge => 'relevant-commenter', :to => :user do |comment|
-      comment.votes >= 10
-    end
-
-    # Changes his name by one wider than 4 chars (arbitrary ruby code and custom model_name)
-    # This badge is temporary (user may lose it)
-    grant_on 'registrations#update', :badge => 'autobiographer', :temporary => true, :model_name => 'User' do |user|
-      user.name.length > 4
-    end
-  end
-end

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

@@ -1,18 +0,0 @@
-# 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
-# actions-triggered.
-
-class MeritPointRules
-  include Merit::PointRules
-
-  def initialize
-    score 5, :to => :user, :on => [
-      'comments#vote'
-    ]
-
-    score 20, :on => [
-      'comments#create',
-      'registrations#update'
-    ]
-  end
-end