wisper 1.6.1 → 2.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07d3725f067d12c6952f8f3dad49ee68ec0aa0a9
-  data.tar.gz: 643d00e3723146e6783cf1b819f16ee941663b20
+  metadata.gz: e196cad72b441abfb2aa87211e0241729dbfe803
+  data.tar.gz: d1506f6acdac8f354ab801814c73726933201abd
 SHA512:
-  metadata.gz: 33edefa84e8681b40ac3e3375120bf69446b4285a76b6cb4d40793289a7deaef42f839c686c7ca9246ff329a2c7c9ff71527c789581876773ea64d05539cda5e
-  data.tar.gz: c203cdab275836176dc0f47b6bc690967950793144b580feacdd3d2171a8905ea53fd1e0231ab8218a9d15068d4e8a6967d77172e2f56d810971efbfbdf79cd1
+  metadata.gz: 2f1fee408008e32f3861df1438edec17fb05e599e1bb6a196e6c288a5def62d8736d9d7667e22089bee64dae89e54f3d2a8615ecbba24a37efdd6aa23e0fb41d
+  data.tar.gz: b6f4e0b0bdfd905c8ae1562ca79f2c7606804de8ee7e23c4d378019ff780cb3176c1467752b6ec61ee16499658fe9de48bf1b8611da590bdf29bb8d89dcd5b9b

checksums.yaml.gz.sig

@@ -0,0 +1,2 @@
+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/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 *.rbc
+.ruby-version
 .bundle
 .config
 .yardoc

data/.travis.yml

@@ -6,7 +6,6 @@ rvm:
   - '1.9.3'
   - '2.0.0'
   - '2.1.2'
-  - '2.2.2'
   - jruby
   - rbx-2
   ### ALLOWED FAILURES ###

data/CHANGELOG.md

@@ -1,8 +1,11 @@
-## 1.6.1 (17 Aug 2015)
+## 2.0.0.rc1 (17 Dec 2014)
 
 Authors: Kris Leech
 
-* Fixed Ruby warnings
+* remove: deprecated methods
+* 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
 
 ## 1.6.0 (25 Oct 2014)
 

