tilia-event 2.0.2 → 2.0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ebd104e4bd4fad29c5d9b324e24c1947e488411d
-  data.tar.gz: 30025c76c470a73c763b392a9b773079ccbd3cc2
+  metadata.gz: dd62eda4d7ad27d38ac0646a1ed55ced5d1f7a36
+  data.tar.gz: a62e52f647e8e57f96cb3d71f565b14884724f05
 SHA512:
-  metadata.gz: 4fb4120ef5c5c4c9fd815254811821f0923dd49256068cae465b331f6b36f9a5795a231203a1ddc841a19f149d8882fa287cb346db58211fc651e5a8d3dfc9c5
-  data.tar.gz: 71dc762483506d3320b0c88a7c1d42657ab8410ff492ed0da39b4e15a6f1a5a073f39e379381a26f1aaa5e50719e656ef33951012c48075354537822108f3a8a
+  metadata.gz: 6ed6f9171f2a35753e2478444efde70bd8e31342038dbd482a70b134876be432d084e4f2a0a8200a50d1277c21f35e857c5c1141cd510021be286d12c3dfe21a
+  data.tar.gz: 2d98457d04bf88779e1275201004a1e613e7437a853392a178e6f6a046658774d958af5ceecd9cb9821b2f8e2d9316a0d604eb3eb4b2abad2862bed97b60b63a

data/.simplecov

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

data/Gemfile

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

data/Gemfile.lock

@@ -1,30 +1,33 @@
+PATH
+  remote: .
+  specs:
+    tilia-event (2.0.2.1)
+      activesupport (>= 4.0)
+
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.2.4)
+    activesupport (4.2.5.1)
       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)
+    ast (2.2.0)
     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)
+    parser (2.3.0.2)
+      ast (~> 2.2)
     powerpack (0.1.1)
-    rainbow (2.0.0)
+    rainbow (2.1.0)
     rake (10.4.2)
-    rubocop (0.34.2)
-      astrolabe (~> 1.3)
-      parser (>= 2.2.2.5, < 3.0)
+    rubocop (0.36.0)
+      parser (>= 2.3.0.0, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
-      ruby-progressbar (~> 1.4)
+      ruby-progressbar (~> 1.7)
     ruby-progressbar (1.7.5)
     simplecov (0.10.0)
       docile (~> 1.1.0)
@@ -40,11 +43,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (~> 4.2)
   minitest (~> 5.8)
   rake
-  rubocop (~> 0.34)
+  rubocop (~> 0.36)
   simplecov (~> 0.10)
+  tilia-event!
   yard (~> 0.8)
 
 BUNDLED WITH

data/lib/tilia/event/event_emitter.rb

@@ -6,11 +6,6 @@ module Tilia
     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

@@ -7,20 +7,20 @@ module Tilia
     module EventEmitterInterface
       # Subscribe to an event.
       #
-      # @param [String] _event_name
-      # @param [Proc, Method] _call_back
-      # @param [Fixnum] _priority
+      # @param event_name
+      # @param [#call] call_back
+      # @param [Fixnum] priority
       # @return [void]
-      def on(_event_name, _call_back, _priority = 100)
+      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
+      # @param event_name
+      # @param [#call] call_back
+      # @param [Fixnum] priority
       # @return [void]
-      def once(_event_name, _call_back, _priority = 100)
+      def once(event_name, call_back, priority = 100)
       end
 
       # Emits an event.
@@ -43,11 +43,11 @@ module Tilia
       # 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
+      # @param event_name
+      # @param [Array] arguments
+      # @param [#call, nil] continue_call_back
       # @return [Boolean]
-      def emit(_event_name, _arguments = [], _continue_call_back = nil)
+      def emit(event_name, arguments = [], continue_call_back = nil)
       end
 
       # Returns the list of listeners for an event.
@@ -55,9 +55,9 @@ module Tilia
       # 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)
+      # @param event_name
+      # @return [Array<#call>]
+      def listeners(event_name)
       end
 
       # Removes a specific listener from an event.
@@ -65,10 +65,10 @@ module Tilia
       # 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
+      # @param event_name
+      # @param [#call] listener
       # @return [Boolean]
-      def remove_listener(_event_name, _listener)
+      def remove_listener(event_name, listener)
       end
 
       # Removes all listeners.
@@ -77,9 +77,9 @@ module Tilia
       # removed. If it is not specified, every listener for every event is
       # removed.
       #
-      # @param [String] _event_name
+      # @param event_name
       # @return [void]
-      def remove_all_listeners(_event_name = nil)
+      def remove_all_listeners(event_name = nil)
       end
     end
   end

data/lib/tilia/event/event_emitter_trait.rb

@@ -8,17 +8,16 @@ module Tilia
     # Using the trait + interface allows you to add EventEmitter capabilities
     # without having to change your base-class.
     module EventEmitterTrait
-      # The list of listeners
+      # Initializes the instance variables of the trait
       #
-      # @return [Hash]
-      attr_accessor :listeners
+      # Do not forget to call super when initializing classes including this
+      # module
+      def initialize(*args)
+        @listeners = {}
+        super
+      end
 
-      # Subscribe to an event.
-      #
-      # @param [String] event_name
-      # @param [Proc, Method] call_back
-      # @param [Fixnum] priority
-      # @return [void]
+      # (see EventEmitterInterface#on)
       def on(event_name, call_back, priority = 100)
         @listeners[event_name] ||= [false, [], []]
 
@@ -27,12 +26,7 @@ module Tilia
         @listeners[event_name][2] << call_back
       end
 
-      # Subscribe to an event exactly once.
-      #
-      # @param [String] event_name
-      # @param [Proc, Method] call_back
-      # @param [Fixnum] priority
-      # @return [void]
+      # (see EventEmitterInterface#once)
       def once(event_name, call_back, priority = 100)
         wrapper = nil
         wrapper = lambda do |*arguments|
@@ -43,30 +37,7 @@ module Tilia
         on(event_name, wrapper, priority)
       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]
