evil_events 0.1.0rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d92142f28955faa9a09b89fd4e49d90ee6d916c
+  data.tar.gz: 8e1db3af52fabe05fe15328f6fe096d7cca34f4c
+SHA512:
+  metadata.gz: ba2407d8d151584caee50926f92bc7ffa766dc996ba79f8a7c6c175edc83296e9bb3a83ba49621afe13122c0fd0bd4c86015070e5bd9ed8e66d327e5ea362268
+  data.tar.gz: afc02be9c2ffc74d5b02e5bb8c7ccfb420e3fd13efc9838df62257ee6504ca562a051af252b1a33c2a3e568fbda79a3d45b9c375e9438ab52728688c248409d5

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.rspec_status
+.DS_Store
+.idea
+/.gtm/

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=progress
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,84 @@
+require: rubocop-rspec
+
+AllCops:
+  DisplayCopNames:   true
+  DisplayStyleGuide: true
+  TargetRubyVersion: 2.3
+  Include:
+    - lib/**/*
+    - spec/**/*
+  Exclude:
+    - Gemfile
+    - Rakefile
+    - evil_events.gemspec
+
+Style/SingleLineMethods:
+  Exclude:
+    - spec/**/*
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/Alias:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/EmptyCaseCondition:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+Metrics/MethodLength:
+  Max: 25
+
+RSpec/HookArgument:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 5
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Enabled: false
+
+RSpec/LetSetup:
+  Enabled: false
+
+RSpec/AnyInstance:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+- 2.3.5
+- 2.4.2
+- 2.2.7
+- ruby-head
+- jruby-head
+
+sudo: false
+before_install: gem install bundler -v 1.15.3

data/.yardopts

@@ -0,0 +1 @@
+--protected --private --markup markdown

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in evil_events.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Rustam Ibragimov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,17 @@
+# EvilEvents - powerful event system for ruby applications
+
+[![Gem Version](https://badge.fury.io/rb/evil_events.svg)](https://badge.fury.io/rb/evil_events)
+
+Note: work in progress!
+
+### TODO
+- Full test coverage (0.1.0)
+- Basic documentation (README) (0.1.0)
+- FULL documentation (0.2.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)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'evil_events'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/evil_events.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$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.name        = 'evil_events'
+  spec.version     = EvilEvents::VERSION
+  spec.authors     = 'Rustam Ibragimov'
+  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.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(spec|features)/})
+  end
+
+  spec.add_dependency 'dry-types',        '0.12.0'
+  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 'pry',           '0.11.1'
+  spec.add_development_dependency 'simplecov',     '0.15.1'
+  spec.add_development_dependency 'rubocop',       '0.50.0'
+  spec.add_development_dependency 'bundler',       '1.15.4'
+  spec.add_development_dependency 'rake',          '12.1.0'
+  spec.add_development_dependency 'rspec',         '3.6.0'
+  spec.add_development_dependency 'rubocop-rspec', '1.18.0'
+end

data/lib/evil_events/boot_point.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module EvilEvents
+  # @api private
+  # @since 0.1.0
+  module BootPoint
+    # @api private
+    # @since 0.1.0
+    class System
+      # @since 0.1.0
+      extend Shared::DependencyContainer::Mixin
+
+      register(:event_system, memoize: true) { EvilEvents::System.new }
+      register(:config) { EvilEvents::Config }
+    end
+  end
+end

data/lib/evil_events/config.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module EvilEvents
+  # @api public
+  # @since 0.1.0
+  Config = EvilEvents::Shared::MockableClassBuilder.new_class do
+    extend EvilEvents::Shared::Configurable
+
+    class << self
+      # @return void
+      #
+      # @since 0.1.0
+      def reset!
+        config.adapter.default = :memory_sync
+        config.subscriber.default_delegator = :call
+        config.logger = EvilEvents::Shared::Logger.new(STDOUT)
+      end
+    end
+
+    setting :adapter, reader: true do
+      setting :default, :memory_sync
+    end
+
+    setting :subscriber, reader: true do
+      setting :default_delegator, :call
+    end
+
+    setting :logger, EvilEvents::Shared::Logger.new(STDOUT), reader: true
+  end
+end

data/lib/evil_events/core/activity_logging.rb

@@ -0,0 +1,24 @@
+# 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::System[:config].logger
+    end
+  end
+end

data/lib/evil_events/core/broadcasting/adapters/memory_async.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module EvilEvents::Core::Broadcasting
+  class Adapters
+    # @api public
+    # @since 0.1.0
+    class MemoryAsync
+      # @since 0.1.0
+      include Dispatcher::Dispatchable
+
+      # @param event [EvilEvents::Core::Events::AbstractEvent]
+      # @return void
+      #
+      # @since 0.1.0
+      def call(event)
+        ::Thread.new { dispatch(event) }
+      end
+    end
+  end
+end

data/lib/evil_events/core/broadcasting/adapters/memory_sync.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module EvilEvents::Core::Broadcasting
+  class Adapters
+    # @api public
+    # @since 0.1.0
+    class MemorySync
+      # @since 0.1.0
+      include Dispatcher::Dispatchable
+
+      # @param event [EvilEvents::Core::Events::AbstractEvent]
+      # @return void
+      #
+      # @since 0.1.0
+      def call(event)
+        dispatch(event)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module EvilEvents::Core::Broadcasting
+  # @since 0.1.0
+  class Adapters
+    extend EvilEvents::Shared::DependencyContainer::Mixin
+
+    register :memory_sync,  -> { Adapters::MemorySync.new }
+    register :memory_async, -> { Adapters::MemoryAsync.new }
+  end
+end

