merit 1.0.1 → 1.1.0

data/Gemfile.lock

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

data/README.md

@@ -2,21 +2,17 @@
 
 ![Merit](http://i567.photobucket.com/albums/ss118/DeuceBigglebags/th_nspot26_300.jpg)
 
-[![Build Status](https://secure.travis-ci.org/tute/merit.png?branch=master)](http://travis-ci.org/tute/merit)
+[![Build Status](https://travis-ci.org/tute/merit.png?branch=master)](http://travis-ci.org/tute/merit)
 
 # Installation
 
 1. Add `gem 'merit'` to your `Gemfile`
 2. Run `rails g merit:install`
 3. Run `rails g merit MODEL_NAME` (e.g. `user`)
-4. Depending on your ORM
-  * ActiveRecord: Run `rake db:migrate`
-  * Mongoid: Set `config.orm = :mongoid` in `config/initializers/merit.rb`
+4. Run `rake db:migrate`
 5. Define badges you will use in `config/initializers/merit.rb`
 6. Configure reputation rules for your application in `app/models/merit/*`
 
-NOTE: Mongoid support is experimental.
-
 ---
 
 # Defining badge rules
@@ -152,9 +148,11 @@ end
 
 # To-do list
 
+* `Merit::BadgeRules.new.defined_rules` should be cached on initialization,
+  instead of initialized per controllers `after_filter` and
+  `merit_action.check_rules`.
 * target_object should be configurable (now it's singularized controller name)
 * Translate comments from spanish in `rules_badge.rb`.
 * Should namespace app/models into Merit module.
 * :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!).

data/UPGRADING.md

@@ -1,8 +1,13 @@
 # Upgrading
 
+## to 1.1.0
+
+Code refactorings. Support for Ruby 1.8.7 has been dropped.
+
 ## to 1.0.1
 
-Adds Merit::Point#created_at attribute.
+Adds `Merit::Point#created_at` (`merit_score_points` table) attribute.
+May already be added if upgrading from merit < 1).
 
 ## to 1.0.0
 
@@ -27,6 +32,7 @@ Run the following migration to have the new DB tables:
           t.references :score
           t.integer :num_points, :default => 0
           t.string :log
+          t.datetime :created_at
         end
       end
 
@@ -38,16 +44,27 @@ Run the following migration to have the new DB tables:
 
     # This will create a single point entry log, with previous points granted
     # to each meritable resource. Code example for a User class.
+
     class UpgradeMeritableResources < ActiveRecord::Migration
       def up
         User.find_each do |user|
+          unless user.sash
+            user.sash = Sash.create!
+            user.save
+          end
+
           user.sash.scores << Merit::Score.create
-          user.add_points(user.points, 'Initial merit points import.')
+          user.add_points(user.read_attribute(:points), 'Initial merit points import.')
         end
         remove_column :users, :points
       end
     end
 
+If you get an `ActiveRecord::DangerousAttributeError: points` exception, you
+may need to temporarily tweak your meritable model, as explained in
+http://stackoverflow.com/a/1515571/356060.
+
+
 ## to 0.10.0
 
 `badges_sashes` table gets a primary key `id` column. Run the following migration:

data/app/models/merit_action.rb

@@ -14,21 +14,15 @@ class MeritAction
   end
 
   def check_badge_rules
-    return if badge_rules.nil?
+    badge_rules = Merit::BadgeRules.new.defined_rules[action_str] || []
     badge_rules.each { |rule| rule.grant_or_delete_badge(self) }
   end
 
   def check_point_rules
-    return if point_rules.nil?
+    point_rules = Merit::PointRules.new.defined_rules[action_str] || []
     point_rules.each { |rule| rule.grant_points(self) }
   end
 
-  def badge_rules
-    @badge_rules ||= Merit::BadgeRules.new.defined_rules[action_str] || []
-  end
-  def point_rules
-    @point_rules ||= Merit::PointRules.new.actions_to_point[action_str] || []
-  end
   def action_str
     "#{target_model}\##{action_method}"
   end

data/lib/merit/controller_extensions.rb

@@ -8,7 +8,7 @@ module Merit
         action      = "#{controller_name}\##{action_name}"
         badge_rules = BadgeRules.new
         point_rules = PointRules.new
-        if badge_rules.defined_rules[action].present? || point_rules.actions_to_point[action].present?
+        if badge_rules.defined_rules[action].present? || point_rules.defined_rules[action].present?
           merit_action_id = MeritAction.create(
             :user_id       => send(Merit.current_user_method).try(:id),
             :action_method => action_name,

data/lib/merit/model_additions.rb

@@ -21,34 +21,37 @@ module Merit
           where(:_id => id).first
         end
       end
-    end
-  end
 
-  # Delegate relationship methods from meritable models to their sash
-  %w(badge_ids badges points).each do |method|
-    define_method(method) do
-      _sash = sash || create_sash_and_scores
-      _sash.send method
-    end
-  end
+      # Add instance methods to meritable models
+      # Using define_method on meritable classes to not pollute every model
 
-  def add_points(num_points, log = 'Manually granted through `add_points`', category = 'default')
-    _sash = sash || create_sash_and_scores
-    _sash.add_points num_points, log, category
-  end
-  def substract_points(num_points, log = 'Manually granted through `add_points`', category = 'default')
-    _sash = sash || create_sash_and_scores
-    _sash.substract_points num_points, log, category
-  end
+      # Delegate relationship methods from meritable models to their sash
+      %w(badge_ids badges points).each do |method|
+        define_method(method) do
+          _sash = sash || create_sash_and_scores
+          _sash.send method
+        end
+      end
+
+      define_method(:add_points) do |num_points, log = 'Manually through `add_points`', category = 'default'|
+        _sash = sash || create_sash_and_scores
+        _sash.add_points num_points, log, category
+      end
+      define_method(:substract_points) do |num_points, log = 'Manually through `substract_points`', category = 'default'|
+        _sash = sash || create_sash_and_scores
+        _sash.substract_points num_points, log, category
+      end
 
-  # Create sash if doesn't have
-  def create_sash_and_scores
-    if self.sash.blank?
-      self.sash = Sash.create
-      self.sash.scores << Merit::Score.create
-      self.save(:validate => false)
+      # Create sash if doesn't have
+      define_method(:create_sash_and_scores) do
+        if self.sash.blank?
+          self.sash = Sash.create
+          self.sash.scores << Merit::Score.create
+          self.save(:validate => false)
+        end
+        self.sash
+      end
     end
-    self.sash
   end
 end
 

data/lib/merit/rules_badge.rb

@@ -53,9 +53,7 @@ module Merit
 
     # Check non processed actions and grant badges if applies
     def check_new_actions
-      MeritAction.where(:processed => false).each do |merit_action|
-        merit_action.check_rules
-      end
+      MeritAction.where(:processed => false).map &:check_rules
     end
 
     # Currently defined rules

data/lib/merit/rules_points.rb

@@ -17,15 +17,15 @@ module Merit
         rule.block = block
 
         actions.each do |action|
-          actions_to_point[action] ||= []
-          actions_to_point[action] << rule
+          defined_rules[action] ||= []
+          defined_rules[action] << rule
         end
       end
     end
 
     # Currently defined rules
-    def actions_to_point
-      @actions_to_point ||= {}
+    def defined_rules
+      @defined_rules ||= {}
     end
   end
 end

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

data/test/merit_unit_test.rb

@@ -28,6 +28,23 @@ class MeritUnitTest < ActiveSupport::TestCase
     assert_equal Badge.find(98), rule.badge
   end
 
+  test "Extending only certain ActiveRecord models" do
+    class MeritableModel < ActiveRecord::Base
+      def self.columns; @columns ||= []; end
+      has_merit
+    end
+    assert MeritableModel.method_defined?(:points), 'Meritable model should respond to merit methods'
+    assert !ActiveRecord::Base.method_defined?(:points), 'ActiveRecord::Base shouldn\'t respond to merit methods'
+  end
+
+  # Do we need this non-documented attribute?
+  test "BadgesSash#set_notified! sets boolean attribute" do
+    badge_sash = BadgesSash.new
+    assert !badge_sash.notified_user
+    badge_sash.set_notified!
+    assert badge_sash.notified_user
+  end
+
   # TODO: Test and refactor:
   # Rule: grant_or_delete_badge(action), sash_to_badge
   # Badge: delete_from

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: merit
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-26 00:00:00.000000000 Z
+date: 2012-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ambry
@@ -325,3 +325,4 @@ signing_key:
 specification_version: 3
 summary: General reputation Rails engine.
 test_files: []
+has_rdoc: