instrumentable 0.0.3

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in instrumentable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 David Tomberlin
+
+MIT License
+
+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,50 @@
+# Instrumentable
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'instrumentable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install instrumentable
+
+## Usage
+```ruby
+require "instrumentable"
+
+class WidgetRenderer
+  include Instrumentable
+
+  attr_reader   :id
+  attr_accessor :name
+
+  def render
+    # do crazy render here
+  end 
+
+  instrument_for :render, 'load.widget', :widget_id => :id, :widget_name => :name
+end
+```
+
+## Requirements
+* ActiveSupport
+
+## Running Tests
+
+    ruby -Itest test/instrumentable_test.rb
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = Dir['test/**/*_test.rb']
+  t.verbose = true
+end

data/instrumentable.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'instrumentable/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "instrumentable"
+  gem.version       = Instrumentable::VERSION
+  gem.authors       = ["David Tomberlin"]
+  gem.email         = ["siyegen@gmail.com"]
+  gem.description   = %q{Gem for decorating methods to use with ActiveSupport::Notifications}
+  gem.summary       = %q{Gem for decorating methods to use with ActiveSupport::Notifications}
+  gem.homepage      = ""
+
+  gem.add_dependency 'activesupport', "~> 3.2"
+  gem.add_development_dependency 'minitest'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/instrumentable.rb

@@ -0,0 +1,39 @@
+require "securerandom"
+require "active_support/concern"
+require "active_support/notifications"
+require "instrumentable/version"
+
+# Includes +instrument_for+ into the class. The class uses it by adding
+# the instrument_for method to the end of the class specifying
+# what method to apply it to.
+module Instrumentable
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    # Internal: Decorates :method_to_instrument with  AS::N.instrument
+    # firing with :event_name to the matching AS::N.subscribe
+    #
+    # Example:
+    #
+    #   # Decorates render method with AS:N:instrument 'model.render' and passes
+    #   # a payload of :model_name and :id to the subscribe method
+    #   instrument_for :render, 'model.render', {:model_name => :model_name, :id => :id
+    def instrument_for(method_to_instrument, event_name, payload={})
+      instrument_method = :"instrument_for_#{method_to_instrument}"
+
+      # Hide original method under new method
+      alias_method instrument_method, method_to_instrument
+
+      # Redefine method_to_instrument to call inside the Notification
+      define_method(method_to_instrument) do |*args, &block|
+        callable_payload = payload.inject({}) do |result, element|
+          value = (__send__(element.last) if respond_to?(element.last)) || element.last
+          result.tap { |r| r[element.first] = value }
+        end
+        ActiveSupport::Notifications.instrument event_name, callable_payload do
+          __send__(instrument_method, *args, &block)
+        end
+      end
+    end
+  end
+end

data/lib/instrumentable/version.rb

@@ -0,0 +1,3 @@
+module Instrumentable
+  VERSION = "0.0.3"
+end

data/test/instrumentable_test.rb

@@ -0,0 +1,40 @@
+require "minitest_helper"
+require_relative "../lib/instrumentable"
+
+class FakeModel
+  include Instrumentable
+  def simple_event; end
+  def payload_event; end
+  instrument_for :simple_event,   'event.name',   :my_payload => :id
+  instrument_for :payload_event,  'payload.name', :my_payload => 'megaman'
+end
+
+describe Instrumentable do
+
+  it "must instrument simple_event" do
+    fm = FakeModel.new
+    def fm.id; 1; end
+    expected = ['event.name-1']
+    events = []
+
+    callback = lambda { |*_| events << "#{_.first}-#{_.last[:my_payload]}" }
+    ActiveSupport::Notifications.subscribed(callback, 'event.name') do
+      fm.simple_event
+      ActiveSupport::Notifications.instrument('other.event')
+    end
+    events.must_equal expected
+  end
+
+  it "must handle non-callable payloads" do
+    fm = FakeModel.new
+    expected = ['payload.name-megaman']
+    events = []
+
+    callback = lambda { |*_| events << "#{_.first}-#{_.last[:my_payload]}" }
+    ActiveSupport::Notifications.subscribed(callback, 'payload.name') do
+      fm.payload_event
+      ActiveSupport::Notifications.instrument('other.event')
+    end
+    events.must_equal expected
+  end
+end

data/test/minitest_helper.rb

@@ -0,0 +1,5 @@
+$:.push File.expand_path("../../lib", __FILE__)
+
+require 'instrumentable'
+require 'minitest/autorun'
+require 'minitest/pride'

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: instrumentable
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- David Tomberlin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem for decorating methods to use with ActiveSupport::Notifications
+email:
+- siyegen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- instrumentable.gemspec
+- lib/instrumentable.rb
+- lib/instrumentable/version.rb
+- test/instrumentable_test.rb
+- test/minitest_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Gem for decorating methods to use with ActiveSupport::Notifications
+test_files:
+- test/instrumentable_test.rb
+- test/minitest_helper.rb
+has_rdoc: