wisper 1.2.0 → 1.2.1

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
+bundler_args: --without=metrics
+script: rspec spec
 rvm:
   - '1.9.2'
   - '1.9.3'

data/Gemfile

@@ -2,9 +2,7 @@ source 'https://rubygems.org'
 
 gemspec
 
-group :development do
-  gem 'guard'
-  gem 'guard-rspec'
-  gem 'rb-fsevent', '~>0.9.1' if RUBY_PLATFORM =~ /darwin/
+group :metrics do
+  gem 'simplecov'
   gem 'flay'
 end

data/README.md

@@ -1,32 +1,28 @@
 # Wisper
 
-Simple pub/sub for Ruby objects
+Wisper is a Ruby library for decoupling and managing the dependencies of your
+Ruby objects using Pub/Sub.
 
 [![Code Climate](https://codeclimate.com/github/krisleech/wisper.png)](https://codeclimate.com/github/krisleech/wisper)
 [![Build Status](https://travis-ci.org/krisleech/wisper.png?branch=master)](https://travis-ci.org/krisleech/wisper)
 
-While this is not dependent on Rails in any way it was extracted from a Rails
-project and can used as an alternative to ActiveRecord callbacks and Observers.
+Wisper was extracted from a Rails codebase but is not dependant on Rails.
 
-The problem with callbacks and Observers is that they always happen. How many
-times have you wanted to do `User.create` without firing off a welcome email?
-
-It is also super useful for integrating web socket notifications, statistics
-and activity streams in to your controller layer without coupling them to your 
-models.
+It is commonly used as an alternative to ActiveRecord callbacks and Observers
+to reduce coupling between data and domain layers.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'wisper', '~>1.0.0'
+gem 'wisper', '~>1.2.0'
 ```
 
 ## Usage
 
-Any class with the Wisper module included can broadcast events to subscribed
-listeners. Listeners are added, at runtime, to the publishing object.
+Any class with the `Wisper::Publisher` module included can broadcast events 
+to subscribed listeners. Listeners subscribe, at runtime, to the publisher.
 
 ### Publishing
 
@@ -36,24 +32,23 @@ class MyPublisher
 
   def do_something
     # ...
-    publish(:done_something, self)
+    publish(:done_something)
   end
 end
 ```
 
-When the publisher publishes an event it can pass any number of arguments which 
-are passed on to the listeners.
+When a publisher broadcasts an event it can pass any number of arguments which 
+are to be passed on to the listeners.
 
 ```ruby
-publish(:done_something, self, 'hello', 'world')
+publish(:done_something, 'hello', 'world')
 ```
 
 ### Subscribing
 
 #### Listeners
 
-Any object can be a listener and by default they are only subscribed to events
-they can respond to.
+Any object can be a listener and only receives events it can respond to.
 
 ```ruby
 my_publisher = MyPublisher.new
@@ -62,7 +57,7 @@ my_publisher.subscribe(MyListener.new)
 
 #### Blocks
 
-Blocks are subscribed to single events.
+Blocks are subscribed to single events only.
 
 ```ruby
 my_publisher = MyPublisher.new
@@ -130,13 +125,20 @@ responsibility.
 class PlayerJoiningTeam
   include Wisper::Publisher
 
-  def execute(player, team)
+  attr_reader :player, :team
+
+  def initialize(player, team)
+    @player = player
+    @team   = team
+  end
+
+  def execute
     membership = Membership.new(player, team)
 
     if membership.valid?
       membership.save!
-      email_player(player, team)
-      assign_first_mission(player, team)
+      email_player
+      assign_first_mission
       publish(:player_joining_team_successful, player, team)
     else
       publish(:player_joining_team_failed, player, team)
@@ -145,11 +147,11 @@ class PlayerJoiningTeam
 
   private
 
-  def email_player(player, team)
+  def email_player
     # ...
   end
 
-  def assign_first_mission(player, team)
+  def assign_first_mission
     # ...
   end
 end
@@ -195,11 +197,12 @@ end
 ## Global listeners
 
 If you become tired of adding the same listeners to _every_ publisher you can
-add global listeners. They receive all published events which they can respond
+add listeners globally. They receive all broadcast events which they can respond
 to.
 
-However it means that when looking at the code it will not be obvious that the
-global listeners are being executed in additional to the regular listeners.
+Global listeners should be used with caution, the execution path becomes less
+obvious on reading the code and of course you are introducing global state and
+'always on' behaviour. This may not desirable.
 
 ```ruby
 Wisper.add_listener(MyListener.new)
@@ -235,7 +238,7 @@ of events to `:on`.
 post_creater.subscribe(PusherListener.new, :on => :create_post_successful)
 ```
 
-## Mapping event to a different method
+## Mapping an event to a different method
 
 By default the method called on the subscriber is the same as the event
 broadcast. However it can be mapped to a different method using `:with`.
@@ -244,9 +247,8 @@ broadcast. However it can be mapped to a different method using `:with`.
 report_creator.subscribe(MailResponder.new, :with => :successful)
 ```
 
-In the above case it is pretty useless unless used in conjuction with `:on`
-since all events will get mapped to `:successful`. Instead you might do
-something like this:
+This is pretty useless unless used in conjuction with `:on`, since all events 
+will get mapped to `:successful`. Instead you might do something like this:
 
 ```ruby
 report_creator.subscribe(MailResponder.new, :on   => :create_report_successful,
@@ -275,8 +277,8 @@ post.on(:success) { |post| redirect_to post }
 
 ## RSpec
 
-Wisper comes with a method for stubbing event publishers so that you can create isolation tests
-that only care about reacting to events.
+Wisper comes with a method for stubbing event publishers so that you can create 
+isolation tests that only care about reacting to events.
 
 Given this piece of code:
 
@@ -328,8 +330,18 @@ See `spec/lib/rspec_extensions_spec.rb` for a runnable example.
 
 Tested with MRI 1.9.x, MRI 2.0.0, JRuby (1.9 and 2.0 mode) and Rubinius (1.9
 mode).
+
 See the [build status](https://travis-ci.org/krisleech/wisper) for details.
 
+## Running Specs
+
+```
+rspec spec
+```
+
+There is both a `Rakefile` and `Guardfile`, if you like you prefer to run the
+specs using `guard-rspec` or `rake`.
+
 ## License
 
 (The MIT License)

data/lib/wisper.rb

@@ -17,7 +17,7 @@ module Wisper
     TemporaryListeners.with(*args, &block)
   end
 
-  def self.add_listener(listener)
-    GlobalListeners.add(listener)
+  def self.add_listener(listener, options = {})
+    GlobalListeners.add(listener, options)
   end
 end

data/lib/wisper/version.rb

@@ -1,3 +1,3 @@
 module Wisper
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

data/spec/lib/global_subscribers_spec.rb

@@ -12,6 +12,15 @@ describe Wisper::GlobalListeners do
       publisher.send(:broadcast, :it_happened)
     end
 
+    it 'works with options' do
+      Wisper::GlobalListeners.add(global_listener, :on => :it_happened,
+                                                   :with => :woot)
+      global_listener.should_receive(:woot).once
+      global_listener.should_not_receive(:it_happened_again)
+      publisher.send(:broadcast, :it_happened)
+      publisher.send(:broadcast, :it_happened_again)
+    end
+
     it 'works along side local listeners' do
       # global listener
       Wisper::GlobalListeners.add(global_listener)

data/spec/spec_helper.rb

@@ -1,5 +1,8 @@
-require 'simplecov'
-SimpleCov.start
+begin
+  require 'simplecov'
+  SimpleCov.start
+rescue LoadError
+end
 
 require 'wisper'
 

data/wisper.gemspec

@@ -11,13 +11,12 @@ Gem::Specification.new do |gem|
   gem.description   = %q{pub/sub for Ruby objects}
   gem.summary       = %q{pub/sub for Ruby objects}
   gem.homepage      = "https://github.com/krisleech/wisper"
+  gem.license       = "MIT"
 
   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"]
 
-  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'simplecov'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wisper
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-21 00:00:00.000000000 Z
+date: 2013-10-07 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'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -43,22 +27,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !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: pub/sub for Ruby objects
 email:
 - kris.leech@gmail.com
@@ -93,7 +61,8 @@ files:
 - spec/spec_helper.rb
 - wisper.gemspec
 homepage: https://github.com/krisleech/wisper
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths: