evil_events 0.1.0rc2 → 0.1.0rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a6c5ea4454784cde26a98119cba57b5d593b38a
-  data.tar.gz: f6966cb8fa6f63a8a81185ebb7ed27135325972b
+  metadata.gz: 6ba90c2963630dfa0bd968c6da4fccc798c72e8a
+  data.tar.gz: b403a12b2797da58c9d08271a6f8350faa4ecc9f
 SHA512:
-  metadata.gz: 5318459757e376efd82ab5a05bead86551b44b18948348523123777fe42a237f8d069e7fa79a19e4cb78a034c85b1be45d758e53a8dc7b261362f86cbfeb6c3f
-  data.tar.gz: 384d7919a39d38a2998cc2663c14ec6ff453c6012668eae704321d4a1a1bfae413f44c585d263a295b091fa4d948c4cf0dc43b536ea74419ea8332d5674f8a73
+  metadata.gz: 944e8fe8086ec3e38fd8267a1aa0b5d7c0505357053d55b9cfd814ebf309c25b46c505f1fdb668ba86b00d04a2cc8e4fe3f6cb2ef3559489e1264016254f98f5
+  data.tar.gz: 323332e087b6d55203956b33161cac1e694dc905e9dbc54e414d2895ea795d1f50df3beba53d5ec1cfb2af80809190122040ee00a30c2ee17b501de5807d844a

data/.hound.yml

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

data/.jrubyrc

@@ -0,0 +1 @@
+debug.fullTrace=true

data/.rubocop.yml

@@ -54,7 +54,10 @@ Metrics/BlockLength:
     - spec/**/*
 
 Metrics/CyclomaticComplexity:
-  Max: 7
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 10
 
 Metrics/MethodLength:
   Max: 25

data/.travis.yml

@@ -6,7 +6,7 @@ rvm:
 - ruby-head
 - jruby-head
 
-env: JRUBY_OPTS=--debug
 sudo: false
 before_install: gem install bundler -v 1.15.3
 cache: bundler
+script: bundle exec rspec

data/README.md

@@ -1,4 +1,4 @@
-# EvilEvents - powerful event system for ruby applications
+# EvilEvents - event subsystem for ruby applications
 
 [![Gem Version](https://badge.fury.io/rb/evil_events.svg)](https://badge.fury.io/rb/evil_events)
 [![Build Status](https://travis-ci.org/ergosploit/evil_events.svg?branch=master)](https://travis-ci.org/ergosploit/evil_events)
@@ -7,13 +7,12 @@
 NOTE: Work in progress!
 
 ### ROADMAP
-- Full test coverage (0.1.0)
 - Basic documentation (README) (0.1.0)
-- FULL documentation (0.2.1)
+- FULL documentation (0.1.1)
 - Notifier abstraction (0.2.0)
 - Event sourcing (0.3.0)
 - RSpec matchers (separated gem)
-- metadata field (0.1.0)
-- Concrete error messages for exceptions (0.1.0)
-- Event emition hooks (0.2.0)
-- Event emition scheduling (0.2.0)
+- Concrete error messages for exceptions (0.1.1)
+- Hooks (0.2.0)
+- Scheduling (0.2.0)
+- Event logic (0.2.0)

data/evil_events.gemspec

@@ -13,10 +13,10 @@ Gem::Specification.new do |spec|
   spec.email       = 'iamdaiver@icloud.com'
   spec.homepage    = 'https://github.com/ergosploit/evil_events'
   spec.license     = 'MIT'
-  spec.summary     = 'Event subsystem for any ruby application'
-  spec.description = 'Flexible and fully customizable event subsystem for ruby applications' \
-                     'with a wide set of customization interfaces and ' \
-                     'powerful event definition DSL'
+  spec.summary     = 'Event subsystem for ruby applications'
+  spec.description = 'Ultra simple, but very flexible and fully customizable event subsystem ' \
+                     'for ruby applications with a wide set of customization interfaces ' \
+                     ' and smart event definition DSL.'
 
   spec.bindir        = 'bin'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

data/lib/evil_events/core/activity_logger.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module EvilEvents::Core
+  # @api private
+  # @since 0.1.0
+  class ActivityLogger
+    class << self
+      # @param activity [String, NilClass]
+      # @param message [String, NilClass]
+      # @return void
+      #
+      # @since 0.1.0
+      def log(activity: nil, message: nil)
+        progname = "[EvilEvents:#{activity}]"
+        logger.add(logger.level, message, progname)
+      end
+
+      private
+
+      # @return [Logger]
+      #
+      # @since 0.1.0
+      def logger
+        EvilEvents::BootPoint[:config].logger
+      end
+    end
+  end
+end

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

@@ -4,9 +4,6 @@ module EvilEvents::Core::Broadcasting
   # @api private
   # @since 0.1.0
   class Emitter
-    # @since 0.1.0
-    include EvilEvents::Core::ActivityLogging
-
     # @since 0.1.0
     EmitterError = Class.new(StandardError)
     # @since 0.1.0
@@ -45,9 +42,9 @@ module EvilEvents::Core::Broadcasting
     # @since 0.1.0
     def log_emitter_activity(event)
       activity = "EventEmitted(#{event.adapter_name})"
-      message  = "Type: #{event.type} :: Payload: #{event.payload}"
+      message  = "Type: #{event.type} :: Payload: #{event.payload} :: Metadata: #{event.metadata}"
 
-      log_activity(activity: activity, message: message)
+      EvilEvents::Core::ActivityLogger.log(activity: activity, message: message)
     end
   end
 end

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

@@ -20,14 +20,16 @@ module EvilEvents::Core::Events
     # @since 0.1.0
     include EventExtensions::Emittable
     # @since 0.1.0
+    include EventExtensions::MetadataExtendable
+    # @since 0.1.0
     extend EvilEvents::Shared::CombinedContextMixin
 
     # @param payload_attributes [Hash]
     #
     # @since 0.1.0
-    def initialize(**payload_attributes)
-      @uuid    = SecureRandom.uuid # TODO: cover with a spec (uuid belongs to metadata)
-      @payload = payload_class.new(**payload_attributes)
+    def initialize(payload: {}, metadata: {})
+      @payload  = build_payload(**payload)
+      @metadata = build_metadata(**metadata)
     end
 
     # @return [Hash]
@@ -37,11 +39,11 @@ module EvilEvents::Core::Events
       @payload.to_h
     end
 
-    # @return void
+    # @return [Hash]
     #
     # @since 0.1.0
-    def emit
-      EvilEvents::BootPoint[:event_system].emit(self)
+    def metadata
+      @metadata.to_h
     end
   end
 end

data/lib/evil_events/core/events/event_extensions/metadata_extendable/abstract_metadata.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# TODO: dry and refactor with AbstractPayload
+module EvilEvents::Core::Events::EventExtensions::MetadataExtendable
+  # @abstract
+  # @api private
+  # @since 0.1.0
+  class AbstractMetadata < EvilEvents::Shared::Structure
+    class << self
+      # @since 0.1.0
+      alias_method :_native_attribute, :attribute
+
+      # @param key [Symbol]
+      # @param type [EvilEvents::Shared::Types::Any]
+      #
+      # @since 0.1.0
+      def attribute(key, type = EvilEvents::Types::Any)
+        _native_attribute(key, type)
+      end
+    end
+
+    # NOTE: dry-struct API + dry-initializer API
+    constructor_type :strict_with_defaults
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# TODO: refactor with EvilEvents::Core::Events::EventExtensions::Payloadable
+module EvilEvents::Core::Events::EventExtensions
+  # @api private
+  # @since 0.1.0
+  module MetadataExtendable
+    class << self
+      # @param base_class [Class]
+      #
+      # @since 0.1.0
+      def included(base_class)
+        base_class.extend(ClassMethods)
+      end
+    end
+
+    private
+
+    # @return [Class{AbstractMetadata}]
+    #
+    # @since 0.1.0
+    def build_metadata(**metadata_attributes)
+      self.class.const_get(:Metadata).new(**metadata_attributes)
+    end
+
+    # @since 0.1.0
+    module ClassMethods
+      # @param child_class [Class]
+      #
+      # @since 0.1.0
+      def inherited(child_class)
+        child_class.const_set(:Metadata, Class.new(AbstractMetadata))
+        super
+      end
+
+      # @param key [Symbol]
+      # @param type [EvilEvents::Shared::Types::Any]
+      # @return void
+      #
+      # @since 0.1.0
+      def metadata(key, type = EvilEvents::Types::Any)
+        const_get(:Metadata).attribute(key, type)
+      end
+
+      # @return [Array<Symbol>]
+      #
+      # @since 0.1.0
+      def metadata_fields
+        const_get(:Metadata).attribute_names
+      end
+    end
+  end
+end

data/lib/evil_events/core/events/event_extensions/payloadable/abstract_payload.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# TODO: dry and refactor with AbstractMetadata
 module EvilEvents::Core::Events::EventExtensions::Payloadable
   # @abstract
   # @api private

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# TODO: refactor with EvilEvents::Core::Events::EventExtensions::MetadataExtendable
 module EvilEvents::Core::Events::EventExtensions
   # @api private
   # @since 0.1.0
@@ -15,11 +16,11 @@ module EvilEvents::Core::Events::EventExtensions
 
     private
 
-    # @return [AbstractPayload]
+    # @return [Class{AbstractPayload}]
     #
     # @since 0.1.0
-    def payload_class
-      self.class.const_get(:Payload)
+    def build_payload(**payload_attributes)
+      self.class.const_get(:Payload).new(**payload_attributes)
     end
 
     # @since 0.1.0
@@ -37,14 +38,14 @@ module EvilEvents::Core::Events::EventExtensions
       # @return void
       #
       # @since 0.1.0
-      def attribute(key, type = EvilEvents::Types::Any)
+      def payload(key, type = EvilEvents::Types::Any)
         const_get(:Payload).attribute(key, type)
       end
 
       # @return [Array<Symbol>]
       #
       # @since 0.1.0
-      def attribute_names
+      def payload_fields
         const_get(:Payload).attribute_names
       end
     end

data/lib/evil_events/core/events/serializers/hash.rb

@@ -14,7 +14,7 @@ class EvilEvents::Core::Events::Serializers
     def serialize(event)
       raise SerializationError unless event.is_a?(EvilEvents::Core::Events::AbstractEvent)
 
-      { type: event.type, payload: event.payload }
+      { type: event.type, payload: event.payload, metadata: event.metadata }
     end
 
     # @param hash [::Hash]
@@ -24,13 +24,16 @@ class EvilEvents::Core::Events::Serializers
     # @since 0.1.0
     def deserialize(hash)
       raise DeserializationError unless hash.is_a?(::Hash)
-      event_type    = hash[:type]    || hash['type']
-      event_payload = hash[:payload] || hash['payload']
-      raise DeserializationError unless event_type && event_payload
-      raise DeserializationError unless event_payload.is_a?(::Hash)
+      event_type     = hash[:type]     || hash['type']
+      event_payload  = hash[:payload]  || hash['payload']  # TODO: || {} here
+      event_metadata = hash[:metadata] || hash['metadata'] # TODO: || {} here
+      raise DeserializationError unless event_type && event_payload && event_metadata
+      raise DeserializationError unless event_payload.is_a?(::Hash) && event_metadata.is_a?(::Hash)
 
       EvilEvents::BootPoint[:event_system].resolve_event_object(
-        event_type, symbolized_event_payload(event_payload)
+        event_type,
+        payload:  symbolized_event_data(event_payload),
+        metadata: symbolized_event_data(event_metadata)
       )
     end
 
@@ -38,12 +41,12 @@ class EvilEvents::Core::Events::Serializers
     # @return [::Hash]
     #
     # @since 0.1.0
-    def symbolized_event_payload(payload_hash)
+    def symbolized_event_data(payload_hash)
       payload_hash.each_pair.each_with_object({}) do |(key, value), result_hash|
         result_hash[key.to_sym] = value
       end
     end
-    private_class_method :symbolized_event_payload
+    private_class_method :symbolized_event_data
   end
 
   # @since 0.1.0

data/lib/evil_events/core/events/serializers/json.rb

@@ -14,7 +14,7 @@ class EvilEvents::Core::Events::Serializers
     def serialize(event)
       raise SerializationError unless event.is_a?(EvilEvents::Core::Events::AbstractEvent)
 
-      ::JSON.generate(type: event.type, payload: event.payload)
+      ::JSON.generate(type: event.type, payload: event.payload, metadata: event.metadata)
     end
 
     # @param json [String]
@@ -26,15 +26,18 @@ class EvilEvents::Core::Events::Serializers
       raise DeserializationError unless json.is_a?(String)
 
       begin
-        json_hash     = ::JSON.parse(json, symbolize_names: true)
-        event_type    = json_hash[:type]
-        event_payload = json_hash[:payload]
-        raise DeserializationError unless event_type && event_payload
+        json_hash      = ::JSON.parse(json, symbolize_names: true)
+        event_type     = json_hash[:type]
+        event_payload  = json_hash[:payload]  # TODO: || {} here
+        event_metadata = json_hash[:metadata] # TODO: || {} here
+        raise DeserializationError unless event_type && event_payload && event_metadata
       rescue ::JSON::ParserError
         raise DeserializationError
       end
 
-      EvilEvents::BootPoint[:event_system].resolve_event_object(event_type, event_payload)
+      EvilEvents::BootPoint[:event_system].resolve_event_object(
+        event_type, payload: event_payload, metadata: event_metadata
+      )
     end
   end
 

data/lib/evil_events/core/events.rb

@@ -13,6 +13,8 @@ module EvilEvents::Core
     require_relative 'events/event_extensions/adapter_customizable'
     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/abstract_event'
     require_relative 'events/manager'

data/lib/evil_events/core.rb

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

data/lib/evil_events/shared/combined_context.rb

@@ -106,6 +106,8 @@ module EvilEvents
           __outer_context__.method(method_name)
         when __required_context__.respond_to?(method_name)
           __required_context__.method(method_name)
+        when ::Kernel.respond_to?(method_name)
+          ::Kernel.method(method_name)
         else
           super
         end

data/lib/evil_events/system/event_manager.rb

@@ -80,8 +80,8 @@ class EvilEvents::System
     # @return [EvilEvents::Core::Events::AbstractEvent]
     #
     # @since 0.1.0
-    def resolve_event_object(event_type, **event_attributes)
-      manager_of_event_type(event_type).event_class.new(**event_attributes)
+    def resolve_event_object(event_type, payload: {}, metadata: {})
+      manager_of_event_type(event_type).event_class.new(payload: payload, metadata: metadata)
     end
 
     # @param event_class [EvilEvents::Core::Events::AbstractEvent]

data/lib/evil_events/system/mock.rb

@@ -57,7 +57,7 @@ class EvilEvents::System
 
     # @see EvilEvents::System
     # @since 0.1.0
-    def resolve_event_object(event_type, **event_attributes); end
+    def resolve_event_object(event_type, payload: {}, metadata: {}); end
 
     # @see EvilEvents::System
     # @since 0.1.0

data/lib/evil_events/version.rb

@@ -3,5 +3,5 @@
 module EvilEvents
   # @api public
   # @since 0.1.0
-  VERSION = '0.1.0rc2'
+  VERSION = '0.1.0rc3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: evil_events
 version: !ruby/object:Gem::Version
-  version: 0.1.0rc2
+  version: 0.1.0rc3
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-08 00:00:00.000000000 Z
+date: 2017-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-types
@@ -206,20 +206,22 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.18.0
-description: Flexible and fully customizable event subsystem for ruby applicationswith
-  a wide set of customization interfaces and powerful event definition DSL
+description: Ultra simple, but very flexible and fully customizable event subsystem
+  for ruby applications with a wide set of customization interfaces  and smart event
+  definition DSL.
 email: iamdaiver@icloud.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
+- ".jrubyrc"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -231,7 +233,7 @@ files:
 - lib/evil_events/boot_point.rb
 - lib/evil_events/config.rb
 - lib/evil_events/core.rb
-- lib/evil_events/core/activity_logging.rb
+- lib/evil_events/core/activity_logger.rb
 - lib/evil_events/core/broadcasting.rb
 - lib/evil_events/core/broadcasting/adapters.rb
 - lib/evil_events/core/broadcasting/adapters/memory_async.rb
@@ -245,6 +247,8 @@ files:
 - lib/evil_events/core/events/event_extensions/adapter_customizable.rb
 - lib/evil_events/core/events/event_extensions/emittable.rb
 - lib/evil_events/core/events/event_extensions/manageable.rb
+- lib/evil_events/core/events/event_extensions/metadata_extendable.rb
+- lib/evil_events/core/events/event_extensions/metadata_extendable/abstract_metadata.rb
 - lib/evil_events/core/events/event_extensions/observable.rb
 - lib/evil_events/core/events/event_extensions/payloadable.rb
 - lib/evil_events/core/events/event_extensions/payloadable/abstract_payload.rb
@@ -296,8 +300,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
-summary: Event subsystem for any ruby application
+summary: Event subsystem for ruby applications
 test_files: []

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at iamdaiver@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/lib/evil_events/core/activity_logging.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module EvilEvents::Core
-  # @api private
-  # @since 0.1.0
-  module ActivityLogging
-    # @param activity [String, NilClass]
-    # @param message [String, NilClass]
-    # @return void
-    #
-    # @since 0.1.0
-    def log_activity(activity: nil, message: nil)
-      progname = "[EvilEvents:#{activity}]"
-      activity_logger.add(activity_logger.level, message, progname)
-    end
-
-    # @return [Logger]
-    #
-    # @since 0.1.0
-    def activity_logger
-      EvilEvents::BootPoint[:config].logger
-    end
-  end
-end