eventception 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: caefa105ae332455e90b0834581a77c3c90cf44b
-  data.tar.gz: d4f3bf6f98004732be5c9edd84f20790f941319f
+  metadata.gz: f854c8c737febfffaab07c28270e82c956f874a4
+  data.tar.gz: 288483563809c33e1caf0c013ceaa13a8d982542
 SHA512:
-  metadata.gz: 88d5ca641b33ac10cc87ef059f1ec870aa2706a779a2b9fd91211cb421efa02b3819656b4a92393117ed6410686c633b982ce2ef2ab8ffaa4af27df5b97698a9
-  data.tar.gz: 20629ad6754729360fce12e56eaa0b13c01807b99add1f3a33ce3ecf9e91fc50cbcf4a176a5b79d1fddd5c8fc32aa0e289530bd729582141e94e39090d11cb90
+  metadata.gz: fdfbee3158f0324e2cdc53ffbea7ae1784067bc151a6522fded984daab89ff25acb24acf39cabfc78997d5160f0e4488bc113c8cc4b6089ce682daa0a531a083
+  data.tar.gz: efdf934fe595c79c3dc467fd2252a3756894865ff93ee10d3f037044ba6b07c39ab75a446c83b354519cf258c0a42bbf31c490223c2c1d719e569bd02da2e629

data/CHANGELOG.md

@@ -3,8 +3,27 @@ All notable changes to this project will be documented in this file. This change
 
 ## [Unreleased]
 
