merit 2.1.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fffa4a71100476ce7342d95ec21d9841dcdba506
-  data.tar.gz: 366af39f2fe07ec2eb644a5e7e2710a6fb95abcf
+  metadata.gz: d1c7ff1372bb3ca30c5c71a235ebfbaa285be9a6
+  data.tar.gz: 93f9531439ccb6efd93c8a3092e46016d328283e
 SHA512:
-  metadata.gz: 766d06b7c33496656d497f3b06a522e9e29f3d4322e500168cfbfcb0deae4ec0502e1ac754108e6545e61c2e16d7f4538cae24d29e65b8bc1fd4789ffae6e646
-  data.tar.gz: 09a1a3dbdc6d61b0acdebb4458fbc043eebcb487f95455bdc913120b97420bee7a4301ae8d34632045b9eb754377ee514fb720cd8a1022b9e6c829bcf7c1fb1d
+  metadata.gz: 66770fcab721991a7c18ecc53d6e0bbb7190775404db8ceddd39605d32e300c1d6b1c61fa16d07a9075718777f3d093dbd72a4b1873901c367a1111fdab8713c
+  data.tar.gz: 7f4b0660da679fb7551208aa268121c9f41bd91967fed1963a2972081f8dee27941bcf6b20d97c6c37776e81f84a7ac30af33d9a5de18f3fcaaaac7c85f3cdf3

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 2.1.2
+
+- Improves observer API.
+
 ## 2.1.1
 
 - [#158] Migrations bug fix.

data/Gemfile

@@ -33,7 +33,7 @@ end
 platforms :rbx do
   gem 'rubysl', '~> 2.0'
   gem 'racc'
-  gem 'rubysl-test-unit'
+  gem 'minitest'
   gem 'rubinius-developer_tools'
 end
 

data/README.md

@@ -35,8 +35,8 @@ Status](https://coveralls.io/repos/tute/merit/badge.png?branch=master)](https://
 # Installation
 
 1. Add `gem 'merit'` to your `Gemfile`
-2. Run `rails g merit:install`
-3. Run `rails g merit MODEL_NAME` (e.g. `user`)
+2. Run `rails g merit:install`. This creates several migrations.
+3. Run `rails g merit MODEL_NAME` (e.g. `user`). This creates a migration and adds `has_merit` to MODEL_NAME.
 4. Run `rake db:migrate`
 5. Define badges in `config/initializers/merit.rb`. You can also define ORM:
    `:active_record` (default) or `:mongoid`.
@@ -50,7 +50,7 @@ Status](https://coveralls.io/repos/tute/merit/badge.png?branch=master)](https://
 Create badges in `config/initializers/merit.rb`
 
 `Merit::Badge.create!` takes a hash describing the badge:
-* `:id` integer (reqired)
+* `:id` integer (required)
 * `:name` this is how you reference the badge (required)
 * `:level` (optional)
 * `:description` (optional)
@@ -61,7 +61,7 @@ Create badges in `config/initializers/merit.rb`
 ```ruby
 Merit::Badge.create!(
   id: 1,
-  name: "Yearling",
+  name: "year-member",
   description: "Active member for a year",
   custom_fields: { difficulty: :silver }
 )
@@ -265,37 +265,27 @@ end
 You can get observers notified any time merit changes reputation in your
 application.
 
-To do so, add your observer (to `app/models` or `app/observers`, for example):
+It needs to implement the `update` method, which receives as parameter the
+following hash:
+
+* `description`, describes what happened. For example: "granted 5 points",
+  "granted just-registered badge", "removed autobiographer badge".
+* `sash_id`, who saw it's reputation changed.
+* `granted_at`, date and time when the reputation change took effect.
+
+Example code (add your observer to `app/models` or `app/observers`):
 
 ```ruby
 # reputation_change_observer.rb
 class ReputationChangeObserver
   def update(changed_data)
-    # description will be something like:
-    #   granted 5 points
-    #   granted just-registered badge
-    #   removed autobiographer badge
     description = changed_data[:description]
 
-    # If user is your meritable model, you can grab it like:
-    if changed_data[:merit_object]
-      sash_id = changed_data[:merit_object].sash_id
-      user = User.where(sash_id: sash_id).first
-    end
-
-    # To know where and when it happened:
-    merit_action = Merit::Action.find changed_data[:merit_action_id]
-    controller = merit_action.target_model
-    action = merit_action.action_method
-    when = merit_action.created_at
-
-    # From here on, you can create a new Notification assuming that's an
-    # ActiveRecord Model in your app, send an email, etc. For example:
-    Notification.create(
-      user: user,
-      what: description,
-      where: "#{controller}##{action}",
-      when: when)
+    # If user is your meritable model, you can query for it doing:
+    user = User.where(sash_id: changed_data[:sash_id]).first
+
+    # When did it happened:
+    datetime = changed_data[:granted_at]
   end
 end
 ```
@@ -304,9 +294,6 @@ end
 config.add_observer 'ReputationChangeObserver'
 ```
 
-TODO: Improve API sending in `changed_data` concrete data instead of merit
-objects.
-
 
 # Uninstalling Merit
 

data/lib/merit/judge.rb

@@ -29,7 +29,7 @@ module Merit
         notify_observers(
           description: "granted #{points} points",
           merit_object: point,
-          merit_action_id: @action.id
+          sash_id: point.sash_id
         )
       end
     end
@@ -43,18 +43,17 @@ module Merit
         notify_observers(
           description: "granted #{badge.name} badge",
           merit_object: badge_sash,
-          merit_action_id: @action.id
+          sash_id: badge_sash.sash_id
         )
       end
     end
 
     def remove_badges
       sashes.each do |sash|
-        badge_sash = sash.rm_badge badge.id
+        sash.rm_badge badge.id
         notify_observers(
           description: "removed #{badge.name} badge",
-          merit_object: badge_sash,
-          merit_action_id: @action.id
+          sash_id: sash.id
         )
       end
     end
@@ -91,9 +90,13 @@ module Merit
       @rule.badge
     end
 
-    def notify_observers(changed_data)
+    def notify_observers(changed_data = {})
       changed
-      super
+      hash = {
+        granted_at: @action.created_at,
+        merit_action_id: @action.id
+      }.merge(changed_data)
+      super(hash)
     end
   end
 end

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

@@ -18,7 +18,7 @@ module Merit
     # @return [ActiveRecord::Relation] containing the points
     def score_points(options = {})
       scope = Merit::Score::Point
-                .includes(:score)
+                .joins(:score)
                 .where('merit_scores.sash_id = ?', id)
       if (category = options[:category])
         scope = scope.where('merit_scores.category = ?', category)

data/merit.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |s|
   s.homepage    = "http://github.com/tute/merit"
   s.files       = `git ls-files`.split("\n").reject{|f| f =~ /^\./ }
   s.license     = 'MIT'
-  s.version     = '2.1.1'
+  s.version     = '2.1.2'
   s.authors     = ["Tute Costa"]
   s.email       = 'tutecosta@gmail.com'
 
@@ -18,5 +18,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'rubocop'
   s.add_development_dependency 'minitest-rails'
-  s.add_development_dependency 'mocha', '0.13.3'
+  s.add_development_dependency 'mocha', '0.14'
 end

data/test/integration/navigation_test.rb

@@ -1,21 +1,25 @@
 require 'test_helper'
 
 class NavigationTest < ActiveSupport::IntegrationCase
-
   def tear_down
     DummyObserver.unstub(:update)
   end
 
   test 'user sign up should grant badge to itself' do
-    DummyObserver.any_instance.expects(:update).times 1
+    DummyObserver.any_instance.expects(:update).times(1).with do |hash|
+        hash[:description] == 'granted just-registered badge' &&
+          hash[:sash_id] == user('Jack').sash_id &&
+          hash[:granted_at].to_date == Date.today
+      end
+
     visit '/users/new'
     fill_in 'Name', with: 'Jack'
     assert_difference('Merit::ActivityLog.count') do
       click_button('Create User')
     end
 
-    user = User.where(name: 'Jack').first
-    assert_equal [Merit::Badge.by_name('just-registered').first], user.badges
+    just_registered = Merit::Badge.by_name('just-registered').first
+    assert_equal [just_registered], user('Jack').badges
   end
 
   test 'User#add_badge should add one badge, #rm_badge should delete one' do
@@ -43,8 +47,20 @@ class NavigationTest < ActiveSupport::IntegrationCase
   end
 
   test 'users#index should grant badge multiple times' do
-    DummyObserver.any_instance.expects(:update).times 14
-    user = User.create(name: 'test-user')
+    DummyObserver.any_instance.expects(:update).times(1).with do |hash|
+        hash[:description] == 'granted visited_admin badge' &&
+        hash[:sash_id] == user.sash_id
+      end
+    DummyObserver.any_instance.expects(:update).times(5).with do |hash|
+        hash[:description] == 'granted gossip badge' &&
+        hash[:sash_id] == user.sash_id
+      end
+    8.times do |merit_action_id|
+      DummyObserver.any_instance.expects(:update).times(1).with do |hash|
+          hash[:description] == 'granted wildcard_badge badge' &&
+          hash[:sash_id] == user.sash_id
+        end
+    end
 
     # Multiple rule
     assert_difference 'badges_by_name(user, "gossip").count', 3 do
@@ -70,7 +86,7 @@ class NavigationTest < ActiveSupport::IntegrationCase
   test 'user workflow should grant some badges at some times' do
     DummyObserver.any_instance.expects(:update).at_least_once
     # Commented 9 times, no badges yet
-    user = User.create(name: 'test-user')
+    user # creates user
     # Create needed friend user object
     friend = User.create(name: 'friend')
 
@@ -121,14 +137,10 @@ class NavigationTest < ActiveSupport::IntegrationCase
     end
 
     relevant_badge = Merit::Badge.by_name('relevant-commenter').first
-    user_badges    = User.where(name: 'test-user').first.badges
-    assert user_badges.include?(relevant_badge), "User badges: #{user.badges.collect(&:name).inspect} should contain relevant-commenter badge."
+    assert user.badges.include?(relevant_badge), "User badges: #{user.badges.collect(&:name).inspect} should contain relevant-commenter badge."
 
     # Edit user's name by long name
     # tests ruby code in grant_on is being executed, and gives badge
-    user = User.where(name: 'test-user').first
-    user_badges = user.badges
-
     visit "/users/#{user.id}/edit"
     fill_in 'Name', with: 'long_name!'
     click_button('Update User')
@@ -249,10 +261,25 @@ class NavigationTest < ActiveSupport::IntegrationCase
   end
 
   test 'assigning points to a group of records' do
-    DummyObserver.any_instance.expects(:update).times 5
-    commenter = User.create(name: 'commenter')
-    comment_1 = commenter.comments.create(name: 'comment_1', comment: 'a')
-    comment_2 = commenter.comments.create(name: 'comment_2', comment: 'b')
+    DummyObserver.any_instance.expects(:update).times(2).with do |hash|
+        hash[:description] == 'granted 1 points' &&
+        hash[:sash_id] == user('commenter').sash_id
+      end
+    DummyObserver.any_instance.expects(:update).times(1).with do |hash|
+        hash[:description] == 'granted 2 points' &&
+        hash[:sash_id] == user('commenter').comments.first.sash_id
+      end
+    DummyObserver.any_instance.expects(:update).times(1).with do |hash|
+        hash[:description] == 'granted 2 points' &&
+        hash[:sash_id] == user('commenter').comments.last.sash_id
+      end
+    DummyObserver.any_instance.expects(:update).times(1).with do |hash|
+        hash[:description] == 'granted 5 points' &&
+        hash[:sash_id] == user('commenter').sash_id
+      end
+
+    comment_1 = user('commenter').comments.create(name: 'a', comment: 'a')
+    comment_2 = user('commenter').comments.create(name: 'b', comment: 'b')
 
     visit comments_path
     # Thanks for voting point, to voted user and it's comments
@@ -268,8 +295,11 @@ class NavigationTest < ActiveSupport::IntegrationCase
   end
 
   test 'api/comments#show should grant 1 point to user' do
-    DummyObserver.any_instance.expects(:update).times 1
-    user = User.create(name: 'test-user')
+    DummyObserver.any_instance.expects(:update).times(1).with do |hash|
+        hash[:description] == 'granted 1 points' &&
+        hash[:sash_id] == user.sash_id
+      end
+
     assert_equal 0, user.points
     comment = user.comments.create!(name: 'test-comment', comment: 'comment body')
 
@@ -277,6 +307,10 @@ class NavigationTest < ActiveSupport::IntegrationCase
     assert_equal 1, user.points
   end
 
+  def user(name = 'test-user')
+    User.where(name: name).first || User.create(name: name)
+  end
+
   def badges_by_name(user, name)
     user.reload.badges.select{|b| b.name == name }
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: merit
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.2
 platform: ruby
 authors:
 - Tute Costa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-12 00:00:00.000000000 Z
+date: 2014-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ambry
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.3
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.3
+        version: '0.14'
 description: Manage badges, points and rankings (reputation) of resources in a Rails
   application.
 email: tutecosta@gmail.com
@@ -293,3 +293,4 @@ signing_key:
 specification_version: 4
 summary: General reputation Rails engine.
 test_files: []
+has_rdoc: