event_spitter 0.5.0

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 'Mike Breen'
+
+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,56 @@
+# EventSpitter
+
+Like Nodejs' EventEmitter but in Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'event_spitter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install event_spitter
+
+## Usage
+
+    # include EventSpitter in your class.
+    class Something
+      include EventSpitter
+    end
+
+    something = Something.new
+
+    # Then add a listener
+    listener = ->(msg) { puts('msg') }
+    something.on('greeting', listener)
+
+    # Trigger the event
+    something.emit('greeting', 'hello world')
+    # => "hello world"
+
+    # Add a listener that will fire one time only
+    one_timer = ->(msg) { puts(msg + ' once') }
+    something.once('greeting', one_timer)
+
+    something.emit('greeting', 'hello world')
+    # => "hello world"
+    # => "hello world once"
+
+    something.emit('greeting', 'hello world')
+    # => "hello world"
+
+    # Remove a listener
+    # something.off('greeting', listener)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => [:test]

data/event_spitter.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/event_spitter/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["'Mike Breen'"]
+  gem.email         = ["hardbap@gmail.com"]
+  gem.description   = %q{An EventEmitter library for Ruby}
+  gem.summary       = %q{}
+  gem.homepage      = ""
+
+  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)/})
+  gem.name          = "event_spitter"
+  gem.require_paths = ["lib"]
+  gem.version       = EventSpitter::VERSION
+end

data/lib/event_spitter.rb

@@ -0,0 +1,105 @@
+require "event_spitter/version"
+
+module EventSpitter
+
+  # Public: Add a listener for an event.
+  #
+  # event_name - The String name of the event.
+  # listener    - The Proc listener for the event.
+  #
+  # Examples
+  #
+  #   listener = ->(msg) { puts(msg) }
+  #   emitter.on('connection', listener)
+  #
+  # Returns nothing.
+  def on(event_name, listener)
+    events[event_name] = Array(events[event_name]) << listener
+  end
+  alias_method :add_listener, :on
+
+  # Public: Remove a listener for an event.
+  #
+  # event_name - The String name of the event.
+  # listener    - The Proc listener on the event.
+  #
+  # Examples
+  #
+  #   emitter.off('connection', listener)
+  #
+  # Returns nothing.
+  def off(event_name, listener)
+    Array(events[event_name]).delete(listener)
+  end
+  alias_method :remove_listener, :off
+
+  # Public: Adds a one time listener for the event.
+  #
+  # event_name - The String name of the event.
+  # listener    - The Proc listener for the event.
+  #
+  # Examples
+  #
+  #   listener = ->(msg) { puts(msg) }
+  #   emitter.once('connection', listener)
+  #
+  # Returns nothing.
+  def once(event_name, listener)
+    new_listener = ->(*args) do
+      listener.call(*args)
+      off(event_name, new_listener)
+    end
+
+    on(event_name, new_listener)
+  end
+
+  # Public: An Array of listeners for an event.
+  #
+  # Returns event listeners Array.
+  def listeners(event_name)
+    events[event_name]
+  end
+
+  # Public: Executes the listeners for an event.
+  #
+  # event_name - The String event name.
+  # args       - Zero or more argument to be passed to the listeners.
+  #
+  # Examples
+  #
+  #   emitter.emit('connection', 'hello world!')
+  #
+  # Returns nothing.
+  def emit(event_name, *args)
+    events.fetch(event_name, []).each do |listener|
+      listener.call(*args)
+    end
+  end
+
+  # Public: Remove all listeners for event names. If zero event names
+  # as supplied then all event listeners are removed.
+  #
+  # event_names - Zero or more String event names.
+  #
+  # Examples
+  #
+  #   emitter.remove_all_listeners
+  #
+  #   emitter.remove_all_listeners('connection')
+  #
+  # Returns nothing.
+  def remove_all_listeners(*event_names)
+    if event_names.any?
+      event_names.each { |key| events.delete(key) }
+    else
+      events.clear
+    end
+  end
+
+  # Internal: The list of events.
+  #
+  # Returns a Hash of events and their listeners.
+  def events
+    @events ||= {}
+  end
+end

data/lib/event_spitter/version.rb

@@ -0,0 +1,3 @@
+module EventSpitter
+  VERSION = "0.5.0"
+end

data/test/event_spitter_test.rb

@@ -0,0 +1,92 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require_relative '../lib/event_spitter'
+
+class DummyClass; include EventSpitter; end
+
+class EventSpitterTest < MiniTest::Unit::TestCase
+
+  def test_adding_an_event_listener
+    obj = DummyClass.new
+    listener = ->() {}
+    obj.on('something-cool', listener)
+
+    assert_equal [listener], obj.listeners('something-cool')
+  end
+
+  def test_removing_an_event_listener
+    obj = DummyClass.new
+    listener = ->() {}
+    obj.on('something-cool', listener)
+
+    obj.off('something-cool', listener)
+    assert_empty obj.listeners('something-cool')
+  end
+
+  def test_emitting_an_event
+    obj = DummyClass.new
+    listener = MiniTest::Mock.new
+    listener.expect(:call, 42)
+
+    obj.on('something-cool', listener)
+    obj.emit('something-cool')
+    listener.verify
+  end
+
+  def test_emitting_an_event_passing_args
+    obj = DummyClass.new
+    listener = MiniTest::Mock.new
+    listener.expect(:call, 42, ['rock-on'])
+
+    obj.on('something-cool', listener)
+    obj.emit('something-cool', 'rock-on')
+    listener.verify
+  end
+
+  def test_remove_all_listeners_with_arguments
+    obj = DummyClass.new
+    listener = ->() {}
+
+    obj.on('something-cool', listener)
+    obj.on('whats-that', listener)
+
+    obj.remove_all_listeners('something-cool', 'whats-that')
+
+    assert_nil obj.listeners('something-cool'), '"something-cool" event listeners not removed'
+    assert_nil obj.listeners('whats-that'), '"whats-that" event listeners not removed'
+  end
+
+  def test_remove_all_listeners_without_arguments
+    obj = DummyClass.new
+    listener = ->() {}
+
+    obj.on('something-cool', listener)
+    obj.on('whats-that', listener)
+
+    obj.remove_all_listeners
+
+    assert_nil obj.listeners('something-cool'), '"something-cool" event listeners not removed'
+    assert_nil obj.listeners('whats-that'), '"whats-that" event listeners not removed'
+  end
+
+  def test_adding_one_time_listener
+    obj = DummyClass.new
+    listener = ->() { }
+
+    obj.once('something-cool', listener)
+    obj.emit('something-cool')
+
+    assert_empty obj.listeners('something-cool')
+  end
+
+  def test_one_time_listener_does_not_stomp_args
+    obj = DummyClass.new
+    listener = MiniTest::Mock.new
+    listener.expect(:call, 42, ['rock-on'])
+
+    obj.once('something-cool', listener)
+    obj.emit('something-cool', 'rock-on')
+    listener.verify
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: event_spitter
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- ! '''Mike Breen'''
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-13 00:00:00.000000000 Z
+dependencies: []
+description: An EventEmitter library for Ruby
+email:
+- hardbap@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- event_spitter.gemspec
+- lib/event_spitter.rb
+- lib/event_spitter/version.rb
+- test/event_spitter_test.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- test/event_spitter_test.rb