evil_events 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce935f449ea78c46b999cb78c539ebb0831ffe6c
-  data.tar.gz: d95c3b341243285c82c1955f2cf09f44d5d5cbe1
+  metadata.gz: 6ca82399f2d2f7e433c6dd9c111d2a6c3c285940
+  data.tar.gz: 445c719e88bb2f1ff12720b8aec3fc62c451ef91
 SHA512:
-  metadata.gz: 722725a362de968307d9ff12b9b46f60b044110eafc404d77f1e9a96ff5e19c37d00853c2deb0a940021a8f6632ef17cdfba04791ba0c1ce4db3c95e7dfb1b10
-  data.tar.gz: 4bba1a00b98b3aa7f8ae62b5434698f8e71fa6ab6401ff167c73a5e8108a3fbd16beb06b698c54c26a4d82e7fafd62ebff2939cbe7c41fcc4b678d78fd947e38
+  metadata.gz: c3ea9dfd03ec8f792d926d83ed2f014cc22ce8bb42d8730e626473ffb48d28bbfe2d2bdb990b9d2d279d8a3fc7a3fcb32d8d0c0ac2304a94a1a1418d096d57c6
+  data.tar.gz: 4aa79a4f86765a4babbbc9aaea8c7a0947cc1f653a8c484b2496bc71daff8ce1a385b01c5665a265174f9f89a0f436a028a6b3f87022f17b9b6219bb69d27214

data/.rubocop.yml

@@ -16,6 +16,10 @@ Style/SingleLineMethods:
   Exclude:
     - spec/**/*
 
+Style/RescueModifier:
+  Exclude:
+    - spec/**/*
+
 Style/AsciiComments:
   Enabled: false
 
@@ -25,6 +29,9 @@ Style/Alias:
 Style/GuardClause:
   Enabled: false
 
+Style/DoubleNegation:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false
 
@@ -37,12 +44,18 @@ Style/EmptyCaseCondition:
 Style/FrozenStringLiteralComment:
   Enabled: true
 
+Style/InverseMethods:
+  Enabled: false
+
 Style/ParallelAssignment:
   Enabled: false
 
 Style/CommentedKeyword:
   Enabled: false
 
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
 Naming/FileName:
   Enabled: false
 
@@ -65,11 +78,14 @@ Metrics/PerceivedComplexity:
 Metrics/MethodLength:
   Max: 25
 
+RSpec/ContextWording:
+  Enabled: false
+
 RSpec/HookArgument:
   Enabled: false
 
 RSpec/NestedGroups:
-  Max: 5
+  Max: 6
 
 RSpec/MessageSpies:
   Enabled: false

data/.travis.yml

@@ -2,7 +2,7 @@ language: ruby
 rvm:
 - 2.3.5
 - 2.4.2
-- 2.2.7
+- 2.2.8
 - ruby-head
 - jruby-head
 

data/CHANGELOG.md

@@ -1,6 +1,34 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.2.0] - 2017-11-19
+### Added
+- Support for custom coercive types:
+  - New utility for custom coercive types: `EvilEvents::Shared::TypeConverter`
+  - `AbstractEvent` supports new coercive types (metadata and payload are supported)
+  - Configuration point for coercive types: `EvilEvents::Config.setup_types { |types| ... }`
+- Configuration point for adapters: `EvilEvents::Config.setup_adapters { |adapters| ... }`
+- General class for internal errors: now all internal `*Error` classes inherits from `EvilEvents::Core::Error`
+- Access to the list of registered event classes via `EvilEvents::Application.registered_events`
+- Plugin ecosystem: see `EvilEvents::Plugins` (simple API example: `EvilEvents::Plugins.load!(:rails)`)
+- Comparable event class signature object `<EventClass>.signature` with data about:
+  -  class name
+  -  class creation strategy
+  -  adapter info (name and object)
+  -  default delegator method name
+  -  metadata attributes schema
+  -  payload attributes schema
+  -  string type alias
+- Event subscriptions via event type alias pattern (Regexp) and conditional proc (Proc)
+- The ability to subscribe to the list of events (via list of event type attributes)
+
+### Changed
+- Renamed config opts aggregator: `EvilEvents::Config.config` => `EvilEvents::Config.options`
+- Moved adapters config object: `EvilEvents::Adapters` => `EvilEvents::Config::Adapters`
+
+### Fixed
+- Fixed a bug when an event created by an exceptional block still remains in the internal event registry
+
 ## [0.1.1] - 2017-10-29
-### [Added]
+### Added
 - Serialization of event ids: support for using :id key in JSON/Hash serialization/deserialization.

