evil_events 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ca82399f2d2f7e433c6dd9c111d2a6c3c285940
-  data.tar.gz: 445c719e88bb2f1ff12720b8aec3fc62c451ef91
+  metadata.gz: e81af2ef5e25afbc5c4364b377c2b70720fa3d41
+  data.tar.gz: d9adbc345247a59247f3ac6b33ea09eefd604b4c
 SHA512:
-  metadata.gz: c3ea9dfd03ec8f792d926d83ed2f014cc22ce8bb42d8730e626473ffb48d28bbfe2d2bdb990b9d2d279d8a3fc7a3fcb32d8d0c0ac2304a94a1a1418d096d57c6
-  data.tar.gz: 4aa79a4f86765a4babbbc9aaea8c7a0947cc1f653a8c484b2496bc71daff8ce1a385b01c5665a265174f9f89a0f436a028a6b3f87022f17b9b6219bb69d27214
+  metadata.gz: dd67713c85af8fee6105d6df4d989a1060b527a125005e0fd7b113c73edbcfa9c033293b70798e0e2d33ebb3feb5a68044e0cadf71b49e773068b75f989de449
+  data.tar.gz: 67b06826b3ead1501c3b3c2b3d741d2addaf5a03d1752991ae176457f69c85f165adc65e7f4d6a857b912cb6557c772f3b5f70fa9ff101f20395aaf9d40a2e72

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -53,9 +53,18 @@ Style/ParallelAssignment:
 Style/CommentedKeyword:
   Enabled: false
 
+Style/EvalWithLocation:
+  Enabled: false
+
 Lint/AmbiguousRegexpLiteral:
   Enabled: false
 
+Lint/HandleExceptions:
+  Enabled: false
+
+Lint/UnusedBlockArgument:
+  Enabled: false
+
 Naming/FileName:
   Enabled: false
 
@@ -104,3 +113,6 @@ RSpec/LetSetup:
 
 RSpec/AnyInstance:
   Enabled: false
+
+RSpec/ExpectChange:
+  Enabled: false

data/.travis.yml

@@ -1,12 +1,13 @@
 language: ruby
 rvm:
+- 2.2.8
 - 2.3.5
 - 2.4.2
-- 2.2.8
+- 2.5.0
 - ruby-head
 - jruby-head
 
 sudo: false
-before_install: gem install bundler -v 1.15.3
+before_install: gem install bundler
 cache: bundler
 script: bundle exec rspec

data/CHANGELOG.md

