decouplio 1.0.0alpha4 → 1.0.0alpha8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 837f903aec27c7a95ab61c92f4072e040fa4c2dfc74ebcafe0f740428b3cce59
-  data.tar.gz: faeef52b5bc5f8f1abdd419c13cd7871576c86a23e9d5d00c8aa9ab12a150b05
+  metadata.gz: 13faf170a6cfce8a57a5263eb8ba404ee1ceadcda93990c9c780987bd6a79a8e
+  data.tar.gz: 18e855d3cbf016a0e1976e72147309db0ec0e91d764b1c7988cdb7172868c804
 SHA512:
-  metadata.gz: 5df71fc94709fc03625e36281d5458043616200153deee80fb5e2013900d85f8412a0adb30ce1516a90633e4ecef8aa9ff37d7ff5b7cdfc1aca1b2179aee7e0c
-  data.tar.gz: b39a6be930ed5ce6adf0257537fd5b99392259d889fc236457ed4d9b6f5e69a868648cf2a945f064be25d6978d8ad158001554d0b24da2e32cd92c1fe39a217c
+  metadata.gz: 53426aa0ac2fdd513d7fb80dea55e4e5e1425b3ef08912fe53f3fefbdfa25773d8fa3dce9dc8a84efec89c8078f42756af1b741a34f9d937050a823f577bdfad
+  data.tar.gz: 5209925b7857efa198cae3f9e2ceb1341cd160944ab9855557fea6bacb1762c3239f0b08a33abf837d5d610de36d157a761c132b053eed25b07c676ceaaf191d

data/.rubocop.yml

@@ -75,7 +75,6 @@ Lint/ConstantDefinitionInBlock:
     - spec/fail_spec.rb
     - spec/palp_block_spec.rb
     - spec/wrap_block_spec.rb
-    - spec/error_store_for_inner_step_spec.rb
 
 RSpec/LeakyConstantDeclaration:
   Exclude:
@@ -83,16 +82,6 @@ RSpec/LeakyConstantDeclaration:
     - spec/fail_spec.rb
     - spec/palp_block_spec.rb
     - spec/wrap_block_spec.rb
-    - spec/error_store_for_inner_step_spec.rb
-
-RSpec/FilePath:
-  Exclude:
-    - spec/default_error_handler_spec.rb
-
-RSpec/ExampleLength:
-  Max: 15
-  Exclude:
-    - spec/default_error_handler_spec.rb
 
 RSpec/MultipleExpectations:
   Enabled: false
@@ -111,3 +100,9 @@ Naming/MethodParameterName:
 
 Naming/RescuedExceptionsVariableName:
   Enabled: false
+
+Layout/LineContinuationSpacing:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.7.0
+2.7.6

data/decouplio.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Gem for business logic encapsulation'
   spec.description   = "Decouplio is a zero dependency, thread safe and framework agnostic gem designed to encapsulate application business logic. It's reverse engineered through TDD and inspired by such frameworks and gems like Trailblazer, Interactor."
-  spec.homepage      = 'https://github.com/differencialx/decouplio/blob/master/docs'
+  spec.homepage      = 'https://differencialx.github.io/decouplio.github.io/'
   spec.license       = 'MIT'
 
   if spec.respond_to?(:metadata)

data/lib/decouplio/action.rb

@@ -3,25 +3,23 @@
 require 'forwardable'
 require_relative 'flow'
 require_relative 'processor'
-require_relative 'default_error_handler'
+require_relative 'default_meta_store'
+require_relative 'action_state_printer'
 require_relative 'errors/logic_redefinition_error'
 require_relative 'errors/logic_is_not_defined_error'
-require_relative 'errors/error_store_error'
 require_relative 'errors/execution_error'
 require_relative 'const/results'
 
 module Decouplio
   class Action
-    PREVIOUS_STEP_INDEX = -2
+    attr_reader :railway_flow, :ctx, :meta_store
 
-    extend Forwardable
-    def_delegators :@error_store, :errors, :add_error
-    attr_reader :railway_flow, :ctx, :error_store
+    alias ms meta_store
 
     def initialize(
-      parent_railway_flow: nil, parent_ctx: nil, error_store:, **params
+      parent_railway_flow: nil, parent_ctx: nil, meta_store:, **params
     )
-      @error_store = error_store
+      @meta_store = meta_store
       @ctx = parent_ctx || params
       @railway_flow = parent_railway_flow || []
       @failure = false
@@ -47,39 +45,12 @@ module Decouplio
       @failure = false
     end
 
