onuro 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7826a6ec7bc1eecff6013f3fcfe7d59ae8b7a1aba636b062c886d87e9278e6ee
-  data.tar.gz: f25e753a231f1ab7e23360b9263b464f9383f3c4a3f13210d98ac71d32f44303
+  metadata.gz: 0b8f298894039efad8040411f7f20ef9520904d86ba94e2a2e81affec3e3e42e
+  data.tar.gz: 69feab312564ca16fa4bcd2da211cf40c67e961379a744857c920bad0d761bb7
 SHA512:
-  metadata.gz: 456107defeb433d5878e7625aaaa77c95f442e37d09a91fb37afa9f5b8d6c9141c12bfd87936988a9d1da659e717e4663478b7fcd20e03ed9cb898ef6c548e58
-  data.tar.gz: f72546cb01de305f26e307a46dfcce80c741c3e739e99855b0575b42b0dbcd9d63ee1efb5d9ecce6c8d644dce92a74717422e9d315d05629e435a31c7fd5c131
+  metadata.gz: 342d089f5b6ea8180887d006e37fb3a3e13951483688774b46288319ea68e777230dee9f26e432f47611a72bd1fc24330d99858318d27afa47f70977b951e441
+  data.tar.gz: dddd4518bbf349f4b2ba1700936d6eee919f320e21d335e8fde0c365c360cbe1e6151169fc6b04ba0d8618728d3eaa6c6f42ba8045fbd6113eafd2981d5cf1b5

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/log/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -1,3 +1,6 @@
+require:
+  - rubocop-rspec
+  
 Metrics/LineLength:
   Max: 100
 
@@ -9,3 +12,6 @@ Rails/Output:
 
 Style/ClassAndModuleChildren:
   Enabled: false
+
+Metrics/AbcSize:
+  Max: 30

data/Gemfile.lock

@@ -1,14 +1,27 @@
 PATH
   remote: .
   specs:
-    onuro (0.1.1)
+    onuro (0.1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
     ast (2.4.0)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
     diff-lcs (1.3)
+    docile (1.3.1)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.2)
+    json (2.2.0)
+    minitest (5.11.3)
     parallel (1.17.0)
     parser (2.6.3.0)
       ast (~> 2.4.0)