@@ -1,6 +1,24 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.3.0] - 2018-02-25
+### Added
+- Support for Ruby 2.5.0
+- Introduce Event Emition Hooks API. Supported hooks (are decalred in an event class):
+  - `before_emit -> (event) {} # proc/lambda` - invoked once before an event emition process;
+  - `after_emit -> (event) {} # proc/lambda` - invoked once after an event emition process;
+  - `on_error -> (event, error) {} # proc/lambda` - invoked on each raised error due to emition process
+    (usually these errors are raised by subscribers and their's event processing methods)
+- Added `AbstractEvent.emit!(**event_attributes)` method to provide an ability to emit events via event class constant.
+
+### Changed
+- New more convenient exception hierarchy: now all exceptions live under `EvilEvents` namespace.
+- Full refactoring of the event notification abstraction. New types of notifying processes:
+  - `sequential` (single-threaded): ordered notification logic, subscribers are notified one after the other;
+  - `worker` (multi-threaded): unordered notification logic, each subscriber is notified in own thread (depending on the settings);
+  - Process type should be globally pre-configured before application startup (new configuration options for each type of process);
+  - Notifier can be restarted via `EvilEvents::Application.restart_event_notifier` (it would be convenient to have an ability to reload/restart notifier object in development mode interactively).
+
 ## [0.2.0] - 2017-11-19
 ### Added
 - Support for custom coercive types:

data/evil_events.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   end
 
   spec.add_dependency 'dry-monads',       '~> 0.4.0'
-  spec.add_dependency 'dry-types',        '~> 0.12.1'
+  spec.add_dependency 'dry-types',        '~> 0.12.2'
   spec.add_dependency 'dry-struct',       '~> 0.3.1'
   spec.add_dependency 'dry-configurable', '~> 0.7.0'
   spec.add_dependency 'dry-container',    '~> 0.6.0'
@@ -36,9 +36,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'coveralls',      '~> 0.8.21'
   spec.add_development_dependency 'simplecov',      '~> 0.14.1'
   spec.add_development_dependency 'simplecov-json', '~> 0.2'
-  spec.add_development_dependency 'rubocop',        '~> 0.51.0'
+  spec.add_development_dependency 'rubocop',        '~> 0.52.1'
   spec.add_development_dependency 'rspec',          '~> 3.7.0'
-  spec.add_development_dependency 'rubocop-rspec',  '~> 1.20.1'
+  spec.add_development_dependency 'rubocop-rspec',  '~> 1.23.0'
 
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake'

data/lib/evil_events/application.rb

@@ -11,6 +11,13 @@ module EvilEvents
       def registered_events
         EvilEvents::Core::Bootstrap[:event_system].registered_events
       end
+
+      # @see EvilEvents::Core::System
+      # @api public
+      # @since 0.3.0
+      def restart_event_notifier
+        EvilEvents::Core::Bootstrap[:event_system].restart_event_notifier
+      end
     end
   end
 end

data/lib/evil_events/core/broadcasting/emitter.rb

@@ -4,18 +4,16 @@ module EvilEvents::Core::Broadcasting
   # @api private
   # @since 0.1.0
   class Emitter
-    # @since 0.1.0
-    EmitterError = Class.new(EvilEvents::Core::Error)
-    # @since 0.1.0
-    IncorrectEventError = Class.new(EmitterError)
-
     # @param event [EvilEvents::Core::Events::AbstractEvent]
-    # @raise [IncorrectEventError]
+    # @raise [EvilEvents::IncorrectEventForEmitError]
     # @return void
     #
     # @since 0.1.0
     def emit(event)
-      raise IncorrectEventError unless event.is_a?(EvilEvents::Core::Events::AbstractEvent)
+      unless event.is_a?(EvilEvents::Core::Events::AbstractEvent)
+        raise EvilEvents::IncorrectEventForEmitError
+      end
+
       log_activity(event)
       event.adapter.call(event)
     end

data/lib/evil_events/core/config.rb

@@ -14,7 +14,7 @@ module EvilEvents::Core
 
     # @api private
     # @since 0.1.0
-    def initialize
+    def initialize # rubocop:disable Metrics/AbcSize
       @config = Module.new do
         extend EvilEvents::Shared::Configurable
 
@@ -27,6 +27,21 @@ module EvilEvents::Core
         end
 
         setting :logger, EvilEvents::Shared::Logger.new(STDOUT), reader: true
+
+        setting :notifier, reader: true do
+          setting :type, :sequential
+
+          setting :sequential, reader: true do
+            # NOTE: place future settings here
+          end
+
+          setting :worker, reader: true do
+            setting :min_threads, 0
+            setting :max_threads, 5
+            setting :max_queue, 1000
+            setting :fallback_policy, :main_thread
+          end
+        end
       end
     end
 

data/lib/evil_events/core/events/abstract_event.rb

@@ -23,6 +23,8 @@ module EvilEvents::Core::Events
     include EventExtensions::MetadataExtendable
     # @sicne 0.2.0
     include EventExtensions::ClassSignature
+    # @since 0.3.0
+    include EventExtensions::Hookable
     # @since 0.1.0
     extend EvilEvents::Shared::CombinedContext::Mixin
 

data/lib/evil_events/core/events/event_extensions/class_signature/signature.rb

@@ -34,7 +34,7 @@ module EvilEvents::Core::Events::EventExtensions::ClassSignature
     #
     # @since 0.2.0
     def class_stamp
-      { name: event_class.name, creation_strategy: event_class.__creation_strategy }
+      { name: event_class.name, creation_strategy: event_class.__creation_strategy__ }
     end
 
     # @return [String]

data/lib/evil_events/core/events/event_extensions/class_signature.rb

@@ -12,7 +12,7 @@ module EvilEvents::Core::Events::EventExtensions
         base_class.extend(ClassMethods)
 
         base_class.singleton_class.class_eval do
-          attr_accessor :__creation_strategy
+          attr_accessor :__creation_strategy__
         end
       end
     end

data/lib/evil_events/core/events/event_extensions/emittable.rb

@@ -4,9 +4,38 @@ module EvilEvents::Core::Events::EventExtensions
   # @api private
   # @since 0.1.0
   module Emittable
+    class << self
+      # @param base_class [Class{AbstractEvent}]
+      #
+      # @api private
+      # @since 0.3.0
+      def included(base_class)
+        base_class.extend(ClassMethods)
+      end
+    end
+
+    # @return void
+    #
+    # @api public
     # @since 0.1.0
     def emit!
       EvilEvents::Core::Bootstrap[:event_system].emit(self)
     end
+
+    module ClassMethods
+      # @option id [NilClass, Object]
+      # @option payload [Hash]
+      # @option metadata [Hash]
+      # @return void
+      #
+      # @see EvilEvents::Core::Events::AbstractEvent#initialize
+      # @see EvilEvents::Core::Events::EventExtensions::Emittable#emit!
+      #
+      # @api public
+      # @since 0.3.0
+      def emit!(**event_attributes)
+        new(**event_attributes).emit!
+      end
+    end
   end
 end

data/lib/evil_events/core/events/event_extensions/hookable/abstract_hook.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module EvilEvents::Core::Events::EventExtensions::Hookable
+  # @api private
+  # @since 0.3.0
+  class AbstractHook
+    # @return [#call]
+    #
+    # @since 0.3.0
+    attr_reader :callable
+
+    # @param callable [#call]
+    #
+    # @since 0.3.0
+    def initialize(callable)
+      @callable = callable
+    end
+
+    # @param source [Object]
+    # @return void
+    #
+    # @since 0.3.0
+    def call(source)
+      callable.call(source)
+    end
+  end
+end

data/lib/evil_events/core/events/event_extensions/hookable/after_emit_hook.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module EvilEvents::Core::Events::EventExtensions::Hookable
+  # @api private
+  # @since 0.3.0
+  class AfterEmitHook < AbstractHook
+    # @!method call(source)
+    #   @param source [EvilEvents::Core::Events::AbstractEvent]
+    #   @return void
+  end
+end

data/lib/evil_events/core/events/event_extensions/hookable/before_emit_hook.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module EvilEvents::Core::Events::EventExtensions::Hookable
+  # @api private
+  # @since 0.3.0
+  class BeforeEmitHook < AbstractHook
+    # @!method call(source)
+    #   @param source [EvilEvents::Core::Events::AbstractEvent]
+    #   @return void
+  end
+end

data/lib/evil_events/core/events/event_extensions/hookable/on_error_hook.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module EvilEvents::Core::Events::EventExtensions::Hookable
+  # @api private
+  # @since 0.3.0
+  class OnErrorHook < AbstractHook
+    # @param event [EvilEvents::Core::Events::AbstractEvent]
+    # @param error [StandardError]
+    # @return void
+    #
+    # @since 0.3.0
+    def call(event, error)
+      callable.call(event, error)
+    end
+  end
+end

data/lib/evil_events/core/events/event_extensions/hookable.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module EvilEvents::Core::Events::EventExtensions
+  # @api private
+  # @since 0.3.0
+  module Hookable
+    class << self
+      # @param base_class [Class]
+      #
+      # @since 0.3.0
+      def included(base_class)
+        base_class.extend(ClassMethods)
+      end
+    end
+
+    # @param error [StandardError]
+    #
+    # @api private
+    # @since 0.3.0
+    def __call_on_error_hooks__(error)
+      self.class.__on_error_hooks__.each do |hook|
+        hook.call(self, error)
+      end
+    end
+
+    # @api private
+    # @since 0.3.0
+    def __call_before_hooks__
+      self.class.__before_emit_hooks__.each do |hook|
+        hook.call(self)
+      end
+    end
+
+    # @api private
+    # @since 0.3.0
+    def __call_after_hooks__
+      self.class.__after_emit_hooks__.each do |hook|
+        hook.call(self)
+      end
+    end
+
+    # @since 0.3.0
+    module ClassMethods
+      # @param hook [#call]
+      #
+      # @api public
+      # @since 0.3.0
+      def before_emit(hook)
+        __before_emit_hooks__ << BeforeEmitHook.new(hook)
+      end
+
+      # @param hook [#call]
+      #
+      # @api public
+      # @since 0.3.0
+      def after_emit(hook)
+        __after_emit_hooks__ << AfterEmitHook.new(hook)
+      end
+
+      # @param hook [#call]
+      #
+      # @api public
+      # @since 0.3.0
+      def on_error(hook)
+        __on_error_hooks__ << OnErrorHook.new(hook)
+      end
+
+      # @return [Concurrent::Array<BeforeHook>]
+      #
+      # @api private
+      # @since 0.3.0
+      def __before_emit_hooks__
+        @__before_emit_hooks__ ||= Concurrent::Array.new
+      end
+
+      # @return [Concurrent::Array<AfterHook>]
+      #
+      # @api private
+      # @since 0.3.0
+      def __after_emit_hooks__
+        @__after_emit_hooks__ ||= Concurrent::Array.new
+      end
+
+      # @return [Concurrent::Array<OnErrorHook>]
+      #
+      # @api private
+      # @since 0.3.0
+      def __on_error_hooks__
+        @__on_error_hooks__ ||= Concurrent::Array.new
+      end
+    end
+  end
+end

data/lib/evil_events/core/events/event_extensions/type_aliasing.rb

@@ -4,15 +4,6 @@ module EvilEvents::Core::Events::EventExtensions
   # @api private
   # @since 0.1.0
   module TypeAliasing
-    # @since 0.1.0
-    TypeAliasingError = Class.new(EvilEvents::Core::Error)
-    # @since 0.1.0
-    IncopatibleEventTypeError = Class.new(TypeAliasingError)
-    # @since 0.1.0
-    EventTypeNotDefinedError = Class.new(TypeAliasingError)
-    # @since 0.1.0
-    EventTypeAlreadyDefinedError = Class.new(TypeAliasingError)
-
     class << self
       # @param base_class [Class]
       #
@@ -31,17 +22,20 @@ module EvilEvents::Core::Events::EventExtensions
 
     module ClassMethods
       # @param type_alias [String, NilClass]
+      # @raise [EvilEvents::IncopatibleEventTypeError]
+      # @raise [EvilEvents::EventTypeNotDefinedError]
+      # @raise [EvilEvents::EventTypeAlreadyDefinedError]
       # @return [String]
       #
       # @since 0.1.0
       def type(type_alias = nil)
         case
         when incompatible_type_alias_type?(type_alias)
-          raise IncopatibleEventTypeError
+          raise EvilEvents::IncopatibleEventTypeError
         when fetching_type_alias_when_type_alias_not_defined?(type_alias)
-          raise EventTypeNotDefinedError
+          raise EvilEvents::EventTypeNotDefinedError
         when providing_type_alias_when_type_alias_already_defined?(type_alias)
-          raise EventTypeAlreadyDefinedError
+          raise EvilEvents::EventTypeAlreadyDefinedError
         when tries_to_define_type_alias_first_time?(type_alias)
           @type = type_alias
         end

data/lib/evil_events/core/events/event_factory.rb

@@ -19,14 +19,14 @@ module EvilEvents::Core::Events
     def create_abstract_class(event_type)
       Class.new(AbstractEvent).tap do |klass|
         klass.type(event_type)
-        klass.__creation_strategy = CLASS_INHERITANCE_STRATEGY
+        klass.__creation_strategy__ = CLASS_INHERITANCE_STRATEGY
 
         class << klass
           def inherited(child_class)
             child_class.type(type)
-            child_class.__creation_strategy = CLASS_INHERITANCE_STRATEGY
+            child_class.__creation_strategy__ = CLASS_INHERITANCE_STRATEGY
             child_class.manage!
-          rescue EvilEvents::Core::Events::ManagerRegistry::AlreadyManagedEventClassError
+          rescue EvilEvents::AlreadyManagedEventClassError
             EvilEvents::Core::Bootstrap[:event_system].unregister_event_class(child_class)
             raise
           end
@@ -44,7 +44,7 @@ module EvilEvents::Core::Events
     def create_class(event_type, &event_class_definitions)
       Class.new(AbstractEvent).tap do |klass|
         begin
-          klass.__creation_strategy = PROC_EVAL_STRATEGY
+          klass.__creation_strategy__ = PROC_EVAL_STRATEGY
           klass.type(event_type)
           klass.manage!
           klass.evaluate(&event_class_definitions) if block_given?

data/lib/evil_events/core/events/manager.rb

@@ -4,13 +4,6 @@ module EvilEvents::Core::Events
   # @api private
   # @since 0.1.0
   class Manager
-    # @since 0.1.0
-    ManagerError = Class.new(EvilEvents::Core::Error)
-    # @since 0.1.0
-    InconsistentEventClassError = Class.new(ManagerError)
-    # @since 0.1.0
-    InvalidDelegatorTypeError = Class.new(ManagerError)
-
     # @return [EvilEvents::Core::Events::AbstractEvent]
     #
     # @since 0.1.0
@@ -31,7 +24,7 @@ module EvilEvents::Core::Events
 
     # @param raw_subscriber [Object]
     # @param delegator [Symbol, String, NilClass]
-    # @raise [InvalidDelegatorTypeError]
+    # @raise [EvilEvents::InvalidDelegatorTypeError]
     # @return void
     #
     # @since 0.1.0
@@ -40,19 +33,20 @@ module EvilEvents::Core::Events
       when NilClass, Symbol, String
         subscribers.push(create_event_subscriber(raw_subscriber, delegator))
       else
-        raise InvalidDelegatorTypeError
+        raise EvilEvents::InvalidDelegatorTypeError
       end
     end
 
     # @param event [EvilEvents::Core::Events::AbstractEvent]
-    # @raise [Notifier::InconsistentEventClassError]
-    # @raise [Notifier::FailedSubscribersError]
+    # @raise [EvilEvents::InconsistentEventClassError]
+    # @raise [EvilEvents::FailedNotifiedSubscribersError]
     #
     # @return void
     #
     # @since 0.1.0
     def notify(event)
-      Notifier.run(self, event)
+      raise EvilEvents::InconsistentEventClassError unless supported_event?(event)
+      EvilEvents::Core::Bootstrap[:event_system].process_event_notification(self, event)
     end
 
     # @return [String, Symbol]
@@ -64,6 +58,14 @@ module EvilEvents::Core::Events
 
     private
 
+    # @param event [EvilEvents::Core::Events::AbstractEvent]
+    # @return [Boolean]
+    #
+    # @since 0.3.0
+    def supported_event?(event)
+      event.is_a?(event_class)
+    end
+
     # @param raw_subscriber [Object]
     # @param delegator [Symbol, String, NilClass]
     # @return [EvilEvents::Core::Events::Subscriber]

data/lib/evil_events/core/events/manager_factory.rb

@@ -4,20 +4,15 @@ module EvilEvents::Core::Events
   # @api private
   # @since 0.1.0
   module ManagerFactory
-    # @since 0.1.0
-    ManagerFactoryError = Class.new(EvilEvents::Core::Error)
-    # @since 0.1.0
-    IncorrectEventClassError = Class.new(ManagerFactoryError)
-
     class << self
       # @param event_class [Class{EvilEvents::Core::Events::AbstractEvent}]
-      # @raise [IncorrectEventClassError]
+      # @raise [EvilEvents::IncorrectEventClassError]
       # @return [EvilEvents::Core::Events::Manager]
       #
       # @since 0.1.0
       def create(event_class)
         unless event_class.is_a?(Class) && event_class < EvilEvents::Core::Events::AbstractEvent
-          raise IncorrectEventClassError
+          raise EvilEvents::IncorrectEventClassError
         end
 
         Manager.new(event_class)

data/lib/evil_events/core/events/manager_registry.rb

@@ -7,15 +7,6 @@ module EvilEvents::Core::Events
     # @since 0.1.0
     extend Forwardable
 
-    # @since 0.1.0
-    ManagerRegistryError = Class.new(EvilEvents::Core::Error)
-    # @since 0.1.0
-    IncorrectManagerObjectError = Class.new(ManagerRegistryError)
-    # @since 0.1.0
-    NonManagedEventClassError = Class.new(ManagerRegistryError)
-    # @since 0.1.0
-    AlreadyManagedEventClassError = Class.new(ManagerRegistryError)
-
     # @since 0.1.0
     def_delegators :managers, :empty?, :size
 
@@ -30,13 +21,13 @@ module EvilEvents::Core::Events
     end
 
     # @param event_class [Class{EvilEvents::Core::Events::AbstractEvent}]
-    # @raise [NonManagedEventClassError]
+    # @raise [EvilEvents::NonManagedEventClassError]
     # @return [EvilEvents::Core::Events::Manager]
     #
     # @since 0.1.0
     def manager_of_event(event_class)
       # NOTE: raise exceptions to simplify runtime problems
-      managers[event_class] || (raise NonManagedEventClassError)
+      managers[event_class] || (raise EvilEvents::NonManagedEventClassError)
     end
 
     # @param event_type [String]
@@ -77,18 +68,20 @@ module EvilEvents::Core::Events
     end
 
     # @param manager [EvilEvents::Core::Events::Manager]
-    # @raise [IncorrectManagerObjectError]
-    # @raise [AlreadyManagedEventClassError]
+    # @raise [EvilEvents::IncorrectManagerObjectError]
+    # @raise [EvilEvents::AlreadyManagedEventClassError]
     # @return void
     #
     # @since 0.1.0
     def register(manager)
-      raise IncorrectManagerObjectError unless manager.is_a?(EvilEvents::Core::Events::Manager)
+      unless manager.is_a?(EvilEvents::Core::Events::Manager)
+        raise EvilEvents::IncorrectManagerObjectError
+      end
 
       if potential_manager_duplicate?(manager) || !managed_event_type?(manager.event_type)
         managers[manager.event_class] = manager
       else
-        raise AlreadyManagedEventClassError
+        raise EvilEvents::AlreadyManagedEventClassError
       end
     end
 

data/lib/evil_events/core/events/notifier/abstract.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.3.0
+class EvilEvents::Core::Events::Notifier::Abstract
+  # @param options [Hash]
+  #
+  # @api private
+  # @since 0.3.0
+  def initialize(**options); end
+
+  # @param manager [EvilEvents::Core::Events::Manager]
+  # @param event [EvilEvents::Core::Events::AbstractEvent]
+  #
+  # @api private
+  # @since 0.3.0
+  def notify(manager, event); end
+
+  # @api private
+  # @since 0.3.0
+  def restart!; end
+
+  # @api private
+  # @since 0.3.0
+  def shutdown!; end
+end