decouplio 1.0.0alpha1 → 1.0.0alpha4

data/lib/decouplio/errors/step_is_not_defined_for_doby_error.rb

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

data/lib/decouplio/errors/step_is_not_defined_for_pass_error.rb

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

data/lib/decouplio/logic_dsl.rb

@@ -2,13 +2,15 @@
 
 require_relative 'flow'
 require_relative 'const/types'
+require_relative 'const/doby_aide_options'
 require_relative 'octo_hash_case'
 require_relative 'errors/options_validation_error'
 require_relative 'errors/palp_validation_error'
 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_is_first_step_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
@@ -32,7 +34,7 @@ module Decouplio
       end
 
       def fail(stp, **options)
-        raise Decouplio::Errors::FailCanNotBeTheFirstStepError if @steps.empty?
+        raise Decouplio::Errors::FailCanNotBeFirstStepError if @steps.empty?
 
         @steps << options.merge(type: Decouplio::Const::Types::FAIL_TYPE, name: stp)
       end
@@ -84,11 +86,36 @@ 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: options
+          doby_options: doby_options,
+          **step_options
+        }
+      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
         }
       end
     end

data/lib/decouplio/options_validator.rb

@@ -10,6 +10,8 @@ require_relative 'errors/extra_key_for_pass_error'
 require_relative 'errors/extra_key_for_resq_error'
 require_relative 'errors/extra_key_for_wrap_error'
 require_relative 'errors/fail_finish_him_error'
+require_relative 'errors/doby_finish_him_error'
+require_relative 'errors/aide_finish_him_error'
 require_relative 'errors/invalid_error_class_error'
 require_relative 'errors/invalid_wrap_name_error'
 require_relative 'errors/pass_finish_him_error'
@@ -19,10 +21,15 @@ require_relative 'errors/resq_handler_method_error'
 require_relative 'errors/step_finish_him_error'
 require_relative 'errors/step_is_not_defined_for_step_error'
 require_relative 'errors/step_is_not_defined_for_fail_error'
+require_relative 'errors/step_is_not_defined_for_pass_error'
 require_relative 'errors/step_is_not_defined_for_wrap_error'
+require_relative 'errors/step_is_not_defined_for_aide_error'
+require_relative 'errors/step_is_not_defined_for_doby_error'
 require_relative 'errors/wrap_finish_him_error'
 require_relative 'errors/wrap_klass_method_error'
 require_relative 'errors/step_controversial_keys_error'
+require_relative 'errors/doby_controversial_keys_error'
+require_relative 'errors/aide_controversial_keys_error'
 require_relative 'errors/fail_controversial_keys_error'
 require_relative 'errors/pass_controversial_keys_error'
 require_relative 'errors/octo_controversial_keys_error'
@@ -64,7 +71,7 @@ module Decouplio
       when Decouplio::Const::Types::FAIL_TYPE
         validate_fail(options: filtered_options, step_names: step_names)
       when Decouplio::Const::Types::PASS_TYPE
-        validate_pass(options: filtered_options)
+        validate_pass(options: filtered_options, step_names: step_names)
       when Decouplio::Const::Types::OCTO_TYPE
         validate_octo(options: filtered_options, hash_case: options[:hash_case])
       when Decouplio::Const::Types::WRAP_TYPE
@@ -80,12 +87,16 @@ module Decouplio
       when Decouplio::Const::Types::ACTION_TYPE_PASS
         validate_action(action_class: options[:action], type: Decouplio::Const::Types::PASS_TYPE)
         validate_error_store(parent_action_class: @action_class, child_action_class: options[:action])
-        validate_pass(options: filtered_options)
+        validate_pass(options: filtered_options, step_names: step_names)
       when Decouplio::Const::Types::RESQ_TYPE_STEP,
            Decouplio::Const::Types::RESQ_TYPE_FAIL,
            Decouplio::Const::Types::RESQ_TYPE_PASS
         validate(options: options[:step_to_resq], step_names: step_names)
         validate_resq(options: filtered_options)
+      when Decouplio::Const::Types::DOBY_TYPE
+        validate_doby(options: filtered_options, step_names: step_names)
+      when Decouplio::Const::Types::AIDE_TYPE
+        validate_aide(options: filtered_options, step_names: step_names)
       end
     end
 