+      # (see EventEmitterInterface#emit)
       def emit(event_name, arguments = [], continue_call_back = nil)
         if !continue_call_back.is_a?(Proc)
 
@@ -91,13 +62,7 @@ module Tilia
         true
       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>]
+      # (see EventEmitterInterface#listeners)
       def listeners(event_name)
         return [] unless @listeners.key? event_name
 
@@ -123,14 +88,7 @@ module Tilia
         @listeners[event_name][2]
       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]
+      # (see EventEmitterInterface#remove_listener)
       def remove_listener(event_name, listener)
         return false unless @listeners.key?(event_name)
 
@@ -144,26 +102,14 @@ module Tilia
         false
       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]
+      # (see EventEmitterInterface#remove_all_listeners)
       def remove_all_listeners(event_name = nil)
-        if !event_name.nil?
+        if event_name
           @listeners.delete(event_name)
         else
           @listeners = {}
         end
       end
-
-      # TODO: document
-      def initialize_event_emitter_trait
-        @listeners = {}
-      end
     end
   end
 end

data/lib/tilia/event/promise.rb

@@ -14,27 +14,6 @@ module Tilia
       # The promise was rejected. The operation failed.
       REJECTED = 2
 
-      protected
-
-      # The current state of this promise.
-      #
-      # @return [Fixnum]
-      attr_accessor :state
-
-      # A list of subscribers. Subscribers are the callbacks that want us to let
-      # them know if the callback was fulfilled or rejected.
-      #
-      # @return [Array]
-      attr_accessor :subscribers
-
-      # The result of the promise.
-      #
-      # If the promise was fulfilled, this will be the result value. If the
-      # promise was rejected, this is most commonly an exception.
-      attr_accessor :value
-
-      public
-
       # Creates the promise.
       #
       # The passed argument is the executor. The executor is automatically
@@ -43,7 +22,7 @@ module Tilia
       # Each are callbacks that map to self.fulfill and self.reject.
       # Using the executor is optional.
       #
-      # @param [Proc, Method] executor
+      # @param [#call, nil] executor
       # @return [void]
       def initialize(executor = nil)
         @state = PENDING
