wisper 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  metadata.gz: c905b4f311d82eadf52d61a11a0515109335d592
-  data.tar.gz: 9be198a62d94f3c8fbc46253cd109a438d857206
-SHA512: 
-  metadata.gz: 44ddd88e30752991d23dafa678086611a05f0206f152066b18b0283b0eb9462728b06be38f46fdf08caba0ead38919e88530ad1566cc2d8d92d751813805e851
-  data.tar.gz: d7ee6c49e1c6320596e00f1a79624e8ea3bb7f413b4fa76348415e3ff40225772522d1f861946dd83aaf1fbff0e86a89eccb72dd0dca1ca91843a72d78a3193a
+---
+SHA1:
+  metadata.gz: b7eced3bc4dc2f86f783081e2a3e9f592078deb4
+  data.tar.gz: 3ce6be1cf3f79319bf8582c86eced10458c2e65f
+SHA512:
+  metadata.gz: c680af80578aa1d5170d4334ccda9545be5c0cbcea4ad105e82d5a4e0d5d4ab24a8f835ba1d5e4b9a7c8eb723ca7ff36c2ec0dfdc2da8fcf2e51347a95316280
+  data.tar.gz: 5b6501efcf475b2a157e8975e6bf7c1ab83118b73313fd3ea7b8e2c5160bb93a301572f6aa30568b6d264c2fc4d779808dfd2b1ffc8395808274c7785712ecc6

data/.rspec

@@ -1,2 +1,4 @@
 --color
 --format progress
+--require spec_helper
+--warnings

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
-bundler_args: --without=metrics
+bundler_args: --without=extras
 script: rspec spec
 rvm:
   - '1.9.2'

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 ## Unreleased (no breaking changes)
 
-None
+## 1.5.0 (6th Oct 2014)
+
+Authors: Kris Leech
+
+* feature: allow events to be published asynchronously
+* feature: broadcasting of events is plugable and configurable
+* feature: broadcasters can be aliased via a symbol
+* feature: logging broadcaster
 
 ## 1.4.0 (8th Sept 2014)
 

data/Gemfile

@@ -4,13 +4,11 @@ gemspec
 
 gem 'rubysl', '~> 2.0', :platforms => :rbx
 
+gem 'rake',  '~> 10.3.0'
+gem 'rspec', '~> 3.0.0'
 gem 'coveralls', require: false
 
-group :metrics do
+group :extras do
   gem 'flay'
-end
-
-group :development do
-  gem 'rake',  '~> 10.3.0'
-  gem 'rspec', '~> 3.0.0'
+  gem 'pry'
 end

data/README.md

@@ -70,7 +70,13 @@ end
 
 ### Asynchronous Publishing
 