@@ -112,7 +123,8 @@ module Decouplio
       check_fail_finish_him(options: options)
     end
 
-    def validate_pass(options:)
+    def validate_pass(options:, step_names:)
+      check_step_presence_for_pass(options: options, step_names: step_names)
       check_pass_extra_keys(options: options)
       check_pass_finish_him(options: options)
     end
@@ -142,6 +154,18 @@ module Decouplio
       check_resq_exception_classes_inheritance(options: options)
     end
 
+    def validate_doby(options:, step_names:)
+      check_step_presence_for_doby(options: options, step_names: step_names)
+      check_doby_controversial_keys(options: options)
+      check_doby_finish_him(options: options)
+    end
+
+    def validate_aide(options:, step_names:)
+      check_step_presence_for_aide(options: options, step_names: step_names)
+      check_aide_controversial_keys(options: options)
+      check_aide_finish_him(options: options)
+    end
+
     def validate_name(name:)
       return unless Decouplio::Const::ReservedMethods::NAMES.include?(name)
 
@@ -152,7 +176,8 @@ module Decouplio
 
     def check_step_presence_for_step(options:, step_names:)
       options.slice(*STEP_CHECK_STEP_PRESENCE).each do |option_key, option_value|
-        next if %i[on_success on_failure].include?(option_key) && option_value == :finish_him
+        next if %i[on_success on_failure on_error].include?(option_key) &&
+                STEP_ALLOWED_ON_S_ON_F_VALUES.include?(option_value)
 
         next if step_names.keys.include?(option_value)
 
@@ -163,9 +188,52 @@ module Decouplio
       end
     end
 
+    def check_step_presence_for_pass(options:, step_names:)
+      options.slice(*PASS_CHECK_STEP_PRESENCE).each do |option_key, option_value|
+        next if %i[on_error].include?(option_key) &&
+                STEP_ALLOWED_ON_S_ON_F_VALUES.include?(option_value)
+
+        next if step_names.keys.include?(option_value)
+
+        raise Decouplio::Errors::StepIsNotDefinedForPassError.new(
+          errored_option: options.slice(option_key).to_s,
+          details: option_value
+        )
+      end
+    end
+
+    def check_step_presence_for_doby(options:, step_names:)
+      options.slice(*STEP_CHECK_STEP_PRESENCE).each do |option_key, option_value|
+        next if %i[on_success on_failure on_error].include?(option_key) &&
+                STEP_ALLOWED_ON_S_ON_F_VALUES.include?(option_value)
+
+        next if step_names.keys.include?(option_value)
+
+        raise Decouplio::Errors::StepIsNotDefinedForDobyError.new(
+          errored_option: options.slice(option_key).to_s,
+          details: option_value
+        )
+      end
+    end
+
+    def check_step_presence_for_aide(options:, step_names:)
+      options.slice(*STEP_CHECK_STEP_PRESENCE).each do |option_key, option_value|
+        next if %i[on_success on_failure on_error].include?(option_key) &&
+                STEP_ALLOWED_ON_S_ON_F_VALUES.include?(option_value)
+
+        next if step_names.keys.include?(option_value)
+
+        raise Decouplio::Errors::StepIsNotDefinedForAideError.new(
+          errored_option: options.slice(option_key).to_s,
+          details: option_value
+        )
+      end
+    end
+
     def check_step_presence_for_fail(options:, step_names:)
       options.slice(*STEP_CHECK_STEP_PRESENCE).each do |option_key, option_value|
-        next if %i[on_success on_failure].include?(option_key) && option_value == :finish_him
+        next if %i[on_success on_failure on_error].include?(option_key) &&
+                STEP_ALLOWED_ON_S_ON_F_VALUES.include?(option_value)
 
         next if step_names.keys.include?(option_value)
 
@@ -178,7 +246,8 @@ module Decouplio
 
     def check_step_presence_for_wrap(options:, step_names:)
       options.slice(*WRAP_CHECK_STEP_PRESENCE).each do |option_key, option_value|
-        next if %i[on_success on_failure].include?(option_key) && option_value == :finish_him
+        next if %i[on_success on_failure on_error].include?(option_key) &&
+                STEP_ALLOWED_ON_S_ON_F_VALUES.include?(option_value)
 
         next if step_names.keys.include?(option_value)
 
