event_bus 0.0.2 → 0.0.3

data/Gemfile

@@ -0,0 +1,9 @@
+source :rubygems
+gemspec
+
+group :test do
+  gem 'rspec', '~> 2.12'
+  gem 'rake', '~> 0.9.2'
+  gem 'simplecov', :require => false
+end
+

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    event_bus (0.0.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    multi_json (1.5.0)
+    rake (0.9.2.2)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  event_bus!
+  rake (~> 0.9.2)
+  rspec (~> 2.12)
+  simplecov

data/README.md

@@ -0,0 +1,90 @@
+# EventBus
+
+A simple pubsub event bus for Ruby applications.
+
+[![Build Status](https://travis-ci.org/kevinrutherford/event_bus.png)](https://travis-ci.org/kevinrutherford/event_bus)
+
+* <https://rubygems.org/gems/event_bus>
+* <http://rubydoc.info/gems/event_bus/frames>
+* <https://github.com/kevinrutherford/event_bus>
+
+## Features
+
+* Simple, global support for the Observer pattern, aka Publisher-Subscriber.
+* Publish and subscribe to events throughout your Ruby application.
+* Listen for events without coupling to the publishing object or class.
+* Subscribe to events using names or regex patterns.
+* Works with Rails.
+
+## Installation
+
+Install the gem
+
+```
+gem install event_bus
+```
+
+Or add it to your Gemfile and run `bundle`.
+
+``` ruby
+gem 'event_bus'
+```
+
+## Usage
+
+Subscribe to an event in your application's initialization code:
+
+```ruby
+EventBus.listen_for('order-placed', StatsRecorder.new, :order_placed)
+```
+
+Fire the event whenever something significant happens in your application:
+
+```ruby
+class PlaceOrder
+  //...
+  EventBus.listen_for('order-placed', :order => current_order, :customer => current_user)
+end
+```
+
+Handle the event without coupling the publisher or subscriber:
+
+```ruby
+class StatsRecorder
+  def order_placed(details)
+    order = details[:order]
+    //...
+  end
+end
+```
+
+## Compatibility
+
+Tested with Ruby 1.8.7, 1.9.x, JRuby, Rubinius.
+See the [build status](https://travis-ci.org/kevinrutherford/event_bus)
+for details.
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2013 Kevin Rutherford
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec
+

data/lib/event_bus.rb

@@ -52,12 +52,6 @@ class EventBus
   class Registrations
     include Singleton
 
-    Registration = Struct.new(:pattern, :listener, :method_name) do
-      def respond(event_name, details)
-        listener.send(method_name, details) if pattern === event_name
-      end
-    end
-
     def initialize
       clear
     end
@@ -76,6 +70,14 @@ class EventBus
       @listeners << Registration.new(pattern, listener, method_name)
     end
 
+    private
+
+    Registration = Struct.new(:pattern, :listener, :method_name) do
+      def respond(event_name, details)
+        listener.send(method_name, details) if pattern === event_name
+      end
+    end
+
   end
 
 end

data/spec/lib/event_bus_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe EventBus do
+  let(:listener) { double(:listener) }
+  let(:event_name) { 'aa123bb' }
+  let(:receiving_method) { :receiving_method_name }
+
+  before do
+    EventBus.clear
+  end
+
+  describe '.announce' do
+
+    it 'returns itself, to facilitate cascades' do
+      EventBus.clear.should == EventBus
+    end
+
+    context 'when the listener is specific about the event name' do
+      it 'sends the event to the listener' do
+        EventBus.listen_for(event_name, listener, receiving_method)
+        listener.should_receive(receiving_method).with({:a => 1, :b => 2})
+        EventBus.announce(event_name, {:a => 1, :b => 2})
+      end
+    end
+
+    context 'when the listener uses a regex that matches' do
+      it 'sends the event to the listener' do
+        EventBus.listen_for(/123b/, listener, receiving_method)
+        listener.should_receive(receiving_method).with({:a => 1, :b => 2})
+        EventBus.announce(event_name, {:a => 1, :b => 2})
+      end
+    end
+
+    context 'when the listener listens for a different event' do
+      it 'does not send the event to the listener' do
+        EventBus.listen_for('blah', listener, receiving_method)
+        listener.should_not_receive(receiving_method)
+        EventBus.announce(event_name, {:a => 1, :b => 2})
+      end
+    end
+
+    context 'when the listener listens for a non-matching regex' do
+      it 'does not send the event to the listener' do
+        EventBus.listen_for(/123a/, listener, receiving_method)
+        listener.should_not_receive(receiving_method)
+        EventBus.announce(event_name, {:a => 1, :b => 2})
+      end
+    end
+
+  end
+
+  describe '.clear' do
+    it 'sends no event to previous registrants' do
+      EventBus.listen_for(event_name, listener, receiving_method)
+      EventBus.clear
+      listener.should_not_receive(receiving_method)
+      EventBus.announce(event_name, {})
+    end
+
+    it 'returns itself, to facilitate cascades' do
+      EventBus.clear.should == EventBus
+    end
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'simplecov'
+
+SimpleCov.start
+
+require 'event_bus'
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: event_bus
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,15 +9,70 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-21 00:00:00.000000000 Z
-dependencies: []
-description: A simple pubsub event bus
+date: 2013-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: event_bus provides support for application-wide events, without coupling
+  the publishing and subscribing objects or classes to each other
 email: kevin@rutherford-software.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
 - lib/event_bus.rb
+- spec/lib/event_bus_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/kevinrutherford/event_bus
 licenses: []
 post_install_message: 
@@ -41,6 +96,8 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: A simple pubsub event bus
-test_files: []
+summary: A simple pubsub event bus for Ruby applications
+test_files:
+- spec/lib/event_bus_spec.rb
+- spec/spec_helper.rb
 has_rdoc: