signals 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79695d044f17ec3916824ea55ba5551f24fcd4a8
-  data.tar.gz: f1894ecf6cdb059adcf22e9c685b349fca6a7bea
+  metadata.gz: 682db5800cf5ba91ba8694e672f9ba94cc766e27
+  data.tar.gz: 360251fd4a443e0ddac0b738af93e4a05e713026
 SHA512:
-  metadata.gz: b02380267c91e36fa2908332cae607fdf463f8d3c0c94755003b98b2de10e5379ff5f59970ce88e0420f083419022a72db0e9776157272ec8ea3ff2802226853
-  data.tar.gz: e78b36011fd2e6195e110e4765424cd5cb44e04286a9e4a1e0aae3eab7d4251981100b227b564e2578da04363bfa2d2684e7841d349914329df5bdd270d1082a
+  metadata.gz: 2bfa9e3d66d07c05840b374089148a69a124fce7fbfd4760ccf896fd331a033751b81a87ecb174d47bfbadba11a95411abdb094301ff53deb07b471d5cbd2fe2
+  data.tar.gz: 684f968ef7cdfd6be8c9ca7a28e0a49f5e67a7a042a3ad35d703f675809d6b538968017089b3c2a7fa006aa540814888b963a8ab322e7b67a5f11248451b7bb2

data/README.md

@@ -4,9 +4,17 @@ A light weight publish / subscribe. It is similar to how the gem Wisper works
 but without extra functionality. This library assumes nothing and concurrency is
 not a priortiy.
 
+## Installation
+
+```
+gem 'signals'
+```
+
 ## Usage
 
 ```rb
+require 'signals'
+
 class Coach
   include Signals::Publisher
 
@@ -16,15 +24,21 @@ class Coach
 end
 
 class Player
+  def initialize(name)
+    @name = name
+  end
+
   def v_formation(coach)
-    puts "I'm in position"
+    puts "#{@name} is in position"
   end
 end
 
 coach = Coach.new
-player = Player.new
+forward = Player.new('John')
+center = Player.new('Jeff')
 
-coach.subscribe(player)
+coach.subscribe(forward)
+coach.subscribe(center)
 
 coach.run_play
 ```

data/lib/signals/block_listener.rb

@@ -3,10 +3,16 @@ module Signals
   # This is a Listener that once instantiated, will define a method that is
   # named what is passed as the action.
   class BlockListener
-    # @param [String] action
-    def initialize(action, &block)
-      (class << self; self; end;).instance_eval do
-        define_method(action, block)
+    attr_reader :event, :listener
+
+    def initialize(event, &block)
+      @listener = block
+      @event = event
+    end
+
+    def execute(event, *args)
+      if self.event == event
+        self.listener.call(*args)
       end
     end
   end

data/lib/signals/listener.rb

@@ -0,0 +1,21 @@
+module Signals
+
+  class Listener
+    attr_reader :listener
+
+    # @param [Object] listener the listener you want to use
+    def initialize(listener)
+      @listener = listener
+    end
+
+    # @param [Object] event
+    # @return [void]
+    def execute(event, *args)
+      if @listener.respond_to?(event)
+        @listener.send(event, *args)
+      end
+      nil
+    end
+  end
+
+end

data/lib/signals/publisher.rb

@@ -1,31 +1,30 @@
 module Signals
 
   module Publisher
-    # Broadcasts an action to all of the subscribed listeners
-    # @return [Signals::Publisher]
-    def broadcast(action, *args)
+    # Broadcasts an event to all of the subscribed listeners
+    # @return [void]
+    def broadcast(event, *args)
       listeners.each do |listener|
-        if listener.respond_to?(action)
-          listener.send(action, *args)
-        end
+        listener.execute(event, *args)
       end
-      self
+      nil
     end
 
+    # Creates a one off listener that will respond to the event provided only
+    # @param [Object] event the event that is triggered
+    # @return [void]
     def on(event, &block)
-      listeners << BlockListener.new(event, &block)
-      self
+      listeners.add(BlockListener.new(event, &block))
+      nil
     end
 
     # Subscribe a listener to the publisher
-    # @return [Signals::Publisher]
+    # @return [void]
     def subscribe(listener)
-      listeners << listener
-      self
+      listeners.add(Listener.new(listener))
+      nil
     end
 
-    private
-
     # All of the listeners subscribed to a publisher
     # @return [Set] a unique set of listeners
     def listeners

data/lib/signals/version.rb

@@ -1,3 +1,3 @@
 module Signals
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/signals.rb

@@ -3,5 +3,6 @@ end
 
 require 'set'
 require 'signals/version'
+require 'signals/listener'
 require 'signals/block_listener'
 require 'signals/publisher'

data/signals.gemspec

@@ -20,6 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec", "2.14.0.rc1"
 
 end

data/spec/signals/block_listener_spec.rb

@@ -2,8 +2,33 @@ require 'spec_helper'
 
 describe Signals::BlockListener do
 