@@ -211,6 +280,30 @@ module Decouplio
       end
     end
 
+    def check_doby_controversial_keys(options:)
+      on_success_on_failure = options.slice(:on_success, :on_failure)
+      finish_him = options.slice(:finish_him)
+
+      if !on_success_on_failure.empty? && !finish_him.empty?
+        raise Decouplio::Errors::DobyControversialKeysError.new(
+          errored_option: on_success_on_failure.merge(finish_him).to_s,
+          details: [on_success_on_failure.keys.join(', '), :finish_him]
+        )
+      end
+    end
+
+    def check_aide_controversial_keys(options:)
+      on_success_on_failure = options.slice(:on_success, :on_failure)
+      finish_him = options.slice(:finish_him)
+
+      if !on_success_on_failure.empty? && !finish_him.empty?
+        raise Decouplio::Errors::AideControversialKeysError.new(
+          errored_option: on_success_on_failure.merge(finish_him).to_s,
+          details: [on_success_on_failure.keys.join(', '), :finish_him]
+        )
+      end
+    end
+
     def validate_error_store(parent_action_class:, child_action_class:)
       return if parent_action_class.error_store == child_action_class.error_store
 
@@ -304,11 +397,20 @@ module Decouplio
     end
 
     def check_octo_required_keys(options:)
-      return if (OCTO_REQUIRED_KEYS - options.keys).size.zero?
-
-      raise Decouplio::Errors::RequiredOptionsIsMissingForOctoError.new(
-        details: OCTO_REQUIRED_KEYS.join(', ')
-      )
+      if (OCTO_REQUIRED_KEYS - options.keys).size.zero?
+        if options.keys.sort == OCTO_REQUIRED_KEYS.sort
+          raise Decouplio::Errors::OctoControversialKeysError.new(
+            errored_option: options.slice(*OCTO_REQUIRED_KEYS),
+            details: OCTO_REQUIRED_KEYS
+          )
+        end
+      else
+        return if options.slice(*OCTO_REQUIRED_KEYS).size == 1
+
+        raise Decouplio::Errors::RequiredOptionsIsMissingForOctoError.new(
+          details: OCTO_REQUIRED_KEYS.join(', ')
+        )
+      end
     end
 
     def check_step_finish_him(options:)
@@ -324,6 +426,32 @@ module Decouplio
       end
     end
 
+    def check_doby_finish_him(options:)
+      finish_him_value = options.dig(:finish_him)
+
+      return unless finish_him_value && options.key?(:finish_him)
+
+      unless ALLOWED_STEP_FINISH_HIM_VALUES.include?(finish_him_value)
+        raise Decouplio::Errors::DobyFinishHimError.new(
+          errored_option: options.slice(:finish_him).to_s,
+          details: finish_him_value
+        )
+      end
+    end
+
+    def check_aide_finish_him(options:)
+      finish_him_value = options.dig(:finish_him)
+
+      return unless options.key?(:finish_him)
+
+      return if ALLOWED_FAIL_FINISH_HIM_VALUES.include?(finish_him_value)
+
+      raise Decouplio::Errors::AideFinishHimError.new(
+        errored_option: options.slice(:finish_him).to_s,
+        details: finish_him_value
+      )
+    end
+
     def check_fail_finish_him(options:)
       finish_him_value = options.dig(:finish_him)
 
@@ -448,16 +576,24 @@ module Decouplio
     STEP_CHECK_METHOD_EXISTENCE_OPTIONS = %i[
       on_success
       on_failure
+      on_error
       if
       unless
     ].freeze
     STEP_CHECK_STEP_PRESENCE = %i[
       on_success
       on_failure
+      on_error
+    ].freeze
+    STEP_ALLOWED_ON_S_ON_F_VALUES = [
+      Decouplio::Const::Results::STEP_PASS,
+      Decouplio::Const::Results::STEP_FAIL,
+      Decouplio::Const::Results::FINISH_HIM
     ].freeze
     STEP_ALLOWED_OPTIONS = %i[
       on_success
       on_failure
+      on_error
       finish_him
       if
       unless
@@ -466,6 +602,7 @@ module Decouplio
     ALLOWED_STEP_FINISH_HIM_VALUES = %i[
       on_success
       on_failure
+      on_error
     ].freeze
 
     # *************************************************
@@ -479,12 +616,13 @@ module Decouplio
     FAIL_ALLOWED_OPTIONS = %i[
       on_success
       on_failure
+      on_error
       finish_him
       if
       unless
       action
     ].freeze
-    ALLOWED_FAIL_FINISH_HIM_VALUES = [true, :on_success, :on_failure].freeze
+    ALLOWED_FAIL_FINISH_HIM_VALUES = [true, :on_success, :on_failure, :on_error].freeze
 
     # *************************************************
     # PASS
@@ -495,13 +633,17 @@ module Decouplio
       if
       unless
       action
+      on_error
     ].freeze
 
     PASS_CHECK_METHOD_EXISTENCE_OPTIONS = %i[
       if
       unless
     ].freeze