-Please refer to the [wisper-async](https://github.com/krisleech/wisper-async) gem.
+```ruby
+my_publisher.subscribe(MyListener.new, async: true)
+```
+
+Please refer to
+[wisper-celluloid](https://github.com/krisleech/wisper-celluloid) or
+[wisper-sidekiq](https://github.com/krisleech/wisper-sidekiq).
 
 ### ActiveRecord
 

data/lib/wisper.rb

@@ -1,11 +1,14 @@
 require 'set'
 require 'wisper/version'
+require 'wisper/configuration'
 require 'wisper/publisher'
 require 'wisper/registration/registration'
 require 'wisper/registration/object'
 require 'wisper/registration/block'
 require 'wisper/global_listeners'
 require 'wisper/temporary_listeners'
+require 'wisper/broadcasters/send_broadcaster'
+require 'wisper/broadcasters/logger_broadcaster'
 
 module Wisper
   def self.included(base)
@@ -33,4 +36,20 @@ module Wisper
       end
     end
   end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.setup
+    configure do |config|
+      config.broadcaster(:default, Broadcasters::SendBroadcaster.new)
+    end
+  end
 end
+
+Wisper.setup

data/lib/wisper/broadcasters/logger_broadcaster.rb

@@ -0,0 +1,31 @@
+# Provides a way of wrapping another broadcaster with logging
+
+module Wisper
+  module Broadcasters
+    class LoggerBroadcaster
+      def initialize(logger, broadcaster)
+        @logger      = logger
+        @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)
+      end
+
+      private
+
+      def name(object)
+        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}"
+      end
+
+      def arg_names(args)
+        return 'no arguments' if args.empty?
+        args.map { |arg| name(arg) }.join(', ')
+      end
+    end
+  end
+end

data/lib/wisper/broadcasters/send_broadcaster.rb

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

data/lib/wisper/configuration.rb

@@ -0,0 +1,28 @@
+module Wisper
+  class Configuration
+    attr_reader :broadcasters
+
+    def initialize
+      @broadcasters = Broadcasters.new
+    end
+
+    def broadcaster(name, broadcaster)
+      @broadcasters[name] = broadcaster
+    end
+
+    class Broadcasters
+      extend Forwardable
+
+      def_delegators :@data, :fetch, :[], :[]=, :empty?, :include?, :clear
+
+      def initialize
+        @data = {}
+      end
+
+      def fetch(key)
+        raise KeyError, "broadcaster not found for #{key}" unless include?(key)
+        @data[key]
+      end
+    end
+  end
+end

data/lib/wisper/registration/object.rb

@@ -1,19 +1,19 @@
 module Wisper
   class ObjectRegistration < Registration
-    attr_reader :with, :prefix, :allowed_classes
+    attr_reader :with, :prefix, :allowed_classes, :broadcaster
 
     def initialize(listener, options)
       super(listener, options)
       @with   = options[:with]
       @prefix = stringify_prefix(options[:prefix])
       @allowed_classes = Array(options[:scope]).map(&:to_s).to_set
-      fail_on_async if options.has_key?(:async)
+      @broadcaster = map_broadcaster(options[:async] || options[:broadcaster])
     end
 
     def broadcast(event, publisher, *args)
       method_to_call = map_event_to_method(event)
       if should_broadcast?(event) && listener.respond_to?(method_to_call) && publisher_in_scope?(publisher)
-        listener.public_send(method_to_call, *args)
+        broadcaster.broadcast(listener, publisher, method_to_call, args)
       end
     end
 
@@ -42,8 +42,15 @@ module Wisper
       'on'
     end
 
-    def fail_on_async
-      raise 'The async feature has been moved to the wisper-async gem'
+    def map_broadcaster(value)
+      return value if value.respond_to?(:broadcast)
+      value = :async   if value == true
+      value = :default if value == nil
+      configuration.broadcasters.fetch(value)
+    end
+
+    def configuration
+      Wisper.configuration
     end
   end
 end

data/lib/wisper/version.rb

@@ -1,3 +1,3 @@
 module Wisper
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

data/spec/lib/global_subscribers_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe Wisper::GlobalListeners do
   let(:global_listener)  { double('listener') }
   let(:local_listener)   { double('listener') }

data/spec/lib/integration_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 # Example
 class MyCommand
   include Wisper::Publisher

data/spec/lib/simple_example_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 class MyPublisher
   include Wisper::Publisher
 

data/spec/lib/temporary_global_listeners_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe Wisper::TemporaryListeners do
   let(:listener_1) { double('listener', :to_a => nil) } # [1]
   let(:listener_2) { double('listener', :to_a => nil) }

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

@@ -0,0 +1,73 @@
+module Wisper
+  module Broadcasters
+
+    describe LoggerBroadcaster do
+
+      describe 'integration tests:' do
+        let(:publisher) { publisher_class.new }
+        let(:listener)  { double }
+        let(:logger)    { double.as_null_object }
+
+        it 'broadcasts the event to the listener' do
+          publisher.subscribe(listener, :broadcaster => LoggerBroadcaster.new(logger, Wisper::Broadcasters::SendBroadcaster.new))
+          expect(listener).to receive(:it_happened).with(1, 2)
+          publisher.send(:broadcast, :it_happened, 1, 2)
+        end
+      end
+
+      describe 'unit tests:' do
+        let(:publisher)   { classy_double('Publisher',  id: 1) }
+        let(:subscriber)  { classy_double('Subscriber', id: 2) }
+        let(:logger)      { double('Logger').as_null_object }
+        let(:broadcaster) { double('Broadcaster').as_null_object }
+        let(:event)       { 'thing_created' }
+
+        subject           { LoggerBroadcaster.new(logger, broadcaster) }
+
+        describe '#broadcast' do
+          context 'without arguments' do
+            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)
+            end
+
+            it 'delgates broadcast to given broadcaster' do
+              expect(broadcaster).to receive(:broadcast).with(subscriber, publisher, event, args)
+              subject.broadcast(subscriber, publisher, event, args)
+            end
+          end
+
+          context 'with arguments' do
+            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)
+            end
+
+            it 'delgates broadcast to given broadcaster' do
+              expect(broadcaster).to receive(:broadcast).with(subscriber, publisher, event, args)
+              subject.broadcast(subscriber, publisher, event, args)
+            end
+          end
+
+        end
+
+        # provides a way to specify `double.class.name` easily
+        def classy_double(klass, options)
+          double(klass, options.merge(class: double_class(klass)))
+        end
+
+        def arg_double(options)
+          classy_double('Argument', options)
+        end
+
+        def double_class(name)
+          double(name: name)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Wisper
+  module Broadcasters
+    describe SendBroadcaster do
+      let(:subscriber) { double('subscriber') }
+      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)
+          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)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/wisper/configuration_spec.rb