-## 0.0.1 - 2017-07-13
+#### Adds
+
+* Your contribution here.
+
+#### Changes
+
+* Your contribution here.
+
+## v0.1.0 - 2017-07-14
+
+#### Adds
+
+* [#13](https://github.com/dcsg/eventception/pull/13): Add an Immutable Dispatcher - [@dcsg](https://github.com/dcsg).
+
+#### Changes
+
+* [#11](https://github.com/dcsg/eventception/pull/11): Change the license from MIT to GNU LGPLv3 - [@dcsg](https://github.com/dcsg).
+
+## v0.0.1 - 2017-07-13
 
 First release
 
-[Unreleased]: https://github.com/dcsg/eventception/compare/0.0.1...HEAD
+[Unreleased]: https://github.com/dcsg/eventception/compare/v0.1.0...HEAD
+[v0.1.0]: https://github.com/dcsg/eventception/compare/v0.0.1...v0.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    eventception (0.0.1)
+    eventception (0.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -10,6 +10,8 @@ GEM
     byebug (9.0.6)
     coderay (1.1.1)
     diff-lcs (1.3)
+    docile (1.1.5)
+    json (2.0.3)
     method_source (0.8.2)
     parallel (1.11.2)
     parser (2.4.0.0)
@@ -46,6 +48,16 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.8.1)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.1)
+    simplecov-json (0.2)
+      json
+      simplecov
+    simplecov-rcov (0.2.3)
+      simplecov (>= 0.4.1)
     slop (3.6.0)
     unicode-display_width (1.3.0)
 
@@ -60,6 +72,9 @@ DEPENDENCIES
   rake
   rspec (~> 3.6)
   rubocop
+  simplecov
+  simplecov-json
+  simplecov-rcov
 
 BUNDLED WITH
    1.15.1

data/LICENSE

@@ -0,0 +1,165 @@
+ GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -1,6 +1,6 @@
 ## Eventception
 
-[![Build Status](https://travis-ci.org/dcsg/eventception.svg?branch=master)](https://travis-ci.org/dcsg/eventception)
+[![Build Status](https://travis-ci.org/dcsg/eventception.svg?branch=master)](https://travis-ci.org/dcsg/eventception) [![Code Climate](https://codeclimate.com/github/dcsg/eventception/badges/gpa.svg)](https://codeclimate.com/github/dcsg/eventception) [![Test Coverage](https://codeclimate.com/github/dcsg/eventception/badges/coverage.svg)](https://codeclimate.com/github/dcsg/eventception/coverage)
 
 Eventception is a lightweight and simple Ruby Event System inspired on [Symfony Event Dispatcher](https://symfony.com/doc/current/components/event_dispatcher.html).
 
@@ -78,8 +78,18 @@ dispatcher.dispatch(TodoCreatedEvent::NAME, event)
 # STDOUT: created a new to-do with title: 'My To-do'
 ```
 
+## LICENSE
+
+Licensed under [GNU LGPLv3](https://github.com/dcsg/eventception/blob/master/LICENSE)
+
 ## 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
+
 ## Contributors
 
  * [Daniel Gomes](https://github.com/dcsg)

data/eventception.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.homepage    = 'https://github.com/dcsg/eventception'
   spec.summary     = 'Eventception - a lightweight and simple Ruby Event System.'
   spec.description = 'A lightweight and simple Ruby Event System inspired on Symfony Event Dispatcher.'
-  spec.license     = 'MIT'
+  spec.license     = 'LGPL-3.0+'
 
   spec.files         = Dir['**/*'].keep_if { |file| File.file?(file) }
   spec.test_files    = Dir['spec/**/*']
@@ -22,6 +22,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.6'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-json'
+  spec.add_development_dependency 'simplecov-rcov'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-byebug' unless RUBY_PLATFORM == 'java'
   spec.add_development_dependency 'pry-debugger-jruby' if RUBY_PLATFORM == 'java'

data/examples/todo_list/run.rb

@@ -1,3 +1,21 @@
+# Eventception: A lightweight and simple Ruby Event System
+# Copyright (C) 2017 Daniel Gomes <danielcesargomes@gmail.com>
+#
+# This file is part of Eventception.
+#
+# Eventception is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Eventception is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Eventception. If not, see <http://www.gnu.org/licenses/>.
+
 require 'eventception'
 require_relative 'todo_created_event'
 require_relative 'todo_listener'

data/examples/todo_list/todo.rb

@@ -1,3 +1,22 @@
+# Eventception: A lightweight and simple Ruby Event System
+# Copyright (C) 2017 Daniel Gomes <danielcesargomes@gmail.com>
+#
+# This file is part of Eventception.
+#
+# Eventception is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Eventception is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Eventception. If not, see <http://www.gnu.org/licenses/>.
+
+# @author Daniel Gomes <danielcesargomes@gmail.com>
 module TodoList
   class Todo
     attr_reader :title

data/examples/todo_list/todo_created_event.rb

@@ -1,7 +1,26 @@
 # frozen_string_literal: true
 
+# Eventception: A lightweight and simple Ruby Event System
+# Copyright (C) 2017 Daniel Gomes <danielcesargomes@gmail.com>
+#
+# This file is part of Eventception.
+#
+# Eventception is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Eventception is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Eventception. If not, see <http://www.gnu.org/licenses/>.
+
 require 'eventception'
 
+# @author Daniel Gomes <danielcesargomes@gmail.com>
 module TodoList
   class TodoCreatedEvent < Eventception::Event
     NAME = 'todo.created'.freeze

data/examples/todo_list/todo_listener.rb

@@ -1,3 +1,22 @@
+# Eventception: A lightweight and simple Ruby Event System
+# Copyright (C) 2017 Daniel Gomes <danielcesargomes@gmail.com>
+#
+# This file is part of Eventception.
+#
+# Eventception is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Eventception is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Eventception. If not, see <http://www.gnu.org/licenses/>.
+
+# @author Daniel Gomes <danielcesargomes@gmail.com>
 module TodoList
   class TodoListener
     def on_creation(event)

data/lib/eventception.rb

@@ -1,5 +1,6 @@
 require 'eventception/event'
 require 'eventception/listener_handler'
 require 'eventception/dispatcher'
+require 'eventception/immutable_dispatcher'
 require 'eventception/base_subscriber'
 require 'eventception/version'

data/lib/eventception/base_subscriber.rb

@@ -1,5 +1,24 @@
 # frozen_string_literal: true
 
+# Eventception: A lightweight and simple Ruby Event System
+# Copyright (C) 2017 Daniel Gomes <danielcesargomes@gmail.com>
+#
+# This file is part of Eventception.
+#
+# Eventception is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Eventception is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Eventception. If not, see <http://www.gnu.org/licenses/>.
+
+# @author Daniel Gomes <danielcesargomes@gmail.com>
 module Eventception
   class BaseSubscriber
     def subscribed_events

data/lib/eventception/dispatcher.rb

@@ -1,6 +1,28 @@
+# frozen_string_literal: true
+
+# Eventception: A lightweight and simple Ruby Event System
+# Copyright (C) 2017 Daniel Gomes <danielcesargomes@gmail.com>
+#
+# This file is part of Eventception.
+#
+# Eventception is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Eventception is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Eventception. If not, see <http://www.gnu.org/licenses/>.
+
 require 'eventception/priority_listeners'
 require 'eventception/listener_handler'
 
+# @author Daniel Gomes <danielcesargomes@gmail.com>
+# @author Ivo Anjo <ivo.anjo@ist.utl.pt>
 module Eventception
   class Dispatcher
     private
@@ -69,6 +91,10 @@ module Eventception
 
     # Gets all listeners for the specific event sorted by descending priority.
     #
+    # == Parameters:
+    # event_name::
+    #   The name of the event
+    #
     # == Returns:
     #   The event listeners for the specific event sorted by descending priority.
     #
@@ -82,6 +108,10 @@ module Eventception
 
     # Checks whether are any registered listeners for the specific event.
     #
+    # == Parameters:
+    # event_name::
+    #   The name of the event
+    #
     # == Returns:
     #   Boolean
     #
@@ -96,9 +126,14 @@ module Eventception
     #   The event to listen on
     # listener::
     #   The listener
+    # listener_method::
+    #   The name of the method to be executed in the listener
     # priority::
     #   The higher this value, the earlier an event listener will be triggered in the chain (defaults to 0)
     #
+    # == Returns:
+    #   Nil
+    #
     def add_listener(event_name:, listener:, listener_method:, priority: 0)
       event_listeners[event_name][priority] << ListenerHandler.new(listener, listener_method)
       sorted.delete(event_name)
@@ -106,6 +141,19 @@ module Eventception
       nil
     end
 
+    # Removes an event listener from the specified events.
+    #
+    # == Parameters:
+    # event_name::
+    #   The event to listen on
+    # listener::
+    #   The listener
+    # listener_method::
+    #   The name of the method to be executed in the listener
+    #
+    # == Returns:
+    #   Nil
+    #
     def remove_listener(event_name:, listener:, listener_method:)
       return unless listeners_for?(event_name: event_name)
 
@@ -118,6 +166,8 @@ module Eventception
       end
 
       event_listeners.delete(event_name) if listener_for_event.empty?
+
+      nil
     end
 
     # Add an event subscriber.
@@ -128,6 +178,9 @@ module Eventception
     # subscriber::
     #   The subscriber
     #
+    # == Returns:
+    #   Nil
+    #
     def add_subscriber(subscriber:)
       subscriber.subscribed_events.each do |event_subscribed|
         add_listener(
@@ -137,8 +190,21 @@ module Eventception
           priority: event_subscribed[:priority] || 0,
         )
       end
+
+      nil
     end
 
+    # Removes an event subscriber.
+    #
+    # The subscriber is asked for all the events he is interested in and added as a listener for these events.
+    #
+    # == Parameters:
+    # subscriber::
+    #   The subscriber
+    #
+    # == Returns:
+    #   Nil
+    #
     def remove_subscriber(subscriber:)
       subscriber.subscribed_events.each do |event_subscribed|
         remove_listener(
@@ -147,6 +213,8 @@ module Eventception
           listener_method: event_subscribed.fetch(:listener_method),
         )
       end
+
+      nil
     end
 
     protected
@@ -161,6 +229,9 @@ module Eventception
     # event::
     #   The event
     #
+    # == Returns:
+    #   Nil
+    #
     def do_dispatch(listeners:, event:)
       listeners.each do |_priority, priority_listeners|
         priority_listeners.each do |listener_handler|
@@ -181,8 +252,13 @@ module Eventception
     # event_name::
     #   The event name
     #
+    # == Returns:
+    #   Nil
+    #
     def sort_listeners(event_name)
       sorted[event_name] = event_listeners[event_name].sort_by { |key, _| -key }.to_h
+
+      nil
     end
   end
 end

data/lib/eventception/event.rb

@@ -1,3 +1,22 @@
+# Eventception: A lightweight and simple Ruby Event System
+# Copyright (C) 2017 Daniel Gomes <danielcesargomes@gmail.com>
+#
+# This file is part of Eventception.
+#
+# Eventception is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Eventception is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Eventception. If not, see <http://www.gnu.org/licenses/>.
+
+# @author Daniel Gomes <danielcesargomes@gmail.com>
 module Eventception
   class Event
     private

data/lib/eventception/immutable_dispatcher.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+# Eventception: A lightweight and simple Ruby Event System
+# Copyright (C) 2017 Daniel Gomes <danielcesargomes@gmail.com>
+#
+# This file is part of Eventception.
+#
+# Eventception is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Eventception is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Eventception. If not, see <http://www.gnu.org/licenses/>.
+
+# @author Daniel Gomes <danielcesargomes@gmail.com>
+module Eventception
+  class ImmutableDispatcher
+    private
+
+    attr_reader :dispatcher
+
+    public
+
+    # Creates an unmodifiable proxy for an event dispatcher.
+    #
+    # == Parameters:
+    # listeners::
+    #   Array of event listeners
+    # subscribers::
+    #   Array of event subscribers
+    #
+    # == Returns:
+    #   Nil
+    #
+    def initialize(listeners: [], subscribers: [])
+      @dispatcher = Eventception::Dispatcher.new
+
+      listeners.each do |listener|
+        dispatcher.add_listener(
+          event_name: listener.fetch(:event_name),
+          listener: listener.fetch(:listener),
+          listener_method: listener.fetch(:listener_method),
+          priority: listener.fetch(:priority, 0),
+        )
+      end
+
+      subscribers.each { |subscriber| dispatcher.add_subscriber(subscriber: subscriber) }
+
+      nil
+    end
+
+    # Dispatches an event to all registered listeners.
+    #
+    # == Parameters:
+    # event_name::
+    #   The name of the event to dispatch. The name of
+    #   the event is the name of the method that is
+    #   invoked on listeners.
+    # event::
+    #   The event to pass to the event handlers/listeners
+    #   If not supplied, an empty Event instance is created.
+    #
+    # == Returns:
+    #   The Event.
+    #
+    def dispatch(event_name:, event: Eventception::Event.new)
+      dispatcher.dispatch(event_name: event_name, event: event)
+
+      event
+    end
+
+    # Gets all listeners sorted by descending priority.
+    #
+    # == Returns:
+    #   All event listeners sorted by event_name and descending priority.
+    #
+    def listeners
+      dispatcher.listeners
+    end
+
+    # Checks whether are any registered listeners.
+    #
+    # == Returns:
+    #   Boolean
+    #
+    def listeners?
+      dispatcher.listeners?
+    end
+
+    # Gets all listeners for the specific event sorted by descending priority.
+    #
+    # == Parameters:
+    # event_name::
+    #   The name of the event
+    #
+    # == Returns:
+    #   The event listeners for the specific event sorted by descending priority.
+    #
+    def listeners_for(event_name:)
+      dispatcher.listeners_for(event_name: event_name)
+    end
+
+    # Checks whether are any registered listeners for the specific event.
+    #
+    # == Parameters:
+    # event_name::
+    #   The name of the event
+    #
+    # == Returns:
+    #   Boolean
+    #
+    def listeners_for?(event_name:)
+      dispatcher.listeners_for?(event_name: event_name)
+    end
+  end
+end

data/lib/eventception/listener_handler.rb

@@ -1,3 +1,22 @@
+# Eventception: A lightweight and simple Ruby Event System
+# Copyright (C) 2017 Daniel Gomes <danielcesargomes@gmail.com>
+#
+# This file is part of Eventception.
+#
+# Eventception is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Eventception is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Eventception. If not, see <http://www.gnu.org/licenses/>.
+
+# @author Daniel Gomes <danielcesargomes@gmail.com>
 module Eventception
   class ListenerHandler
     attr_reader :listener

data/lib/eventception/priority_listeners.rb

@@ -1,3 +1,22 @@
+# Eventception: A lightweight and simple Ruby Event System
+# Copyright (C) 2017 Daniel Gomes <danielcesargomes@gmail.com>
+#
+# This file is part of Eventception.
+#
+# Eventception is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Eventception is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Eventception. If not, see <http://www.gnu.org/licenses/>.
+
+# @author Ivo Anjo <ivo.anjo@ist.utl.pt>
 module Eventception
   class PriorityListeners
     include Enumerable

data/lib/eventception/version.rb

@@ -1,3 +1,3 @@
 module Eventception
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.1.0'.freeze
 end

data/spec/eventception/dispatcher_spec.rb

@@ -1,9 +1,29 @@
+# Eventception: A lightweight and simple Ruby Event System
+# Copyright (C) 2017 Daniel Gomes <danielcesargomes@gmail.com>
+#
+# This file is part of Eventception.
+#
+# Eventception is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Eventception is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Eventception. If not, see <http://www.gnu.org/licenses/>.
+
 require 'spec_helper'
 require 'support/listener'
 require 'support/subscriber'
 require 'support/test_event'
 require 'eventception/listener_handler'
 
+# @author Daniel Gomes <danielcesargomes@gmail.com>
+# @author Ivo Anjo <ivo.anjo@ist.utl.pt>
 describe Eventception::Dispatcher do
   subject(:dispatcher) { described_class.new }
 

data/spec/eventception/immutable_dispatcher_spec.rb

@@ -0,0 +1,61 @@
+# Eventception: A lightweight and simple Ruby Event System
+# Copyright (C) 2017 Daniel Gomes <danielcesargomes@gmail.com>
+#
+# This file is part of Eventception.
+#
+# Eventception is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Eventception is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Eventception. If not, see <http://www.gnu.org/licenses/>.
+
+require 'spec_helper'
+require 'support/listener'
+require 'support/subscriber'
+require 'support/test_event'
+
+# @author Daniel Gomes <danielcesargomes@gmail.com>
+describe Eventception::ImmutableDispatcher do
+  subject(:dispatcher) { described_class.new(listeners: listeners, subscribers: subscribers) }
+
+  let(:listener) { Eventception::Support::Listener.new }
+  let(:listener_method) { 'on_before' }
+  let(:listeners) { [] }
+  let(:subscriber) { Eventception::Support::Subscriber.new }
+  let(:subscribers) { [] }
+  let(:event_name) { :on_after }
+  let(:priority) { 0 }
+
+  describe '#initialize' do
+    context 'when one listener is provided' do
+      let(:listeners) {
+        [
+          {event_name: event_name, listener: listener, listener_method: listener_method, priority: priority},
+        ]
+      }
+
+      it 'then a listener is registered' do
+        expect(dispatcher.listeners?).to be true
+      end
+
+      it 'then it have one listener registered' do
+        expect(dispatcher.listeners.size).to eq 1
+      end
+
+      it 'then a listener for the event \'on_before\' is registered' do
+        expect(dispatcher.listeners_for?(event_name: event_name)).to be true
+      end
+
+      it 'then no listeners are registered for an invalid event name' do
+        expect(dispatcher.listeners_for?(event_name: :invalid)).to be false
+      end
+    end
+  end
+end

data/spec/eventception/listener_handler_spec.rb

@@ -1,3 +1,21 @@
+# Eventception: A lightweight and simple Ruby Event System
+# Copyright (C) 2017 Daniel Gomes <danielcesargomes@gmail.com>
+#
+# This file is part of Eventception.
+#
+# Eventception is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Eventception is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Eventception. If not, see <http://www.gnu.org/licenses/>.
+
 require 'eventception'
 require 'spec_helper'
 require 'support/listener'
@@ -5,6 +23,7 @@ require 'support/subscriber'
 require 'support/test_event'
 require 'support/listener'
 
+# @author Daniel Gomes <danielcesargomes@gmail.com>
 describe Eventception::ListenerHandler do
   subject(:event_handler) { described_class.new(listener, listener_method) }
 

data/spec/examples/todo_list_spec.rb

@@ -1,3 +1,22 @@
+# Eventception: A lightweight and simple Ruby Event System
+# Copyright (C) 2017 Daniel Gomes <danielcesargomes@gmail.com>
+#
+# This file is part of Eventception.
+#
+# Eventception is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Eventception is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Eventception. If not, see <http://www.gnu.org/licenses/>.
+
+# @author Ivo Anjo <ivo.anjo@ist.utl.pt>
 RSpec.describe 'TodoList example' do
   it 'runs without error' do
     load File.expand_path('../../../examples/todo_list/run.rb', Pathname.new(__FILE__).realpath)

data/spec/spec_helper.rb

@@ -1,3 +1,21 @@
+# Eventception: A lightweight and simple Ruby Event System
+# Copyright (C) 2017 Daniel Gomes <danielcesargomes@gmail.com>
+#
+# This file is part of Eventception.
+#
+# Eventception is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Eventception is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Eventception. If not, see <http://www.gnu.org/licenses/>.
+
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
@@ -5,3 +23,17 @@ require 'eventception'
 
 RSpec.configure do |config|
 end
+
+if ENV['SIMPLECOV_ENABLED'] == '1'
+  require 'simplecov'
+  require 'simplecov-json'
+  require 'simplecov-rcov'
+
+  SimpleCov.formatters = [
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::JSONFormatter,
+    SimpleCov::Formatter::RcovFormatter,
+  ]
+
+  SimpleCov.start
+end

data/spec/support/listener.rb

@@ -1,3 +1,22 @@
+# Eventception: A lightweight and simple Ruby Event System
+# Copyright (C) 2017 Daniel Gomes <danielcesargomes@gmail.com>
+#
+# This file is part of Eventception.
+#
+# Eventception is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Eventception is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Eventception. If not, see <http://www.gnu.org/licenses/>.
+
+# @author Daniel Gomes <danielcesargomes@gmail.com>
 module Eventception
   module Support
     class Listener

data/spec/support/subscriber.rb

@@ -1,6 +1,25 @@
+# Eventception: A lightweight and simple Ruby Event System
+# Copyright (C) 2017 Daniel Gomes <danielcesargomes@gmail.com>
+#
+# This file is part of Eventception.
+#
+# Eventception is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Eventception is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Eventception. If not, see <http://www.gnu.org/licenses/>.
+
 require 'eventception'
 require_relative 'test_event'
 
+# @author Daniel Gomes <danielcesargomes@gmail.com>
 module Eventception
   module Support
     class Subscriber < Eventception::BaseSubscriber

data/spec/support/test_event.rb

@@ -1,7 +1,26 @@
 # frozen_string_literal: true
 
+# Eventception: A lightweight and simple Ruby Event System
+# Copyright (C) 2017 Daniel Gomes <danielcesargomes@gmail.com>
+#
+# This file is part of Eventception.
+#
+# Eventception is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Eventception is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Eventception. If not, see <http://www.gnu.org/licenses/>.
+
 require 'eventception'
 
+# @author Daniel Gomes <danielcesargomes@gmail.com>
 module Eventception
   module Support
     class TestEvent < Eventception::Event

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eventception
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Daniel Gomes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-13 00:00:00.000000000 Z
+date: 2017-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,6 +67,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: simplecov-json
+  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: simplecov-rcov
+  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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +149,7 @@ files:
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - eventception.gemspec
@@ -118,11 +161,13 @@ files:
 - lib/eventception/base_subscriber.rb
 - lib/eventception/dispatcher.rb
 - lib/eventception/event.rb
+- lib/eventception/immutable_dispatcher.rb
 - lib/eventception/listener_handler.rb
 - lib/eventception/priority_listeners.rb
 - lib/eventception/version.rb
 - pkg/eventception-0.0.1.gem
 - spec/eventception/dispatcher_spec.rb
+- spec/eventception/immutable_dispatcher_spec.rb
 - spec/eventception/listener_handler_spec.rb
 - spec/examples/todo_list_spec.rb
 - spec/spec_helper.rb
@@ -131,7 +176,7 @@ files:
 - spec/support/test_event.rb
 homepage: https://github.com/dcsg/eventception
 licenses:
-- MIT
+- LGPL-3.0+
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -155,6 +200,7 @@ specification_version: 4
 summary: Eventception - a lightweight and simple Ruby Event System.
 test_files:
 - spec/eventception/dispatcher_spec.rb
+- spec/eventception/immutable_dispatcher_spec.rb
 - spec/eventception/listener_handler_spec.rb
 - spec/examples/todo_list_spec.rb
 - spec/spec_helper.rb