evil_events 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a6865070862de35490cfff6007e0c034c95436a6
-  data.tar.gz: ab3eae931b6e1c9ec8b8c3c3725fd7f70a79993b
+SHA256:
+  metadata.gz: ebb72755c7492ae455bb03f369b5751a39afdcccda53ad047b820233a82e511c
+  data.tar.gz: 8c603db8c385f308b674a8f34bf2b18c9ac14973c2cbab875b7c017500ec7384
 SHA512:
-  metadata.gz: de6d15423662b1eb23e34e699ee91565d186c0487c24ee0585c738077bd526a9607f9c5d68c554c83b0e2e99734fef4c147f72efbaa39b2179ba6ed4253c5ade
-  data.tar.gz: 16e42671c7a962619d163173d96515859914ea6d65c2714b1e6e7aac5f26c261465f30758b8ef265538cecfba7230e27d45f90d811f2ded84887d4e09df3f5d5
+  metadata.gz: 5c9a12d72f309306e5ebbd5284998715574196e57a643809cdb9f45daa4a9595c8b446d31460557c14ea72795aae42079fd0d86239ef0aba0eec5fb4645533b9
+  data.tar.gz: 13d6e35c94e8700cb49779a593cd8825c1bd50713165fc1524b2a13135bb4ef4418ad185f0f5fe2b443c79502159bb23660f8a70ffc694f7536e2c187094cc34

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 .rspec_status
+.ruby-version

data/.rubocop.yml

@@ -3,7 +3,7 @@ require: rubocop-rspec
 AllCops:
   DisplayCopNames:   true
   DisplayStyleGuide: true
-  TargetRubyVersion: 2.4.2
+  TargetRubyVersion: 2.4.4
   Include:
     - lib/**/*
     - spec/**/*
@@ -56,6 +56,12 @@ Style/CommentedKeyword:
 Style/EvalWithLocation:
   Enabled: false
 
+Style/RegexpLiteral:
+  EnforcedStyle: mixed
+
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
 Lint/AmbiguousRegexpLiteral:
   Enabled: false
 
@@ -71,6 +77,9 @@ Naming/FileName:
 Naming/VariableNumber:
   EnforcedStyle: snake_case
 
+Naming/UncommunicativeMethodParamName:
+  Enabled: false
+
 Metrics/LineLength:
   Max: 100
 

data/.travis.yml

@@ -1,11 +1,10 @@
 language: ruby
 rvm:
-- 2.2.8
-- 2.3.5
-- 2.4.2
-- 2.5.0
+- 2.2.10
+- 2.3.7
+- 2.4.4
+- 2.5.1
 - ruby-head
-- jruby-head
 
 sudo: false
 before_install: gem install bundler

data/CHANGELOG.md