-  describe '#initialize' do
-    pending
+  describe '#execute' do
+    it 'should execute the event it was registered for' do
+      block = Signals::BlockListener.new(:testing)
+      block.stub(listener: double('lambda', call: true))
+
+      block.execute(:testing)
+
+      block.listener.should have_received(:call).once
+    end
+
+    it 'should not execute when the event does not match' do
+      block = Signals::BlockListener.new(:testing)
+      block.stub(listener: double('lambda', call: true))
+
+      block.execute(:another)
+
+      block.listener.should_not have_received(:call)
+    end
+
+    it 'should pass parameters on to the proc' do
+      block = Signals::BlockListener.new(:testing)
+      block.stub(listener: double('lambda', call: true))
+
+      block.execute(:testing, 1, 2)
+
+      block.listener.should have_received(:call).with(1,2).once
+    end
   end
 
 end

data/spec/signals/listener_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Signals::Listener do
+
+  describe '#execute' do
+    it 'should execute an existing method with no params' do
+      simple = double('SimpleListener', testing: true)
+      listener = Signals::Listener.new(simple)
+
+      listener.execute(:testing)
+
+      listener.listener.should have_received(:testing).once
+    end
+
+    it 'should execute an existing method with params' do
+      simple = double('SimpleListener', testing: true)
+      listener = Signals::Listener.new(simple)
+
+      listener.execute(:testing, 1, 2)
+
+      listener.listener.should have_received(:testing).with(1, 2).once
+    end
+
+    it 'should not raise an error when the method does not exist' do
+      simple = double('SimpleListener')
+      listener = Signals::Listener.new(simple)
+
+      expect { listener.execute(:testing) }.to_not raise_error
+    end
+  end
+end

data/spec/signals/publisher_spec.rb

@@ -5,68 +5,42 @@ describe Signals::Publisher do
     include Signals::Publisher
   end
 
-  class DummySimpleListener
-    def simple_method
-      true
-    end
+  class SimpleListener
   end
 
-  class DummyComplexListener
-    def complex_method(a, b)
-      true
-    end
-  end
+  let(:publisher) { DummyPublisher.new }
 
   describe '#broadcast' do
-    it 'should broadcast to no listeners' do
-      publisher = DummyPublisher.new
-      expect { publisher.broadcast(:simple_method) }.to_not raise_error
-    end
+    it 'should broadcast an event' do
+      listener = double('AListener', execute: true)
+      publisher.stub(listeners: Set.new([listener]))
 
-    it 'should broadcast to a simple listener' do
-      publisher = DummyPublisher.new
-      publisher.stub(:listeners).and_return([DummySimpleListener.new])
-      expect { publisher.broadcast(:simple_method) }.to_not raise_error
-    end
-
-    it 'should broadcast to a complex listener' do
-      publisher = DummyPublisher.new
-      publisher.stub(:listeners).and_return([DummyComplexListener.new])
-      expect { publisher.broadcast(:complex_method, 1, 2) }.to_not raise_error
-    end
+      publisher.broadcast(:event, 1, 2)
 
-    it 'should broadcast an unsupported event to a listener' do
-      publisher = DummyPublisher.new
-      publisher.stub(:listeners).and_return([DummySimpleListener.new])
-      expect { publisher.broadcast(:does_not_exist) }.to_not raise_error
-    end
-
-    context 'when providing too few arguments' do
-      it 'should raise an argument error' do
-        publisher = DummyPublisher.new
-        publisher.stub(:listeners).and_return([DummyComplexListener.new])
-        expect { publisher.broadcast(:complex_method, 1) }.to raise_error(/wrong number of arguments/)
-      end
-    end
-
-    context 'when providing too many arguments' do
-      it 'should raise an argument error' do
-        publisher = DummyPublisher.new
-        publisher.stub(:listeners).and_return([DummySimpleListener.new])
-        expect { publisher.broadcast(:simple_method, 1) }.to raise_error(/wrong number of arguments/)
-      end
+      listener.should have_received(:execute).with(:event, 1, 2)
     end
   end
 
   describe '#subscribe' do
-    it 'should subscribe an object' do
-      publisher = DummyPublisher.new
-      expect { publisher.subscribe(Object.new) }.to_not raise_error
+    it 'should subscribe a listener' do
+      expect {
+        publisher.subscribe(SimpleListener.new)
+      }.to_not raise_error
     end
   end
 
   describe '#on' do
-    pending
+    it 'should subscribe a block listener' do
+      publisher.stub(listeners: double('Set', add: true))
+
+      publisher.on(:event) { true }
+
+      publisher.listeners.should have_received(:add).once
+    end
   end
 
+  describe '#listeners' do
+    subject { publisher.listeners }
+    it { should be_a(Set) }
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: signals
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Matthew Johnston
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-02 00:00:00.000000000 Z
+date: 2013-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,16 +42,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.0.rc1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.0.rc1
 description: A lightweight publish / subscribe library
 email:
 - warmwaffles@gmail.com
@@ -69,10 +69,12 @@ files:
 - Rakefile
 - lib/signals.rb
 - lib/signals/block_listener.rb
+- lib/signals/listener.rb
 - lib/signals/publisher.rb
 - lib/signals/version.rb
 - signals.gemspec
 - spec/signals/block_listener_spec.rb
+- spec/signals/listener_spec.rb
 - spec/signals/publisher_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/warmwaffles/signals
@@ -101,5 +103,6 @@ specification_version: 4
 summary: A lightweight publish / subscribe library
 test_files:
 - spec/signals/block_listener_spec.rb
+- spec/signals/listener_spec.rb
 - spec/signals/publisher_spec.rb
 - spec/spec_helper.rb