-    def previous_step
-      railway_flow[PREVIOUS_STEP_INDEX]
-    end
-
     def append_railway_flow(stp)
       railway_flow << stp
     end
 
     def inspect
-      <<~INSPECT
-        Result: #{success? ? 'success' : 'failure'}
-
-        Railway Flow:
-          #{railway_flow.join(' -> ')}
-
-        Context:
-          #{ctx.map { |k, v| "#{k.inspect} => #{v.inspect}" }.join("\n  ")}
-
-        Errors:
-          #{
-            if errors.is_a?(Hash)
-              if errors.empty?
-                'None'
-              else
-                errors.map do |k, v|
-                  "#{k.inspect} => #{v.inspect}"
-                end.join("\n  ")
-              end
-            else
-              errors
-            end
-          }
-      INSPECT
+      Decouplio::ActionStatePrinter.call(self)
     end
 
     def to_s
@@ -87,16 +58,19 @@ module Decouplio
     end
 
     class << self
-      attr_accessor :error_store
+      attr_accessor :meta_store
 
-      def error_store_class(klass)
-        self.error_store = klass
+      def meta_store_class(klass)
+        self.meta_store = klass
       end
 
       def call(**params)
-        instance = new(error_store: error_store.new, **params)
+        instance = new(
+          **{
+            meta_store: meta_store.new
+          }.merge(**params)
+        )
         Decouplio::Processor.call(instance: instance, **@flow)
-        # TODO: process block with after actions
         instance
       end
 
@@ -114,7 +88,7 @@ module Decouplio
       private
 
       def inherited(child_class)
-        child_class.error_store = error_store || Decouplio::DefaultErrorHandler
+        child_class.meta_store = meta_store || Decouplio::DefaultMetaStore
       end
 
       def logic(&block)

data/lib/decouplio/action_state_printer.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Decouplio
+  class ActionStatePrinter
+    def self.call(action)
+      <<~INSPECT
+
+        Result: #{result(action)}
+
+        RailwayFlow:
+          #{railway_flow(action)}
+
+        Context:
+          #{action_context(action)}
+
+        #{meta_store(action)}
+
+      INSPECT
+    end
+
+    def self.result(action)
+      action.success? ? 'success' : 'failure'
+    end
+
+    def self.railway_flow(action)
+      action.railway_flow.join(' -> ')
+    end
+
+    def self.action_context(action)
+      action.ctx.map { |k, v| "#{k.inspect} => #{v.inspect}" }.join("\n  ")
+    end
+
+    def self.meta_store(action)
+      action.ms.to_s
+    end
+  end
+end

data/lib/decouplio/composer.rb

@@ -20,8 +20,6 @@ require_relative 'steps/inner_action_pass'
 require_relative 'steps/service_step'
 require_relative 'steps/service_fail'
 require_relative 'steps/service_pass'
-require_relative 'steps/doby'
-require_relative 'steps/aide'
 require_relative 'options_validator'
 require_relative 'validators/condition'
 
@@ -129,10 +127,6 @@ module Decouplio
           create_inner_service_fail(stp, flow)
         when Decouplio::Const::Types::SERVICE_TYPE_PASS
           create_inner_service_pass(stp, flow)
-        when Decouplio::Const::Types::DOBY_TYPE
-          create_doby(stp, flow)
-        when Decouplio::Const::Types::AIDE_TYPE
-          create_aide(stp, flow)
         end
       end
 
@@ -249,6 +243,7 @@ module Decouplio
         Decouplio::Steps::ServiceStep.new(
           name: stp[:name],
           service: stp[:service],
+          args: stp[:_args],
           on_success_type: success_type(flow, stp),
           on_failure_type: failure_type(flow, stp)
         )
@@ -258,6 +253,7 @@ module Decouplio
         Decouplio::Steps::ServiceFail.new(
           name: stp[:name],
           service: stp[:service],
+          args: stp[:_args],
           on_success_type: success_type(flow, stp),
           on_failure_type: failure_type(flow, stp)
         )
@@ -267,26 +263,7 @@ module Decouplio
         Decouplio::Steps::ServicePass.new(
           name: stp[:name],
           service: stp[:service],
-          on_success_type: success_type(flow, stp),
-          on_failure_type: failure_type(flow, stp)
-        )
-      end
-
-      def create_doby(stp, flow)
-        Decouplio::Steps::Doby.new(
-          name: stp[:name],
-          doby_class: stp[:doby_class],
-          doby_options: stp[:doby_options],
-          on_success_type: success_type(flow, stp),
-          on_failure_type: failure_type(flow, stp)
-        )
-      end
-
-      def create_aide(stp, flow)
-        Decouplio::Steps::Aide.new(
-          name: stp[:name],
-          aide_class: stp[:aide_class],
-          aide_options: stp[:aide_options],
+          args: stp[:_args],
           on_success_type: success_type(flow, stp),
           on_failure_type: failure_type(flow, stp)
         )
