mushroom 0.0.1

data/.gitignore

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    mushroom (0.0.1)
+      activesupport (>= 3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    diff-lcs (1.1.3)
+    i18n (0.6.0)
+    multi_json (1.3.2)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mushroom!
+  rspec (>= 2.8.0)

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ivan Vanderbyl
+
+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,75 @@
+# Mushroom
+
+Mushroom is a super simple wrapper around ActiveSupport Instrumentation introduced in Rails 3.
+
+Muchroom allows any component of your application to trigger events which later get subscribed to by any
+other component in your application.
+
+The returned event can be used to handle follow up behaviour, profile running code, and event dispatch requests to
+other services.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mushroom'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mushroom
+
+## Usage
+
+```ruby
+
+# app/models/server.rb
+class Server
+  include Mushroom
+
+  def run
+    notify :start #=> Dispatches a 'server:start' event with the current server instance as the event target.
+  end
+
+  # You can instrument methods inline.
+  # This will trigger the server:stop event when you call #stop
+  # and notify all subscribers to the stop event.
+  #
+  # The server:stop event #duration will be 1 second.
+  #
+  def stop
+    sleep 1
+  end
+  instrument :stop
+end
+
+# lib/my\_app/event\_handler.rb
+class EventHandler < Muchroom::Subscriber
+  events :start, :stop, :on => Server
+  events :cleanup, :on => ServerCache
+
+  def notify
+    # Handle event here
+    puts name     #=> "server:start"
+    puts target   #=> <Server id:1 ...>
+    puts duration #=> 0.001
+  end
+end
+
+Server.new.run
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+# Author
+
+- Ivan Vanderbyl

data/Rakefile

@@ -0,0 +1,14 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+$: << 'lib'
+
+require "mushroom"
+require 'rake'
+require "rspec/core/rake_task"
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+

data/lib/mushroom.rb

@@ -0,0 +1,55 @@
+require 'mushroom/version'
+require 'active_support'
+require 'active_support/core_ext/array/extract_options'
+require 'active_support/core_ext/class/attribute'
+require 'active_support/inflector'
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/module/aliasing'
+
+module Mushroom
+  extend ActiveSupport::Concern
+
+  autoload :Subscriber, 'mushroom/subscriber'
+
+  included do
+    class_eval do
+      # Public: Instrument a method call
+      #
+      # Example:
+      #   def start
+      #     # work hard here
+      #   end
+      #   instrument :start
+      #
+      def self.instrument(method, options = {})
+        define_method(:"#{method}_with_instrument") do |*args, &block|
+          instrument(method) do
+            send(:"#{method}_without_instrument", *args, &block)
+          end
+        end
+        alias_method_chain method, 'instrument'
+      end
+    end
+  end
+
+  class << self
+    def event_name(event, sender)
+      if sender.is_a?(String)
+        klass_name = sender
+      else
+        klass_name = sender.respond_to?(:ancestors) && sender.ancestors.first == sender ? sender.name : sender.class.name
+      end
+      [klass_name.demodulize.underscore.gsub('/', ':'), event.to_s].join(':')
+    end
+  end
+
+  def notify(event, *args)
+    instrument(event, *args) {}
+  end
+
+  def instrument(event, *args, &block)
+    event = Mushroom.event_name(event, self)
+    ActiveSupport::Notifications.instrument(event.to_s, :target => self, :args => args, &block)
+  end
+
+end

data/lib/mushroom/subscriber.rb

@@ -0,0 +1,84 @@
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/hash/slice'
+
+module Mushroom
+  class Subscriber
+
+    attr_reader :event
+    delegate :payload, :name, :time, :transaction_id, :duration, :to => :event
+
+    def initialize(event)
+      @event = event
+    end
+
+    class << self
+
+      # Public: Setter and getter for events
+      #
+      # Can be called multiple times to set events on a Subscriber.
+      #
+      # Events cannot be inherited by subclassed objects.
+      #
+      # Example:
+      #   class Handler < Mushroom::Subscriber
+      #     events :start, :on => Server
+      #     events :stop, :on => [Server, Time]
+      #     events :register, :activate, :on => [User]
+      #   end
+      #
+      # Returns: Array of current event registrations.
+      def events(*events_and_options)
+        if events_and_options.empty?
+          self._events
+        else
+          create_event_subscription(*events_and_options)
+        end
+      end
+
+      # Internal: Trigger the notification within this subscriber
+      def notify(event)
+        instance = new(event)
+
+        if instance.method(:notify).arity == 0
+          instance.notify
+        elsif instance.method(:notify).arity > 0
+          instance.notify(*event.payload[:args])
+        end
+      end
+
+      protected
+
+      def _events
+        Thread.current[:"_events_#{object_id}"] ||= []
+      end
+
+      def _events=(hash)
+        Thread.current[:"_events_#{object_id}"] = []
+      end
+
+      def create_event_subscription(*events_and_options)
+        options = {
+          :on => nil
+        }.update(events_and_options.extract_options!)
+
+        targets = Array(options[:on]) || raise(ArgumentError, "Event subscription must include :on => Class")
+
+        targets.each do |target|
+          events_and_options.each do |event|
+            event = Mushroom.event_name(event, target)
+
+            # Actually subscribe the event
+            ActiveSupport::Notifications.subscribe(event) do |*args|
+              self.notify(ActiveSupport::Notifications::Event.new(*args))
+            end
+
+            (self._events ||=[]).push(event)
+          end
+        end
+
+        return self._events
+      end
+    end
+
+  end
+end

data/lib/mushroom/version.rb

@@ -0,0 +1,3 @@
+module Mushroom
+  VERSION = "0.0.1"
+end

data/mushroom.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/mushroom/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ivan Vanderbyl"]
+  gem.email         = ["ivanvanderbyl@me.com"]
+  gem.description   = %q{Super simple events and instrumentation within your ruby app}
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/ivanvanderbyl/mushroom"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "mushroom"
+  gem.require_paths = ["lib"]
+  gem.version       = Mushroom::VERSION
+
+  gem.add_dependency "activesupport", ">= 3.0.0"
+
+  gem.add_development_dependency "rspec", ">= 2.8.0"
+end

data/spec/mushroom/subscriber_spec.rb

@@ -0,0 +1,101 @@
+require "spec_helper"
+
+describe Mushroom::Subscriber do
+
+  class Server
+  end
+
+  class Dummy
+  end
+
+  class EventHandler < Mushroom::Subscriber
+    def notify
+    end
+  end
+
+  class ServerEventHandler < Mushroom::Subscriber
+    def notify
+    end
+  end
+
+  after do
+    EventHandler.send(:_events=, {})
+  end
+
+  describe '.events' do
+    it 'allows adding event for a class' do
+      lambda { EventHandler.events :destroy, :on => Server }.should_not raise_error
+      EventHandler.events.should == ['server:destroy']
+    end
+
+    it 'stores events which weve added' do
+      EventHandler.events :start, :stop, :on => Server
+      EventHandler.events.should == ['server:start', 'server:stop']
+    end
+
+    it 'allows adding events for the same target multiple times' do
+      EventHandler.events :start, :on => Server
+      EventHandler.events :stop, :on => Server
+      EventHandler.events.should == ['server:start', 'server:stop']
+    end
+
+    it 'allows subscribing the same events to multiple targets' do
+      EventHandler.events :start, :on => [Server, Dummy]
+      EventHandler.events.should == ['server:start', 'dummy:start']
+    end
+
+    it 'does not inherit events across subscribers' do
+      EventHandler.send(:_events=, {})
+      EventHandler.events :stop, :on => Dummy
+      ServerEventHandler.events.should == []
+      ServerEventHandler.events :start, :on => Server
+      EventHandler.events.should == ['dummy:stop']
+    end
+
+    it 'should be thread safe' do
+      t1 = Thread.new { EventHandler.events :start, :on => Server }
+      t1.join
+      EventHandler.events.should == []
+    end
+  end
+
+  describe '.notify' do
+    it 'gets called when an event is triggered' do
+      class CustomHandler < Mushroom::Subscriber
+        events :start, :on => Server
+      end
+      CustomHandler.should_receive(:notify).once
+      Server.new.notify(:start)
+    end
+
+    it 'passes arguments to subscriber' do
+      class CustomHandler < Mushroom::Subscriber
+        events :start, :on => Server
+
+        def notify(payload)
+          payload.should == {:payload => {:id => 123}}
+        end
+      end
+
+      Server.new.notify(:start, {:payload => {:id => 123}})
+    end
+
+    it 'passes multiple arguments to subscriber' do
+      Thread.current[:now] = Time.now
+
+      class CustomHandler < Mushroom::Subscriber
+        events :start, :on => Server
+
+        def notify(payload, time)
+          payload.should == {:payload => {:id => 123}}
+          time.should_not == nil
+          time.should == Thread.current[:now]
+        end
+      end
+
+      Server.new.notify(:start, {:payload => {:id => 123}}, Thread.current[:now])
+    end
+
+  end
+end
+

data/spec/mushroom_spec.rb

@@ -0,0 +1,57 @@
+require "spec_helper"
+
+describe Mushroom do
+  class Server
+    include Mushroom
+
+    def start
+      notify :start
+    end
+
+    def stop
+      sleep 0.1
+    end
+    instrument :stop
+  end
+
+  let(:server) { Server.new }
+
+  describe '.event_name' do
+    it 'constructs a valid event name from class and event triggered' do
+      server = Server.new
+
+      Mushroom.event_name(:start, server).should == 'server:start'
+    end
+
+    it 'works with a string' do
+      Mushroom.event_name(:start, 'server').should == 'server:start'
+    end
+
+    it 'works with a class' do
+      Mushroom.event_name(:start, Server).should == 'server:start'
+    end
+  end
+
+  describe 'Server' do
+    describe '#start' do
+      it 'triggers a server:start event' do
+        ActiveSupport::Notifications.should_receive(:instrument).with("server:start", {:target=>server, :args=>[]}).once
+        server.start
+      end
+    end
+
+    describe '#stop' do
+      it 'triggers a server:stop event' do
+        ActiveSupport::Notifications.should_receive(:instrument).with("server:stop", {:target=>server, :args=>[]}).once
+        server.stop
+      end
+    end
+  end
+
+  describe '#instrument' do
+    it 'can be called from instance' do
+      ActiveSupport::Notifications.should_receive(:instrument).with("server:render", {:target=>server, :args=>[]}).once
+      server.instrument(:render) { sleep 0.01 }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require "mushroom"
+
+Dir[File.expand_path("../support/*.rb", __FILE__)].each { |file| require file }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+
+  config.before(:all) do
+  end
+end
+

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: mushroom
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ivan Vanderbyl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70190744237180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70190744237180
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70190744236020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *70190744236020
+description: Super simple events and instrumentation within your ruby app
+email:
+- ivanvanderbyl@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/mushroom.rb
+- lib/mushroom/subscriber.rb
+- lib/mushroom/version.rb
+- mushroom.gemspec
+- spec/mushroom/subscriber_spec.rb
+- spec/mushroom_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ivanvanderbyl/mushroom
+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.15
+signing_key: 
+specification_version: 3
+summary: Super simple events and instrumentation within your ruby app
+test_files:
+- spec/mushroom/subscriber_spec.rb
+- spec/mushroom_spec.rb
+- spec/spec_helper.rb