decouplio 1.0.0alpha → 1.0.0alpha3

data/lib/decouplio/action.rb

@@ -7,15 +7,18 @@ require_relative 'default_error_handler'
 require_relative 'errors/logic_redefinition_error'
 require_relative 'errors/logic_is_not_defined_error'
 require_relative 'errors/error_store_error'
+require_relative 'const/results'
 
 module Decouplio
   class Action
+    PREVIOUS_STEP_INDEX = -2
+
     extend Forwardable
     def_delegators :@error_store, :errors, :add_error
     attr_reader :railway_flow, :ctx, :error_store
 
     def initialize(
-      parent_railway_flow: nil, parent_ctx: nil, wrapper: false, error_store:, **params
+      parent_railway_flow: nil, parent_ctx: nil, error_store:, **params
     )
       @error_store = error_store
       @ctx = parent_ctx || params
@@ -43,6 +46,10 @@ module Decouplio
       @failure = false
     end
 
+    def previous_step
+      railway_flow[PREVIOUS_STEP_INDEX]
+    end
+
     def append_railway_flow(stp)
       railway_flow << stp
     end
@@ -55,10 +62,22 @@ module Decouplio
           #{railway_flow.join(' -> ')}
 
         Context:
-          #{ctx}
+          #{ctx.map { |k, v| "#{k.inspect} => #{v.inspect}" }.join("\n  ")}
 
         Errors:
-          #{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
     end
 

data/lib/decouplio/composer.rb

@@ -21,6 +21,7 @@ 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,7 +130,9 @@ module Decouplio
         when Decouplio::Const::Types::SERVICE_TYPE_PASS
           create_inner_service_pass(stp, flow)
         when Decouplio::Const::Types::DOBY_TYPE
-          create_doby(stp)
+          create_doby(stp, flow)
+        when Decouplio::Const::Types::AIDE_TYPE
+          create_aide(stp, flow)
         end
       end
 
@@ -183,7 +186,8 @@ module Decouplio
       def create_octo(stp)
         Decouplio::Steps::Octo.new(
           name: stp[:name],
-          ctx_key: stp[:ctx_key]
+          ctx_key: stp[:ctx_key],
+          method: stp[:method]
         )
       end
 
@@ -266,11 +270,23 @@ module Decouplio
         )
       end
 
-      def create_doby(stp)
+      def create_doby(stp, flow)
         Decouplio::Steps::Doby.new(
           name: stp[:name],
           doby_class: stp[:doby_class],
-          doby_options: stp[:doby_options]
+          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],
+          on_success_type: success_type(flow, stp),
+          on_failure_type: failure_type(flow, stp)
         )
       end
 
@@ -294,6 +310,8 @@ module Decouplio
             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
