onuro 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b8f298894039efad8040411f7f20ef9520904d86ba94e2a2e81affec3e3e42e
-  data.tar.gz: 69feab312564ca16fa4bcd2da211cf40c67e961379a744857c920bad0d761bb7
+  metadata.gz: ba55460305728147a6a6902162062d320bb2c8f3324b7001b2177b46ef5d297f
+  data.tar.gz: 426b556b04838c980ee44fee95210322ed89eeef0e522de578e3358183b0e88d
 SHA512:
-  metadata.gz: 342d089f5b6ea8180887d006e37fb3a3e13951483688774b46288319ea68e777230dee9f26e432f47611a72bd1fc24330d99858318d27afa47f70977b951e441
-  data.tar.gz: dddd4518bbf349f4b2ba1700936d6eee919f320e21d335e8fde0c365c360cbe1e6151169fc6b04ba0d8618728d3eaa6c6f42ba8045fbd6113eafd2981d5cf1b5
+  metadata.gz: 8e74ec30d7458cfb9f27d451181a1abd5272e4e7c0f8e715a1e080fd672f0d22b773cd48a36cca5b1047af3a0400b2b6b8eea5cbe7cbb572c32ebeb18c77cb45
+  data.tar.gz: 1c8c9b00aabdb5138095427d48eee6c7965fd69a17da7d52d616f6d758f3a1f3eafd726f146d9121364e9e354803b2e197d20c8ccabf7b251ee1643ec27b782f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    onuro (0.1.2)
+    onuro (0.1.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -22,6 +22,43 @@ Or install it yourself as:
 
 ## Usage
 
+The easiest way to load Event + Rules configuration in the **Engine** is using the configuration blocks. Its important to mention these global pre-configured events, would be changed when in runt-time an **engine instance** is begin fetched with new events.
+
+```ruby
+class Rule1 < Onuro::BaseRule; end
+class Rule2 < Onuro::BaseRule; end
+class Rule3 < Onuro::BaseRule; end
+class MyCustomEventStrategy < Onuro::DefaultEventStrategy; end
+
+
+Onuro::Engine.configure do |config|
+  config.add_event(:event_one) do |event|
+    event.add_ruleset_stage [
+      Onuro::RuleStage.new(rule: Rule1, enabled: true, order: 1),
+      Onuro::RuleStage.new(rule: Rule3, enabled: true, order: 2)
+    ]
+    event.add_event_strategy(MyCustomEventStrategy.new)
+    event.exec_order(:desc)
+    event.ignore_diseabled
+  end
+
+  config.add_event(:event_two) do |event|
+    event.add_ruleset_stage [
+      Onuro::RuleStage.new(rule: Rule1, enabled: true, order: 1),
+      Onuro::RuleStage.new(rule: Rule2, enabled: true, order: 2)
+    ]
+  end
+
+  config.add_event(:event_three) do |event|
+    event.add_ruleset_stage [Onuro::RuleStage.new(rule: Rule1, enabled: true, order: 1)]
+  end
+
+  config.add_event(:event_four) do |event|
+    event.add_rule_stage Onuro::RuleStage.default_ruleset_stage_factory([Rule1, Rule2, Rule3])
+  end
+end
+```
+
 ### Engine
 
 ### Rule
@@ -40,12 +77,12 @@ 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.
+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.add_event_strategy(MyCustomEventStrategy.new)
           builder.exec_order(:desc)
           buidler.ignore_diseabled
         end

data/lib/onuro/engine.rb

@@ -6,8 +6,46 @@ module Onuro
 
     attr_accessor :events
 
+    class << self
+      # Setter for shared global objects
+      attr_writer :configuration
+    end
+
+    # Returns the global [EngineConfiguration](Onuro/EngineConfiguration) object. While
+    # you _can_ use this method to access the configuration, the more common
+    # convention is to use [Onuro::Engine.configure](Onuro::Engine#configure-class_method).
+    #
+    # @example
+    #     Onuro::Engine.configuration.tbd = 1234
+    # @see Onuro::Engine.configure
+    # @see Onuro::EngineConfiguration
+    def self.configuration
+      @configuration ||= Onuro::EngineConfiguration.new
+    end
+
+    # Users must invoke this if they want to have the configuration reset when
+    # they use the runner multiple times within the same process. Users must deal
+    # themselves with re-configuration of Onuro::Engine before run.
+    def self.reset
+      @configuration = nil
+    end
+
+    # Yields the global configuration to a block.
+    # @yield [EngineConfiguration] global configuration
+    #
+    # @example
+    #     Onuro::Engine.configure do |config|
+    #       config.events 'documentation'
+    #     end
+    # @see Onuro::EngineConfiguration
+    def self.configure
+      yield configuration if block_given?
+    end
+
     def initialize
-      self.events = Hash.new(0)
+      # Loading events from the global configuration, if we have it
+      # We need to clone, otherwise will get the smae obejct_id reference
+      self.events = Engine.configuration.events.clone
     end
 
     def add_event(event)

data/lib/onuro/engine_configuration.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Onuro
+  class EngineConfiguration
+    attr_reader :events
+
+    def initialize
+      @events = Hash.new(0)
+    end
+
+    def add_event(event_name)
+      event = EventBuilder.build(event_name)
+      events[event.name] = event
+    end
+  end
+end

data/lib/onuro/event_builder.rb

@@ -32,7 +32,7 @@ module Onuro
 
     def self.build(name)
       builder = new(name)
-      yield builder
+      yield builder if block_given?
       builder.event
     end
   end

data/lib/onuro/rule_stage.rb

@@ -9,5 +9,15 @@ module Onuro
       @enabled = enabled
       @order = order
     end
+
+    def self.default_ruleset_stage_factory(rules)
+      ruleset_stage = []
+      order = 1
+      rules.each do |rule|
+        ruleset_stage << RuleStage.new(rule: rule, enabled: true, order: order)
+        order += 1
+      end
+      ruleset_stage
+    end
   end
 end

data/lib/onuro/version.rb

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

data/lib/onuro.rb

@@ -3,6 +3,7 @@
 require 'onuro/version'
 require 'onuro/execution_result'
 require 'onuro/logging'
+require 'onuro/engine_configuration'
 require 'onuro/engine'
 require 'onuro/default_event_strategy'
 require 'onuro/event_builder'
@@ -10,6 +11,7 @@ require 'onuro/event'
 require 'onuro/base_rule'
 require 'onuro/rule_stage'
 
+# Namespace for all Onuro code.
 module Onuro
   class Error < StandardError; end
   class InvalidEventNameException < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onuro
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Rodrigo Reyes
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-14 00:00:00.000000000 Z
+date: 2019-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -159,6 +159,7 @@ files:
 - lib/onuro/base_rule.rb
 - lib/onuro/default_event_strategy.rb
 - lib/onuro/engine.rb
+- lib/onuro/engine_configuration.rb
 - lib/onuro/event.rb
 - lib/onuro/event_builder.rb
 - lib/onuro/execution_result.rb