@@ -1,6 +1,79 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.4.0] - 2018-05-02
+### Added
+- **Routing Key Based Event Types**. A new way of subscribing to events and approach to event naming: routing-key-based event naming;
+  - Event names must be named in the routing-key style;
+  - New method for subscription: `EvilEvents::SubscriberMixin#subscribe_to_scope(*event_scopes, delegator: nil)`;
+  - Event subscription follows this pattern:
+    - `*` - manadtory presence of the event scope (this pattern requires an event scope presence);
+    - `#` - any count of event scopes (zero or more) (this pattern doesnt require an event scope presence);
+    - `.` - event scope splitter;
+    - `other symbols` - chars for event scope names;
+  - Example (our events: `user`, `user.created`, `user.created.tomorrow`, `deposit`, `deposit.created`, `created`, `created.today`):
+    - `user.#` - all event types starting with `user` (`user`, `user.created`, `user.created.tomorrow`);
+    - `user.*` - all events with only TWO parts. `user` part is required (`user.created`);
+    - `*.created.#` => `user.created.tomorrow`, `user.created`, `deposit.created`;
+    - `#.created.*` => `user.created.tomorrow`, `user.created`, `created`, `created.today`, `deposit.created`;
+    - `#` => all events;
+    - `*` => events with only one part in name: `user`, `deposit`, `created`;
+    - and etc;
+- Support for Ruby `2.2.10`, `2.3.7`, `2.4.4`, `2.5.1`;
+- Ability to broadcast events via any registered adapter by explicitly passed `:adapter` attribute in emition methods:
+  - `EvilEvents::Emitter.emit('your_event_type', adapter: :your_adapter_identifier, **event_attrs)`;
+  - `YourEventClass.emit!(adapter: :your_adapter_identifier, **event_attrs)`;
+  - `your_event.emit!(adapter: :your_adapter_identifier)`;
+- Added XML event serialization format (no more JRuby at this moment **:(**):
+  - `EvilEvents::Serializer.load_from_xml(xml)` - returns an event object;
+  - `your_event.serialize_to_xml` - returns xml string;
+  - `your_event.dump_to_xml` - returns xml string (`serialize_to_xml` alias);
+- Added MessagePack event serialization format (no more JRuby at this moment **:(**):
+  - `EvilEvents::Serializer.load_from_msgpack(message)` - returns an event object;
+  - `your_event.serialize_to_msgpack` - returns messagepack string;
+  - `your_event.dump_to_msgpack` - returns messagepack string (`serialize_to_msgpack` alias);
+- Added an ability to check an event object similarity:
+  - `your_event.similar_to?(another_event)` - `returns` true if `another_event` has equal id/type/metadata/paylaod
+    attributes (and interface) - otherwise returns `false`.
+
+### Changed
+- Removed `EvilEvents::Shared::Configurable` => `EvilEvents::Shared::AnyConfig` is used instead (smart dry-configurable wrapper);
+- Removed `EvilEvents::Shared::CombinedContext` class and submodules => `Symbiont` is used instead (gem `symbiont-ruby`);
+- Refactored event serialization abstraction:
+  - Each event serializer represents a complex logic now and is constructed by a set of objects:
+    - engines - low-level data-transformers, works with event serialization state (event data mapper);
+    - packer - responsible for serialization via corresponding engine  (works with events and event serialization state);
+    - unpacker - responsible for deserialization logic via corresponding engine (works with low-level data and event serialization state);
+    - serializers container;
+    - config - configuration point of the each serializer;
+    - event serialization state - event data mapper (id, type, payload, metadata), engines works with this state;
+  - Supported engines:
+    - Hash (`:native`) - based on ::Hash class;
+    - JSON (`:native`) - based on ::JSON class;
+    - MessagePack (`:mpacker`) - based on MessagePack gem;
+    - XML (`:ox`) - based on Ox gem;
+  - Added configuration points for the each type of serializer:
+    - `EvilEvents::Config.options.serializers` - root
+    - `EvilEvents::Config.options.serializers.json.engine` - `:native` by default;
+    - `EvilEvents::Config.options.serializers.hashing.enigne` - `:native` by default;
+    - `EvilEvents::Config.options.serializers.xml.engine` - `:native` by default;
+    - `EvilEvents::Config.options.serializers.msgpack.engine` - `:mpacker` by default;
+    - `EvilEvents::Config.options.serializers.msgpack.mpacker.configurator` - `->(engine) {}` by default;
+- Added specific serialization error classes (inherited from `EvilEvents::SerializationError`/`EvilEvents::DeserializationError` respectively):
+  - `EvilEvents::SerializersError`
+  - `EvilEvents::SerializationError`
+  - `EvilEvents::JSONSerializationError`
+  - `EvilEvents::XMLSerializationError`
+  - `EvilEvents::HashSerializationError`
+  - `EvilEvents::MessagePackSerializationError`
+  - `EvilEvents::DeserializationError`
+  - `EvilEvents::JSONDeserializationError`
+  - `EvilEvents::XMLDeserializationError`
+  - `EvilEvents::HashDeserializationError`
+  - `EvilEvents::MessagePackDeserializationError`
+  - `EvilEvents::SerializationEngineError`
+  - `EvilEvents::UnrecognizedSerializationEngineError`
+
 ## [0.3.1] - 2018-03-01
 ### Fixed
 - A problem with Forwardable constant resolution when it cant be resolved due to dynamic definition in error classes (NameError fix).

data/evil_events.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'evil_events/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = '>= 2.2.7'
+  spec.required_ruby_version = '>= 2.2.10'
 
   spec.name        = 'evil_events'
   spec.version     = EvilEvents::VERSION
@@ -32,13 +32,16 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'dry-configurable', '~> 0.7.0'
   spec.add_dependency 'dry-container',    '~> 0.6.0'
   spec.add_dependency 'concurrent-ruby',  '~> 1.0.5'
+  spec.add_dependency 'symbiont-ruby',    '~> 0.2.0'
+  spec.add_dependency 'ox',               '~> 2.9.2'
+  spec.add_dependency 'msgpack',          '~> 1.2.4'
 
   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.52.1'
+  spec.add_development_dependency 'rubocop',        '~> 0.55.0'
   spec.add_development_dependency 'rspec',          '~> 3.7.0'
-  spec.add_development_dependency 'rubocop-rspec',  '~> 1.23.0'
+  spec.add_development_dependency 'rubocop-rspec',  '~> 1.25.1'
 
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake'

data/lib/evil_events.rb

@@ -6,10 +6,13 @@ require 'dry-struct'
 require 'dry-types'
 require 'concurrent/array'
 require 'concurrent/map'
+require 'symbiont'
 require 'securerandom'
 require 'forwardable'
+require 'msgpack'
 require 'logger'
 require 'json'
+require 'ox'
 
 # @api public
 # @since 0.1.0

data/lib/evil_events/core/broadcasting.rb

@@ -10,5 +10,6 @@ module EvilEvents::Core
     require_relative 'broadcasting/adapters/memory_sync'
     require_relative 'broadcasting/adapters/memory_async'
     require_relative 'broadcasting/emitter'
+    require_relative 'broadcasting/emitter/adapter_proxy'
   end
 end

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

@@ -5,41 +5,47 @@ module EvilEvents::Core::Broadcasting
   # @since 0.1.0
   class Emitter
     # @param event [EvilEvents::Core::Events::AbstractEvent]
+    # @option adapter [Symbol,NilClass]
     # @raise [EvilEvents::IncorrectEventForEmitError]
-    # @return void
+    # @return [void]
     #
     # @since 0.1.0
-    def emit(event)
+    def emit(event, adapter: nil)
       unless event.is_a?(EvilEvents::Core::Events::AbstractEvent)
         raise EvilEvents::IncorrectEventForEmitError
       end
 
-      log_activity(event)
-      event.adapter.call(event)
+      adapter_proxy = AdapterProxy.new(event, explicit_identifier: adapter)
+
+      log_activity(event, adapter_proxy)
+      adapter_proxy.broadcast!
     end
 
     # @param event_type [String]
-    # @param event_attributes [Hash]
-    # @return void
+    # @option id [NilClass,String]
+    # @option payload [Hash]
+    # @option metadata [Hash]
+    # @option adapter [Symbol,NilClass]
+    # @return [void]
     #
     # @since 0.1.0
-    def raw_emit(event_type, **event_attributes)
+    def raw_emit(event_type, id: nil, payload: {}, metadata: {}, adapter: nil)
       event_object = EvilEvents::Core::Bootstrap[:event_system].resolve_event_object(
-        event_type,
-        **event_attributes
+        event_type, id: id, payload: payload, metadata: metadata
       )
 
-      emit(event_object)
+      emit(event_object, adapter: adapter)
     end
 
     private
 
     # @param event [EvilEvents::Core::Events::AbstractEvent]
-    # @return void
+    # @param adapter_proxy [EvilEvents::Core::Broadcasting::Emitter::AdapterProxy]
+    # @return [void]
     #
     # @since 0.1.0
-    def log_activity(event)
-      activity = "EventEmitted(#{event.adapter_name})"
+    def log_activity(event, adapter_proxy)
+      activity = "EventEmitted(#{adapter_proxy.identifier})"
       message  = "ID: #{event.id} :: " \
                  "TYPE: #{event.type} :: " \
                  "PAYLOAD: #{event.payload} :: " \

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+class EvilEvents::Core::Broadcasting::Emitter
+  # @api private
+  # @since 0.4.0
+  class AdapterProxy
+    # @return [Symbol]
+    #
+    # @api private
+    # @since 0.4.0
+    attr_reader :identifier
+
+    # @param event [EvilEvents::Core::Events::AbstractEvent]
+    # @option explicit_identifier [Symbol,NilClass]
+    #
+    # @api private
+    # @since 0.4.0
+    def initialize(event, explicit_identifier: nil)
+      @event      = event
+      @identifier = explicit_identifier || event.adapter_name
+      @adapter    = EvilEvents::Core::Bootstrap[:event_system].resolve_adapter(@identifier)
+    end
+
+    # @return [void]
+    #
+    # @api private
+    # @since 0.4.0
+    def broadcast!
+      adapter.call(event)
+    end
+
+    private
+
+    # @return [EvilEvents::Core::Events::AbstractEvent]
+    #
+    # @api private
+    # @since 0.4.0
+    attr_reader :event
+
+    # @return [EvilEvents::Core::Broadcasting::Dispatcher::Mixin]
+    #
+    # @api private
+    # @since 0.4.0
+    attr_reader :adapter
+  end
+end

data/lib/evil_events/core/config.rb

@@ -3,7 +3,7 @@
 module EvilEvents::Core
   # @api private
   # @since 0.1.0
-  class Config
+  class Config < EvilEvents::Shared::AnyConfig
     class << self
       # @api private
       # @since 0.1.0
@@ -12,58 +12,55 @@ module EvilEvents::Core
       end
     end
 
-    # @api private
-    # @since 0.1.0
-    def initialize # rubocop:disable Metrics/AbcSize
-      @config = Module.new do
-        extend EvilEvents::Shared::Configurable
-
-        setting :adapter, reader: true do
-          setting :default, :memory_sync
+    # rubocop:disable Metrics/BlockLength
+    configure do
+      setting :serializers, reader: true do
+        setting :json do
+          setting :engine, :native
         end
 
-        setting :subscriber, reader: true do
-          setting :default_delegator, :call
+        setting :hashing do
+          setting :engine, :native
         end
 
-        setting :logger, EvilEvents::Shared::Logger.new(STDOUT), reader: true
-
-        setting :notifier, reader: true do
-          setting :type, :sequential
+        setting :xml do
+          setting :engine, :ox
+        end
 
-          setting :sequential, reader: true do
-            # NOTE: place future settings here
-          end
+        setting :msgpack do
+          setting :engine, :mpacker
 
-          setting :worker, reader: true do
-            setting :min_threads, 0
-            setting :max_threads, 5
-            setting :max_queue, 1000
-            setting :fallback_policy, :main_thread
+          setting :mpacker do
+            setting :configurator, ->(engine) {}
           end
         end
       end
-    end
 
-    private
+      setting :adapter, reader: true do
+        setting :default, :memory_sync
+      end
 
-    # @return [Module{EvilEvents::Shared::Configurable}]
-    #
-    # @api private
-    # @since 0.1.0
-    attr_reader :config
+      setting :subscriber, reader: true do
+        setting :default_delegator, :call
+      end
 
-    # @api private
-    # @since 0.1.0
-    def method_missing(method_name, *attributes, &block)
-      return super unless config.respond_to?(method_name)
-      config.public_send(method_name, *attributes, &block)
-    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
 
-    # @api private
-    # @since 0.1.0
-    def respond_to_missing?(method_name, include_private = false)
-      config.respond_to?(method_name, include_private) || super
+        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
+    # rubocop:enable Metrics/BlockLength
   end
 end

data/lib/evil_events/core/events.rb

@@ -6,18 +6,48 @@ module EvilEvents::Core
   module Events
     require_relative 'events/serializers'
     require_relative 'events/serializers/base'
-    require_relative 'events/serializers/hash'
+    require_relative 'events/serializers/base/generic_config'
+    require_relative 'events/serializers/base/abstract_engine'
+    require_relative 'events/serializers/base/data_transformer'
+    require_relative 'events/serializers/base/event_serialization_state'
+    require_relative 'events/serializers/base/abstract_factory'
     require_relative 'events/serializers/json'
+    require_relative 'events/serializers/json/engines'
+    require_relative 'events/serializers/json/engines/native'
+    require_relative 'events/serializers/json/config'
+    require_relative 'events/serializers/json/factory'
+    require_relative 'events/serializers/json/packer'
+    require_relative 'events/serializers/json/unpacker'
+    require_relative 'events/serializers/hash'
+    require_relative 'events/serializers/hash/engines'
+    require_relative 'events/serializers/hash/engines/native'
+    require_relative 'events/serializers/hash/config'
+    require_relative 'events/serializers/hash/factory'
+    require_relative 'events/serializers/hash/packer'
+    require_relative 'events/serializers/hash/unpacker'
+    require_relative 'events/serializers/xml'
+    require_relative 'events/serializers/xml/engines'
+    require_relative 'events/serializers/xml/engines/ox'
+    require_relative 'events/serializers/xml/config'
+    require_relative 'events/serializers/xml/factory'
+    require_relative 'events/serializers/xml/packer'
+    require_relative 'events/serializers/xml/unpacker'
+    require_relative 'events/serializers/message_pack'
+    require_relative 'events/serializers/message_pack/engines'
+    require_relative 'events/serializers/message_pack/engines/mpacker'
+    require_relative 'events/serializers/message_pack/config'
+    require_relative 'events/serializers/message_pack/factory'
+    require_relative 'events/serializers/message_pack/packer'
+    require_relative 'events/serializers/message_pack/unpacker'
     require_relative 'events/event_extensions/type_aliasing'
     require_relative 'events/event_extensions/payloadable'
     require_relative 'events/event_extensions/payloadable/abstract_payload'
     require_relative 'events/event_extensions/manageable'
-    require_relative 'events/event_extensions/adapter_customizable'
+    require_relative 'events/event_extensions/dispatchable'
     require_relative 'events/event_extensions/observable'
     require_relative 'events/event_extensions/serializable'
     require_relative 'events/event_extensions/metadata_extendable'
     require_relative 'events/event_extensions/metadata_extendable/abstract_metadata'
-    require_relative 'events/event_extensions/emittable'
     require_relative 'events/event_extensions/class_signature'
     require_relative 'events/event_extensions/class_signature/signature'
     require_relative 'events/event_extensions/class_signature/equalizer'
@@ -40,6 +70,7 @@ module EvilEvents::Core
     require_relative 'events/manager/subscriber_list'
     require_relative 'events/manager_factory'
     require_relative 'events/manager_registry'
+    require_relative 'events/manager_registry/scoped_event_type_matcher'
     require_relative 'events/subscriber'
     require_relative 'events/subscriber/mixin'
     require_relative 'events/event_factory'