signals 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 79695d044f17ec3916824ea55ba5551f24fcd4a8
+  data.tar.gz: f1894ecf6cdb059adcf22e9c685b349fca6a7bea
+SHA512:
+  metadata.gz: b02380267c91e36fa2908332cae607fdf463f8d3c0c94755003b98b2de10e5379ff5f59970ce88e0420f083419022a72db0e9776157272ec8ea3ff2802226853
+  data.tar.gz: e78b36011fd2e6195e110e4765424cd5cb44e04286a9e4a1e0aae3eab7d4251981100b227b564e2578da04363bfa2d2684e7841d349914329df5bdd270d1082a

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.ruby-gemset

@@ -0,0 +1 @@
+signals

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in signals.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matthew Johnston
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# Signals
+
+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.
+
+## Usage
+
+```rb
+class Coach
+  include Signals::Publisher
+
+  def run_play
+    broadcast(:v_formation, self)
+  end
+end
+
+class Player
+  def v_formation(coach)
+    puts "I'm in position"
+  end
+end
+
+coach = Coach.new
+player = Player.new
+
+coach.subscribe(player)
+
+coach.run_play
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/signals/block_listener.rb

@@ -0,0 +1,14 @@
+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)
+      end
+    end
+  end
+
+end

data/lib/signals/publisher.rb

@@ -0,0 +1,36 @@
+module Signals
+
+  module Publisher
+    # Broadcasts an action to all of the subscribed listeners
+    # @return [Signals::Publisher]
+    def broadcast(action, *args)
+      listeners.each do |listener|
+        if listener.respond_to?(action)
+          listener.send(action, *args)
+        end
+      end
+      self
+    end
+
+    def on(event, &block)
+      listeners << BlockListener.new(event, &block)
+      self
+    end
+
+    # Subscribe a listener to the publisher
+    # @return [Signals::Publisher]
+    def subscribe(listener)
+      listeners << listener
+      self
+    end
+
+    private
+
+    # All of the listeners subscribed to a publisher
+    # @return [Set] a unique set of listeners
+    def listeners
+      @listeners ||= Set.new
+    end
+  end
+
+end

data/lib/signals/version.rb

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

data/lib/signals.rb

@@ -0,0 +1,7 @@
+module Signals
+end
+
+require 'set'
+require 'signals/version'
+require 'signals/block_listener'
+require 'signals/publisher'

data/signals.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'signals/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "signals"
+  spec.version       = Signals::VERSION
+  spec.authors       = ["Matthew Johnston"]
+  spec.email         = ["warmwaffles@gmail.com"]
+  spec.description   = %q{A lightweight publish / subscribe library}
+  spec.summary       = %q{A lightweight publish / subscribe library}
+  spec.homepage      = "https://github.com/warmwaffles/signals"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+end

data/spec/signals/block_listener_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Signals::BlockListener do
+
+  describe '#initialize' do
+    pending
+  end
+
+end

data/spec/signals/publisher_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe Signals::Publisher do
+  class DummyPublisher
+    include Signals::Publisher
+  end
+
+  class DummySimpleListener
+    def simple_method
+      true
+    end
+  end
+
+  class DummyComplexListener
+    def complex_method(a, b)
+      true
+    end
+  end
+
+  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 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
+
+    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
+    end
+  end
+
+  describe '#subscribe' do
+    it 'should subscribe an object' do
+      publisher = DummyPublisher.new
+      expect { publisher.subscribe(Object.new) }.to_not raise_error
+    end
+  end
+
+  describe '#on' do
+    pending
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+require 'signals'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: signals
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthew Johnston
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A lightweight publish / subscribe library
+email:
+- warmwaffles@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/signals.rb
+- lib/signals/block_listener.rb
+- lib/signals/publisher.rb
+- lib/signals/version.rb
+- signals.gemspec
+- spec/signals/block_listener_spec.rb
+- spec/signals/publisher_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/warmwaffles/signals
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A lightweight publish / subscribe library
+test_files:
+- spec/signals/block_listener_spec.rb
+- spec/signals/publisher_spec.rb
+- spec/spec_helper.rb