data/evil_events.gemspec

@@ -26,20 +26,21 @@ Gem::Specification.new do |spec|
     f.match(%r{^(spec|features)/})
   end
 
-  spec.add_dependency 'dry-monads',       '0.3.1'
-  spec.add_dependency 'dry-types',        '0.12.1'
-  spec.add_dependency 'dry-struct',       '0.3.1'
-  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_development_dependency 'coveralls',      '0.8.21'
-  spec.add_development_dependency 'pry',            '0.11.2'
-  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 'bundler',        '1.15.4'
-  spec.add_development_dependency 'rake',           '12.2.1'
-  spec.add_development_dependency 'rspec',          '3.7.0'
-  spec.add_development_dependency 'rubocop-rspec',  '1.19.0'
+  spec.add_dependency 'dry-monads',       '~> 0.4.0'
+  spec.add_dependency 'dry-types',        '~> 0.12.1'
+  spec.add_dependency 'dry-struct',       '~> 0.3.1'
+  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_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 'rspec',          '~> 3.7.0'
+  spec.add_development_dependency 'rubocop-rspec',  '~> 1.20.1'
+
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'bundler'
 end

data/lib/evil_events.rb

@@ -6,6 +6,7 @@ require 'dry-struct'
 require 'dry-types'
 require 'concurrent/array'
 require 'concurrent/map'
+require 'securerandom'
 require 'logger'
 require 'json'
 
@@ -19,8 +20,9 @@ module EvilEvents
   require_relative 'evil_events/config'
   require_relative 'evil_events/event'
   require_relative 'evil_events/serializer'
-  require_relative 'evil_events/adapters'
   require_relative 'evil_events/emitter'
   require_relative 'evil_events/subscriber_mixin'
   require_relative 'evil_events/dispatcher_mixin'
+  require_relative 'evil_events/application'
+  require_relative 'evil_events/plugins'
 end

data/lib/evil_events/application.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module EvilEvents
+  # @api public
+  # @since 0.2.0
+  module Application
+    class << self
+      # @see EvilEvents::Core::System
+      # @api public
+      # @since 0.2.0
+      def registered_events
+        EvilEvents::Core::Bootstrap[:event_system].registered_events
+      end
+    end
+  end
+end

data/lib/evil_events/config.rb

@@ -4,19 +4,36 @@ module EvilEvents
   # @api public
   # @since 0.1.0
   module Config
+    require_relative 'config/adapters'
+    require_relative 'config/types'
+
     class << self
-      # @see EvilEvents::Config
+      # @see EvilEvents::Core::Config
       # @api public
       # @since 0.1.0
-      def configure
-        config.configure { |conf| yield(conf) if block_given? }
+      def options
+        EvilEvents::Core::Bootstrap[:config]
       end
 
-      # @see EvilEvents::Config
+      # @see EvilEvents::Core::Config
       # @api public
       # @since 0.1.0
-      def config
-        EvilEvents::Core::Bootstrap[:config]
+      def configure
+        options.configure { |conf| yield(conf) if block_given? }
+      end
+
+      # @see EvilEvents::Config::Types
+      # @api public
+      # @since 0.2.0
+      def setup_types
+        yield(Config::Types) if block_given?
+      end
+
+      # @see EvilEvents::Config::Adapters
+      # @api public
+      # @since 0.2.0
+      def setup_adapters
+        yield(Config::Adapters) if block_given?
       end
     end
   end

data/lib/evil_events/{adapters.rb → config/adapters.rb}

@@ -1,20 +1,20 @@
 # frozen_string_literal: true
 
-module EvilEvents
+module EvilEvents::Config
   # @api public
-  # @since 0.1.0
+  # @since 0.2.0
   module Adapters
     class << self
       # @see EvilEvents::Core::System
       # @api public
-      # @since 0.1.0
+      # @since 0.2.0
       def register(adapter_name, adapter_object)
         EvilEvents::Core::Bootstrap[:event_system].register_adapter(adapter_name, adapter_object)
       end
 
       # @see EvilEvents::Core::System
       # @api public
-      # @since 0.1.0
+      # @since 0.2.0
       def resolve(adapter_name)
         EvilEvents::Core::Bootstrap[:event_system].resolve_adapter(adapter_name)
       end

data/lib/evil_events/config/types.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module EvilEvents::Config
+  # @api public
+  # @since 0.2.0
+  module Types
+    class << self
+      # @see EvilEvents::Core::System
+      # @api public
+      # @since 0.2.0
+      def define_converter(type, &coercer)
+        EvilEvents::Core::Bootstrap[:event_system].register_converter(type, coercer)
+      end
+
+      # @see EvilEvents::Core::System
+      # @api public
+      # @since 0.2.0
+      def resolve_type(type, **options)
+        EvilEvents::Core::Bootstrap[:event_system].resolve_type(type, **options)
+      end
+      alias_method :[], :resolve_type
+    end
+  end
+end

