triton 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+.idea
+*.gem

data/.rvmrc

@@ -0,0 +1,55 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
+environment_id="ruby-1.9.3-p0@triton"
+
+#
+# Uncomment following line if you want options to be set only for given project.
+#
+# PROJECT_JRUBY_OPTS=( --1.9 )
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  if [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]]
+  then
+    . "${rvm_path:-$HOME/.rvm}/hooks/after_use"
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  if ! rvm --create  "$environment_id"
+  then
+    echo "Failed to create RVM environment '${environment_id}'."
+    exit 1
+  fi
+fi
+
+#
+# If you use an RVM gemset file to install a list of gems (*.gems), you can have
+# it be automatically loaded. Uncomment the following and adjust the filename if
+# necessary.
+#
+# filename=".gems"
+# if [[ -s "$filename" ]]
+# then
+#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
+# fi
+
+# If you use bundler, this might be useful to you:
+if command -v bundle && [[ -s Gemfile ]]
+then
+  bundle install
+fi
+
+

data/Gemfile

@@ -0,0 +1,12 @@
+source :rubygems
+
+gemspec
+
+platforms :mri_18 do
+  gem "ruby-debug", ">= 0.10.3"
+  gem "linecache", "<= 0.45"
+end
+
+platforms :mri_19 do
+  gem "ruby-debug19"
+end

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    triton (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    archive-tar-minitar (0.5.2)
+    columnize (0.3.4)
+    linecache (0.45)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    metaclass (0.0.1)
+    minitest (2.7.0)
+    mocha (0.10.0)
+      metaclass (~> 0.0.1)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  linecache (<= 0.45)
+  minitest (~> 2.7.0)
+  mocha (~> 0.10.0)
+  ruby-debug (>= 0.10.3)
+  ruby-debug19
+  triton!

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2011 Cédric Darné.
+
+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,23 @@
+Triton
+======
+
+Description
+-----------
+Triton is an implementation of the event/listener pattern like EventEmitter on Node.js.
+
+Installation
+------------
+    gem install triton
+
+Example
+-------
+    require 'triton'
+    Triton::Messenger.on(:alert) { puts "alert!" }
+    Triton::Messenger.emit(:alert)
+        # -> alert!
+
+License
+-------
+Released under the MIT License.  See the [LICENSE][license] file for further details.
+
+[license]: https://github.com/cdarne/triton/blob/master/LICENSE.md

data/lib/triton.rb

@@ -0,0 +1,2 @@
+require_relative "triton/version"
+require_relative "triton/messenger"

data/lib/triton/messenger.rb

@@ -0,0 +1,99 @@
+module Triton
+  # The Messenger module provides a simple event emitter/listener system
+  #
+  # == Example
+  #
+  #     require 'triton'
+  #
+  #     Triton::Messenger.on(:alert) { puts "alert!" }
+  #     Triton::Messenger.emit(:alert)
+  #                         # -> alert!
+  module Messenger
+    extend self # This make Messenger behave like a singleton
+
+    def listeners # this makes @listeners to be auto-initialized and accessed read-only
+      @listeners ||= Hash.new
+    end
+
+    # Register the given block to be called when the events of type +type+ will be emitted.
+    # if +once+, the block will be called once
+    def add_listener(type, once=false, &callback)
+      listeners[type] ||= []
+      listeners[type] << Listener.new(type, callback, once)
+      emit(:new_listener, self, type, once, callback)
+    end
+
+    alias :on :add_listener
+
+    # Register the given block to be called only once when the events of type +type+ will be emitted.
+    def once(type, &callback)
+      add_listener(type, true, &callback)
+    end
+
+    # Unregister the given block. It won't be call then went an event is emitted.
+    def remove_listener(type, listener)
+      if listeners.has_key? type
+        listeners[type].delete(listener)
+        listeners.delete(type) if listeners[type].empty?
+      end
+    end
+
+    # Unregister all the listener for the +type+ events.
+    # If +type+ is omitted, unregister *all* the listeners.
+    def remove_all_listeners(type=nil)
+      if type
+        listeners.delete(type)
+      else
+        listeners.clear
+      end
+    end
+
+    # Emit an event of type +type+ and call all the registered listeners to this event.
+    # The +sender+ param will help the listener to identify who is emitting the event.
+    # You can pass then every additional arguments you'll need
+    def emit(type, sender=nil, *args)
+      listeners[type].each { |l| l.fire(sender, *args) } if listeners.has_key? type
+    end
+
+    # Mixin that add shortcuts to emit events
+    module Emittable
+      def emit(type, *args)
+        Triton::Messenger.emit(type, self, *args)
+      end
+    end
+
+    # Mixin that add shortcuts to emit events
+    module Listenable
+      def add_listener(type, once=false, &listener)
+        Triton::Messenger.add_listener(type, once, &listener)
+      end
+
+      alias :on :add_listener
+
+      def once(type, &listener)
+        Triton::Messenger.once(type, &listener)
+      end
+    end
+
+    # The Listener class helps managing event triggering.
+    # It may not be used as its own.
+    class Listener
+      attr_accessor :type, :callback, :once
+
+      def initialize(type, callback, once=false)
+        @type = type
+        @callback = callback
+        @once = once
+      end
+
+      # Call the event listener passing through the +sender+ and the additional args
+      def fire(sender=nil, *args)
+        @callback.call(sender, *args)
+
+        if @once
+          Messenger::remove_listener(@type, self)
+        end
+      end
+    end
+  end
+end

data/lib/triton/version.rb

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

data/test/messenger_test.rb

@@ -0,0 +1,170 @@
+require_relative "./test_helper"
+
+describe Triton::Messenger do
+
+  before :each do
+    Triton::Messenger.remove_all_listeners
+  end
+
+  it "registers listeners" do
+    ok = false
+    Triton::Messenger.on(:test) { ok = true }
+    Triton::Messenger.emit(:test)
+    ok.must_equal true
+  end
+
+  it "registers listeners once with the +once+ parameter" do
+    ok = 0
+    Triton::Messenger.on(:test, true) { ok += 1 }
+    2.times { Triton::Messenger.emit(:test) }
+    ok.must_equal 1
+  end
+
+  it "registers listeners once with _once_" do
+    ok = 0
+    Triton::Messenger.once(:test) { ok += 1 }
+    2.times { Triton::Messenger.emit(:test) }
+    ok.must_equal 1
+  end
+
+  it "emits a new_listener event when an listener is registered" do
+    received_sender = nil
+    received_args = nil
+    cb = lambda do |s, *args|
+      received_sender = s
+      received_args = args
+    end
+    Triton::Messenger.on(:new_listener, false, &cb)
+    received_sender.must_be_same_as Triton::Messenger
+    received_args.must_equal [:new_listener, false, cb]
+  end
+
+  it "unregisters listeners" do
+    ok = false
+    Triton::Messenger.on(:test) { fail "it should not have been called" }
+    Triton::Messenger.on(:test) { ok = true }
+    Triton::Messenger.remove_listener(:test, Triton::Messenger.listeners[:test].first)
+    Triton::Messenger.emit(:test)
+    ok.must_equal true
+  end
+
+  it "should not unregister listeners of unknown type" do
+    ok = false
+    Triton::Messenger.on(:test) { ok = true }
+    Triton::Messenger.remove_listener(:unknown, Triton::Messenger.listeners[:test].first)
+    Triton::Messenger.emit(:test)
+    ok.must_equal true
+  end
+
+  it "should not unregister unknown listeners" do
+    ok = false
+    Triton::Messenger.on(:test) { ok = true }
+    Triton::Messenger.remove_listener(:test, Triton::Messenger::Listener.new(:test, nil))
+    Triton::Messenger.emit(:test)
+    ok.must_equal true
+  end
+
+  it "unregisters all listeners of one type" do
+    ok = false
+    Triton::Messenger.on(:test) { fail "it should not have been called" }
+    Triton::Messenger.on(:test) { fail "it should not have been called" }
+    Triton::Messenger.on(:test2) { ok = true }
+    Triton::Messenger.remove_all_listeners(:test)
+    Triton::Messenger.emit(:test)
+    Triton::Messenger.emit(:test2)
+    ok.must_equal true
+  end
+
+  it "unregisters all listeners of all type" do
+    Triton::Messenger.on(:test) { fail "it should not have been called" }
+    Triton::Messenger.on(:test2) { fail "it should not have been called" }
+    Triton::Messenger.remove_all_listeners
+    Triton::Messenger.emit(:test)
+    Triton::Messenger.emit(:test2)
+  end
+
+  it "emits events to the right listener" do
+    Triton::Messenger.on(:test) { }
+    Triton::Messenger.on(:test2) { fail "it should not have been called" }
+    Triton::Messenger.emit(:test)
+  end
+
+  it "should not emit events when the type is unknown" do
+    Triton::Messenger.on(:test) { fail "it should not have been called" }
+    Triton::Messenger.on(:test2) { fail "it should not have been called" }
+    Triton::Messenger.emit(:unknown)
+  end
+
+  it "emits events and passes the sender" do
+    received_sender = nil
+    expected_sender = Object.new
+    Triton::Messenger.on(:test) { |s| received_sender = s }
+    Triton::Messenger.emit(:test, expected_sender)
+    received_sender.must_be_same_as expected_sender
+  end
+
+  it "emits events and passes additional arguments" do
+    received_args = nil
+    expected_args = {:arg => "yeah"}
+    Triton::Messenger.on(:test) { |s, opts| received_args = opts }
+    Triton::Messenger.emit(:test, nil, :arg => "yeah")
+    received_args.must_equal expected_args
+  end
+end
+
+
+describe Triton::Messenger::Listener do
+
+  it "should default the once instance variable to false" do
+    event = Triton::Messenger::Listener.new(:test, nil)
+    event.once.must_equal false
+  end
+
+  it "calls the provided callback" do
+    called = false
+    cb = lambda { |s| called = true }
+    event = Triton::Messenger::Listener.new(:test, cb)
+    event.fire
+    called.must_equal true
+  end
+
+  it "unregisters itself once the event fired" do
+    event = Triton::Messenger::Listener.new(:test, lambda { |s| }, true)
+    Triton::Messenger.expects(:remove_listener).with(:test, event)
+    event.fire
+  end
+end
+
+describe Triton::Messenger::Emittable do
+
+  it "should emit a signal on this name" do
+    klass = Class.new { include Triton::Messenger::Emittable }
+    instance = klass.new
+    Triton::Messenger.expects(:emit).with(:test, instance, :arg)
+    instance.emit(:test, :arg)
+  end
+end
+
+describe Triton::Messenger::Listenable do
+
+  before :each do
+    Triton::Messenger.remove_all_listeners
+    klass = Class.new { include Triton::Messenger::Listenable }
+    @instance = klass.new
+  end
+
+  it "should shortcut the #add_listener method" do
+    Triton::Messenger.expects(:add_listener).with(:test_add_listener, true)
+    @instance.add_listener(:test_add_listener, true)
+  end
+
+  it "should shortcut the #on method" do
+    Triton::Messenger.expects(:add_listener).with(:test_on, true)
+    @instance.on(:test_on, true)
+  end
+
+  it "should shortcut the #once method" do
+    Triton::Messenger.expects(:once).with(:test_once)
+    @instance.once(:test_once)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'mocha'
+require_relative '../lib/triton'

data/triton.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require "#{File.dirname(__FILE__)}/lib/triton/version"
+
+Gem::Specification.new do |s|
+  s.add_development_dependency "minitest", "~> 2.7.0"
+  s.add_development_dependency "mocha", "~> 0.10.0"
+  s.add_development_dependency "bundler", "~> 1.0"
+  s.authors = ["Cédric Darné"]
+  s.description = %q{Triton is an implementation of the event/listener pattern like EventEmitter on Node.js}
+  s.email = "cedric.darne@gmail.com"
+  s.extra_rdoc_files = ['LICENSE.md', 'README.md']
+  s.files = `git ls-files`.split("\n")
+  s.homepage = 'http://github.com/cdarne/triton'
+  s.name = "triton"
+  s.require_path = ['lib']
+  s.required_ruby_version = ">= 1.9.2"
+  s.required_rubygems_version = Gem::Requirement.new('>= 1.8.0')
+  s.summary = s.description
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.version = Triton::VERSION.dup
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: triton
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Cédric Darné
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &21387460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :development
+  prerelease: false
+  version_requirements: *21387460
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &21386660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: *21386660
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &21385920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: *21385920
+description: Triton is an implementation of the event/listener pattern like EventEmitter
+  on Node.js
+email: cedric.darne@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.md
+- README.md
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- lib/triton.rb
+- lib/triton/messenger.rb
+- lib/triton/version.rb
+- test/messenger_test.rb
+- test/test_helper.rb
+- triton.gemspec
+homepage: http://github.com/cdarne/triton
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- - lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.0
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Triton is an implementation of the event/listener pattern like EventEmitter
+  on Node.js
+test_files:
+- test/messenger_test.rb
+- test/test_helper.rb