wisper 1.2.1 → 1.3.0

data/.travis.yml

@@ -7,4 +7,4 @@ rvm:
   - '2.0.0'
   - jruby-19mode
   - jruby-20mode
-  - rbx-19mode
+  - rbx

data/Gemfile

@@ -2,6 +2,8 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'rubysl', '~> 2.0', :platforms => :rbx
+
 group :metrics do
   gem 'simplecov'
   gem 'flay'

data/README.md

@@ -212,6 +212,24 @@ In a Rails app you might want to add your global listeners in an initalizer.
 
 Global listeners are threadsafe.
 
+### Scoping to publisher class
+
+You might want to globally subscribe a listener to publishers with a certain
+class.
+
+```ruby
+Wisper.add_listener(MyListener.new, :scope => :MyPublisher)
+```
+
+This will subscribe the listener to all instances of `MyPublisher` and its
+subclasses.
+
+Alternatively you can also do exactly the same with a publisher class:
+
+```ruby
+MyPublisher.add_listener(MyListener.new)
+```
+
 ## Temporary Global Listeners
 
 You can also globally subscribe listeners for the duration of a block.
@@ -238,6 +256,19 @@ of events to `:on`.
 post_creater.subscribe(PusherListener.new, :on => :create_post_successful)
 ```
 
+## Prefixing broadcast events
+
+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)
+```
+
+If `post_creater` where 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".
+
 ## Mapping an event to a different method
 
 By default the method called on the subscriber is the same as the event

data/lib/wisper/publisher.rb

@@ -23,6 +23,14 @@ module Wisper
 
     alias :on :respond_to
 
+    module ClassMethods
+      def add_listener(listener, options = {})
+        GlobalListeners.add(listener, options.merge(:scope => self))
+      end
+
+      alias :subscribe :add_listener
+    end
+
     private
 
     def local_registrations
@@ -43,7 +51,7 @@ module Wisper
 
     def broadcast(event, *args)
       registrations.each do | registration |
-        registration.broadcast(clean_event(event), *args)
+        registration.broadcast(clean_event(event), self, *args)
       end
     end
 
@@ -53,6 +61,10 @@ module Wisper
     def clean_event(event)
       event.to_s.gsub('-', '_')
     end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
   end
 end
 

data/lib/wisper/registration/block.rb

@@ -1,6 +1,6 @@
 module Wisper
   class BlockRegistration < Registration
-    def broadcast(event, *args)
+    def broadcast(event, publisher, *args)
       if should_broadcast?(event)
         listener.call(*args)
       end

data/lib/wisper/registration/object.rb

@@ -1,24 +1,45 @@
 module Wisper
   class ObjectRegistration < Registration
-    attr_reader :with
+    attr_reader :with, :prefix, :allowed_classes
 
     def initialize(listener, options)
       super(listener, options)
-      @with  = options[:with]
+      @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)
     end
 
-    def broadcast(event, *args)
+    def broadcast(event, publisher, *args)
       method_to_call = map_event_to_method(event)
-      if should_broadcast?(event) && listener.respond_to?(method_to_call)
+      if should_broadcast?(event) && listener.respond_to?(method_to_call) && publisher_in_scope?(publisher)
         listener.public_send(method_to_call, *args)
       end
     end
 
     private
 
+    def publisher_in_scope?(publisher)
+      allowed_classes.empty? || publisher.class.ancestors.any? { |ancestor| allowed_classes.include?(ancestor.to_s) }
+    end
+
     def map_event_to_method(event)
-      with || event
+      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 fail_on_async

data/lib/wisper/rspec/stub_wisper_publisher.rb

@@ -8,7 +8,7 @@ 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
+    define_method(called_method) do |*args|
       publish(event_to_publish, *published_event_args)
     end
   end)

data/lib/wisper/version.rb

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

data/spec/lib/global_subscribers_spec.rb

@@ -34,6 +34,23 @@ describe Wisper::GlobalListeners do
       publisher.send(:broadcast, :it_happened)
     end
 
+    it 'can be scoped to classes' do
+      publisher_1 = publisher_class.new
+      publisher_2 = publisher_class.new
+      publisher_3 = publisher_class.new
+
+      Wisper::GlobalListeners.add(global_listener, :scope => [publisher_1.class,
+                                                              publisher_2.class])
+
+      global_listener.should_receive(:it_happened_1).once
+      global_listener.should_receive(:it_happened_2).once
+      global_listener.should_not_receive(:it_happened_3)
+
+      publisher_1.send(:broadcast, :it_happened_1)
+      publisher_2.send(:broadcast, :it_happened_2)
+      publisher_3.send(:broadcast, :it_happened_3)
+    end
+
     it 'is threadsafe' do
       num_threads = 100
       (1..num_threads).to_a.map do
@@ -54,7 +71,7 @@ describe Wisper::GlobalListeners do
     end
 
     it 'returns an immutable collection' do