data/lib/evil_events/core.rb

@@ -4,6 +4,7 @@ module EvilEvents
   # @api private
   # @since 0.1.0
   module Core
+    require_relative 'core/error'
     require_relative 'core/activity_logger'
     require_relative 'core/broadcasting'
     require_relative 'core/events'

data/lib/evil_events/core/bootstrap.rb

@@ -8,6 +8,6 @@ module EvilEvents::Core
     extend EvilEvents::Shared::DependencyContainer::Mixin
 
     register(:event_system, memoize: true) { EvilEvents::Core::System.new }
-    register(:config, memoize: true) { EvilEvents::Config.new }
+    register(:config, memoize: true) { EvilEvents::Core::Config.new }
   end
 end

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

@@ -5,7 +5,7 @@ module EvilEvents::Core::Broadcasting
   # @since 0.1.0
   class Emitter
     # @since 0.1.0
-    EmitterError = Class.new(StandardError)
+    EmitterError = Class.new(EvilEvents::Core::Error)
     # @since 0.1.0
     IncorrectEventError = Class.new(EmitterError)
 

data/lib/evil_events/core/error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module EvilEvents::Core
+  # @api private
+  # @since 0.2.0
+  Error = Class.new(StandardError)
+  ArgumentError = Class.new(ArgumentError)
+end

data/lib/evil_events/core/events.rb

@@ -18,6 +18,9 @@ module EvilEvents::Core
     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'
     require_relative 'events/abstract_event'
     require_relative 'events/manager'
     require_relative 'events/manager/notifier'

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

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

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module EvilEvents::Core::Events::EventExtensions
+  # @api private
+  # @since 0.2.0
+  module ClassSignature
+    class << self
+      # @param base_calss [Class{AbstractEvent}]
+      #
+      # @since 0.2.0
+      def included(base_class)
+        base_class.extend(ClassMethods)
+
+        base_class.singleton_class.class_eval do
+          attr_accessor :__creation_strategy
+        end
+      end
+    end
+
+    # @since 0.2.0
+    module ClassMethods
+      # @return [Signature]
+      #
+      # @since 0.2.0
+      def signature
+        Signature.new(self)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module EvilEvents::Core::Events::EventExtensions::ClassSignature
+  # @api private
+  # @since 0.2.0
+  class Equalizer
+    # @rreturn [Signature]
+    #
+    # @since 0.2.0
+    attr_reader :signature_a
+    # @rreturn [Signature]
+    #
+    # @since 0.2.0
+    attr_reader :signature_b
+
+    # @param signature_a [Signature]
+    # @param signature_b [Signature]
+    #
+    # @since 0.2.0
+    def initialize(signature_a, signature_b)
+      @signature_a = signature_a
+      @signature_b = signature_b
+    end
+
+    # @return [Boolean]
+    #
+    # @since 0.2.0
+    def equal_payload?
+      signature_a.payload_stamp == signature_b.payload_stamp
+    end
+
+    # @return [Boolean]
+    #
+    # @since 0.2.0
+    def equal_metadata?
+      signature_a.metadata_stamp == signature_b.metadata_stamp
+    end
+
+    # @return [Boolean]
+    #
+    # @since 0.2.0
+    def equal_delegator?
+      signature_a.delegator_stamp == signature_b.delegator_stamp
+    end
+
+    # @return [Boolean]
+    #
+    # @since 0.2.0
+    def equal_adapter?
+      signature_a.adapter_stamp == signature_b.adapter_stamp
+    end
+
+    # @return [Boolean]
+    #
+    # @since 0.2.0
+    def equal_type_alias?
+      signature_a.type_alias_stamp == signature_b.type_alias_stamp
+    end
+
+    # @return [Boolean]
+    #
+    # @since 0.2.0
+    def equal_class?
+      signature_a.class_stamp == signature_b.class_stamp
+    end
+
+    # @option strict [Boolean]
+    # @return [Boolean]
+    #
+    # @since 0.2.0
+    def similar_signatures?
+      # rubocop:disable Layout/MultilineOperationIndentation
+      equal_type_alias? &&
+      equal_class?      &&
+      equal_payload?    &&
+      equal_metadata?   &&
+      equal_delegator?  &&
+      equal_adapter?
+      # rubocop:enable Layout/MultilineOperationIndentation
+    end
+  end
+end