@@ -71,11 +50,11 @@ module Tilia
       # If either of the callbacks throw an exception, the returned promise will
       # be rejected and the exception will be passed back.
       #
-      # @param [Proc, Method] on_fulfilled
-      # @param [Proc, Method] on_rejected
+      # @param [#call, nil] on_fulfilled
+      # @param [#call, nil] on_rejected
       # @return [Promise]
       def then(on_fulfilled = nil, on_rejected = nil)
-        sub_promise = self.class.new
+        sub_promise = Promise.new
         case @state
         when PENDING
           @subscribers << [sub_promise, on_fulfilled, on_rejected]
@@ -92,7 +71,7 @@ module Tilia
       # I would have used the word 'catch', but it's a reserved word in PHP, so
       # we're not allowed to call our function that.
       #
-      # @param [Proc, Method] on_rejected
+      # @param [#call] on_rejected
       # @return [Promise]
       def error(on_rejected)
         self.then(nil, on_rejected)
@@ -169,13 +148,13 @@ module Tilia
       # rejected.
       #
       # @param [Promise] sub_promise
-      # @param [Proc, Method] call_back
+      # @param [#call, nil] call_back
       # @return [void]
       def invoke_callback(sub_promise, call_back = nil)
         if call_back.is_a?(Proc) || call_back.is_a?(Method)
           begin
             result = call_back.call(@value)
-            if result.is_a?(self.class)
+            if result.is_a?(Promise)
               result.then(sub_promise.method(:fulfill), sub_promise.method(:reject))
             else
               sub_promise.fulfill(result)
@@ -183,12 +162,10 @@ module Tilia
           rescue => e
             sub_promise.reject(e.to_s)
           end
+        elsif @state == FULFILLED
+          sub_promise.fulfill(@value)
         else
-          if @state == FULFILLED
-            sub_promise.fulfill(@value)
-          else
-            sub_promise.reject(@value)
-          end
+          sub_promise.reject(@value)
         end
       end
     end

data/lib/tilia/event/promise_already_resolved_exception.rb

@@ -2,7 +2,7 @@ module Tilia
   module Event
     # This exception is thrown when the user tried to reject or fulfill a promise,
     # after either of these actions were already performed.
-    class PromiseAlreadyResolvedException < RuntimeError
+    class PromiseAlreadyResolvedException < StandardError
     end
   end
 end

data/lib/tilia/event/version.rb

@@ -3,7 +3,7 @@ module Tilia
     # This class contains the version number for this package.
     class Version
       # Full version number
-      VERSION = '2.0.2'
+      VERSION = '2.0.2.1'.freeze
     end
   end
 end

data/test/continue_callback_test.rb

@@ -11,13 +11,13 @@ module Tilia
           handler_counter += 1
         end
 