@@ -0,0 +1,18 @@
+module Wisper
+  describe Configuration do
+    describe 'broadcasters' do
+      let(:broadcaster) { double }
+      let(:key)         { :default }
+
+      it '#broadcasters returns empty collection' do
+        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
+      end
+    end
+  end
+end

data/spec/lib/wisper/publisher_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe Wisper::Publisher do
   let(:listener)  { double('listener') }
   let(:publisher) { publisher_class.new }
@@ -82,9 +80,6 @@ describe Wisper::Publisher do
       let(:listener_1) { double('Listener') }
       let(:listener_2) { double('Listener') }
 
-      before do
-      end
-
       it 'scopes listener to given class' do
         expect(listener_1).to receive(:it_happended)
         expect(listener_2).not_to receive(:it_happended)
@@ -115,6 +110,66 @@ describe Wisper::Publisher do
       end
     end
 
+    describe ':broadcaster argument'do
+      let(:broadcaster) { double('broadcaster') }
+      let(:listener)    { double('listener') }
+      let(:event_name)  { 'it_happened' }
+
+      before do
+        Wisper.configuration.broadcasters.clear
+        allow(listener).to    receive(event_name)
+        allow(broadcaster).to receive(:broadcast)
+      end
+
+      after { Wisper.setup } # restore default configuration
+
+      it 'given an object which responds_to broadcast it uses object' do
+        publisher.subscribe(listener, broadcaster: broadcaster)
+        expect(broadcaster).to receive('broadcast')
+        publisher.send(:broadcast, event_name)
+      end
+
+      it 'given a key it uses a configured broadcaster' do
+        Wisper.configure { |c| c.broadcaster(:foobar, broadcaster) }
+        publisher.subscribe(listener, broadcaster: :foobar)
+        expect(broadcaster).to receive('broadcast')
+        publisher.send(:broadcast, event_name)
+      end
+
+      it 'given an unknown key it raises error' do
+        expect { publisher.subscribe(listener, broadcaster: :foobar) }.to raise_error(KeyError, /broadcaster not found/)
+      end
+
+      it 'given nothing it uses the default broadcaster' do
+        Wisper.configure { |c| c.broadcaster(:default, broadcaster) }
+        publisher.subscribe(listener)
+        expect(broadcaster).to receive('broadcast')
+        publisher.send(:broadcast, event_name)
+      end
+
+      describe 'async alias' do
+        it 'given an object which responds_to broadcast it uses object' do
+          publisher.subscribe(listener, async: broadcaster)
+          expect(broadcaster).to receive('broadcast')
+          publisher.send(:broadcast, event_name)
+        end
+
+        it 'given true it uses configured async broadcaster' do
+          Wisper.configure { |c| c.broadcaster(:async, broadcaster) }
+          publisher.subscribe(listener, async: true)
+          expect(broadcaster).to receive('broadcast')
+          publisher.send(:broadcast, event_name)
+        end
+
+        it 'given false it uses configured default broadcaster' do
+          Wisper.configure { |c| c.broadcaster(:default, broadcaster) }
+          publisher.subscribe(listener, async: false)
+          expect(broadcaster).to receive('broadcast')
+          publisher.send(:broadcast, event_name)
+        end
+      end
+    end
+
     it 'returns publisher so methods can be chained' do
       expect(publisher.add_listener(listener, :on => 'so_did_this')).to \
         eq publisher

