wisper 2.0.0.rc1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e196cad72b441abfb2aa87211e0241729dbfe803
-  data.tar.gz: d1506f6acdac8f354ab801814c73726933201abd
+  metadata.gz: 62cd6c2948137446de8f7f515bcbebd11c14092d
+  data.tar.gz: dfbc3b2d28c9023edc9f8308a6c406887c20efed
 SHA512:
-  metadata.gz: 2f1fee408008e32f3861df1438edec17fb05e599e1bb6a196e6c288a5def62d8736d9d7667e22089bee64dae89e54f3d2a8615ecbba24a37efdd6aa23e0fb41d
-  data.tar.gz: b6f4e0b0bdfd905c8ae1562ca79f2c7606804de8ee7e23c4d378019ff780cb3176c1467752b6ec61ee16499658fe9de48bf1b8611da590bdf29bb8d89dcd5b9b
+  metadata.gz: d82be662081f118b83ce5f01f87a0760be1bbc9d711163fc76ac303db689ba307ec453afb9edfb374fa1b23e92ab6a684a2c3857580d3f6a29195c75c8d6f754
+  data.tar.gz: 9395fbd3e0d2b925d31dc06682aa573ad66b0f4ee980533b1671e497ce7f2b8b82019840c7f8eb15c7f52b7bdae73934592ae0e5634729b4ad99f2c068bcae3e

data/.gitignore

@@ -17,3 +17,4 @@ test/tmp
 test/version_tmp
 tmp
 tags
+vendor

data/.travis.yml

@@ -1,17 +1,22 @@
 language: ruby
+before_install:
+  - gem update --system
+  - gem update bundler
 bundler_args: --without=extras
 script: rspec spec
+sudo: false
 rvm:
-  - '1.9.2'
-  - '1.9.3'
-  - '2.0.0'
-  - '2.1.2'
-  - jruby
-  - rbx-2
+  - '2.1.10'
+  - '2.2.6'
+  - '2.3.3'
+  - '2.4.0'
+  - jruby-9.1.6.0
+  # - rbx-2
   ### ALLOWED FAILURES ###
   # see how compatible we are with dev versions, but do not fail the build
   - ruby-head
   - jruby-head
-allow_failures:
-  - rvm: ruby-head
-  - rvm: jruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## HEAD (unreleased)
+
+## 2.0.0 (7th Mar 2017)
+
+Authors: Sergey Mostovoy
+
+* fix: logger raises exception if hash is passed as an argument to a listener
+
 ## 2.0.0.rc1 (17 Dec 2014)
 
 Authors: Kris Leech
