Merge pull request #9523 from stopdropandrew/Instrumenter#instrument-…

…yields-payload ActiveSupport::Notifications::Instrumenter#instrument should yield Conflicts: activesupport/CHANGELOG.md
rails · Mar 27, 2013 · 57fbcc5 · 57fbcc5
2 parents d684de4 + a007800
commit 57fbcc5
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 2 deletions.
diff --git a/activesupport/CHANGELOG.md b/activesupport/CHANGELOG.md
@@ -1,5 +1,10 @@
 ## Rails 4.0.0 (unreleased) ##
 
+*   `ActiveSupport::Notifications::Instrumenter#instrument` should yield
+    its payload.
+
+    *stopdropandrew*
+
 *   `ActiveSupport::TimeWithZone` raises `NoMethodError` in proper context.
     Fixes #9772.
 
@@ -9,6 +14,7 @@
 
     *Charles Jones*
 
+
 ## Rails 4.0.0.beta1 (February 25, 2013) ##
 
 *   Improve singularizing a singular for multiple cases.

diff --git a/activesupport/lib/active_support/notifications/instrumenter.rb b/activesupport/lib/active_support/notifications/instrumenter.rb
@@ -17,7 +17,7 @@ def initialize(notifier)
       def instrument(name, payload={})
         start name, payload
         begin
-          yield
+          yield payload
         rescue Exception => e
           payload[:exception] = [e.class.name, e.message]
           raise e

diff --git a/activesupport/test/notifications/instrumenter_test.rb b/activesupport/test/notifications/instrumenter_test.rb
@@ -34,6 +34,14 @@ def test_instrument
         assert called
       end
 
+      def test_instrument_yields_the_payload_for_further_modification
+        assert_equal 2, instrumenter.instrument("awesome") { |p| p[:result] = 1 + 1 }
+        assert_equal 1, notifier.finishes.size
+        name, _, payload = notifier.finishes.first
+        assert_equal "awesome", name
+        assert_equal Hash[:result => 2], payload
+      end
+
       def test_start
         instrumenter.start("foo", payload)
         assert_equal [["foo", instrumenter.id, payload]], notifier.starts

diff --git a/activesupport/test/notifications_test.rb b/activesupport/test/notifications_test.rb
@@ -157,7 +157,7 @@ def test_instrument_returns_block_result
       assert_equal 2, instrument(:awesome) { 1 + 1 }
     end
 
-    def test_instrument_yields_the_paylod_for_further_modification
+    def test_instrument_yields_the_payload_for_further_modification
       assert_equal 2, instrument(:awesome) { |p| p[:result] = 1 + 1 }
       assert_equal 1, @events.size
       assert_equal :awesome, @events.first.name