data/spec/lib/wisper/registrations/object_spec.rb

@@ -0,0 +1,14 @@
+describe Wisper::ObjectRegistration do
+
+  describe 'broadcaster' do
+    it 'defaults to SendBroadcaster' do
+      subject = Wisper::ObjectRegistration.new(double('listener'), {})
+      expect(subject.broadcaster).to be_instance_of(Wisper::Broadcasters::SendBroadcaster)
+    end
+
+    it 'default is lazily evaluated' do
+      expect(Wisper::Broadcasters::SendBroadcaster).to_not receive :new
+      Wisper::ObjectRegistration.new(double('listener'), broadcaster: double('DifferentBroadcaster').as_null_object)
+    end
+  end
+end

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

@@ -1,4 +1,3 @@
-require 'spec_helper'
 require 'wisper/rspec/matchers'
 
 RSpec::configure do |config|

data/spec/lib/wisper_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe Wisper do
   before do
     # assign the stderr to a new StringIO to test errors
@@ -79,4 +77,18 @@ describe Wisper do
       end
     end
   end
+
+  it '.configuration returns configuration' do
+    expect(Wisper.configuration).to be_an_instance_of(Wisper::Configuration)
+  end
+
+  it '.configure yields block to configuration' do
+    Wisper.configure do |config|
+      expect(config).to be_an_instance_of(Wisper::Configuration)
+    end
+  end
+
+  it 'has a default broadcaster' do
+    expect(Wisper.configuration.broadcasters[:default]).to be_instance_of(Wisper::Broadcasters::SendBroadcaster)
+  end
 end

metadata

@@ -1,36 +1,35 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: wisper
-version: !ruby/object:Gem::Version 
-  version: 1.4.0
+version: !ruby/object:Gem::Version
+  version: 1.5.0
 platform: ruby
-authors: 
+authors:
 - Kris Leech
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-09-08 00:00:00 Z
+date: 2014-10-06 00:00:00.000000000 Z
 dependencies: []
-
 description: pub/sub for Ruby objects
-email: 
+email:
 - kris.leech@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
-- .rspec
-- .travis.yml
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
 - README.md
 - Rakefile
 - lib/wisper.rb
+- lib/wisper/broadcasters/logger_broadcaster.rb
+- lib/wisper/broadcasters/send_broadcaster.rb
+- lib/wisper/configuration.rb
 - lib/wisper/global_listeners.rb
 - lib/wisper/publisher.rb
 - lib/wisper/registration/block.rb
@@ -40,50 +39,54 @@ files:
 - lib/wisper/rspec/stub_wisper_publisher.rb
 - lib/wisper/temporary_listeners.rb
 - lib/wisper/version.rb
-- spec/lib/async_spec.rb
 - spec/lib/global_subscribers_spec.rb
 - spec/lib/integration_spec.rb
 - spec/lib/simple_example_spec.rb
 - 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_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
 homepage: https://github.com/krisleech/wisper
-licenses: 
+licenses:
 - MIT
 metadata: {}
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - &id001 
-    - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id001
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: pub/sub for Ruby objects
-test_files: 
-- spec/lib/async_spec.rb
+test_files:
 - spec/lib/global_subscribers_spec.rb
 - spec/lib/integration_spec.rb
 - spec/lib/simple_example_spec.rb
 - 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_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

data/spec/lib/async_spec.rb

@@ -1,10 +0,0 @@
-require 'spec_helper'
-
-describe 'async option' do
-  let(:listener)  { double('listener') }
-  let(:publisher) { publisher_class.new }
-
-  it 'it raises a deprecation exception' do
-    expect { publisher.add_listener(listener, :async => true) }.to raise_error
-  end
-end