@@ -327,22 +345,22 @@ 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)
+      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,
-          nil
+          flow[step_id][:on_success]
         )
         stp[:flow][Decouplio::Const::Results::FAIL] = next_failure_step(
           flow_values,
           idx,
-          nil
+          flow[step_id][:on_failure]
         )
         stp[:flow][Decouplio::Const::Results::ERROR] = next_failure_step(
           flow_values,
           idx,
-          nil
+          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]
@@ -350,6 +368,29 @@ module Decouplio
         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(
@@ -409,18 +450,30 @@ module Decouplio
         return :finish_him if [:on_success, true].include?(finish_him(stp))
 
         step_id = stp.dig(:flow, Decouplio::Const::Results::PASS)
-        Decouplio::Const::Types::PASS_FLOW.include?(
-          flow[step_id]&.[](:type)
-        )
+        if step_id.nil? && Decouplio::Const::Results::STEP_PASS == stp[:on_success]
+          Decouplio::Const::Results::STEP_PASS
+        elsif step_id.nil? && Decouplio::Const::Results::STEP_FAIL == stp[:on_success]
+          Decouplio::Const::Results::STEP_FAIL
+        else
+          Decouplio::Const::Types::PASS_FLOW.include?(
+            flow[step_id]&.[](:type)
+          )
+        end
       end
 
       def failure_type(flow, stp)
         return :finish_him if [:on_failure, true].include?(finish_him(stp))
 
         step_id = stp.dig(:flow, Decouplio::Const::Results::FAIL)
-        Decouplio::Const::Types::FAIL_FLOW.include?(
-          flow[step_id]&.[](:type)
-        )
+        if step_id.nil? && Decouplio::Const::Results::STEP_PASS == stp[:on_failure]
+          Decouplio::Const::Results::STEP_PASS
+        elsif step_id.nil? && Decouplio::Const::Results::STEP_FAIL == stp[:on_on_failure]
+          Decouplio::Const::Results::STEP_FAIL
+        else
+          Decouplio::Const::Types::FAIL_FLOW.include?(
+            flow[step_id]&.[](:type)
+          )
+        end
       end
 
       def finish_him(stp)
@@ -543,7 +596,18 @@ module Decouplio
       def next_success_step(steps, idx, value)
         steps_slice = steps[(idx + 1)..]
         steps_slice.each_with_index do |stp, index|
-          if value == stp[:name]
+          if (
+            Decouplio::Const::Results::STEP_PASS == value &&
+            Decouplio::Const::Types::SUCCESS_TRACK_STEP_TYPES.include?(stp[:type])
+          ) || (
+            Decouplio::Const::Results::STEP_FAIL == value &&
+            Decouplio::Const::Types::FAILURE_TRACK_STEP_TYPES.include?(stp[:type])
+          ) || (
+            !value &&
+            Decouplio::Const::Types::SUCCESS_TRACK_STEP_TYPES.include?(stp[:type])
+          )
+            return stp[:step_id]
+          elsif value == stp[:name]
             prev_step = steps_slice[index - 1]
             if [
               Decouplio::Const::Types::IF_TYPE_PASS,
@@ -553,8 +617,6 @@ module Decouplio
             else
               return stp[:step_id]
             end
-          elsif !value && Decouplio::Const::Types::SUCCESS_TRACK_STEP_TYPES.include?(stp[:type])
-            return stp[:step_id]
           end
         end
 
@@ -564,7 +626,18 @@ module Decouplio
       def next_failure_step(steps, idx, value)
         steps_slice = steps[(idx + 1)..]
         steps_slice.each_with_index do |stp, index|
-          if value == stp[:name]
+          if (
+            Decouplio::Const::Results::STEP_PASS == value &&
+            Decouplio::Const::Types::SUCCESS_TRACK_STEP_TYPES.include?(stp[:type])
+          ) || (
+            Decouplio::Const::Results::STEP_FAIL == value &&
+            Decouplio::Const::Types::FAILURE_TRACK_STEP_TYPES.include?(stp[:type])
+          ) || (
+            !value &&
+            Decouplio::Const::Types::FAILURE_TRACK_STEP_TYPES.include?(stp[:type])
+          )
+            return stp[:step_id]
+          elsif value == stp[:name]
             prev_step = steps_slice[index - 1]
             if [
               Decouplio::Const::Types::IF_TYPE_FAIL,
@@ -574,8 +647,6 @@ module Decouplio
             else
               return stp[:step_id]
             end
-          elsif !value && Decouplio::Const::Types::FAILURE_TRACK_STEP_TYPES.include?(stp[:type])
-            return stp[:step_id]
           end
         end
 

data/lib/decouplio/const/doby_aide_options.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Decouplio
+  module Const
+    module DobyAideOptions
+      ALLOWED = %i[
+        on_success
+        on_failure
+        finish_him
+        if
+        unless
+      ].freeze
+    end
+  end
+end

data/lib/decouplio/const/reserved_methods.rb

@@ -1,17 +1,21 @@
 # frozen_string_literal: true
 
+require_relative 'results'
+
 module Decouplio
   module Const
     module ReservedMethods
-      NAMES = %i[
-        []
-        success?
-        failure?
-        fail_action
-        pass_action
-        append_railway_flow
-        inspect
-        to_s
+      NAMES = [
+        :[],
+        :success?,
+        :failure?,
+        :fail_action,
+        :pass_action,
+        :append_railway_flow,
+        :inspect,
+        :to_s,
+        Decouplio::Const::Results::STEP_PASS,
+        Decouplio::Const::Results::STEP_FAIL
       ].freeze
     end
   end

data/lib/decouplio/const/results.rb

@@ -8,6 +8,8 @@ module Decouplio
       ERROR = :error
       FINISH_HIM = :finish_him
       NO_STEP = nil
+      STEP_PASS = :PASS
+      STEP_FAIL = :FAIL
     end
   end
 end

data/lib/decouplio/const/types.rb

@@ -14,6 +14,7 @@ module Decouplio
       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
@@ -81,6 +82,14 @@ 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 = {
@@ -93,7 +102,8 @@ module Decouplio
         UNLESS_TYPE_PASS => RESQ_TYPE_STEP,
         IF_TYPE_FAIL => RESQ_TYPE_FAIL,
         UNLESS_TYPE_FAIL => RESQ_TYPE_FAIL,
-        DOBY_TYPE => RESQ_TYPE_STEP
+        DOBY_TYPE => RESQ_TYPE_STEP,
+        AIDE_TYPE => RESQ_TYPE_FAIL
       }.freeze
       STEP_TYPE_TO_INNER_TYPE = {
         STEP_TYPE => ACTION_TYPE_STEP,
@@ -115,7 +125,8 @@ module Decouplio
         OCTO_TYPE,
         WRAP_TYPE,
         RESQ_TYPE,
-        DOBY_TYPE
+        DOBY_TYPE,
+        AIDE_TYPE
       ].freeze
       PASS_FLOW = [
         STEP_TYPE,
@@ -135,7 +146,8 @@ module Decouplio
         IF_TYPE_FAIL,
         UNLESS_TYPE_FAIL,
         ACTION_TYPE_FAIL,
-        SERVICE_TYPE_FAIL
+        SERVICE_TYPE_FAIL,
+        AIDE_TYPE
       ].freeze
 
       MAIN_FLOW_TYPES = [
@@ -143,7 +155,8 @@ module Decouplio
         FAIL_TYPE,
         PASS_TYPE,
         WRAP_TYPE,
-        DOBY_TYPE
+        DOBY_TYPE,
+        AIDE_TYPE
       ].freeze
       SUCCESS_TRACK_STEP_TYPES = [
         STEP_TYPE,
@@ -166,7 +179,8 @@ module Decouplio
         UNLESS_TYPE_FAIL,
         RESQ_TYPE_FAIL,
         ACTION_TYPE_FAIL,
-        SERVICE_TYPE_FAIL
+        SERVICE_TYPE_FAIL,
+        AIDE_TYPE
       ].freeze
     end
   end

data/lib/decouplio/const/validations/aide.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Decouplio
+  module Const
+    module Validations
+      module Aide
+        VALIDATION_ERROR_MESSAGE = <<~ERROR_MESSAGE
+          Next options are not allowed for "aide":
+          %s
+
+          Details:
+          %s
+
+          Allowed options are:
+          %s
+
+          Please read the manual about allowed options here:
+          %s
+        ERROR_MESSAGE
+
+        ALLOWED_OPTIONS_MESSAGE = <<~ALLOWED_OPTIONS
+          on_success: <step name OR :finish_him>
+          on_failure: <step name OR :finish_him>
+          finish_him: :on_success
+          finish_him: :on_failure
+          finish_him: true
+          if: <instance method symbol>
+          unless: <instance method symbol>
+        ALLOWED_OPTIONS
+        MANUAL_URL = 'https://stub.aide.manual.url'
+        OPTIONS_IS_NOT_ALLOWED = '"%s" option(s) is not allowed for "aide"'
+        METHOD_NOT_DEFINED = 'aide :%s'
+        CONTROVERSIAL_KEYS = '"%s" option(s) is not allowed along with "%s" option(s)'
+        FIRST_STEP = '"aide" can not be the first step'
+      end
+    end
+  end
+end

data/lib/decouplio/const/validations/doby.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Decouplio
+  module Const
+    module Validations
+      module Doby
+        VALIDATION_ERROR_MESSAGE = <<~ERROR_MESSAGE
+          Next options are not allowed for "doby":
+          %s
+
+          Details:
+          %s
+
+          Allowed options are:
+          %s
+
+          Please read the manual about allowed options here:
+          %s
+        ERROR_MESSAGE
+
+        ALLOWED_OPTIONS_MESSAGE = <<~ALLOWED_OPTIONS
+          on_success: <step name OR :finish_him>
+          on_failure: <step name OR :finish_him>
+          finish_him: :on_success
+          finish_him: :on_failure
+          if: <instance method symbol>
+          unless: <instance method symbol>
+        ALLOWED_OPTIONS
+        MANUAL_URL = 'https://stub.doby.manual.url'
+        OPTIONS_IS_NOT_ALLOWED = '"%s" option(s) is not allowed for "doby"'
+        METHOD_NOT_DEFINED = 'doby :%s'
+        CONTROVERSIAL_KEYS = '"%s" option(s) is not allowed along with "%s" option(s)'
+      end
+    end
+  end
+end

data/lib/decouplio/const/validations/fail.rb

@@ -19,6 +19,10 @@ module Decouplio
         ERROR_MESSAGE
 
         ALLOWED_OPTIONS_MESSAGE = <<~ALLOWED_OPTIONS
+          on_success: <step name OR :finish_him>
+          on_failure: <step name OR :finish_him>
+          finish_him: :on_success
+          finish_him: :on_failure
           finish_him: true
           if: <instance method symbol>
           unless: <instance method symbol>
@@ -27,7 +31,7 @@ module Decouplio
         OPTIONS_IS_NOT_ALLOWED = '"%s" option(s) is not allowed for "fail"'
         METHOD_NOT_DEFINED = 'fail :%s'
         CONTROVERSIAL_KEYS = '"%s" option(s) is not allowed along with "%s" option(s)'
-        FIRST_STEP = '"fail" can not be first step'
+        FIRST_STEP = '"fail" can not be the first step'
       end
     end
   end

data/lib/decouplio/const/validations/octo.rb

@@ -28,7 +28,8 @@ module Decouplio
           %s
         ERROR_MESSAGE
         ALLOWED_OPTIONS_MESSAGE = <<~ALLOWED_OPTIONS
-          ctx_key: <ctx key with strategy name to be used for strategy mapping> - required
+          ctx_key: <ctx key with strategy name to be used for strategy mapping> - required if "method" option is not present
+          method: <method which will return strategy name to be used for strategy mapping> - required if "ctx_key" option is not present
           if: <instance method symbol>
           unless: <instance method symbol>
         ALLOWED_OPTIONS

data/lib/decouplio/errors/aide_can_not_be_first_step_error.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative 'base_error'
+require_relative '../const/validations/aide'
+
+module Decouplio
+  module Errors
+    class AideCanNotBeFirstStepError < Decouplio::Errors::BaseError
+      def template
+        Decouplio::Const::Validations::Aide::FIRST_STEP
+      end
+
+      def interpolation_values
+        []
+      end
+    end
+  end
+end

data/lib/decouplio/errors/aide_controversial_keys_error.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'base_error'
+require_relative '../const/validations/aide'
+
+module Decouplio
+  module Errors
+    class AideControversialKeysError < Decouplio::Errors::BaseError
+      def template
+        Decouplio::Const::Validations::Aide::VALIDATION_ERROR_MESSAGE
+      end
+
+      def interpolation_values
+        [
+          @errored_option,
+          format(
+            Decouplio::Const::Validations::Aide::CONTROVERSIAL_KEYS,
+            *@details
+          ),
+          Decouplio::Const::Validations::Aide::ALLOWED_OPTIONS_MESSAGE,
+          Decouplio::Const::Validations::Aide::MANUAL_URL
+        ]
+      end
+    end
+  end
+end

data/lib/decouplio/errors/aide_finish_him_error.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'base_error'
+require_relative '../const/validations/aide'
+
+module Decouplio
+  module Errors
+    class AideFinishHimError < Decouplio::Errors::BaseError
+      def template
+        Decouplio::Const::Validations::Aide::VALIDATION_ERROR_MESSAGE
+      end
+
+      def interpolation_values
+        [
+          @errored_option,
+          format(
+            Decouplio::Const::Validations::Common::WRONG_FINISH_HIM_VALUE,
+            @details
+          ),
+          Decouplio::Const::Validations::Aide::ALLOWED_OPTIONS_MESSAGE,
+          Decouplio::Const::Validations::Aide::MANUAL_URL
+        ]
+      end
+    end
+  end
+end

data/lib/decouplio/errors/doby_controversial_keys_error.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'base_error'
+require_relative '../const/validations/doby'
+
+module Decouplio
+  module Errors
+    class DobyControversialKeysError < Decouplio::Errors::BaseError
+      def template
+        Decouplio::Const::Validations::Doby::VALIDATION_ERROR_MESSAGE
+      end
+
+      def interpolation_values
+        [
+          @errored_option,
+          format(
+            Decouplio::Const::Validations::Doby::CONTROVERSIAL_KEYS,
+            *@details
+          ),
+          Decouplio::Const::Validations::Doby::ALLOWED_OPTIONS_MESSAGE,
+          Decouplio::Const::Validations::Doby::MANUAL_URL
+        ]
+      end
+    end
+  end
+end

data/lib/decouplio/errors/doby_finish_him_error.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'base_error'
+require_relative '../const/validations/doby'
+
+module Decouplio
+  module Errors
+    class DobyFinishHimError < Decouplio::Errors::BaseError
+      def template
+        Decouplio::Const::Validations::Doby::VALIDATION_ERROR_MESSAGE
+      end
+
+      def interpolation_values
+        [
+          @errored_option,
+          format(
+            Decouplio::Const::Validations::Common::WRONG_FINISH_HIM_VALUE,
+            @details
+          ),
+          Decouplio::Const::Validations::Doby::ALLOWED_OPTIONS_MESSAGE,
+          Decouplio::Const::Validations::Doby::MANUAL_URL
+        ]
+      end
+    end
+  end
+end

data/lib/decouplio/errors/{fail_is_first_step_error.rb → fail_can_not_be_first_step_error.rb}

@@ -5,7 +5,7 @@ require_relative '../const/validations/fail'
 
 module Decouplio
   module Errors
-    class FailCanNotBeTheFirstStepError < Decouplio::Errors::BaseError
+    class FailCanNotBeFirstStepError < Decouplio::Errors::BaseError
       def template
         Decouplio::Const::Validations::Fail::FIRST_STEP
       end

data/lib/decouplio/errors/step_is_not_defined_for_aide_error.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'base_error'
+require_relative '../const/validations/fail'
+
+module Decouplio
+  module Errors
+    class StepIsNotDefinedForAideError < Decouplio::Errors::BaseError
+      def template
+        Decouplio::Const::Validations::Aide::VALIDATION_ERROR_MESSAGE
+      end
+
+      def interpolation_values
+        [
+          @errored_option,
+          format(
+            Decouplio::Const::Validations::Common::STEP_IS_NOT_DEFINED,
+            @details
+          ),
+          Decouplio::Const::Validations::Aide::ALLOWED_OPTIONS_MESSAGE,
+          Decouplio::Const::Validations::Aide::MANUAL_URL
+        ]
+      end
+    end
+  end
+end