-    ALLOWED_PASS_FINISH_HIM_VALUES = [true].freeze
+    PASS_CHECK_STEP_PRESENCE = %i[
+      on_error
+    ].freeze
+    ALLOWED_PASS_FINISH_HIM_VALUES = [true, :on_error].freeze
 
     # *************************************************
     # OCTO
@@ -509,6 +651,7 @@ module Decouplio
 
     OCTO_ALLOWED_OPTIONS = %i[
       ctx_key
+      method
       if
       unless
     ].freeze
@@ -518,6 +661,7 @@ module Decouplio
     ].freeze
     OCTO_REQUIRED_KEYS = %i[
       ctx_key
+      method
     ].freeze
 
     # *************************************************
@@ -527,16 +671,19 @@ module Decouplio
     WRAP_CHECK_METHOD_EXISTENCE_OPTIONS = %i[
       on_success
       on_failure
+      on_error
       if
       unless
     ].freeze
     WRAP_CHECK_STEP_PRESENCE = %i[
       on_success
       on_failure
+      on_error
     ].freeze
     WRAP_ALLOWED_OPTIONS = %i[
       on_success
       on_failure
+      on_error
       finish_him
       if
       unless
@@ -547,6 +694,7 @@ module Decouplio
     ALLOWED_WRAP_FINISH_HIM_VALUES = %i[
       on_success
       on_failure
+      on_error
     ].freeze
 
     # *************************************************
@@ -556,6 +704,7 @@ module Decouplio
     RESQ_NOT_ALLOWED_OPTIONS = %i[
       on_success
       on_failure
+      on_error
       finish_him
       if
       unless

data/lib/decouplio/steps/aide.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'base_step'
+
+module Decouplio
+  module Steps
+    class Aide < Decouplio::Steps::BaseStep
+      def initialize(name:, aide_class:, aide_options:, on_success_type:, on_failure_type:)
+        super()
+        @name = name
+        @aide_class = aide_class
+        @aide_options = aide_options
+        @on_success_type = on_success_type
+        @on_failure_type = on_failure_type
+      end
+
+      def process(instance:)
+        instance.append_railway_flow(@name)
+        result = @aide_class.call(
+          ctx: instance.ctx,
+          error_store: instance.error_store,
+          **@aide_options
+        )
+        resolve(instance: instance, result: result)
+      end
+
+      def resolve(instance:, result:)
+        Decouplio::Steps::Shared::FailResolver.call(
+          instance: instance,
+          result: result,
+          on_success_type: @on_success_type,
+          on_failure_type: @on_failure_type
+        )
+      end
+    end
+  end
+end

data/lib/decouplio/steps/base_resq.rb

@@ -5,10 +5,11 @@ require_relative 'base_step'
 module Decouplio
   module Steps
     class BaseResq < BaseStep
-      def initialize(handler_hash:, step_to_resq:)
+      def initialize(handler_hash:, step_to_resq:, on_error_type:)
         super()
         @handler_hash = handler_hash
         @step_to_resq = step_to_resq
+        @on_error_type = on_error_type
       end
 
       def process(instance:)
@@ -21,8 +22,17 @@ module Decouplio
         instance.append_railway_flow(handler_method)
         instance.public_send(handler_method, e, **instance.ctx)
 
-        instance.fail_action
-        Decouplio::Const::Results::ERROR
+        case @on_error_type
+        when Decouplio::Const::Results::PASS, Decouplio::Const::Results::STEP_PASS
+          instance.pass_action
+          Decouplio::Const::Results::ERROR
+        when Decouplio::Const::Results::FINISH_HIM
+          instance.fail_action
+          Decouplio::Const::Results::FINISH_HIM
+        else
+          instance.fail_action
+          Decouplio::Const::Results::ERROR
+        end
       else
         result
       end

data/lib/decouplio/steps/doby.rb

@@ -5,27 +5,32 @@ require_relative 'base_step'
 module Decouplio
   module Steps
     class Doby < Decouplio::Steps::BaseStep
-      def initialize(name:, doby_class:, doby_options:)
+      def initialize(name:, doby_class:, doby_options:, on_success_type:, on_failure_type:)
         super()
         @name = name
         @doby_class = doby_class
         @doby_options = doby_options
+        @on_success_type = on_success_type
+        @on_failure_type = on_failure_type
       end
 
       def process(instance:)
         instance.append_railway_flow(@name)
-        result = @doby_class.call(ctx: instance.ctx, **@doby_options)
+        result = @doby_class.call(
+          ctx: instance.ctx,
+          error_store: instance.error_store,
+          **@doby_options
+        )
         resolve(result: result, instance: instance)
       end
 
       def resolve(result:, instance:)
-        if result
-          instance.pass_action
-          Decouplio::Const::Results::PASS
-        else
-          instance.fail_action
-          Decouplio::Const::Results::FAIL
-        end
+        Decouplio::Steps::Shared::StepResolver.call(
+          instance: instance,
+          result: result,
+          on_success_type: @on_success_type,
+          on_failure_type: @on_failure_type
+        )
       end
     end
   end

data/lib/decouplio/steps/fail.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'base_step'
+require_relative 'shared/fail_resolver'
 
 module Decouplio
   module Steps
@@ -22,28 +23,12 @@ module Decouplio
       private
 
       def resolve(result:, instance:)
-        if result
-          case @on_success_type
-          when Decouplio::Const::Results::PASS
-            instance.pass_action
-            Decouplio::Const::Results::PASS
-          when Decouplio::Const::Results::FAIL
-            instance.fail_action
-            Decouplio::Const::Results::PASS
-          when Decouplio::Const::Results::FINISH_HIM
-            instance.fail_action
-            Decouplio::Const::Results::FINISH_HIM
-          end
-        elsif @on_failure_type == Decouplio::Const::Results::PASS
-          instance.pass_action
-          Decouplio::Const::Results::FAIL
-        elsif @on_failure_type == Decouplio::Const::Results::FAIL
-          instance.fail_action
-          Decouplio::Const::Results::FAIL
-        elsif @on_failure_type == Decouplio::Const::Results::FINISH_HIM
-          instance.fail_action
-          Decouplio::Const::Results::FINISH_HIM
-        end
+        Decouplio::Steps::Shared::FailResolver.call(
+          instance: instance,
+          result: result,
+          on_success_type: @on_success_type,
+          on_failure_type: @on_failure_type
+        )
       end
     end
   end

data/lib/decouplio/steps/inner_action_fail.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'base_step'
+require_relative 'shared/fail_resolver'
 
 module Decouplio
   module Steps
@@ -27,28 +28,12 @@ module Decouplio
 
         instance.error_store.merge(outcome.error_store)
 
-        if result
-          case @on_success_type
-          when Decouplio::Const::Results::PASS
-            instance.pass_action
-            Decouplio::Const::Results::PASS
-          when Decouplio::Const::Results::FAIL
-            instance.fail_action
-            Decouplio::Const::Results::PASS
-          when Decouplio::Const::Results::FINISH_HIM
-            instance.fail_action
-            Decouplio::Const::Results::FINISH_HIM
-          end
-        elsif @on_failure_type == Decouplio::Const::Results::PASS
-          instance.pass_action
-          Decouplio::Const::Results::FAIL
-        elsif @on_failure_type == Decouplio::Const::Results::FAIL
-          instance.fail_action
-          Decouplio::Const::Results::FAIL
-        elsif @on_failure_type == Decouplio::Const::Results::FINISH_HIM
-          instance.fail_action
-          Decouplio::Const::Results::FINISH_HIM
-        end
+        Decouplio::Steps::Shared::FailResolver.call(
+          instance: instance,
+          result: result,
+          on_success_type: @on_success_type,
+          on_failure_type: @on_failure_type
+        )
       end
     end
   end