mushroom 0.0.1 → 0.0.2

data/README.md

@@ -2,7 +2,7 @@
 
 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
+Mushroom 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
@@ -24,6 +24,8 @@ Or install it yourself as:
 
 ## Usage
 
+**Simple example: Dispatch an event and receive it somewhere else**
+
 ```ruby
 
 # app/models/server.rb
@@ -33,35 +35,107 @@ class Server
   def run
     notify :start #=> Dispatches a 'server:start' event with the current server instance as the event target.
   end
+end
+
+# lib/my_app/event_handler.rb
+class EventHandler < Mushroom::Subscriber
+  events :start, :on => Server
+
+  def notify
+    # Handle event here
+    puts name     #=> "server:start"
+    puts target   #=> <Server id:1 ...>
+    puts duration #=> 0.001
+  end
+end
+
+Server.new.run
+```
+
+**Slightly more advanced example: Instrument a method running, and display its duration:**
 
-  # 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
+```ruby
+class Server
+  include Mushroom
+
+  def start
     sleep 1
   end
-  instrument :stop
+  instrument :start
 end
 
-# lib/my\_app/event\_handler.rb
-class EventHandler < Muchroom::Subscriber
-  events :start, :stop, :on => Server
-  events :cleanup, :on => ServerCache
+# lib/my_app/event_handler.rb
+class EventHandler < Mushroom::Subscriber
+  events :start, :on => Server
 
   def notify
     # Handle event here
     puts name     #=> "server:start"
     puts target   #=> <Server id:1 ...>
-    puts duration #=> 0.001
+    puts duration #=> 1000.0
   end
 end
 
-Server.new.run
+Server.new.start
+```
+
+**Subscribing to multiple events:**
+
+```ruby
+# lib/my_app/event_handler.rb
+class EventHandler < Mushroom::Subscriber
+  events :start, :stop, :destroy, :on => Server
+end
 ```
 
+**Subscribing events to multiple targets**
+
+```ruby
+# lib/my_app/event_handler.rb
+class EventHandler < Mushroom::Subscriber
+  events :create, :destroy, :on => [Server, User, Account]
+end
+```
+
+**Passing extra parameters to the subscriber**
+
+```ruby
+class Server
+  include Mushroom
+
+  def start
+    notify :start, Time.now
+  end
+end
+
+# lib/my_app/event_handler.rb
+class EventHandler < Mushroom::Subscriber
+  events :start, :on => Server
+
+  def notify(started_at)
+    puts started_at #=> 2012-04-26 16:56:54 +1000
+  end
+end
+
+Server.new.start
+```
+
+Remember to declare all the arguments you expect to be received in `#notify` or you won't receive them all. You can also get the same
+arguments from the `#payload` method.
+
+## Subscriber API
+
+The following methods are available on your Subscriber subclass:
+
+```ruby
+# payload
+# name
+# time
+# transaction_id
+# duration
+```
+
+
 ## Contributing
 
 1. Fork it

data/lib/mushroom/subscriber.rb

@@ -6,11 +6,20 @@ module Mushroom
 
     attr_reader :event
     delegate :payload, :name, :time, :transaction_id, :duration, :to => :event
-
+    
     def initialize(event)
       @event = event
     end
 
+    # The endpoint for notifications
+    def notify
+      raise NotImplementedError
+    end
+
+    def target
+      payload[:target]
+    end
+
     class << self
 
       # Public: Setter and getter for events

data/lib/mushroom/version.rb

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

data/spec/mushroom/subscriber_spec.rb

@@ -96,6 +96,21 @@ describe Mushroom::Subscriber do
       Server.new.notify(:start, {:payload => {:id => 123}}, Thread.current[:now])
     end
 
+    it 'target points to the instance that triggered the event' do
+      $server = Server.new
+
+      class CustomHandler < Mushroom::Subscriber
+        events :start, :on => Server
+
+        def notify
+          target.should == $server
+        end
+      end
+
+      $server.notify(:start)
+    end
+
+
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mushroom
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70190744237180 !ruby/object:Gem::Requirement
+  requirement: &70109746263340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70190744237180
+  version_requirements: *70109746263340
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70190744236020 !ruby/object:Gem::Requirement
+  requirement: &70109746262600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *70190744236020
+  version_requirements: *70109746262600
 description: Super simple events and instrumentation within your ruby app
 email:
 - ivanvanderbyl@me.com