data/lib/evil_events/core/broadcasting/dispatcher/dispatchable.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module EvilEvents::Core::Broadcasting
+  class Dispatcher
+    # @api public
+    # @since 0.1.0
+    module Dispatchable
+      # @param event [EvilEvents::Core::Events::AbstractEvent]
+      # @return void
+      #
+      # @since 0.1.0
+      def dispatch(event)
+        Dispatcher.dispatch(event)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module EvilEvents::Core::Broadcasting
+  # @api private
+  # @since 0.1.0
+  class Dispatcher # Broadcaster
+    class << self
+      # @param event [EvilEvents::Core::Events::AbstractEvent]
+      # @return void
+      #
+      # @since 0.1.0
+      def dispatch(event) # Broadcast
+        EvilEvents::BootPoint::System[:event_system].manager_of_event(event).notify(event)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module EvilEvents::Core::Broadcasting
+  # @api private
+  # @since 0.1.0
+  class Emitter
+    # @since 0.1.0
+    include EvilEvents::Core::ActivityLogging
+
+    # @param event [EvilEvents::Core::Events::AbstractEvent]
+    # @return void
+    #
+    # @since 0.1.0
+    def emit(event)
+      log_emitter_activity(event)
+      event.adapter.call(event)
+    end
+
+    # @param event_type [String]
+    # @param event_attributes [Hash]
+    # @return void
+    #
+    # @since 0.1.0
+    def raw_emit(event_type, **event_attributes)
+      event_object = EvilEvents::BootPoint::System[:event_system].resolve_event_object(
+        event_type,
+        **event_attributes
+      )
+
+      emit(event_object)
+    end
+
+    private
+
+    # @param event [EvilEvents::Core::Events::AbstractEvent]
+    # @return void
+    #
+    # @since 0.1.0
+    def log_emitter_activity(event)
+      activity = "EventEmitted(#{event.adapter_name})"
+      message  = "Type: #{event.type} :: Payload: #{event.payload}"
+      log_activity(activity, message)
+    end
+  end
+end

data/lib/evil_events/core/broadcasting.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module EvilEvents::Core
+  # @since 0.1.0
+  module Broadcasting
+    require_relative 'broadcasting/dispatcher'
+    require_relative 'broadcasting/dispatcher/dispatchable'
+    require_relative 'broadcasting/adapters'
+    require_relative 'broadcasting/adapters/memory_sync'
+    require_relative 'broadcasting/adapters/memory_async'
+    require_relative 'broadcasting/emitter'
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module EvilEvents::Core::Events
+  # @abstract
+  # @api private
+  # @since 0.1.0
+  class AbstractEvent
+    # @since 0.1.0
+    include EventExtensions::TypeAliasing
+    # @since 0.1.0
+    include EventExtensions::Payloadable
+    # @since 0.1.0
+    include EventExtensions::Manageable
+    # @since 0.1.0
+    include EventExtensions::Observable
+    # @since 0.1.0
+    include EventExtensions::AdapterCustomizable
+    # @since 0.1.0
+    include EventExtensions::Serializable
+    # @since 0.1.0
+    extend EvilEvents::Shared::CombinedContextMixin
+
+    # @param payload_attributes [Hash]
+    #
+    # @since 0.1.0
+    def initialize(**payload_attributes)
+      @payload = payload_class.new(**payload_attributes)
+    end
+
+    # @return [Hash]
+    #
+    # @since 0.1.0
+    def payload
+      @payload.to_h
+    end
+
+    # @return void
+    #
+    # @since 0.1.0
+    def emit
+      EvilEvents::BootPoint::System[:event_system].emit(self)
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module EvilEvents::Core::Events
+  # @api private
+  # @since 0.1.0
+  module EventClassFactory
+    class << self
+      # @param event_type [String]
+      # @raise [EvilEvents::Core::Events::ManagerRegistry::AlreadyManagedEventClassError]
+      # @return [AbstractEvent]
+      #
+      # @since 0.1.0
+      def create_abstract(event_type)
+        Class.new(AbstractEvent).tap do |klass|
+          klass.type(event_type)
+
+          class << klass
+            def inherited(child_class)
+              begin
+                child_class.type(type)
+                child_class.manage!
+              rescue EvilEvents::Core::Events::ManagerRegistry::AlreadyManagedEventClassError
+                EvilEvents::BootPoint::System[:event_system].unregister_event_class(child_class)
+                raise
+              end
+
+              super
+            end
+          end
+        end
+      end
+
+      # @param event_type [String]
+      # @param event_class_definitions [Proc]
+      # @yield [AbstractEvent]
+      # @raise [EvilEvents::Core::Events::ManagerRegistry::AlreadyManagedEventClassError]
+      # @return [AbstractEvent]
+      #
+      # @since 0.1.0
+      def create(event_type, &event_class_definitions)
+        Class.new(AbstractEvent).tap do |klass|
+          begin
+            klass.type(event_type)
+            klass.manage!
+            klass.evaluate(&event_class_definitions) if block_given?
+          rescue EvilEvents::Core::Events::ManagerRegistry::AlreadyManagedEventClassError
+            EvilEvents::BootPoint::System[:event_system].unregister_event_class(klass)
+            raise
+          end
+        end
+      end
+    end
+  end
+end