tilia-event 2.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ebd104e4bd4fad29c5d9b324e24c1947e488411d
+  data.tar.gz: 30025c76c470a73c763b392a9b773079ccbd3cc2
+SHA512:
+  metadata.gz: 4fb4120ef5c5c4c9fd815254811821f0923dd49256068cae465b331f6b36f9a5795a231203a1ddc841a19f149d8882fa287cb346db58211fc651e5a8d3dfc9c5
+  data.tar.gz: 71dc762483506d3320b0c88a7c1d42657ab8410ff492ed0da39b4e15a6f1a5a073f39e379381a26f1aaa5e50719e656ef33951012c48075354537822108f3a8a

data/.gitignore

@@ -0,0 +1,19 @@
+# Gem files
+/*.gem
+
+# backup files
+*~
+
+# swap files
+*.swp
+*.kate-swp
+
+# file manager files
+*.directory
+
+# coverage
+/coverage
+
+# documentation
+/doc
+/.yardoc

data/.rubocop.yml

@@ -0,0 +1,32 @@
+# Disable metrics - we stick to the sabre coding
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+# ['word', 'array'] looks better when aligned with other arrays that can't use
+# %w() syntax
+Style/WordArray:
+  Enabled: false

data/.simplecov

@@ -0,0 +1,4 @@
+SimpleCov.start do
+  add_filter "/spec/"
+end
+

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.3

data/CHANGELOG.sabre.md

@@ -0,0 +1,51 @@
+ChangeLog
+=========
+
+2.0.2 (2015-05-19)
+------------------
+
+* This release has no functional changes. It's just been brought up to date
+  with the latest coding standards.
+
+
+2.0.1 (2014-10-06)
+------------------
+
+* Fixed: `$priority` was ignored in `EventEmitter::once` method.
+* Fixed: Breaking the event chain was not possible in `EventEmitter::once`.
+
+
+2.0.0 (2014-06-21)
+------------------
+
+* Added: When calling emit, it's now possible to specify a callback that will be
+  triggered after each method handled. This is dubbed the 'continueCallback' and
+  can be used to implement strategy patterns.
+* Added: Promise object!
+* Changed: EventEmitter::listeners now returns just the callbacks for an event,
+  and no longer returns the list by reference. The list is now automatically
+  sorted by priority.
+* Update: Speed improvements.
+* Updated: It's now possible to remove all listeners for every event.
+* Changed: Now uses psr-4 autoloading.
+
+
+1.0.1 (2014-06-12)
+------------------
+
+* hhvm compatible!
+* Fixed: Issue #4. Compatiblitiy for PHP < 5.4.14.
+
+
+1.0.0 (2013-07-19)
+------------------
+
+* Added: removeListener, removeAllListeners
+* Added: once, to only listen to an event emitting once.
+* Added README.md.
+
+
+0.0.1-alpha (2013-06-29)
+------------------------
+
+* First version!

data/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contributing
+
+This project adheres to the [Open Code of Conduct][code-of-conduct]. By participating, you are expected to honor this code.
+[code-of-conduct]: http://todogroup.org/opencodeofconduct/#tilia-event/tilia@jakobsack.de
+
+This library is a port of [sabre/uri](http://github.com/fruux/sabre-event). The ruby code should match the php code as good as possible. For more information refer to the [coding guidelines](https://tilia.github.io/coding_guidelines).
+
+If you are having an issue [search the open issues](https://github.com/tilia/tilia-event/issues) or create an issue and we'll help point you in the right direction.
+
+## Submitting a Pull Request
+
+* Fork the project on Github
+* Install development dependencies (`bundle install`)
+* Create a topic branch for your changes
+* Ensure that you provide *documentation* and *test coverage* for your changes (patches won't be accepted without)
+* Ensure that all tests pass (`bundle exec rake`)
+* Create a [pull request](https://github.com/tilia/tilia-event/pulls) on Github (these are also a great place to start a conversation around a patch as early as possible)
+
+## Testing
+
+To run the tests:
+
+    $ rake
+
+If nothing complains, congratulations!

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# External dependencies
+gem 'activesupport', '~> 4.2'
+
+# Testing
+gem 'rake'
+gem 'minitest', '~> 5.8'
+gem 'simplecov', '~> 0.10'
+gem 'rubocop', '~> 0.34'
+gem 'yard', '~> 0.8'

data/Gemfile.lock

@@ -0,0 +1,51 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.4)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    ast (2.1.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
+    docile (1.1.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.8.1)
+    parser (2.2.3.0)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    rubocop (0.34.2)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.5, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 4.2)
+  minitest (~> 5.8)
+  rake
+  rubocop (~> 0.34)
+  simplecov (~> 0.10)
+  yard (~> 0.8)
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (C) 2015 Jakob Sack (tilia@jakobsack.de)
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Tilia nor the names of its contributors
+      may be used to endorse or promote products derived from this software
+      without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+    POSSIBILITY OF SUCH DAMAGE.

data/LICENSE.sabre

@@ -0,0 +1,27 @@
+Copyright (C) 2013-2015 fruux GmbH (https://fruux.com/)
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Sabre nor the names of its contributors
+      may be used to endorse or promote products derived from this software
+      without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+    POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,37 @@
+tilia/event
+===========
+
+[![Build Status](https://travis-ci.org/tilia/tilia-event.svg?branch=master)](https://travis-ci.org/tilia/tilia-event)
+
+**tilia/event is a port of [sabre/event](https://github.com/fruux/sabre-event)**
+
+sabre/event is a lightweight library for event-based development in PHP.
+
+This library provides two patterns:
+
+1. EventEmitter
+2. Promises
+
+Full documentation can be found on [the website][1].
+
+
+Installation
+------------
+
+Simply add tilia-event to your Gemfile and bundle it up:
+
+```ruby
+  gem 'tilia-event', '~> 2.0'
+```
+
+
+Contributing
+------------
+
+See [Contributing](CONTRIBUTING.md)
+
+
+License
+-------
+
+tilia-event is licensed under the terms of the [three-clause BSD-license](LICENSE).

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rake'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'yard'
+
+Rake::TestTask.new do |t|
+  t.test_files = Dir.glob('test/**/*_test.rb')
+  t.libs << 'test'
+end
+RuboCop::RakeTask.new do |t|
+  t.options = ['--format', 'html', '--out', 'coverage/rubocop.html']
+end
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb', '-', 'README.md']
+  t.options = ['--private', '--protected']
+end
+
+task(default: :test)