-      Wisper::GlobalListeners.listeners.frozen?.should be_true
+      Wisper::GlobalListeners.listeners.should be_frozen
       expect { Wisper::GlobalListeners.listeners << global_listener }.to raise_error(RuntimeError)
     end
   end

data/spec/lib/wisper/publisher_spec.rb

@@ -21,7 +21,7 @@ describe Wisper::Publisher do
         listener.stub(:so_did_this)
         listener.should_not_receive(:so_did_this)
 
-        listener.respond_to?(:so_did_this).should be_true
+        listener.should respond_to(:so_did_this)
 
         publisher.add_listener(listener, :on => 'this_happened')
 
@@ -35,7 +35,7 @@ describe Wisper::Publisher do
         listener.stub(:so_did_this)
         listener.should_not_receive(:so_did_this)
 
-        listener.respond_to?(:so_did_this).should be_true
+        listener.should respond_to(:so_did_this)
 
         publisher.add_listener(listener, :on => ['this_happened', 'and_this'])
 
@@ -56,12 +56,71 @@ describe Wisper::Publisher do
       end
     end
 
+    describe ':prefix argument' do
+      it 'prefixes broadcast events with given symbol' do
+        listener.should_receive(:after_it_happened)
+        listener.should_not_receive(:it_happened)
+
+        publisher.add_listener(listener, :prefix => :after)
+
+        publisher.send(:broadcast, 'it_happened')
+      end
+
+      it 'prefixes broadcast events with "on" when given true' do
+        listener.should_receive(:on_it_happened)
+        listener.should_not_receive(:it_happened)
+
+        publisher.add_listener(listener, :prefix => true)
+
+        publisher.send(:broadcast, 'it_happened')
+      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')  }
+
+      before do
+      end
+
+      it 'scopes listener to given class' do
+        listener_1.should_receive(:it_happended)
+        listener_2.should_not_receive(:it_happended)
+        publisher.add_listener(listener_1, :scope => publisher.class)
+        publisher.add_listener(listener_2, :scope => Class.new)
+        publisher.send(:broadcast, 'it_happended')
+      end
+
+      it 'scopes listener to given class string' do
+        listener_1.should_receive(:it_happended)
+        listener_2.should_not_receive(:it_happended)
+        publisher.add_listener(listener_1, :scope => publisher.class.to_s)
+        publisher.add_listener(listener_2, :scope => Class.new.to_s)
+        publisher.send(:broadcast, 'it_happended')
+      end
+
+      it 'includes all subclasses of given class' do
+        publisher_super_klass = publisher_class
+        publisher_sub_klass = Class.new(publisher_super_klass)
+
+        listener = double('Listener')
+        listener.should_receive(:it_happended).once
+
+        publisher = publisher_sub_klass.new
+
+        publisher.add_listener(listener, :scope => publisher_super_klass)
+        publisher.send(:broadcast, 'it_happended')
+      end
+    end
+
     it 'returns publisher so methods can be chained' do
       publisher.add_listener(listener, :on => 'so_did_this').should == publisher
     end
 
     it 'is aliased to .subscribe' do
-      publisher.respond_to?(:subscribe).should be_true
+      publisher.should respond_to(:subscribe)
     end
   end
 
@@ -170,7 +229,7 @@ describe Wisper::Publisher do
 
   describe '.listeners' do
     it 'returns an immutable collection' do
-      publisher.listeners.frozen?.should be_true
+      publisher.listeners.should be_frozen
       expect { publisher.listeners << listener }.to raise_error(RuntimeError)
     end
 
@@ -180,4 +239,20 @@ describe Wisper::Publisher do
        publisher.listeners.size.should == 1
     end
   end
+
+  describe '#add_listener' do
+    let(:publisher_klass_1) { publisher_class }
+    let(:publisher_klass_2) { publisher_class }
+
+    it 'subscribes listeners to all instances of publisher' do
+      publisher_klass_1.add_listener(listener)
+      listener.should_receive(:it_happened).once
+      publisher_klass_1.new.send(:broadcast, 'it_happened')
+      publisher_klass_2.new.send(:broadcast, 'it_happened')
+    end
+
+    it 'is aliased to #subscribe' do
+      publisher_klass_1.should respond_to(:subscribe)
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -7,11 +7,19 @@ end
 require 'wisper'
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
   config.order = 'random'
   config.after(:each) { Wisper::GlobalListeners.clear }
+
+  # Support both Rspec2 should and Rspec3 expect syntax
+  config.expect_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
+
+  config.mock_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
 end
 
 # returns an anonymous wispered class

data/wisper.gemspec

@@ -18,5 +18,5 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rspec', "~> 3.0.0.beta1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wisper
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-07 00:00:00.000000000 Z
+date: 2014-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0.beta1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0.beta1
 description: pub/sub for Ruby objects
 email:
 - kris.leech@gmail.com