-        ee.on('foo', bla)
-        ee.on('foo', bla)
-        ee.on('foo', bla)
+        ee.on(:foo, bla)
+        ee.on(:foo, bla)
+        ee.on(:foo, bla)
 
         continue_counter = 0
         r = ee.emit(
-          'foo',
+          :foo,
           [],
           lambda do
             continue_counter += 1
@@ -38,13 +38,13 @@ module Tilia
           handler_counter += 1
         end
 
-        ee.on('foo', bla)
-        ee.on('foo', bla)
-        ee.on('foo', bla)
+        ee.on(:foo, bla)
+        ee.on(:foo, bla)
+        ee.on(:foo, bla)
 
         continue_counter = 0
         r = ee.emit(
-          'foo',
+          :foo,
           [],
           lambda do
             continue_counter += 1
@@ -66,13 +66,13 @@ module Tilia
           false
         end
 
-        ee.on('foo', bla)
-        ee.on('foo', bla)
-        ee.on('foo', bla)
+        ee.on(:foo, bla)
+        ee.on(:foo, bla)
+        ee.on(:foo, bla)
 
         continue_counter = 0
         r = ee.emit(
-          'foo',
+          :foo,
           [],
           lambda do
             continue_counter += 1

data/test/event_emitter_test.rb

@@ -12,19 +12,19 @@ module Tilia
         ee = EventEmitter.new
         callback1 = -> {}
         callback2 = -> {}
-        ee.on('foo', callback1, 200)
-        ee.on('foo', callback2, 100)
+        ee.on(:foo, callback1, 200)
+        ee.on(:foo, callback2, 100)
 
-        assert_equal([callback2, callback1], ee.listeners('foo'))
+        assert_equal([callback2, callback1], ee.listeners(:foo))
       end
 
       def test_handle_event
         arg_result = nil
 
         ee = EventEmitter.new
-        ee.on('foo', ->(arg) { arg_result = arg })
+        ee.on(:foo, ->(arg) { arg_result = arg })
 
-        assert(ee.emit('foo', ['bar']))
+        assert(ee.emit(:foo, ['bar']))
         assert_equal('bar', arg_result)
       end
 
@@ -33,15 +33,15 @@ module Tilia
 
         ee = EventEmitter.new
         ee.on(
-          'foo',
+          :foo,
           lambda do |_|
             arg_result = 1
             false
           end
         )
-        ee.on('foo', ->(_) { arg_result = 2 })
+        ee.on(:foo, ->(_) { arg_result = 2 })
 
-        refute(ee.emit('foo', ['bar']))
+        refute(ee.emit(:foo, ['bar']))
         assert_equal(1, arg_result)
       end
 
@@ -50,14 +50,14 @@ module Tilia
 
         ee = EventEmitter.new
         ee.on(
-          'foo',
+          :foo,
           lambda do |_|
             arg_result = 1
             false
           end
         )
         ee.on(
-          'foo',
+          :foo,
           lambda do |_|
             arg_result = 2
             false
@@ -65,7 +65,7 @@ module Tilia
           1
         )
 
-        refute(ee.emit('foo', ['bar']))
+        refute(ee.emit(:foo, ['bar']))
         assert_equal(2, arg_result)
       end
 
@@ -73,12 +73,12 @@ module Tilia
         result = []
         ee = EventEmitter.new
 
-        ee.on('foo', -> { result << 'a' }, 200)
-        ee.on('foo', -> { result << 'b' }, 50)
-        ee.on('foo', -> { result << 'c' }, 300)
-        ee.on('foo', -> { result << 'd' })
+        ee.on(:foo, -> { result << 'a' }, 200)
+        ee.on(:foo, -> { result << 'b' }, 50)
+        ee.on(:foo, -> { result << 'c' }, 300)
+        ee.on(:foo, -> { result << 'd' })
 
-        ee.emit('foo')
+        ee.emit(:foo)
         assert_equal(%w(b d a c), result)
       end
 
@@ -89,15 +89,15 @@ module Tilia
 
         ee = EventEmitter.new
 
-        ee.on('foo', call_back)
-        ee.emit('foo')
+        ee.on(:foo, call_back)
+        ee.emit(:foo)
 
         assert(result)
         result = false
 
-        assert(ee.remove_listener('foo', call_back))
+        assert(ee.remove_listener(:foo, call_back))
 
-        ee.emit('foo')
+        ee.emit(:foo)
         refute(result)
       end
 
@@ -108,15 +108,15 @@ module Tilia
 
         ee = EventEmitter.new
 
-        ee.on('foo', call_back)
-        ee.emit('foo')
+        ee.on(:foo, call_back)
+        ee.emit(:foo)
 
         assert(result)
         result = false
 
         refute(ee.remove_listener('bar', call_back))
 
-        ee.emit('foo')
+        ee.emit(:foo)
         assert(result)
       end
 
@@ -127,16 +127,16 @@ module Tilia
 
         ee = EventEmitter.new
 
-        ee.on('foo', call_back)
-        ee.emit('foo')
+        ee.on(:foo, call_back)
+        ee.emit(:foo)
 
         assert(result)
         result = false
 
-        assert(ee.remove_listener('foo', call_back))
-        refute(ee.remove_listener('foo', call_back))
+        assert(ee.remove_listener(:foo, call_back))
+        refute(ee.remove_listener(:foo, call_back))
 
-        ee.emit('foo')
+        ee.emit(:foo)
         refute(result)
       end
 
@@ -147,15 +147,15 @@ module Tilia
 
         ee = EventEmitter.new
 
-        ee.on('foo', call_back)
-        ee.emit('foo')
+        ee.on(:foo, call_back)
+        ee.emit(:foo)
 
         assert(result)
         result = false
 
-        ee.remove_all_listeners('foo')
+        ee.remove_all_listeners(:foo)
 
-        ee.emit('foo')
+        ee.emit(:foo)
         refute(result)
       end
 
@@ -166,15 +166,15 @@ module Tilia
 
         ee = EventEmitter.new
 
-        ee.on('foo', call_back)
-        ee.emit('foo')
+        ee.on(:foo, call_back)
+        ee.emit(:foo)
 
         assert(result)
         result = false
 
         ee.remove_all_listeners
 
-        ee.emit('foo')
+        ee.emit(:foo)
         refute(result)
       end
 
@@ -184,10 +184,10 @@ module Tilia
         call_back = -> { result += 1 }
 
         ee = EventEmitter.new
-        ee.once('foo', call_back)
+        ee.once(:foo, call_back)
 
-        ee.emit('foo')
-        ee.emit('foo')
+        ee.emit(:foo)
+        ee.emit(:foo)
 
         assert_equal(1, result)
       end
@@ -197,14 +197,14 @@ module Tilia
 
         ee = EventEmitter.new
         ee.once(
-          'foo',
+          :foo,
           lambda do |_|
             arg_result = 1
             false
           end
         )
         ee.once(
-          'foo',
+          :foo,
           lambda do |_|
             arg_result = 2
             false
@@ -212,7 +212,7 @@ module Tilia
           1
         )
 
-        refute(ee.emit('foo', ['bar']))
+        refute(ee.emit(:foo, ['bar']))
         assert_equal(2, arg_result)
       end
     end

data/test/promise_test.rb

@@ -75,8 +75,8 @@ module Tilia
 
       def test_executor_success
         real_result = ''
-        _promise = (
-          Promise.new(->(success, _failing) { success.call('hi') })
+        Promise.new(
+          ->(success, _failing) { success.call('hi') }
         ).then(
           ->(result) { real_result = result }
         )
@@ -86,8 +86,8 @@ module Tilia
 
       def test_executor_fail
         real_result = ''
-        _promise = (
-          Promise.new(->(_success, failing) { failing.call('hi') })
+        Promise.new(
+          ->(_success, failing) { failing.call('hi') }
         ).then(
           ->(_result) { real_result = 'incorrect' },
           ->(reason) { real_result = reason }
@@ -113,7 +113,7 @@ module Tilia
         promise = Promise.new
         promise.error(
           lambda do |reason|
-            assert_equal('foo', reason)
+            assert_equal(:foo, reason)
             fail 'hi'
           end
         ).then(
@@ -122,7 +122,7 @@ module Tilia
         )
 
         assert_equal(0, ok)
-        promise.reject('foo')
+        promise.reject(:foo)
         assert_equal(1, ok)
       end
 
@@ -148,7 +148,7 @@ module Tilia
         final_value = 0
         Promise.all([promise1, promise2]).then(
           lambda do |_value|
-            final_value = 'foo'
+            final_value = :foo
             'test'
           end,
           ->(value) { final_value = value }

data/tilia-event.gemspec

@@ -9,5 +9,5 @@ Gem::Specification.new do |s|
   s.email       = 'tilia@jakobsack.de'
   s.files       = `git ls-files`.split("\n")
   s.homepage    = 'https://github.com/tilia/tilia-event'
-  s.add_runtime_dependency 'activesupport', '~> 4.2'
+  s.add_runtime_dependency 'activesupport', '>= 4.0'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: tilia-event
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.2.1
 platform: ruby
 authors:
 - Jakob Sack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-22 00:00:00.000000000 Z
+date: 2016-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '4.0'
 description: tilia-event is a library for lightweight event-based programming.
 email: tilia@jakobsack.de
 executables: []