data/lib/tilia/event.rb

@@ -0,0 +1,16 @@
+# Namespace for tilia project
+module Tilia
+  # Load active support core extensions
+  require 'active_support'
+  require 'active_support/core_ext'
+
+  # Namespace of tilia-event library
+  module Event
+    require 'tilia/event/event_emitter_interface'
+    require 'tilia/event/event_emitter_trait'
+    require 'tilia/event/event_emitter'
+    require 'tilia/event/promise'
+    require 'tilia/event/promise_already_resolved_exception'
+    require 'tilia/event/version'
+  end
+end

data/lib/tilia/event/event_emitter.rb

@@ -0,0 +1,16 @@
+module Tilia
+  module Event
+    # EventEmitter object.
+    #
+    # Instantiate this class, or subclass it for easily creating event emitters.
+    class EventEmitter
+      include EventEmitterInterface
+      include EventEmitterTrait
+
+      # TODO: document
+      def initialize
+        initialize_event_emitter_trait
+      end
+    end
+  end
+end

data/lib/tilia/event/event_emitter_interface.rb

@@ -0,0 +1,86 @@
+module Tilia
+  module Event
+    # Event Emitter Interface
+    #
+    # Anything that accepts listeners and emits events should implement this
+    # interface.
+    module EventEmitterInterface
+      # Subscribe to an event.
+      #
+      # @param [String] _event_name
+      # @param [Proc, Method] _call_back
+      # @param [Fixnum] _priority
+      # @return [void]
+      def on(_event_name, _call_back, _priority = 100)
+      end
+
+      # Subscribe to an event exactly once.
+      #
+      # @param [String] _event_name
+      # @param [Proc, Method] _call_back
+      # @param [Fixnum] _priority
+      # @return [void]
+      def once(_event_name, _call_back, _priority = 100)
+      end
+
+      # Emits an event.
+      #
+      # This method will return true if 0 or more listeners were succesfully
+      # handled. false is returned if one of the events broke the event chain.
+      #
+      # If the continueCallBack is specified, this callback will be called every
+      # time before the next event handler is called.
+      #
+      # If the continueCallback returns false, event propagation stops. This
+      # allows you to use the eventEmitter as a means for listeners to implement
+      # functionality in your application, and break the event loop as soon as
+      # some condition is fulfilled.
+      #
+      # Note that returning false from an event subscriber breaks propagation
+      # and returns false, but if the continue-callback stops propagation, this
+      # is still considered a 'successful' operation and returns true.
+      #
+      # Lastly, if there are 5 event handlers for an event. The continueCallback
+      # will be called at most 4 times.
+      #
+      # @param [String] _event_name
+      # @param [Array] _arguments
+      # @param [Proc, Method] _continue_call_back
+      # @return [Boolean]
+      def emit(_event_name, _arguments = [], _continue_call_back = nil)
+      end
+
+      # Returns the list of listeners for an event.
+      #
+      # The list is returned as an array, and the list of events are sorted by
+      # their priority.
+      #
+      # @param [String] _event_name
+      # @return [Array<Proc, Method>]
+      def listeners(_event_name)
+      end
+
+      # Removes a specific listener from an event.
+      #
+      # If the listener could not be found, this method will return false. If it
+      # was removed it will return true.
+      #
+      # @param [String] _event_name
+      # @param [Proc, Method] _listener
+      # @return [Boolean]
+      def remove_listener(_event_name, _listener)
+      end
+
+      # Removes all listeners.
+      #
+      # If the eventName argument is specified, all listeners for that event are
+      # removed. If it is not specified, every listener for every event is
+      # removed.
+      #
+      # @param [String] _event_name
+      # @return [void]
+      def remove_all_listeners(_event_name = nil)
+      end
+    end
+  end
+end