as-notifications 0.2.0 → 1.0.0

data/MIT-LICENSE

@@ -1,3 +1,5 @@
+==> rails license (https://github.com/rails/rails)
+
 Copyright (c) 2005-2013 David Heinemeier Hansson
 
 Permission is hereby granted, free of charge, to any person obtaining
@@ -17,4 +19,28 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+==> backports license (https://github.com/marcandre/backports)
+
+Copyright (c) 2009 Marc-Andre Lafortune
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,30 @@
+AS::Notification -- Provides an instrumentation API for Ruby
+------------------------------------------------------------
+
+AS::Notification is an extraction of ActiveSupport::Notifications from
+[Rails](https://github.com/rails/rails/tree/master/activesupport).
+
+**It will track activesupport 4.x once that's released.**
+
+[![Build Status](https://travis-ci.org/bernd/as-notifications.png?branch=master)](https://travis-ci.org/bernd/as-notifications)
+
+* [API documentation](http://rubydoc.info/github/bernd/as-notifications/master/AS/Notifications)
+* [ChangeLog](CHANGELOG.md)
+
+## Installation
+
+    $ gem install as-notifications
+
+## Changes to ActiveSupport::Notifications
+
+* Change module name from `ActiveSupport::Notifications` to
+  `AS::Notifications` to avoid conflicts with activesupport
+* Change `require` calls for `active_support/notifications` to
+  `as/notifications`
+* Disable loading `load_paths` file in tests
+* Revert [rails/rails@45448a5](https://github.com/rails/rails/commit/45448a5)
+  changes to avoid `thread_safe` gem dependency
+* Adjust `test/notifications/instrumenter_test.rb` and `test/abstract_unit.rb`
+  to unbreak the tests on Ruby 1.8.
+* Include `define_singleton_method` and `public_send` [backports](https://github.com/marcandre/backports)
+  to make `ActiveSupport::PerThreadRegistry` work on Ruby 1.8.

data/lib/as/backports/define_singleton_method.rb

@@ -0,0 +1,12 @@
+# From https://github.com/marcandre/backports
+# backports is released under the terms of the MIT License, see the included
+# LICENSE file.
+unless Kernel.method_defined? :define_singleton_method
+  module Kernel
+    def define_singleton_method(*args, &block)
+      class << self
+        self
+      end.send(:define_method, *args, &block)
+    end
+  end
+end

data/lib/as/backports/public_send.rb

@@ -0,0 +1,16 @@
+# From https://github.com/marcandre/backports
+# backports is released under the terms of the MIT License, see the included
+# LICENSE file.
+unless Kernel.method_defined? :public_send
+  module Kernel
+    def public_send(method, *args, &block)
+      if respond_to?(method) && !protected_methods.include?(method.to_s)
+        send(method, *args, &block)
+      else
+        :foo.generate_a_no_method_error_in_preparation_for_method_missing rescue nil
+        # otherwise a NameError might be raised when we call method_missing ourselves
+        method_missing(method.to_sym, *args, &block)
+      end
+    end
+  end
+end

data/lib/as/notifications.rb

@@ -1,5 +1,6 @@
 require 'as/notifications/instrumenter'
 require 'as/notifications/fanout'
+require 'as/per_thread_registry'
 
 module AS
   # = Notifications
@@ -177,7 +178,27 @@ module AS
       end
 
       def instrumenter
-        Thread.current[:"instrumentation_#{notifier.object_id}"] ||= Instrumenter.new(notifier)
+        InstrumentationRegistry.instrumenter_for(notifier)
+      end
+    end
+
+    # This class is a registry which holds all of the +Instrumenter+ objects
+    # in a particular thread local. To access the +Instrumenter+ object for a
+    # particular +notifier+, you can call the following method:
+    #
+    #   InstrumentationRegistry.instrumenter_for(notifier)
+    #
+    # The instrumenters for multiple notifiers are held in a single instance of
+    # this class.
+    class InstrumentationRegistry # :nodoc:
+      extend AS::PerThreadRegistry
+
+      def initialize
+        @registry = {}
+      end
+
+      def instrumenter_for(notifier)
+        @registry[notifier] ||= Instrumenter.new(notifier)
       end
     end
 

data/lib/as/notifications/instrumenter.rb

@@ -2,7 +2,7 @@ require 'securerandom'
 
 module AS
   module Notifications
-    # Instrumentors are stored in a thread local.
+    # Instrumenters are stored in a thread local.
     class Instrumenter
       attr_reader :id
 
@@ -17,7 +17,7 @@ module AS
       def instrument(name, payload={})
         start name, payload
         begin
-          yield
+          yield payload
         rescue Exception => e
           payload[:exception] = [e.class.name, e.message]
           raise e

data/lib/as/per_thread_registry.rb

@@ -0,0 +1,57 @@
+module AS
+  # This module is used to encapsulate access to thread local variables.
+  #
+  # Instead of polluting the thread locals namespace:
+  #
+  #   Thread.current[:connection_handler]
+  #
+  # you define a class that extends this module:
+  #
+  #   module ActiveRecord
+  #     class RuntimeRegistry
+  #       extend AS::PerThreadRegistry
+  #
+  #       attr_accessor :connection_handler
+  #     end
+  #   end
+  #
+  # and invoke the declared instance accessors as class methods. So
+  #
+  #   ActiveRecord::RuntimeRegistry.connection_handler = connection_handler
+  #
+  # sets a connection handler local to the current thread, and
+  #
+  #   ActiveRecord::RuntimeRegistry.connection_handler
+  #
+  # returns a connection handler local to the current thread.
+  #
+  # This feature is accomplished by instantiating the class and storing the
+  # instance as a thread local keyed by the class name. In the example above
+  # a key "ActiveRecord::RuntimeRegistry" is stored in <tt>Thread.current</tt>.
+  # The class methods proxy to said thread local instance.
+  #
+  # If the class has an initializer, it must accept no arguments.
+  module PerThreadRegistry
+    if RUBY_VERSION < '1.9'
+      require 'as/backports/define_singleton_method'
+      require 'as/backports/public_send'
+    end
+
+    protected
+
+      def method_missing(name, *args, &block) # :nodoc:
+        # Caches the method definition as a singleton method of the receiver.
+        define_singleton_method(name) do |*a, &b|
+          per_thread_registry_instance.public_send(name, *a, &b)
+        end
+
+        send(name, *args, &block)
+      end
+
+    private
+
+      def per_thread_registry_instance
+        Thread.current[name] ||= new
+      end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: as-notifications
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-19 00:00:00.000000000 Z
+date: 2013-04-27 00:00:00.000000000 Z
 dependencies: []
 description: Provides an instrumentation API for Ruby. It has been extracted from
   rails activesupport.
@@ -19,7 +19,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
+- README.md
+- lib/as/per_thread_registry.rb
 - lib/as/notifications.rb
+- lib/as/backports/define_singleton_method.rb
+- lib/as/backports/public_send.rb
 - lib/as/notifications/fanout.rb
 - lib/as/notifications/instrumenter.rb
 homepage: https://github.com/bernd/as-notifications
@@ -39,7 +43,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4497208537653416032
+      hash: 2076711471121766767
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -48,10 +52,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4497208537653416032
+      hash: 2076711471121766767
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Provides an instrumentation API for Ruby