@@ -6,6 +14,8 @@ Authors: Kris Leech
 * remove: rspec matcher and stubbing (moved to [wisper-rspec](https://github.com/krisleech/wisper-rspec))
 * feature: add regexp support to `on` argument
 * remove: announce alias for broadcasting
+* docs: add Code of Conduct
+* drop support for Ruby 1.9
 
 ## 1.6.0 (25 Oct 2014)
 

data/CONTRIBUTING.md

@@ -2,6 +2,10 @@
 
 We very much welcome contributions to Wisper.
 
+This project is intended to be a safe, welcoming space for collaboration,
+and contributors are expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
 ## Getting started
 
 Please first check the existing [Issues](https://github.com/krisleech/wisper/issues) 
@@ -19,11 +23,15 @@ Please open an issue with your proposed feature. We can discuss the feature and
 if it is acceptable we can also discuss implimentation details. You will in
 most cases have to submit a PR which adds the feature. 
 
-We also have a [Gitter channel](https://gitter.im/krisleech/wisper).
-
 Wisper is a micro library and will remain lean. Some features would be most
 appropriate as an extension to Wisper.
 
+We also have a [Gitter channel](https://gitter.im/krisleech/wisper) if you wish to discuss your ideas.
+
+## Backlog /  Roadmap
+
+The backlog for Wisper and related gems is on [Waffle](https://waffle.io/krisleech/wisper).
+
 ## Questions
 
 Try the [Wiki](https://github.com/krisleech/wisper/wiki) first, the examples
@@ -33,8 +41,6 @@ Please ask questions on StackOverflow, [tagged wisper](https://stackoverflow.com
 
 Feel free to ping me the URL on [Twitter](https://twitter.com/krisleech).
 
-We also have a [channel on Gitter](https://gitter.im/krisleech/wisper).
-
 ## Pull requests
 
 * Fork the project, create a new branch from `v1` or `master`.

data/Gemfile

@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake',  '~> 10.3.0'
-gem 'rspec', '~> 3.0.0'
+gem 'rspec', '~> 3.4.0'
 gem 'coveralls', require: false
 
 group :extras do

data/README.md

@@ -2,10 +2,10 @@
 
 *A micro library providing Ruby objects with Publish-Subscribe capabilities*
 
-[![Gem Version](https://badge.fury.io/rb/wisper.png)](http://badge.fury.io/rb/wisper)
-[![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)
-[![Coverage Status](https://coveralls.io/repos/krisleech/wisper/badge.png?branch=master)](https://coveralls.io/r/krisleech/wisper?branch=master)
+[![Gem Version](https://badge.fury.io/rb/wisper.svg)](http://badge.fury.io/rb/wisper)
+[![Code Climate](https://codeclimate.com/github/krisleech/wisper.svg)](https://codeclimate.com/github/krisleech/wisper)
+[![Build Status](https://travis-ci.org/krisleech/wisper.svg?branch=master)](https://travis-ci.org/krisleech/wisper)
+[![Coverage Status](https://coveralls.io/repos/krisleech/wisper/badge.svg?branch=master)](https://coveralls.io/r/krisleech/wisper?branch=master)
 
 * Decouple core business logic from external concerns in Hexagonal style architectures
 * Use as an alternative to ActiveRecord callbacks and Observers in Rails apps
@@ -19,12 +19,12 @@ Note: Wisper was originally extracted from a Rails codebase but is not dependant
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'wisper'
+gem 'wisper', '2.0.0'
 ```
 
 ## Usage
 
-Any class with the `Wisper::Publisher` module included can broadcast events 
+Any class with the `Wisper::Publisher` module included can broadcast events
 to subscribed listeners. Listeners subscribe, at runtime, to the publisher.
 
 ### Publishing
@@ -47,7 +47,7 @@ class CancelOrder
 end
 ```
 
-When a publisher broadcasts an event it can include number of arguments. 
+When a publisher broadcasts an event it can include any number of arguments.
 
 The `broadcast` method is also aliased as `publish`.
 
@@ -73,7 +73,7 @@ The listener would need to implement a method for every event it wishes to recei
 class OrderNotifier
   def cancel_order_successful(order_id)
     order = Order.find_by_id(order_id)
-       
+
     # notify someone ...    
   end
 end
@@ -88,10 +88,27 @@ cancel_order = CancelOrder.new
 
 cancel_order.on(:cancel_order_successful) { |order_id| ... }
             .on(:cancel_order_failed)     { |order_id| ... }
-            
+
 cancel_order.call(order_id)
 ```
 
+You can also subscribe to multiple events using `on` by passing
+additional events as arguments.
+
+```ruby
+cancel_order = CancelOrder.new
+
+cancel_order.on(:cancel_order_successful) { |order_id| ... }
+            .on(:cancel_order_failed,
+                :cancel_order_invalid)    { |order_id| ... }
+
+cancel_order.call(order_id)
+```
+
+Do not `return` from inside a subscribed block, due to the way
+[Ruby treats blocks](http://product.reverb.com/2015/02/28/the-strange-case-of-wisper-and-ruby-blocks-behaving-like-procs/)
+this will prevent any subsequent listeners having their events delivered.
+
 ### Handling Events Asynchronously
 
 ```ruby
@@ -100,16 +117,30 @@ cancel_order.subscribe(OrderNotifier.new, async: true)
 
 Wisper has various adapters for asynchronous event handling, please refer to
 [wisper-celluloid](https://github.com/krisleech/wisper-celluloid),
-[wisper-sidekiq](https://github.com/krisleech/wisper-sidekiq) or
-[wisper-activejob](https://github.com/krisleech/wisper-activejob).
+[wisper-sidekiq](https://github.com/krisleech/wisper-sidekiq),
+[wisper-activejob](https://github.com/krisleech/wisper-activejob), or
+[wisper-que](https://github.com/joevandyk/wisper-que).
+
+Depending on the adapter used the listener may need to be a class instead of an object. In this situation, every method corresponding to events should be declared as a class method, too. For example:
+
+```ruby
+class OrderNotifier
+  # declare a class method if you are subscribing the listener class instead of its instance like:
+  #   cancel_order.subscribe(OrderNotifier)
+  #
+  def self.cancel_order_successful(order_id)
+    order = Order.find_by_id(order_id)
 
-Depending on the adapter used the listener may need to be a class instead of an object.
+    # notify someone ...    
+  end
+end
+```
 
 ### ActionController
 
 ```ruby
 class CancelOrderController < ApplicationController
- 
+
   def create
     cancel_order = CancelOrder.new
 
@@ -132,7 +163,7 @@ If you wish to publish directly from ActiveRecord models you can broadcast event
 ```ruby
 class Order < ActiveRecord::Base
   include Wisper::Publisher
-  
+
   after_commit     :publish_creation_successful, on: :create
   after_validation :publish_creation_failed,     on: :create
 
@@ -171,9 +202,12 @@ class.
 
 ```ruby
 Wisper.subscribe(MyListener.new, scope: :MyPublisher)
+Wisper.subscribe(MyListener.new, scope: MyPublisher)
+Wisper.subscribe(MyListener.new, scope: "MyPublisher")
+Wisper.subscribe(MyListener.new, scope: [:MyPublisher, :MyOtherPublisher])
 ```
 
-This will subscribe the listener to all instances of `MyPublisher` and its
+This will subscribe the listener to all instances of the specified class(es) and their
 subclasses.
 
 Alternatively you can also do exactly the same with a publisher class itself:
@@ -193,7 +227,7 @@ end
 ```
 
 Any events broadcast within the block by any publisher will be sent to the
-listeners. 
+listeners.
 
 This is useful for capturing events published by objects to which you do not have access in a given context.
 
@@ -202,11 +236,11 @@ Temporary Global Listeners are threadsafe.
 ## Subscribing to selected events
 
 By default a listener will get notified of all events it can respond to. You
-can limit which events a listener is notified of by passing an string, symbol,
+can limit which events a listener is notified of by passing a string, symbol,
 array or regular expression to `on`:
 
 ```ruby
-post_creater.subscribe(PusherListener.new, on: :create_post_successful)
+post_creator.subscribe(PusherListener.new, on: :create_post_successful)
 ```
 
 ## Prefixing broadcast events
@@ -215,10 +249,10 @@ If you would prefer listeners to receive events with a prefix, for example
 `on`, you can do so by passing a string or symbol to `prefix:`.
 
 ```ruby
-post_creater.subscribe(PusherListener.new, prefix: :on)
+post_creator.subscribe(PusherListener.new, prefix: :on)
 ```
 
-If `post_creater` where to broadcast the event `post_created` the subscribed
+If `post_creator` were to broadcast the event `post_created` the subscribed
 listeners would receive `on_post_created`. You can also pass `true` which will
 use the default prefix, "on".
 
@@ -231,7 +265,7 @@ broadcast. However it can be mapped to a different method using `with:`.
 report_creator.subscribe(MailResponder.new, with: :successful)
 ```
 
-This is pretty useless unless used in conjuction with `on:`, since all events
+This is pretty useless unless used in conjunction with `on:`, since all events
 will get mapped to `:successful`. Instead you might do something like this:
 
 ```ruby
@@ -255,11 +289,14 @@ report_creator.subscribe(MailResponder.new, on:   :create_report_failed,
 You could also alias the method within your listener, as such
 `alias successful create_report_successful`.
 
-## RSpec
+## Testing
+
+Testing matchers and stubs are in seperate gems.
 
-Please see [wisper-rspec](https://github.com/krisleech/wisper-rspec).
+* [wisper-rspec](https://github.com/krisleech/wisper-rspec)
+* [wisper-minitest](https://github.com/digitalcuisine/wisper-minitest)
 
-## Clearing Global Listeners
+### Clearing Global Listeners
 
 If you use global listeners in non-feature tests you _might_ want to clear them
 in a hook to prevent global subscriptions persisting between tests.
@@ -268,21 +305,40 @@ in a hook to prevent global subscriptions persisting between tests.
 after { Wisper.clear }
 ```
 
+## Need help?
+
+The [Wiki](https://github.com/krisleech/wisper/wiki) has more examples,
+articles and talks.
+
+Got a specific question, try the
+[Wisper tag on StackOverflow](http://stackoverflow.com/questions/tagged/wisper).
+
 ## Compatibility
 
-Tested with MRI 1.9.x, MRI 2.0.0, JRuby (1.9 and 2.0 mode) and Rubinius (1.9
-mode).
+Tested with MRI 2.x, JRuby and Rubinius.
 
 See the [build status](https://travis-ci.org/krisleech/wisper) for details.
 
 ## Running Specs
 
 ```
-rspec spec
+bundle exec rspec
+```
+
+To run the specs on code changes try [entr](http://entrproject.org/):
+
+```
+ls **/*.rb | entr bundle exec rspec
 ```
 
-There is both a `Rakefile` and `Guardfile`, if you like you prefer to run the
-specs using `guard-rspec` or `rake`.
+## Contributing
+
+Please read the [Contributing Guidelines](https://github.com/krisleech/wisper/blob/master/CONTRIBUTING.md).
+
+## Security
+
+* gem releases are [signed](http://guides.rubygems.org/security/) ([public key](https://github.com/krisleech/wisper/blob/master/gem-public_cert.pem))
+* commits are GPG signed ([public key](https://pgp.mit.edu/pks/lookup?op=get&search=0x3ABC74851F7CCC88))
 
 ## License
 

data/lib/wisper.rb

@@ -2,6 +2,8 @@ require 'set'
 require 'wisper/version'
 require 'wisper/configuration'
 require 'wisper/publisher'
+require 'wisper/value_objects/prefix'
+require 'wisper/value_objects/events'
 require 'wisper/registration/registration'
 require 'wisper/registration/object'
 require 'wisper/registration/block'
@@ -33,6 +35,10 @@ module Wisper
     end
   end
 
+  def self.unsubscribe(*listeners)
+    GlobalListeners.unsubscribe(*listeners)
+  end
+
   def self.publisher
     Publisher
   end

data/lib/wisper/broadcasters/logger_broadcaster.rb

@@ -9,22 +9,28 @@ module Wisper
       end
 
       def broadcast(listener, publisher, event, args)
-        @logger.info("[WISPER] #{name(publisher)} published #{event} to #{name(listener)} with #{arg_names(args)}")
+        @logger.info("[WISPER] #{name(publisher)} published #{event} to #{name(listener)} with #{args_info(args)}")
         @broadcaster.broadcast(listener, publisher, event, args)
       end
 
       private
 
       def name(object)
-        id_method  = %w(id uuid key object_id).find { |id_method| object.respond_to?(id_method) }
+        id_method  = %w(id uuid key object_id).find do |method_name|
+          object.respond_to?(method_name) && object.method(method_name).arity <= 0
+        end
         id         = object.send(id_method)
         class_name = object.class == Class ? object.name : object.class.name
         "#{class_name}##{id}"
       end
 
-      def arg_names(args)
+      def args_info(args)
         return 'no arguments' if args.empty?
-        args.map { |arg| name(arg) }.join(', ')
+        args.map do |arg|
+          arg_string = name(arg)
+          arg_string += ": #{arg.inspect}" if [Numeric, Array, Hash, String].any? {|klass| arg.is_a?(klass) }
+          arg_string
+        end.join(', ')
       end
     end
   end

data/lib/wisper/configuration.rb

@@ -17,10 +17,19 @@ module Wisper
       self
     end
 
+    # sets the default value for prefixes
+    #
+    # @param [#to_s] value
+    #
+    # @return [String]
+    def default_prefix=(value)
+      ValueObjects::Prefix.default = value
+    end
+
     class Broadcasters
       extend Forwardable
 
-      def_delegators :@data, :fetch, :[], :[]=, :empty?, :include?, :clear
+      def_delegators :@data, :[], :[]=, :empty?, :include?, :clear, :keys, :to_h
 
       def initialize
         @data = {}

data/lib/wisper/global_listeners.rb

@@ -24,6 +24,15 @@ module Wisper
       self
     end
 
+    def unsubscribe(*listeners)
+      with_mutex do
+        @registrations.delete_if do |registration|
+          listeners.include?(registration.listener)
+        end
+      end
+      self
+    end
+
     def registrations
       with_mutex { @registrations }
     end
@@ -40,6 +49,10 @@ module Wisper
       instance.subscribe(*listeners)
     end
 
+    def self.unsubscribe(*listeners)
+      instance.unsubscribe(*listeners)
+    end
+
     def self.registrations
       instance.registrations
     end

data/lib/wisper/publisher.rb

@@ -11,6 +11,7 @@ module Wisper
     #
     # @return [self]
     def subscribe(listener, options = {})
+      raise ArgumentError, "#{__method__} does not take a block, did you mean to call #on instead?" if block_given?
       local_registrations << ObjectRegistration.new(listener, options)
       self
     end
@@ -23,6 +24,7 @@ module Wisper
     # @return [self]
     def on(*events, &block)
       raise ArgumentError, 'must give at least one event' if events.empty?
+      raise ArgumentError, 'must pass a block' if !block
       local_registrations << BlockRegistration.new(block, on: events)
       self
     end

data/lib/wisper/registration/object.rb

@@ -7,7 +7,7 @@ module Wisper
     def initialize(listener, options)
       super(listener, options)
       @with   = options[:with]
-      @prefix = stringify_prefix(options[:prefix])
+      @prefix = ValueObjects::Prefix.new options[:prefix]
       @allowed_classes = Array(options[:scope]).map(&:to_s).to_set
       @broadcaster = map_broadcaster(options[:async] || options[:broadcaster])
     end
@@ -29,21 +29,6 @@ module Wisper
       prefix + (with || event).to_s
     end
 
-    def stringify_prefix(_prefix)
-      case _prefix
-      when nil
-        ''
-      when true
-        default_prefix + '_'
-      else
-        _prefix.to_s + '_'
-      end
-    end
-
-    def default_prefix
-      'on'
-    end
-
     def map_broadcaster(value)
       return value if value.respond_to?(:broadcast)
       value = :async   if value == true

data/lib/wisper/registration/registration.rb

@@ -4,39 +4,15 @@ module Wisper
   class Registration
     attr_reader :on, :listener
 
-    ALL = Object.new.freeze
-
     def initialize(listener, options)
       @listener = listener
-      @on       = stringify(options.fetch(:on, ALL))
+      @on = ValueObjects::Events.new options[:on]
     end
 
     private
 
     def should_broadcast?(event)
-      return true if on == ALL
-
-      case on.class.name
-      when 'String'
-        event == on
-      when 'Array'
-        on.include?(event)
-      when 'Regexp'
-        !!on.match(event)
-      else
-        raise ArgumentError, "#{on.class} not supported for `on` argument"
-      end
-    end
-
-    def stringify(on)
-      case on.class.name
-      when 'Symbol'
-        on.to_s
-      when 'Array'
-        on.map(&:to_s)
-      else
-        on
-      end
+      on.include? event
     end
   end
 end

data/lib/wisper/value_objects/events.rb

@@ -0,0 +1,61 @@
+module Wisper
+  module ValueObjects #:nodoc:
+    # Describes allowed events
+    #
+    # Duck-types the argument to quack like array of strings
+    # when responding to the {#include?} method call.
+    class Events
+
+      # @!scope class
+      # @!method new(on)
+      # Initializes a 'list' of events
+      #
+      # @param [NilClass, String, Symbol, Array, Regexp] list
+      #
+      # @raise [ArgumentError]
+      #   if an argument if of unsupported type
+      #
+      # @return [undefined]
+      def initialize(list)
+        @list = list
+      end
+
+      # Check if given event is 'included' to the 'list' of events
+      #
+      # @param [#to_s] event
+      #
+      # @return [Boolean]
+      def include?(event)
+        appropriate_method.call(event.to_s)
+      end
+
+      private
+
+      def methods
+        {
+          NilClass   => ->(_event) { true },
+          String     => ->(event)  { list == event },
+          Symbol     => ->(event)  { list.to_s == event },
+          Enumerable => ->(event)  { list.map(&:to_s).include? event },
+          Regexp     => ->(event)  { list.match(event) || false }
+        }
+      end
+
+      def list
+        @list
+      end
+
+      def appropriate_method
+        @appropriate_method ||= methods[recognized_type]
+      end
+
+      def recognized_type
+        methods.keys.detect(&list.method(:is_a?)) || type_not_recognized
+      end
+
+      def type_not_recognized
+        fail(ArgumentError, "#{list.class} not supported for `on` argument")
+      end
+    end # class Events
+  end # module ValueObjects
+end # module Wisper

data/lib/wisper/value_objects/prefix.rb

@@ -0,0 +1,29 @@
+module Wisper
+  module ValueObjects #:nodoc:
+    # Prefix for notifications
+    #
+    # @example
+    #   Wisper::ValueObjects::Prefix.new nil    # => ""
+    #   Wisper::ValueObjects::Prefix.new "when" # => "when_"
+    #   Wisper::ValueObjects::Prefix.new true   # => "on_"
+    class Prefix < String
+      class << self
+        attr_accessor :default
+      end
+
+      # @param [true, nil, #to_s] value
+      #
+      # @return [undefined]
+      def initialize(value = nil)
+        super "#{ (value == true) ? default : value }_"
+        replace "" if self == "_"
+      end
+
+      private
+
+      def default
+        self.class.default || 'on'
+      end
+    end # class Prefix
+  end # module ValueObjects
+end # module Wisper

data/lib/wisper/version.rb

@@ -1,3 +1,3 @@
 module Wisper
-  VERSION = "2.0.0.rc1"
+  VERSION = "2.0.0"
 end

data/spec/lib/temporary_global_listeners_spec.rb

@@ -1,7 +1,8 @@
 describe Wisper::TemporaryListeners do
   let(:listener_1) { double('listener', :to_a => nil) } # [1]
   let(:listener_2) { double('listener', :to_a => nil) }
-  let(:publisher)  { Object.class_eval { include Wisper::Publisher } }
+
+  let(:publisher)  { publisher_class.new }
 
   describe '.subscribe' do
     it 'globally subscribes listener for duration of given block' do
@@ -31,30 +32,32 @@ describe Wisper::TemporaryListeners do
       publisher.instance_eval { broadcast(:failure) }
     end
 
-    it 'ensures registrations are thread local' do
+    it 'is thread safe' do
       num_threads = 20
       (1..num_threads).to_a.map do
         Thread.new do
           Wisper::TemporaryListeners.registrations << Object.new
-          expect(Wisper::TemporaryListeners.registrations.size).to eql 1
+          expect(Wisper::TemporaryListeners.registrations.size).to eq 1
         end
       end.each(&:join)
 
-      expect(Wisper::TemporaryListeners.registrations.size).to eql 0
+      expect(Wisper::TemporaryListeners.registrations).to be_empty
     end
 
-    it 'ensures registrations are cleared after exception raised in block' do
+    it 'clears registrations when an exception occurs' do
+      MyError = Class.new(StandardError)
+
       begin
         Wisper::TemporaryListeners.subscribe(listener_1) do
-          raise StandardError
+          raise MyError
         end
-      rescue StandardError
+      rescue MyError
       end
 
-      expect(Wisper::TemporaryListeners.registrations.size).to eql 0
+      expect(Wisper::TemporaryListeners.registrations).to be_empty
     end
 
-    it 'returns self so methods can be chained' do
+    it 'returns self' do
       expect(Wisper::TemporaryListeners.subscribe {}).to be_an_instance_of(Wisper::TemporaryListeners)
     end
   end

data/spec/lib/wisper/broadcasters/logger_broadcaster_spec.rb

@@ -28,12 +28,12 @@ module Wisper
           context 'without arguments' do
             let(:args) { [] }
 
-            it 'logs publised event' do
+            it 'logs published event' do
               expect(logger).to receive(:info).with('[WISPER] Publisher#1 published thing_created to Listener#2 with no arguments')
               subject.broadcast(listener, publisher, event, args)
             end
 
-            it 'delgates broadcast to given broadcaster' do
+            it 'delegates broadcast to a given broadcaster' do
               expect(broadcaster).to receive(:broadcast).with(listener, publisher, event, args)
               subject.broadcast(listener, publisher, event, args)
             end
@@ -47,10 +47,30 @@ module Wisper
               subject.broadcast(listener, publisher, event, args)
             end
 
-            it 'delgates broadcast to given broadcaster' do
+            it 'delegates broadcast to a given broadcaster' do
               expect(broadcaster).to receive(:broadcast).with(listener, publisher, event, args)
               subject.broadcast(listener, publisher, event, args)
             end
+
+            context 'when argument is a hash' do
+              let(:args) { [hash] }
+              let(:hash) { {key: 'value'} }
+
+              it 'logs published event and arguments' do
+                expect(logger).to receive(:info).with("[WISPER] Publisher#1 published thing_created to Listener#2 with Hash##{hash.object_id}: #{hash.inspect}")
+                subject.broadcast(listener, publisher, event, args)
+              end
+            end
+
+            context 'when argument is an integer' do
+              let(:args) { [number] }
+              let(:number) { 10 }
+
+              it 'logs published event and arguments' do
+                expect(logger).to receive(:info).with("[WISPER] Publisher#1 published thing_created to Listener#2 with #{number.class.name}##{number.object_id}: 10")
+                subject.broadcast(listener, publisher, event, args)
+              end
+            end
           end
 
         end

data/spec/lib/wisper/configuration/broadcasters_spec.rb

@@ -0,0 +1,11 @@
+module Wisper
+  describe Configuration::Broadcasters do
+    describe 'broadcasters' do
+      describe '#to_h' do
+        it 'returns a Hash' do
+          expect(subject.to_h).to be_instance_of(Hash)
+        end
+      end
+    end
+  end
+end

data/spec/lib/wisper/configuration_spec.rb

@@ -20,5 +20,17 @@ module Wisper
         end
       end
     end
+
+    describe '#default_prefix=' do
+      let(:prefix_class)  { ValueObjects::Prefix }
+      let(:default_value) { double }
+
+      before { allow(prefix_class).to receive(:default=) }
+
+      it 'sets the default value for prefixes' do
+        expect(prefix_class).to receive(:default=).with(default_value)
+        subject.default_prefix = default_value
+      end
+    end
   end
 end

data/spec/lib/wisper/publisher_spec.rb

@@ -211,6 +211,15 @@ describe Wisper::Publisher do
     it 'is aliased to .subscribe' do
       expect(publisher).to respond_to(:subscribe)
     end
+
+    it 'raises a helpful error if trying to pass a block' do
+      invalid = ->{
+        publisher.subscribe(:success) do
+          puts
+        end
+      }
+      expect{ invalid.call }.to raise_error(ArgumentError)
+    end
   end
 
   describe '.on' do
@@ -222,6 +231,10 @@ describe Wisper::Publisher do
       expect { publisher.on() {} }.to raise_error(ArgumentError)
     end
 
+    it 'raises an error of no block given' do
+      expect { publisher.on(:something) }.to raise_error(ArgumentError)
+    end
+
     it 'returns publisher so methods can be chained' do
       expect(publisher.on(:foo) {}).to eq publisher
     end

data/spec/lib/wisper/value_objects/events_spec.rb

@@ -0,0 +1,107 @@
+describe Wisper::ValueObjects::Events do
+  context 'nil' do
+    subject { described_class.new nil }
+
+    describe '#include?' do
+      it 'returns true' do
+        expect(subject.include? 'foo').to be_truthy
+        expect(subject.include? :bar).to be_truthy
+      end
+    end
+  end
+
+  context '"foo"' do
+    let(:foo) { Class.new(String).new 'foo' }
+    subject   { described_class.new foo }
+
+    describe '#include?' do
+      it 'returns true for "foo"' do
+        expect(subject.include? 'foo').to be_truthy
+      end
+
+      it 'returns true for :foo' do
+        expect(subject.include? :foo).to be_truthy
+      end
+
+      it 'returns false otherwise' do
+        expect(subject.include? 'bar').to be_falsey
+        expect(subject.include? :bar).to be_falsey
+      end
+    end
+  end
+
+  context ':foo' do
+    subject { described_class.new :foo }
+
+    describe '#include?' do
+      it 'returns true for "foo"' do
+        expect(subject.include? 'foo').to be_truthy
+      end
+
+      it 'returns true for :foo' do
+        expect(subject.include? :foo).to be_truthy
+      end
+
+      it 'returns false otherwise' do
+        expect(subject.include? 'bar').to be_falsey
+        expect(subject.include? :bar).to be_falsey
+      end
+    end
+  end
+
+  context '[:foo, "bar"]' do
+    subject { described_class.new [:foo, 'bar'] }
+
+    describe '#include?' do
+      it 'returns true for "foo"' do
+        expect(subject.include? 'foo').to be_truthy
+      end
+
+      it 'returns true for :foo' do
+        expect(subject.include? :foo).to be_truthy
+      end
+
+      it 'returns true for "bar"' do
+        expect(subject.include? 'bar').to be_truthy
+      end
+
+      it 'returns true for :bar' do
+        expect(subject.include? :bar).to be_truthy
+      end
+
+      it 'returns false otherwise' do
+        expect(subject.include? 'baz').to be_falsey
+        expect(subject.include? :baz).to be_falsey
+      end
+    end
+  end
+
+  context 'by /foo/' do
+    subject { described_class.new(/foo/) }
+
+    describe '#include?' do
+      it 'returns true for "foo"' do
+        expect(subject.include? 'foo').to be_truthy
+      end
+
+      it 'returns true for :foo' do
+        expect(subject.include? :foo).to be_truthy
+      end
+
+      it 'returns false otherwise' do
+        expect(subject.include? 'bar').to be_falsey
+        expect(subject.include? :bar).to be_falsey
+      end
+    end
+  end
+
+  context 'another class' do
+    subject { described_class.new Object.new }
+
+    describe '#include?' do
+      it 'raises ArgumentError' do
+        expect { subject.include? 'foo' }.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/lib/wisper/value_objects/prefix_spec.rb

@@ -0,0 +1,46 @@
+describe Wisper::ValueObjects::Prefix do
+  
+  it 'is a string' do
+    expect(subject).to be_kind_of String
+  end
+
+  describe '.new' do
+    context 'without arguments' do
+      subject { described_class.new }
+      it { is_expected.to eq '' }
+    end
+
+    context 'nil' do
+      subject { described_class.new nil }
+      it { is_expected.to eq '' }
+    end
+
+    context 'true' do
+      subject { described_class.new true }
+      it { is_expected.to eq 'on_' }
+    end
+
+    context '"foo"' do
+      subject { described_class.new 'foo' }
+      it { is_expected.to eq 'foo_' }
+    end
+  end
+
+  describe '.default=' do
+    after { described_class.default = nil }
+
+    context 'nil' do
+      it "doesn't change default prefix" do
+        expect { described_class.default = nil }
+          .not_to change { described_class.new true }.from('on_')
+      end
+    end
+
+    context '"foo"' do
+      it 'changes default prefix' do
+        expect { described_class.default = 'foo' }
+          .to change { described_class.new true }.from('on_').to('foo_')
+      end
+    end
+  end
+end

data/spec/lib/wisper_spec.rb

@@ -1,62 +1,99 @@
 describe Wisper do
   describe '.subscribe' do
-    context 'given block' do
+    context 'when given block' do
+
       it 'subscribes listeners to all events for duration of the block' do
         publisher = publisher_class.new
-        listener = double('listener')
+        listener  = double('listener')
 
-        expect(listener).to receive(:im_here)
-        expect(listener).not_to receive(:not_here)
+        expect(listener).to receive(:first_event)
+        expect(listener).not_to receive(:second_event)
 
         Wisper.subscribe(listener) do
-          publisher.send(:broadcast, 'im_here')
+          publisher.send(:broadcast, 'first_event')
         end
 
-        publisher.send(:broadcast, 'not_here')
+        publisher.send(:broadcast, 'second_event')
       end
     end
 
-    context 'no block given' do
-      it 'subscribes a listener to all events' do
+    context 'when no block given' do
+      it 'subscribes listener to all events' do
         listener = double('listener')
         Wisper.subscribe(listener)
         expect(Wisper::GlobalListeners.listeners).to eq [listener]
       end
 
-      it 'subscribes multiple listeners to all events' do
+      it 'subscribes listeners to all events' do
         listener_1 = double('listener')
         listener_2 = double('listener')
-        listener_3 = double('listener')
 
         Wisper.subscribe(listener_1, listener_2)
 
         expect(Wisper::GlobalListeners.listeners).to include listener_1, listener_2
-        expect(Wisper::GlobalListeners.listeners).not_to include listener_3
       end
     end
   end
 
-  it '.publisher returns the Publisher module' do
-    expect(Wisper.publisher).to eq Wisper::Publisher
+  describe '.unsubscribe' do
+    it 'removes listener from list of listeners' do
+      listener = double('listener')
+
+      Wisper.subscribe(listener)
+      expect(Wisper::GlobalListeners.listeners).to eq [listener]
+
+      Wisper.unsubscribe(listener)
+      expect(Wisper::GlobalListeners.listeners).to eq []
+    end
+
+    it 'removes listeners from list of listeners' do
+      listener_1 = double('listener')
+      listener_2 = double('listener')
+
+      Wisper.subscribe(listener_1, listener_2)
+      expect(Wisper::GlobalListeners.listeners).to include listener_1, listener_2
+
+      Wisper.unsubscribe(listener_1, listener_2)
+      expect(Wisper::GlobalListeners.listeners).to eq []
+    end
   end
 
-  it '.clear clears all global listeners' do
-    10.times { Wisper.subscribe(double) }
-    Wisper.clear
-    expect(Wisper::GlobalListeners.listeners).to be_empty
+  describe '.publisher' do
+    it 'returns the Publisher module' do
+      expect(Wisper.publisher).to eq Wisper::Publisher
+    end
   end
 
-  it '.configuration returns configuration' do
-    expect(Wisper.configuration).to be_an_instance_of(Wisper::Configuration)
+  describe '.clear' do
+    before { Wisper.subscribe(double) }
+
+    it 'clears all global listeners' do
+      Wisper.clear
+      expect(Wisper::GlobalListeners.listeners).to be_empty
+    end
   end
 
-  it '.configure yields block to configuration' do
-    Wisper.configure do |config|
-      expect(config).to be_an_instance_of(Wisper::Configuration)
+  describe '.configuration' do
+    it 'returns configuration object' do
+      expect(Wisper.configuration).to be_an_instance_of(Wisper::Configuration)
+    end
+
+    it 'is memorized' do
+      expect(Wisper.configuration).to eq Wisper.configuration
     end
   end
 
-  it 'has a default broadcaster' do
-    expect(Wisper.configuration.broadcasters[:default]).to be_instance_of(Wisper::Broadcasters::SendBroadcaster)
+  describe '.configure' do
+    it 'passes configuration to given block' do
+      Wisper.configure do |config|
+        expect(config).to be_an_instance_of(Wisper::Configuration)
+      end
+    end
+  end
+
+  describe '.setup' do
+    it 'sets a default broadcaster' do
+      expect(Wisper.configuration.broadcasters[:default]).to be_instance_of(Wisper::Broadcasters::SendBroadcaster)
+    end
   end
 end

data/spec/spec_helper.rb

@@ -22,11 +22,3 @@ end
 def publisher_class
   Class.new { include Wisper::Publisher }
 end
-
-# prevents deprecation warning showing up in spec output
-def silence_warnings
-  original_verbosity = $VERBOSE
-  $VERBOSE = nil
-  yield
-  $VERBOSE = original_verbosity
-end

data/wisper.gemspec

@@ -8,8 +8,12 @@ Gem::Specification.new do |gem|
   gem.version       = Wisper::VERSION
   gem.authors       = ["Kris Leech"]
   gem.email         = ["kris.leech@gmail.com"]
-  gem.description   = %q{pub/sub for Ruby objects}
-  gem.summary       = %q{pub/sub for Ruby objects}
+  gem.description   = <<-DESC
+    A micro library providing objects with Publish-Subscribe capabilities.
+    Both synchronous (in-process) and asynchronous (out-of-process) subscriptions are supported.
+    Check out the Wiki for articles, guides and examples: https://github.com/krisleech/wisper/wiki
+  DESC
+  gem.summary       = "A micro library providing objects with Publish-Subscribe capabilities"
   gem.homepage      = "https://github.com/krisleech/wisper"
   gem.license       = "MIT"
 

metadata

@@ -1,38 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: wisper
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc1
+  version: 2.0.0
 platform: ruby
 authors:
 - Kris Leech
 autorequire: 
 bindir: bin
-cert_chain:
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDeDCCAmCgAwIBAgIBATANBgkqhkiG9w0BAQUFADBBMRMwEQYDVQQDDAprcmlz
-  LmxlZWNoMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZFgNj
-  b20wHhcNMTQxMTA1MTEwMzQ4WhcNMTUxMTA1MTEwMzQ4WjBBMRMwEQYDVQQDDApr
-  cmlzLmxlZWNoMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZ
-  FgNjb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCtW0/UtrFK/tSm
-  uq5HnCUkZAQjnSaZ/h1Tby9s30CDJjDUdizPRdLQCplLDAMHFsAfTyD0Mc+Ez8o9
-  CdTh8EZ4TSf+nokL+SUprpdR6qm6OWU03Ntd+bDCP0+rdqCX82g3N3mnvjR9aD3a
-  +hd9Fhp0WuEyqTNjQ7IlopeUPDW7eYfSwI4bjfRHxsDR1GuZ3j0npxCAgAIN41WH
-  MSTTZhdo0vKEiKZEtMMnT6w6fG/c3XIhVVPGnqy5+IZqBL0SYC+WJL3vC6yUBgqB
-  nrpA/q+b3M69W+q+TkGv0qOnrxln0O7J2pykjoGIxUhhRkiGEldEhy9dxQWubffr
-  hVJ4F0wLAgMBAAGjezB5MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
-  BBSzq+x8mwj0ldvNkvjOl44OJG354jAfBgNVHREEGDAWgRRrcmlzLmxlZWNoQGdt
-  YWlsLmNvbTAfBgNVHRIEGDAWgRRrcmlzLmxlZWNoQGdtYWlsLmNvbTANBgkqhkiG
-  9w0BAQUFAAOCAQEAF5M2Md3DcNCrQrDRDLaIzHaMM+RTgfbpgmZ6tU0iEowES18g
-  QWQgrAbFuvQRPETJ2gbL5AC35fEqN80nU+3GhgW/bDYhII5D3PGLMorxhFw1JYLI
-  0Fd7MCE0sImc2rPybYUdpZ6TxvqgPKp+8CzM8vBUrdYd+dSHXit1piViWBcZcJb+
-  EL5Ze4IodjkCPAeHvu2MQieieViLyfB4eG1syvfkxvAXCjFHeQoIFP16vVtcljdF
-  k5cHH/4SGeMuGrSLRsqVvltxVV3AbQAfH8WUos2brjYHsoH5tVPrJ7UcFhzP95oU
-  pEfFMW42smiNTOXpzG6JoIpA11szEHFT5ZS+UQ==
-  -----END CERTIFICATE-----
-date: 2014-12-17 00:00:00.000000000 Z
+cert_chain: []
+date: 2017-03-07 00:00:00.000000000 Z
 dependencies: []
-description: pub/sub for Ruby objects
+description: |2
+      A micro library providing objects with Publish-Subscribe capabilities.
+      Both synchronous (in-process) and asynchronous (out-of-process) subscriptions are supported.
+      Check out the Wiki for articles, guides and examples: https://github.com/krisleech/wisper/wiki
 email:
 - kris.leech@gmail.com
 executables: []
@@ -45,7 +26,6 @@ files:
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
-- Guardfile
 - README.md
 - Rakefile
 - gem-public_cert.pem
@@ -59,6 +39,8 @@ files:
 - lib/wisper/registration/object.rb
 - lib/wisper/registration/registration.rb
 - lib/wisper/temporary_listeners.rb
+- lib/wisper/value_objects/events.rb
+- lib/wisper/value_objects/prefix.rb
 - lib/wisper/version.rb
 - spec/lib/global_listeners_spec.rb
 - spec/lib/integration_spec.rb
@@ -66,9 +48,12 @@ files:
 - spec/lib/temporary_global_listeners_spec.rb
 - spec/lib/wisper/broadcasters/logger_broadcaster_spec.rb
 - spec/lib/wisper/broadcasters/send_broadcaster_spec.rb
+- spec/lib/wisper/configuration/broadcasters_spec.rb
 - spec/lib/wisper/configuration_spec.rb
 - spec/lib/wisper/publisher_spec.rb
 - spec/lib/wisper/registrations/object_spec.rb
+- spec/lib/wisper/value_objects/events_spec.rb
+- spec/lib/wisper/value_objects/prefix_spec.rb
 - spec/lib/wisper_spec.rb
 - spec/spec_helper.rb
 - wisper.gemspec
@@ -87,15 +72,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: pub/sub for Ruby objects
+summary: A micro library providing objects with Publish-Subscribe capabilities
 test_files:
 - spec/lib/global_listeners_spec.rb
 - spec/lib/integration_spec.rb
@@ -103,9 +88,11 @@ test_files:
 - spec/lib/temporary_global_listeners_spec.rb
 - spec/lib/wisper/broadcasters/logger_broadcaster_spec.rb
 - spec/lib/wisper/broadcasters/send_broadcaster_spec.rb
+- spec/lib/wisper/configuration/broadcasters_spec.rb
 - spec/lib/wisper/configuration_spec.rb
 - spec/lib/wisper/publisher_spec.rb
 - spec/lib/wisper/registrations/object_spec.rb
+- spec/lib/wisper/value_objects/events_spec.rb
+- spec/lib/wisper/value_objects/prefix_spec.rb
 - spec/lib/wisper_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

checksums.yaml.gz.sig

@@ -1,2 +0,0 @@
-e�I�fwh��~�PDnZ��/Me��n�j@����Zu$�������'�������)��3�X�k��L���K�4�?B���t7D{��8٭�;�¦�d��m�s@�	�!�^*���̊�ǒ����>��3w`��V�Ms
���ԙ�$����C�% �
->q��̺��~��]�E+�� /g�&����W��u!3�CD���f��Sϥ��c⺼Z~�_�wr�D"
Md׭:C*�3�\]p�L��

data/Guardfile

@@ -1,8 +0,0 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-guard 'rspec' do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
-end