data/CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# How to Contribute
+
+We very much welcome contributions to Wisper.
+
+## Getting started
+
+Please first check the existing [Issues](https://github.com/krisleech/wisper/issues) 
+and [Pull Requests](https://github.com/krisleech/wisper/pulls) to ensure your
+issue has not already been discused.
+
+## Bugs
+
+Please submit a bug report to the issue tracker, with the version of Wisper
+and Ruby you are using and a small code sample (or better yet a failing test).
+
+## Features
+
+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.
+
+## Questions
+
+Try the [Wiki](https://github.com/krisleech/wisper/wiki) first, the examples
+and how to sections have lots of information.
+
+Please ask questions on StackOverflow, [tagged wisper](https://stackoverflow.com/questions/tagged/wisper).
+
+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`.
+* Squash commits which are related.
+* Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
+* Documentation only changes should have `[skip ci]` in the commit message
+* Follow existing code style in terms of syntax, indentation etc.
+* Add an entry to the CHANGELOG
+* Do not bump the VERSION, but do indicate in the CHANGELOG if the change is
+not backwards compatible.
+* Issue a Pull Request
+
+## Versions
+
+The `v1` branch is a long lived branch and you should
+branch from this if you wish to fix an issue in version `~> 1.0`.
+
+The `master` branch will target the next version of Wisper.

data/Gemfile

@@ -9,4 +9,5 @@ gem 'coveralls', require: false
 group :extras do
   gem 'flay'
   gem 'pry'
+  gem 'yard'
 end

data/README.md

@@ -32,10 +32,10 @@ to subscribed listeners. Listeners subscribe, at runtime, to the publisher.
 ```ruby
 class CancelOrder
   include Wisper::Publisher
-  
+
   def call(order_id)
     order = Order.find_by_id(order_id)
-    
+
     # business logic...
 
     if order.cancelled?
@@ -49,7 +49,7 @@ end
 
 When a publisher broadcasts an event it can include number of arguments. 
 
-The `broadcast` method is also aliased as `publish` and `announce`.
+The `broadcast` method is also aliased as `publish`.
 
 You can also include `Wisper.publisher` instead of `Wisper::Publisher`.
 
@@ -202,8 +202,8 @@ 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 event or array
-of events to `on:`.
+can limit which events a listener is notified of by passing an string, symbol,
+array or regular expression to `on`:
 
 ```ruby
 post_creater.subscribe(PusherListener.new, on: :create_post_successful)
@@ -224,7 +224,7 @@ use the default prefix, "on".
 
 ## Mapping an event to a different method
 
-By default the method called on the subscriber is the same as the event
+By default the method called on the listener is the same as the event
 broadcast. However it can be mapped to a different method using `with:`.
 
 ```ruby
@@ -257,82 +257,7 @@ You could also alias the method within your listener, as such
 
 ## RSpec
 
-### Broadcast Matcher
-
-```ruby
-require 'wisper/rspec/matchers'
-
-RSpec::configure do |config|
-  config.include(Wisper::RSpec::BroadcastMatcher)
-end
-
-expect { publisher.execute }.to broadcast(:an_event)
-```
-
-### Using message expections
-
-If you need to assert on the arguments broadcast you can subscribe a double 
-with a [message expection](https://github.com/rspec/rspec-mocks#message-expectations)
-and then use any of the [argument matchers](https://github.com/rspec/rspec-mocks#argument-matchers).
-
-```ruby
-listener = double('Listener')
-
-expect(listener).to receive(:an_event).with(some_args)
-
-publisher.subscribe(listener)
-
-publisher.execute
-```
-
-### Stubbing publishers
-
-You can stub publishers and their events in unit (isolated) tests that only care about reacting to events.
-
-Given this piece of code:
-
-```ruby
-class MyController
-  def create
-    publisher = MyPublisher.new
-    
-    publisher.on(:some_event) do |variable|
-      return "Hello with #{variable}!"
-    end
-    
-    publisher.execute
-  end
-end
-```
-
-You can test it like this:
-
-```ruby
-require 'wisper/rspec/stub_wisper_publisher'
-
-describe MyController do
-  context "on some_event" do
-    before do
-      stub_wisper_publisher("MyPublisher", :execute, :some_event, "foo")
-    end
-
-    it "renders" do
-      response = MyController.new.create
-      expect(response).to eq "Hello with foo!"
-    end
-  end
-end
-```
-
-This is useful when testing Rails controllers in isolation from the business logic.  
-
-You can use any number of args to pass to the event:
-
-```ruby
-stub_wisper_publisher("MyPublisher", :execute, :some_event, "foo1", "foo2", ...)
-```
-
-See `spec/lib/rspec_extensions_spec.rb` for a runnable example.
+Please see [wisper-rspec](https://github.com/krisleech/wisper-rspec).
 
 ## Clearing Global Listeners
 

data/gem-public_cert.pem

@@ -0,0 +1,21 @@
+-----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-----

data/lib/wisper.rb

@@ -11,21 +11,6 @@ require 'wisper/broadcasters/send_broadcaster'
 require 'wisper/broadcasters/logger_broadcaster'
 
 module Wisper
-  def self.included(base)
-    warn "[DEPRECATION] `include Wisper::Publisher` instead of `include Wisper`"
-    base.class_eval { include Wisper::Publisher  }
-  end
-
-  def self.with_listeners(*args, &block)
-    warn "[DEPRECATION] `use Wisper.subscribe` instead of `Wisper.with_listeners`"
-    self.subscribe(*args, &block)
-  end
-
-  def self.add_listener(listener, options = {})
-    warn "[DEPRECATION] `use Wisper.subscribe` instead of `Wisper.add_listener`"
-    self.subscribe(listener, options)
-  end
-
   # Examples:
   #
   #   Wisper.subscribe(AuditRecorder.new)

data/lib/wisper/broadcasters/logger_broadcaster.rb

@@ -8,15 +8,15 @@ module Wisper
         @broadcaster = broadcaster
       end
 
-      def broadcast(subscriber, publisher, event, args)
-        @logger.info("[WISPER] #{name(publisher)} published #{event} to #{name(subscriber)} with #{arg_names(args)}")
-        @broadcaster.broadcast(subscriber, publisher, event, args)
+      def broadcast(listener, publisher, event, args)
+        @logger.info("[WISPER] #{name(publisher)} published #{event} to #{name(listener)} with #{arg_names(args)}")
+        @broadcaster.broadcast(listener, publisher, event, args)
       end
 
       private
 
       def name(object)
-        id_method  = %w(id uuid key object_id).find { |possibility| object.respond_to?(possibility) }
+        id_method  = %w(id uuid key object_id).find { |id_method| object.respond_to?(id_method) }
         id         = object.send(id_method)
         class_name = object.class == Class ? object.name : object.class.name
         "#{class_name}##{id}"

data/lib/wisper/broadcasters/send_broadcaster.rb

@@ -1,8 +1,8 @@
 module Wisper
   module Broadcasters
     class SendBroadcaster
-      def broadcast(subscriber, publisher, event, args)
-        subscriber.public_send(event, *args)
+      def broadcast(listener, publisher, event, args)
+        listener.public_send(event, *args)
       end
     end
   end

data/lib/wisper/configuration.rb

@@ -8,14 +8,19 @@ module Wisper
       @broadcasters = Broadcasters.new
     end
 
-    def broadcaster(name, broadcaster)
-      @broadcasters[name] = broadcaster
+    # registers a broadcaster, referenced by key
+    #
+    # @param key [String, #to_s] an arbitrary key
+    # @param broadcaster [#broadcast] a broadcaster
+    def broadcaster(key, broadcaster)
+      @broadcasters[key] = broadcaster
+      self
     end
 
     class Broadcasters
       extend Forwardable
 
-      def_delegators :@data, :[], :[]=, :empty?, :include?, :clear
+      def_delegators :@data, :fetch, :[], :[]=, :empty?, :include?, :clear
 
       def initialize
         @data = {}

data/lib/wisper/global_listeners.rb

@@ -1,7 +1,9 @@
-require 'singleton'
-
 # Handles global subscriptions
 
+# @api private
+
+require 'singleton'
+
 module Wisper
   class GlobalListeners
     include Singleton
@@ -50,11 +52,6 @@ module Wisper
       instance.clear
     end
 
-    def self.add_listener(listener, options = {}) # deprecated
-      warn "[DEPRECATION] use `subscribe` instead of `add_listener`"
-      subscribe(listener, options)
-    end
-
     private
 
     def with_mutex

data/lib/wisper/publisher.rb

@@ -4,42 +4,58 @@ module Wisper
       registrations.map(&:listener).freeze
     end
 
+    # subscribe a listener
+    #
+    # @example
+    #   my_publisher.subscribe(MyListener.new)
+    #
+    # @return [self]
     def subscribe(listener, options = {})
       local_registrations << ObjectRegistration.new(listener, options)
       self
     end
 
+    # subscribe a block
+    #
+    # @example
+    #   my_publisher.on(:order_created) { |args| ... }
+    #
+    # @return [self]
     def on(*events, &block)
       raise ArgumentError, 'must give at least one event' if events.empty?
       local_registrations << BlockRegistration.new(block, on: events)
       self
     end
 
-    def add_block_listener(options = {}, &block)
-      warn "[DEPRECATED] use `on` instead of `add_block_listener`"
-      local_registrations << BlockRegistration.new(block, options)
+    # broadcasts an event
+    #
+    # @example
+    #   def call
+    #     # ...
+    #     broadcast(:finished, self)
+    #   end
+    #
+    # @return [self]
+    def broadcast(event, *args)
+      registrations.each do | registration |
+        registration.broadcast(clean_event(event), self, *args)
+      end
       self
     end
 
-    def add_listener(listener, options = {})
-      warn "[DEPRECATED] use `subscribe` instead of `add_listener`"
-      subscribe(listener, options)
-    end
+    alias :publish :broadcast
 
-    def respond_to(*events, &block)
-      warn '[DEPRECATED] use `on` instead of `respond_to`'
-      on(*events, &block)
-    end
+    private :broadcast, :publish
 
     module ClassMethods
+      # subscribe a listener
+      #
+      # @example
+      #   MyPublisher.subscribe(MyListener.new)
+      #
       def subscribe(listener, options = {})
         GlobalListeners.subscribe(listener, options.merge(:scope => self))
       end
-
-      def add_listener(listener, options = {})
-        warn "[DEPRECATED] use `subscribe` instead of `add_listener`"
-        subscribe(listener, options)
-      end
     end
 
     private
@@ -60,15 +76,6 @@ module Wisper
       local_registrations + global_registrations + temporary_registrations
     end
 
-    def broadcast(event, *args)
-      registrations.each do | registration |
-        registration.broadcast(clean_event(event), self, *args)
-      end
-    end
-
-    alias :publish  :broadcast
-    alias :announce :broadcast
-
     def clean_event(event)
       event.to_s.gsub('-', '_')
     end
@@ -78,4 +85,3 @@ module Wisper
     end
   end
 end
-

data/lib/wisper/registration/block.rb

@@ -1,3 +1,5 @@
+# @api private
+
 module Wisper
   class BlockRegistration < Registration
     def broadcast(event, publisher, *args)

data/lib/wisper/registration/object.rb

@@ -1,3 +1,5 @@
+# @api private
+
 module Wisper
   class ObjectRegistration < Registration
     attr_reader :with, :prefix, :allowed_classes, :broadcaster

data/lib/wisper/registration/registration.rb

@@ -1,16 +1,42 @@
+# @api private
+
 module Wisper
   class Registration
     attr_reader :on, :listener
 
+    ALL = Object.new.freeze
+
     def initialize(listener, options)
-      @listener   = listener
-      @on         = Array(options.fetch(:on) { 'all' }).map(&:to_s)
+      @listener = listener
+      @on       = stringify(options.fetch(:on, ALL))
     end
 
     private
 
     def should_broadcast?(event)
-      on.include?(event) || on.include?('all')
+      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
     end
   end
 end

data/lib/wisper/temporary_listeners.rb

@@ -1,5 +1,7 @@
 # Handles temporary global subscriptions
 
+# @api private
+
 module Wisper
   class TemporaryListeners
 

data/lib/wisper/version.rb

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

data/spec/lib/{global_subscribers_spec.rb → global_listeners_spec.rb}

@@ -79,13 +79,4 @@ describe Wisper::GlobalListeners do
     Wisper::GlobalListeners.clear
     expect(Wisper::GlobalListeners.listeners).to be_empty
   end
-
-  describe 'backwards compatibility' do
-    it '.add_listener is aliased to .add' do
-      silence_warnings do
-        expect(Wisper::GlobalListeners).to receive(:subscribe)
-        Wisper::GlobalListeners.add_listener(global_listener)
-      end
-    end
-  end
 end

data/spec/lib/temporary_global_listeners_spec.rb

@@ -53,10 +53,10 @@ describe Wisper::TemporaryListeners do
 
       expect(Wisper::TemporaryListeners.registrations.size).to eql 0
     end
-  end
 
-  it 'returns self so methods can be chained' do
-    expect(Wisper::TemporaryListeners.subscribe {}).to be_an_instance_of(Wisper::TemporaryListeners)
+    it 'returns self so methods can be chained' do
+      expect(Wisper::TemporaryListeners.subscribe {}).to be_an_instance_of(Wisper::TemporaryListeners)
+    end
   end
 end
 

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

@@ -17,7 +17,7 @@ module Wisper
 
       describe 'unit tests:' do
         let(:publisher)   { classy_double('Publisher',  id: 1) }
-        let(:subscriber)  { classy_double('Subscriber', id: 2) }
+        let(:listener)  { classy_double('Listener', id: 2) }
         let(:logger)      { double('Logger').as_null_object }
         let(:broadcaster) { double('Broadcaster').as_null_object }
         let(:event)       { 'thing_created' }
@@ -29,13 +29,13 @@ module Wisper
             let(:args) { [] }
 
             it 'logs publised event' do
-              expect(logger).to receive(:info).with('[WISPER] Publisher#1 published thing_created to Subscriber#2 with no arguments')
-              subject.broadcast(subscriber, publisher, event, args)
+              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
-              expect(broadcaster).to receive(:broadcast).with(subscriber, publisher, event, args)
-              subject.broadcast(subscriber, publisher, event, args)
+              expect(broadcaster).to receive(:broadcast).with(listener, publisher, event, args)
+              subject.broadcast(listener, publisher, event, args)
             end
           end
 
@@ -43,13 +43,13 @@ module Wisper
             let(:args) { [arg_double(id: 3), arg_double(id: 4)] }
 
             it 'logs published event and arguments' do
-              expect(logger).to receive(:info).with('[WISPER] Publisher#1 published thing_created to Subscriber#2 with Argument#3, Argument#4')
-              subject.broadcast(subscriber, publisher, event, args)
+              expect(logger).to receive(:info).with('[WISPER] Publisher#1 published thing_created to Listener#2 with Argument#3, Argument#4')
+              subject.broadcast(listener, publisher, event, args)
             end
 
             it 'delgates broadcast to given broadcaster' do
-              expect(broadcaster).to receive(:broadcast).with(subscriber, publisher, event, args)
-              subject.broadcast(subscriber, publisher, event, args)
+              expect(broadcaster).to receive(:broadcast).with(listener, publisher, event, args)
+              subject.broadcast(listener, publisher, event, args)
             end
           end
 

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

@@ -1,25 +1,25 @@
 module Wisper
   module Broadcasters
     describe SendBroadcaster do
-      let(:subscriber) { double('subscriber') }
+      let(:listener) { double('listener') }
       let(:event)      { 'thing_created' }
 
       describe '#broadcast' do
         context 'without arguments' do
           let(:args) { [] }
 
-          it 'sends event to subscriber without any arguments' do
-            expect(subscriber).to receive(event).with(no_args())
-            subject.broadcast(subscriber, anything, event, args)
+          it 'sends event to listener without any arguments' do
+            expect(listener).to receive(event).with(no_args())
+            subject.broadcast(listener, anything, event, args)
           end
         end
 
         context 'with arguments' do
           let(:args) { [1,2,3] }
 
-          it 'sends event to subscriber with arguments' do
-            expect(subscriber).to receive(event).with(*args)
-            subject.broadcast(subscriber, anything, event, args)
+          it 'sends event to listener with arguments' do
+            expect(listener).to receive(event).with(*args)
+            subject.broadcast(listener, anything, event, args)
           end
         end
       end

data/spec/lib/wisper/configuration_spec.rb

@@ -8,10 +8,16 @@ module Wisper
         expect(subject.broadcasters).to be_empty
       end
 
-      it '#broadcaster adds given broadcaster' do
-        subject.broadcaster(key, broadcaster)
-        expect(subject.broadcasters).to include key
-        expect(subject.broadcasters[key]).to eql broadcaster
+      describe '#broadcaster' do
+        it 'adds given broadcaster' do
+          subject.broadcaster(key, broadcaster)
+          expect(subject.broadcasters).to include key
+          expect(subject.broadcasters[key]).to eql broadcaster
+        end
+
+        it 'returns the configuration' do
+          expect(subject.broadcaster(key, broadcaster)).to eq subject
+        end
       end
     end
   end

data/spec/lib/wisper/publisher_spec.rb

@@ -14,32 +14,67 @@ describe Wisper::Publisher do
     end
 
     describe ':on argument' do
-      it 'subscribes given listener to a single event' do
-        expect(listener).to receive(:this_happened)
+      before do
+        allow(listener).to receive(:something_a_happened)
+        allow(listener).to receive(:and_this)
         allow(listener).to receive(:so_did_this)
-        expect(listener).not_to receive(:so_did_this)
+      end
 
-        expect(listener).to respond_to(:so_did_this)
+      describe 'given a string' do
+        it 'subscribes listener to an event' do
+          expect(listener).to receive(:this_happened)
+          expect(listener).not_to receive(:so_did_this)
 
-        publisher.subscribe(listener, :on => 'this_happened')
+          publisher.subscribe(listener, on: 'this_happened')
 
-        publisher.send(:broadcast, 'this_happened')
-        publisher.send(:broadcast, 'so_did_this')
+          publisher.send(:broadcast, 'this_happened')
+          publisher.send(:broadcast, 'so_did_this')
+        end
       end
 
-      it 'subscribes given listener to many events' do
-        expect(listener).to receive(:this_happened)
-        expect(listener).to receive(:and_this)
-        allow(listener).to receive(:so_did_this)
-        expect(listener).not_to receive(:so_did_this)
+      describe 'given a symbol' do
+        it 'subscribes listener to an event' do
+          expect(listener).to receive(:this_happened)
+          expect(listener).not_to receive(:so_did_this)
 
-        expect(listener).to respond_to(:so_did_this)
+          publisher.subscribe(listener, on: :this_happened)
 
-        publisher.subscribe(listener, :on => ['this_happened', 'and_this'])
+          publisher.send(:broadcast, 'this_happened')
+          publisher.send(:broadcast, 'so_did_this')
+        end
+      end
 
-        publisher.send(:broadcast, 'this_happened')
-        publisher.send(:broadcast, 'so_did_this')
-        publisher.send(:broadcast, 'and_this')
+      describe 'given an array' do
+        it 'subscribes listener to events' do
+          expect(listener).to receive(:this_happened)
+          expect(listener).to receive(:and_this)
+          expect(listener).not_to receive(:so_did_this)
+
+          publisher.subscribe(listener, on: ['this_happened', 'and_this'])
+
+          publisher.send(:broadcast, 'this_happened')
+          publisher.send(:broadcast, 'so_did_this')
+          publisher.send(:broadcast, 'and_this')
+        end
+      end
+
+      describe 'given a regex' do
+        it 'subscribes listener to matching events' do
+          expect(listener).to receive(:something_a_happened)
+          expect(listener).not_to receive(:so_did_this)
+
+          publisher.subscribe(listener, on: /something_._happened/)
+
+          publisher.send(:broadcast, 'something_a_happened')
+          publisher.send(:broadcast, 'so_did_this')
+        end
+      end
+
+      describe 'given an unsupported argument' do
+        it 'raises an error' do
+          publisher.subscribe(listener, on: Object.new)
+          expect { publisher.send(:broadcast, 'something_a_happened') }.to raise_error(ArgumentError)
+        end
       end
     end
 
@@ -74,8 +109,6 @@ describe Wisper::Publisher do
       end
     end
 
-    # NOTE: these are not realistic use cases, since you would only ever use
-    # `scope` when globally subscribing.
     describe ':scope argument' do
       let(:listener_1) { double('Listener') }
       let(:listener_2) { double('Listener') }
@@ -181,28 +214,8 @@ describe Wisper::Publisher do
   end
 
   describe '.on' do
-    let(:insider) { double('insider') }
-
-    it 'subscribes block to given event' do
-      expect(insider).to receive(:yes).once
-
-      publisher.on(:something_happened) do
-        insider.yes
-      end
-
-      publisher.send(:broadcast, :something_happened)
-      publisher.send(:broadcast, :and_so_did_this)
-    end
-
-    it 'subscribes block to given events' do
-      expect(insider).to receive(:yes).twice
-
-      publisher.on(:something_happened, :and_so_did_this) do
-        insider.yes
-      end
-
-      publisher.send(:broadcast, :something_happened)
-      publisher.send(:broadcast, :and_so_did_this)
+    it 'returns publisher so methods can be chained' do
+      expect(publisher.on('this_thing_happened') {}).to eq publisher
     end
 
     it 'raise an error if no events given' do
@@ -214,82 +227,8 @@ describe Wisper::Publisher do
     end
   end
 
-  # @deprecated
-  describe '.add_listener' do
-    it 'is aliased to .subscribe' do
-      expect(publisher).to receive(:subscribe)
-      silence_warnings do
-        publisher.add_listener(listener)
-      end
-    end
-  end
-
-  # @deprecated
-  describe '.add_block_listener' do
-    let(:insider) { double('insider') }
-
-    it 'subscribes given block to all events' do
-      expect(insider).to receive(:it_happened).twice
-
-      silence_warnings do
-        publisher.add_block_listener do
-          insider.it_happened
-        end
-      end
-
-      publisher.send(:broadcast, 'something_happened')
-      publisher.send(:broadcast, 'and_so_did_this')
-    end
-
-    describe ':on argument' do
-      it '.add_block_listener subscribes block to an event' do
-        expect(insider).not_to receive(:it_happened).once
-
-        silence_warnings do
-          publisher.add_block_listener(:on => 'something_happened') do
-            insider.it_happened
-          end
-        end
-
-        publisher.send(:broadcast, 'something_happened')
-        publisher.send(:broadcast, 'and_so_did_this')
-      end
-
-      it '.add_block_listener subscribes block to all listed events' do
-        expect(insider).to receive(:it_happened).twice
-
-        silence_warnings do
-          publisher.add_block_listener(
-            :on => ['something_happened', 'and_so_did_this']) do
-            insider.it_happened
-          end
-        end
-
-        publisher.send(:broadcast, 'something_happened')
-        publisher.send(:broadcast, 'and_so_did_this')
-        publisher.send(:broadcast, 'but_not_this')
-      end
-    end
-
-    it 'returns publisher so methods can be chained' do
-      silence_warnings do
-        expect(publisher.add_block_listener(:on => 'this_thing_happened') do
-        end).to eq publisher
-      end
-    end
-  end
-
-  # @deprecated
-  describe '.respond_to (alternative block syntax)' do
-    it 'delegates to .on' do
-      expect(publisher).to receive(:on).with(:foobar)
-      silence_warnings do
-        publisher.respond_to(:foobar) {  }
-      end
-    end
-  end
-
   describe '.broadcast' do
+
     it 'does not publish events which cannot be responded to' do
       expect(listener).not_to receive(:so_did_this)
       allow(listener).to receive(:respond_to?).and_return(false)
@@ -318,6 +257,18 @@ describe Wisper::Publisher do
         publisher.send(:broadcast, 'this-happened')
       end
     end
+
+    it 'returns publisher' do
+      expect(publisher.send(:broadcast, :foo)).to eq publisher
+    end
+
+    it 'is not public' do
+      expect(publisher).not_to respond_to(:broadcast)
+    end
+
+    it 'is alised as .publish' do
+      expect(publisher.method(:broadcast)).to eq publisher.method(:publish)
+    end
   end
 
   describe '.listeners' do
@@ -344,13 +295,4 @@ describe Wisper::Publisher do
       publisher_klass_2.new.send(:broadcast, 'it_happened')
     end
   end
-
-  describe '#add_listener' do # deprecated
-    it 'is aliased to #subscribe' do
-      expect(publisher).to receive(:subscribe)
-      silence_warnings do
-        publisher.add_listener(listener)
-      end
-    end
-  end
 end

data/spec/lib/wisper_spec.rb

@@ -1,46 +1,4 @@
 describe Wisper do
-  before do
-    # assign the stderr to a new StringIO to test errors
-    @orig_stderr, $stderr = $stderr, StringIO.new
-  end
-
-  after do
-    # reassign the stderr to the original <IO:<STDERR>> instead of StringIO
-    # used for testing
-    $stderr = @orig_stderr
-  end
-
-  it 'includes Wisper::Publisher for backwards compatibility' do
-    publisher_class = Class.new { include Wisper }
-    expect(publisher_class.ancestors).to include Wisper::Publisher
-
-    $stderr.rewind
-    expect($stderr.gets.chomp).to include 'DEPRECATION'
-  end
-
-  # NOTE .with_listeners is deprecated
-  it '.with_listeners subscribes listeners to all broadcast events for the duration of block' do
-    publisher = publisher_class.new
-    listener = double('listener')
-
-    Wisper.with_listeners(listener) do
-      publisher.send(:broadcast, 'im_here')
-    end
-
-    $stderr.rewind
-    expect($stderr.string.chomp).to include 'DEPRECATION'
-  end
-
-  # NOTE .add_listener is deprecated
-  it '.add_listener adds a global listener' do
-    listener = double('listener')
-
-    Wisper.add_listener(listener)
-
-    $stderr.rewind
-    expect($stderr.string.chomp).to include 'DEPRECATION'
-  end
-
   describe '.subscribe' do
     context 'given block' do
       it 'subscribes listeners to all events for duration of the block' do

data/wisper.gemspec

@@ -13,6 +13,13 @@ Gem::Specification.new do |gem|
   gem.homepage      = "https://github.com/krisleech/wisper"
   gem.license       = "MIT"
 
+  signing_key = File.expand_path('~/.ssh/gem-private_key.pem')
+
+  if File.exist?(signing_key)
+    gem.signing_key = signing_key
+    gem.cert_chain  = ['gem-public_cert.pem']
+  end
+
   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)/})

metadata

@@ -1,14 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: wisper
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 2.0.0.rc1
 platform: ruby
 authors:
 - Kris Leech
 autorequire: 
 bindir: bin
-cert_chain: []
-date: 2015-08-17 00:00:00.000000000 Z
+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
 dependencies: []
 description: pub/sub for Ruby objects
 email:
@@ -19,13 +41,14 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - Guardfile
 - README.md
 - Rakefile
+- gem-public_cert.pem
 - lib/wisper.rb
 - lib/wisper/broadcasters/logger_broadcaster.rb
 - lib/wisper/broadcasters/send_broadcaster.rb
@@ -35,11 +58,9 @@ files:
 - lib/wisper/registration/block.rb
 - lib/wisper/registration/object.rb
 - lib/wisper/registration/registration.rb
-- lib/wisper/rspec/matchers.rb
-- lib/wisper/rspec/stub_wisper_publisher.rb
 - lib/wisper/temporary_listeners.rb
 - lib/wisper/version.rb
-- spec/lib/global_subscribers_spec.rb
+- spec/lib/global_listeners_spec.rb
 - spec/lib/integration_spec.rb
 - spec/lib/simple_example_spec.rb
 - spec/lib/temporary_global_listeners_spec.rb
@@ -48,8 +69,6 @@ files:
 - spec/lib/wisper/configuration_spec.rb
 - spec/lib/wisper/publisher_spec.rb
 - spec/lib/wisper/registrations/object_spec.rb
-- spec/lib/wisper/rspec/matchers_spec.rb
-- spec/lib/wisper/rspec/stub_wisper_publisher_spec.rb
 - spec/lib/wisper_spec.rb
 - spec/spec_helper.rb
 - wisper.gemspec
@@ -68,17 +87,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: pub/sub for Ruby objects
 test_files:
-- spec/lib/global_subscribers_spec.rb
+- spec/lib/global_listeners_spec.rb
 - spec/lib/integration_spec.rb
 - spec/lib/simple_example_spec.rb
 - spec/lib/temporary_global_listeners_spec.rb
@@ -87,7 +106,6 @@ test_files:
 - spec/lib/wisper/configuration_spec.rb
 - spec/lib/wisper/publisher_spec.rb
 - spec/lib/wisper/registrations/object_spec.rb
-- spec/lib/wisper/rspec/matchers_spec.rb
-- spec/lib/wisper/rspec/stub_wisper_publisher_spec.rb
 - spec/lib/wisper_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/.ruby-version

@@ -1 +0,0 @@
-2.2.2

data/lib/wisper/rspec/matchers.rb

@@ -1,57 +0,0 @@
-require 'rspec/expectations'
-
-module Wisper
-  module RSpec
-    class EventRecorder
-      def initialize
-        @broadcast_events = []
-      end
-
-      def respond_to?(method_name)
-        true
-      end
-
-      def method_missing(method_name, *args, &block)
-        @broadcast_events << method_name.to_s
-      end
-
-      def broadcast?(event_name)
-        @broadcast_events.include?(event_name.to_s)
-      end
-    end
-
-    module BroadcastMatcher
-      class Matcher
-        def initialize(event)
-          @event = event
-        end
-
-        def supports_block_expectations?
-          true
-        end
-
-        def matches?(block)
-          event_recorder = EventRecorder.new
-
-          Wisper.subscribe(event_recorder) do
-            block.call
-          end
-
-          event_recorder.broadcast?(@event)
-        end
-
-        def failure_message
-          "expected publisher to broadcast #{@event} event"
-        end
-
-        def failure_message_when_negated
-          "expected publisher not to broadcast #{@event} event"
-        end
-      end
-
-      def broadcast(event)
-        Matcher.new(event)
-      end
-    end
-  end
-end

data/lib/wisper/rspec/stub_wisper_publisher.rb

@@ -1,12 +0,0 @@
-class TestWisperPublisher
-  include Wisper::Publisher
-  def initialize(*args); end
-end
-
-def stub_wisper_publisher(clazz, called_method, event_to_publish, *published_event_args)
-  stub_const(clazz, Class.new(TestWisperPublisher) do
-    define_method(called_method) do |*args|
-      publish(event_to_publish, *published_event_args)
-    end
-  end)
-end

data/spec/lib/wisper/rspec/matchers_spec.rb

@@ -1,17 +0,0 @@
-require 'wisper/rspec/matchers'
-
-RSpec::configure do |config|
-  config.include(Wisper::RSpec::BroadcastMatcher)
-end
-
-describe 'broadcast matcher' do
-  it 'passes when publisher broadcasts inside block' do
-    publisher = publisher_class.new
-    expect { publisher.send(:broadcast, :foobar) }.to broadcast(:foobar)
-  end
-
-  it 'passes with not_to when publisher does not broadcast inside block' do
-    publisher = publisher_class.new
-    expect { publisher }.not_to broadcast(:foobar)
-  end
-end

data/spec/lib/wisper/rspec/stub_wisper_publisher_spec.rb

@@ -1,26 +0,0 @@
-require 'wisper/rspec/stub_wisper_publisher'
-
-describe '#stub_wisper_publisher' do
-  describe "given a piece of code invoking a publisher" do
-    class CodeThatReactsToEvents
-      def do_something
-        publisher = MyPublisher.new
-        publisher.on(:some_event) do |variable1, variable2|
-          return "Hello with #{variable1} #{variable2}!"
-        end
-        publisher.execute
-      end
-    end
-
-    context "when stubbing the publisher to emit an event" do
-      before do
-        stub_wisper_publisher("MyPublisher", :execute, :some_event, "foo1", "foo2")
-      end
-
-      it "emits the event" do
-        response = CodeThatReactsToEvents.new.do_something
-        expect(response).to eq "Hello with foo1 foo2!"
-      end
-    end
-  end
-end