@@ -310,10 +287,6 @@ module Decouplio
                Decouplio::Const::Types::ACTION_TYPE_FAIL,
                Decouplio::Const::Types::SERVICE_TYPE_FAIL
             compose_fail_flow(stp, step_id, flow, idx, flow_hash, next_steps)
-          when Decouplio::Const::Types::DOBY_TYPE
-            compose_doby_flow(stp, step_id, flow, idx, flow_hash, next_steps)
-          when Decouplio::Const::Types::AIDE_TYPE
-            compose_aide_flow(stp, step_id, flow, idx, flow_hash, next_steps)
           when Decouplio::Const::Types::IF_TYPE_PASS, Decouplio::Const::Types::UNLESS_TYPE_PASS
             compose_pass_condition_flow(stp, flow, idx, flow_hash)
           when Decouplio::Const::Types::IF_TYPE_FAIL, Decouplio::Const::Types::UNLESS_TYPE_FAIL
@@ -347,52 +320,6 @@ module Decouplio
         stp[:flow][Decouplio::Const::Results::FINISH_HIM] = Decouplio::Const::Results::NO_STEP
       end
 
-      def compose_doby_flow(stp, step_id, flow, idx, flow_hash, next_steps)
-        flow_values = flow.values + (next_steps&.values || [])
-        stp[:flow][Decouplio::Const::Results::PASS] = next_success_step(
-          flow_values,
-          idx,
-          flow[step_id][:on_success]
-        )
-        stp[:flow][Decouplio::Const::Results::FAIL] = next_failure_step(
-          flow_values,
-          idx,
-          flow[step_id][:on_failure]
-        )
-        stp[:flow][Decouplio::Const::Results::ERROR] = next_failure_step(
-          flow_values,
-          idx,
-          flow[step_id][:on_error]
-        )
-        stp[:flow][Decouplio::Const::Results::PASS] ||= flow_hash[Decouplio::Const::Results::PASS]
-        stp[:flow][Decouplio::Const::Results::FAIL] ||= flow_hash[Decouplio::Const::Results::FAIL]
-        stp[:flow][Decouplio::Const::Results::ERROR] ||= flow_hash[Decouplio::Const::Results::ERROR]
-        stp[:flow][Decouplio::Const::Results::FINISH_HIM] = Decouplio::Const::Results::NO_STEP
-      end
-
-      def compose_aide_flow(stp, step_id, flow, idx, flow_hash, next_steps)
-        flow_values = flow.values + (next_steps&.values || [])
-        stp[:flow][Decouplio::Const::Results::PASS] = next_failure_step(
-          flow_values,
-          idx,
-          flow[step_id][:on_success]
-        )
-        stp[:flow][Decouplio::Const::Results::FAIL] = next_failure_step(
-          flow_values,
-          idx,
-          flow[step_id][:on_failure]
-        )
-        stp[:flow][Decouplio::Const::Results::ERROR] = next_failure_step(
-          flow_values,
-          idx,
-          flow[step_id][:on_error]
-        )
-        stp[:flow][Decouplio::Const::Results::PASS] ||= flow_hash[Decouplio::Const::Results::FAIL]
-        stp[:flow][Decouplio::Const::Results::FAIL] ||= flow_hash[Decouplio::Const::Results::FAIL]
-        stp[:flow][Decouplio::Const::Results::ERROR] ||= flow_hash[Decouplio::Const::Results::ERROR]
-        stp[:flow][Decouplio::Const::Results::FINISH_HIM] = Decouplio::Const::Results::NO_STEP
-      end
-
       def compose_fail_flow(stp, step_id, flow, idx, flow_hash, next_steps)
         flow_values = flow.values + (next_steps&.values || [])
         stp[:flow][Decouplio::Const::Results::PASS] = next_failure_step(

data/lib/decouplio/const/{doby_aide_options.rb → step_options.rb}

@@ -2,10 +2,11 @@
 
 module Decouplio
   module Const
-    module DobyAideOptions
+    module StepOptions
       ALLOWED = %i[
         on_success
         on_failure
+        on_error
         finish_him
         if
         unless

data/lib/decouplio/const/types.rb

@@ -13,8 +13,6 @@ module Decouplio
       IF_TYPE_FAIL = :if_fail
       UNLESS_TYPE_FAIL = :unless_fail
       OCTO_TYPE = :octo
-      DOBY_TYPE = :doby
-      AIDE_TYPE = :aide
       ACTION_TYPE_STEP = :action_step
       ACTION_TYPE_FAIL = :action_fail
       ACTION_TYPE_PASS = :action_pass
@@ -82,14 +80,6 @@ module Decouplio
         SERVICE_TYPE_PASS => {
           IF_TYPE => IF_TYPE_PASS,
           UNLESS_TYPE => UNLESS_TYPE_PASS
-        },
-        DOBY_TYPE => {
-          IF_TYPE => IF_TYPE_PASS,
-          UNLESS_TYPE => UNLESS_TYPE_PASS
-        },
-        AIDE_TYPE => {
-          IF_TYPE => IF_TYPE_FAIL,
-          UNLESS_TYPE => UNLESS_TYPE_FAIL
         }
       }.freeze
       STEP_TYPE_TO_RESQ_TYPE = {
@@ -101,9 +91,7 @@ module Decouplio
         IF_TYPE_PASS => RESQ_TYPE_STEP,
         UNLESS_TYPE_PASS => RESQ_TYPE_STEP,
         IF_TYPE_FAIL => RESQ_TYPE_FAIL,
-        UNLESS_TYPE_FAIL => RESQ_TYPE_FAIL,
-        DOBY_TYPE => RESQ_TYPE_STEP,
-        AIDE_TYPE => RESQ_TYPE_FAIL
+        UNLESS_TYPE_FAIL => RESQ_TYPE_FAIL
       }.freeze
       STEP_TYPE_TO_INNER_TYPE = {
         STEP_TYPE => ACTION_TYPE_STEP,
@@ -124,9 +112,7 @@ module Decouplio
       ACTION_NOT_ALLOWED_STEPS = [
         OCTO_TYPE,
         WRAP_TYPE,
-        RESQ_TYPE,
-        DOBY_TYPE,
-        AIDE_TYPE
+        RESQ_TYPE
       ].freeze
       PASS_FLOW = [
         STEP_TYPE,
@@ -138,25 +124,21 @@ module Decouplio
         ACTION_TYPE_PASS,
         ACTION_TYPE_STEP,
         SERVICE_TYPE_STEP,
-        SERVICE_TYPE_PASS,
-        DOBY_TYPE
+        SERVICE_TYPE_PASS
       ].freeze
       FAIL_FLOW = [
         FAIL_TYPE,
         IF_TYPE_FAIL,
         UNLESS_TYPE_FAIL,
         ACTION_TYPE_FAIL,
-        SERVICE_TYPE_FAIL,
-        AIDE_TYPE
+        SERVICE_TYPE_FAIL
       ].freeze
 
       MAIN_FLOW_TYPES = [
         STEP_TYPE,
         FAIL_TYPE,
         PASS_TYPE,
-        WRAP_TYPE,
-        DOBY_TYPE,
-        AIDE_TYPE
+        WRAP_TYPE
       ].freeze
       SUCCESS_TRACK_STEP_TYPES = [
         STEP_TYPE,
@@ -170,8 +152,7 @@ module Decouplio
         SERVICE_TYPE_PASS,
         RESQ_TYPE_STEP,
         RESQ_TYPE_PASS,
-        OCTO_TYPE,
-        DOBY_TYPE
+        OCTO_TYPE
       ].freeze
       FAILURE_TRACK_STEP_TYPES = [
         FAIL_TYPE,
@@ -179,8 +160,7 @@ module Decouplio
         UNLESS_TYPE_FAIL,
         RESQ_TYPE_FAIL,
         ACTION_TYPE_FAIL,
-        SERVICE_TYPE_FAIL,
-        AIDE_TYPE
+        SERVICE_TYPE_FAIL
       ].freeze
     end
   end

data/lib/decouplio/default_meta_store.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Decouplio
+  class DefaultMetaStore
+    attr_accessor :status
+    attr_reader :errors
+
+    def initialize
+      @errors = {}
+      @status = nil
+    end
+
+    def add_error(key, messages)
+      @errors.store(
+        key,
+        (@errors[key] || []) + [messages].flatten
+      )
+    end
+
+    def to_s
+      <<~METASTORE
+        Status: #{@status || 'NONE'}
+
+        Errors:
+          #{errors_string}
+      METASTORE
+    end
+
+    private
+
+    def errors_string
+      return 'NONE' if @errors.empty?
+
+      @errors.map do |k, v|
+        "#{k.inspect} => #{v.inspect}"
+      end.join("\n  ")
+    end
+  end
+end

data/lib/decouplio/logic_dsl.rb

@@ -2,7 +2,7 @@
 
 require_relative 'flow'
 require_relative 'const/types'
-require_relative 'const/doby_aide_options'
+require_relative 'const/step_options'
 require_relative 'octo_hash_case'
 require_relative 'errors/options_validation_error'
 require_relative 'errors/palp_validation_error'
@@ -10,7 +10,6 @@ require_relative 'errors/resq_definition_error'
 require_relative 'errors/wrap_block_is_not_defined_error'
 require_relative 'errors/palp_block_is_not_defined_error'
 require_relative 'errors/fail_can_not_be_first_step_error'
-require_relative 'errors/aide_can_not_be_first_step_error'
 require_relative 'errors/octo_block_is_not_defined_error'
 
 module Decouplio
@@ -30,17 +29,61 @@ module Decouplio
       end
 
       def step(stp, **options)
-        @steps << options.merge(type: Decouplio::Const::Types::STEP_TYPE, name: stp)
+        if stp.is_a?(Class) && !(stp < Decouplio::Action)
+          step_options = {}
+
+          options.each_key do |key|
+            step_options[key] = options.delete(key) if Decouplio::Const::StepOptions::ALLOWED.include?(key)
+          end
+
+          @steps << {
+            type: Decouplio::Const::Types::STEP_TYPE,
+            name: stp,
+            _args: options,
+            **step_options
+          }
+        else
+          @steps << options.merge(type: Decouplio::Const::Types::STEP_TYPE, name: stp)
+        end
       end
 
       def fail(stp, **options)
         raise Decouplio::Errors::FailCanNotBeFirstStepError if @steps.empty?
 
-        @steps << options.merge(type: Decouplio::Const::Types::FAIL_TYPE, name: stp)
+        if stp.is_a?(Class) && !(stp < Decouplio::Action)
+          step_options = {}
+          options.each_key do |key|
+            step_options[key] = options.delete(key) if Decouplio::Const::StepOptions::ALLOWED.include?(key)
+          end
+
+          @steps << {
+            type: Decouplio::Const::Types::FAIL_TYPE,
+            name: stp,
+            _args: options,
+            **step_options
+          }
+        else
+          @steps << options.merge(type: Decouplio::Const::Types::FAIL_TYPE, name: stp)
+        end
       end
 
       def pass(stp, **options)
-        @steps << options.merge(type: Decouplio::Const::Types::PASS_TYPE, name: stp)
+        if stp.is_a?(Class) && !(stp < Decouplio::Action)
+          step_options = {}
+
+          options.each_key do |key|
+            step_options[key] = options.delete(key) if Decouplio::Const::StepOptions::ALLOWED.include?(key)
+          end
+
+          @steps << {
+            type: Decouplio::Const::Types::PASS_TYPE,
+            name: stp,
+            _args: options,
+            **step_options
+          }
+        else
+          @steps << options.merge(type: Decouplio::Const::Types::PASS_TYPE, name: stp)
+        end
       end
 
       def octo(octo_name, **options, &block)
@@ -85,38 +128,13 @@ module Decouplio
         )
       end
 
-      def doby(doby_class, **options)
-        step_options = {}
-        options.each_key do |key|
-          step_options[key] = options.delete(key) if Decouplio::Const::DobyAideOptions::ALLOWED.include?(key)
-        end
-        doby_options = options
-
-        @steps << {
-          type: Decouplio::Const::Types::DOBY_TYPE,
-          name: doby_class.name.to_sym,
-          doby_class: doby_class,
-          doby_options: doby_options,
-          **step_options
-        }
+      def doby(_doby_class, **_options)
+        raise '"doby" step is deprecated. Please use "step" or "pass" instead. ' \
+              'Just simply replace "doby " with "step " or "pass "'
       end
 
-      def aide(aide_class, **options)
-        raise Decouplio::Errors::AideCanNotBeFirstStepError if @steps.empty?
-
-        step_options = {}
-        options.each_key do |key|
-          step_options[key] = options.delete(key) if Decouplio::Const::DobyAideOptions::ALLOWED.include?(key)
-        end
-        aide_options = options
-
-        @steps << {
-          type: Decouplio::Const::Types::AIDE_TYPE,
-          name: aide_class.name.to_sym,
-          aide_class: aide_class,
-          aide_options: aide_options,
-          **step_options
-        }
+      def aide(_aide_class, **_options)
+        raise '"aide" step is deprecated. Please use "fail". Just simply replace "aide " with "fail "'
       end
     end
   end