@@ -34,18 +47,33 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-rspec (1.33.0)
+      rubocop (>= 0.60.0)
     ruby-progressbar (1.10.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
     unicode-display_width (1.6.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport (~> 5.2)
   bundler (~> 1.17)
+  byebug (~> 11.0)
+  coderay (~> 1.1)
   onuro!
   rake (~> 12.3)
   rspec (~> 3.8)
   rubocop (~> 0.71.0)
+  rubocop-rspec (~> 1.33)
+  simplecov (~> 0.16.1)
 
 BUNDLED WITH
    1.17.2

data/README.md

@@ -22,7 +22,59 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Engine
+
+### Rule
+
+### RuleStage
+
+### Events
+
+Events are the component that hold an *rulset stage* composed of a list of rules and their settings for execution. The easiest way to define and event is creating the instance object always with the event name required. In order to create complex events with more settings, take a look to the *Event Builder* section.
+
+```ruby
+event = Event.new(:my_event)
+engine.add_event(event)
+engine.execute(:my_event)
+```
+
+### Event Builder
+
+An easier way to create an event, is using the **EventBuilder*** class based on the *builder pattern*. This gives a lot of flexibility when you are creating the events and avoid having a lot or parameters in the constructor and assembling  all the event internals, and easy to to be plugged in you **Engine** class instance.
+
+```ruby
+event = EventBuilder.build(:test_ruleset) do |builder|
+          builder.add_ruleset_stage([rule1, rule2, rule3])
+          builder.add_event_strategy(MyCustomEventStrategy)
+          builder.exec_order(:desc)
+          buidler.ignore_diseabled
+        end
+
+engine.add_event(event)
+engine.execute(:test_ruleset)
+```
+
+### Event Strategies
+
+Events allow you to implement your custom strategy, to control what happens before and after the rule is executed in the event. By default Onuro provides a default strategy:
+
+```ruby
+module Onuro
+  class DefaultEventStrategy
+    def before_rule_exec(_rule_stage, _context)
+      true
+    end
+
+    def after_rule_exec(_rule_stage, _context, _result)
+      true
+    end
+  end
+end
+```
+
+You only need to implement the methods **before_rule_exec** and **after_rule_exec** in your custom class returning a boolean value. Basically, this is the *strategy pattern*.
+
+If **before_rule_exec** returns false, skip the current rule execution and move to the next one in the ruleset list.
 
 ## Development
 

data/lib/onuro.rb

@@ -1,11 +1,16 @@
 # frozen_string_literal: true
 
 require 'onuro/version'
+require 'onuro/execution_result'
+require 'onuro/logging'
 require 'onuro/engine'
+require 'onuro/default_event_strategy'
+require 'onuro/event_builder'
+require 'onuro/event'
+require 'onuro/base_rule'
+require 'onuro/rule_stage'
 
 module Onuro
   class Error < StandardError; end
-  # Your code goes here...
-  Event = Struct.new(:name, :rules)
-  Rule = Struct.new(:rule, :enabled, :order)
+  class InvalidEventNameException < StandardError; end
 end

data/lib/onuro/base_rule.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Onuro
+  class BaseRule
+    include ExecutionResult
+    include Logging
+
+    def execute(_context = {})
+      SUCCESSFUL
+    end
+  end
+end

data/lib/onuro/default_event_strategy.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Onuro
+  class DefaultEventStrategy
+    def before_rule_exec(_rule_stage, _context)
+      true
+    end
+
+    def after_rule_exec(_rule_stage, _context, _result)
+      true
+    end
+  end
+end

data/lib/onuro/engine.rb

@@ -1,22 +1,38 @@
 # frozen_string_literal: true
 
-class Onuro::Engine
-  def initialize
-    @events = []
-  end
+module Onuro
+  class Engine
+    include Logging
 
-  def add_event(event)
-    @events << event
-  end
+    attr_accessor :events
 
-  def event?(event_name)
-    @events.each do |event|
-      return true if event.name == event_name
+    def initialize
+      self.events = Hash.new(0)
+    end
+
+    def add_event(event)
+      events[event.name] = event
+      self
+    end
+
+    def add_events(new_events)
+      new_events.each { |event| add_event(event) }
+      self
     end
-    false
-  end
 
-  def execute
-    ['Still WIP']
+    def event?(event_name)
+      events.key?(event_name)
+    end
+
+    def delete_event!(event_name)
+      result = events.delete(event_name)
+      raise InvalidEventNameException unless result
+    end
+
+    def execute(event_name, context = {})
+      raise InvalidEventNameException unless event?(event_name)
+
+      events[event_name].execute(context)
+    end
   end
 end

data/lib/onuro/event.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Onuro
+  class Event
+    include Logging
+    include ExecutionResult
+
+    attr_reader :name, :ruleset_stage
+    attr_accessor :event_strategy
+
+    def name=(name)
+      raise InvalidEventNameException if name.empty?
+
+      @name = name.downcase.to_sym
+    end
+
+    def initialize(name, ruleset_stage: [], event_strategy: DefaultEventStrategy.new)
+      self.name = name
+      self.event_strategy = event_strategy
+      @ruleset_stage = ruleset_stage
+    end
+
+    def add_ruleset_stage(ruleset_stage)
+      @ruleset_stage += ruleset_stage
+    end
+
+    def add_rule_stage(rule_stage)
+      ruleset_stage << rule_stage
+    end
+
+    def execute(context = {})
+      result = execution_flow(context)
+      execution_result(SUCCESSFUL, result[:processed], result[:failed])
+    end
+
+    private
+
+    def execution_result(status, processed, failed)
+      result = Hash.new(0)
+      result[:status] = status
+      result[:event_name] = name
+      result[:processed_rules] = processed
+      result[:failed_rules] = failed
+      result
+    end
+
+    def execution_flow(context = {})
+      result = Hash.new(0)
+      ruleset_stage.each do |rule_stage|
+        proc_exec = event_strategy.before_rule_exec(rule_stage, context)
+        next unless proc_exec
+
+        result_status = rule_stage.rule.new.execute(context)
+        event_strategy.after_rule_exec(rule_stage, context, result)
+
+        result[:processed] += 1 if result_status == SUCCESSFUL
+        result[:failed] += 1 if result_status == FAILURE
+      end
+      result
+    end
+  end
+end

data/lib/onuro/event_builder.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Onuro
+  class EventBuilder
+    attr_accessor :event
+
+    def initialize(name)
+      self.event = Event.new(name)
+    end
+
+    def add_event_strategy(event_strategy)
+      event.event_strategy = event_strategy
+    end
+
+    def add_ruleset_stage(ruleset_stage)
+      event.add_ruleset_stage(ruleset_stage)
+    end
+
+    def add_rule_stage(rule_stage)
+      event.add_rule_stage(rule_stage)
+    end
+
+    def exec_order(order)
+      # can be :asc, :desc, :none by default (order is as rules were introduced
+      # in the ruleset_stage list)
+    end
+
+    def ignore_diseabled
+      # sets to true and all the diseablked rules will be executed
+      # default should be false, so diseabled rules will not be executed
+    end
+
+    def self.build(name)
+      builder = new(name)
+      yield builder
+      builder.event
+    end
+  end
+end

data/lib/onuro/execution_result.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Onuro
+  module ExecutionResult
+    SUCCESSFUL = 'SUCCESSFUL'
+    FAILURE = 'FAILURE'
+    NO_PROCESSABLE = 'NO_PROCESSABLE'
+  end
+end

data/lib/onuro/logging.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'active_support/logger'
+
+module Onuro
+  module Logging
+    def logger
+      Logging.logger
+    end
+
+    # Global, memoized, lazy initialized instance of a logger
+    def self.logger
+      @logger ||= ActiveSupport::Logger.new(logger_file, 10, 1_024_000)
+    end
+
+    def self.logger_file
+      'log/onuro_engine.log'
+    end
+  end
+end

data/lib/onuro/rule_stage.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Onuro
+  class RuleStage
+    attr_reader :rule, :enabled, :order
+
+    def initialize(rule:, enabled:, order:)
+      @rule = rule
+      @enabled = enabled
+      @order = order
+    end
+  end
+end

data/lib/onuro/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Onuro
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/onuro.gemspec

@@ -41,8 +41,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_development_dependency 'activesupport', '~> 5.2'
   spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'byebug', '~> 11.0'
+  spec.add_development_dependency 'coderay', '~> 1.1'
   spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.8'
   spec.add_development_dependency 'rubocop', '~> 0.71.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.33'
+  spec.add_development_dependency 'simplecov', '~> 0.16.1'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: onuro
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Rodrigo Reyes
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-10 00:00:00.000000000 Z
+date: 2019-07-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +108,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.71.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.33'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.33'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
 description: Ruby Workflow Engine based in events that execute a collection of rules.
 email:
 - encode@bytedecoder.me
@@ -74,6 +144,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -85,7 +156,14 @@ files:
 - bin/console
 - bin/setup
 - lib/onuro.rb
+- lib/onuro/base_rule.rb
+- lib/onuro/default_event_strategy.rb
 - lib/onuro/engine.rb
+- lib/onuro/event.rb
+- lib/onuro/event_builder.rb
+- lib/onuro/execution_result.rb
+- lib/onuro/logging.rb
+- lib/onuro/rule_stage.rb
 - lib/onuro/version.rb
 - onuro.gemspec
 homepage: https://github.com/ByteDecoder/onuro