decouplio 1.0.0alpha2 → 1.0.0alpha3

data/lib/decouplio/errors/{deny_can_not_be_first_step_error.rb → aide_can_not_be_first_step_error.rb}

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

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/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

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/logic_dsl.rb

@@ -2,6 +2,7 @@
 
 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'
@@ -9,7 +10,7 @@ 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/deny_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
@@ -85,22 +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 deny(deny_class, **options)
-        raise Decouplio::Errors::DenyCanNotBeFirstStepError if @steps.empty?
+      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::DENY_TYPE,
-          name: deny_class.name.to_sym,
-          deny_class: deny_class,
-          deny_options: options
+          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'
@@ -20,9 +22,13 @@ 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_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'
@@ -86,6 +92,10 @@ module Decouplio
            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
 
@@ -142,6 +152,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)
 
@@ -163,6 +185,32 @@ module Decouplio
       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].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].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) && STEP_ALLOWED_ON_S_ON_F_VALUES.include?(option_value)
@@ -211,6 +259,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 +376,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 +405,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)
 
@@ -514,6 +621,7 @@ module Decouplio
 
     OCTO_ALLOWED_OPTIONS = %i[
       ctx_key
+      method
       if
       unless
     ].freeze
@@ -523,6 +631,7 @@ module Decouplio
     ].freeze
     OCTO_REQUIRED_KEYS = %i[
       ctx_key
+      method
     ].freeze
 
     # *************************************************

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/doby.rb

@@ -5,11 +5,13 @@ 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:)
@@ -23,13 +25,12 @@ module Decouplio
       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/octo.rb

@@ -7,15 +7,20 @@ module Decouplio
     class Octo < BaseStep
       attr_accessor :hash_case
 
-      def initialize(name:, ctx_key:)
+      def initialize(name:, ctx_key:, method:)
         super()
         @name = name
         @ctx_key = ctx_key
+        @method = method
       end
 
       def process(instance:)
         instance.append_railway_flow(@name)
-        instance[@ctx_key]
+        if @method
+          instance.send(@method, **instance.ctx)
+        else
+          instance[@ctx_key]
+        end
       end
     end
   end

data/lib/decouplio/validators/condition.rb

@@ -42,6 +42,16 @@ module Decouplio
             errored_option: condition_options.to_s,
             details: %i[if unless]
           )
+        when Decouplio::Const::Types::DOBY_TYPE
+          raise Decouplio::Errors::DobyControversialKeysError.new(
+            errored_option: condition_options.to_s,
+            details: %i[if unless]
+          )
+        when Decouplio::Const::Types::AIDE_TYPE
+          raise Decouplio::Errors::AideControversialKeysError.new(
+            errored_option: condition_options.to_s,
+            details: %i[if unless]
+          )
         end
       end
     end

data/lib/decouplio/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Decouplio
-  VERSION = '1.0.0alpha2'
+  VERSION = '1.0.0alpha3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: decouplio
 version: !ruby/object:Gem::Version
-  version: 1.0.0alpha2
+  version: 1.0.0alpha3
 platform: ruby
 authors:
 - Alex Bal
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-04 00:00:00.000000000 Z
+date: 2022-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -127,12 +127,12 @@ files:
 - decouplio.gemspec
 - docker-compose.yml
 - docs/_config.yml
+- docs/aide.rb
 - docs/benchmarks.md
 - docs/context.md
 - docs/context.rb
-- docs/deny.rb
 - docs/doby.rb
-- docs/doby_deny.md
+- docs/doby_aide.md
 - docs/error_store.md
 - docs/error_store.rb
 - docs/fail.md
@@ -159,12 +159,14 @@ files:
 - lib/decouplio/action.rb
 - lib/decouplio/composer.rb
 - lib/decouplio/const/colors.rb
+- lib/decouplio/const/doby_aide_options.rb
 - lib/decouplio/const/reserved_methods.rb
 - lib/decouplio/const/results.rb
 - lib/decouplio/const/types.rb
 - lib/decouplio/const/validations/action_option_class.rb
+- lib/decouplio/const/validations/aide.rb
 - lib/decouplio/const/validations/common.rb
-- lib/decouplio/const/validations/deny.rb
+- lib/decouplio/const/validations/doby.rb
 - lib/decouplio/const/validations/fail.rb
 - lib/decouplio/const/validations/logic.rb
 - lib/decouplio/const/validations/octo.rb
@@ -175,8 +177,12 @@ files:
 - lib/decouplio/const/validations/wrap.rb
 - lib/decouplio/default_error_handler.rb
 - lib/decouplio/errors/action_class_error.rb
+- lib/decouplio/errors/aide_can_not_be_first_step_error.rb
+- lib/decouplio/errors/aide_controversial_keys_error.rb
+- lib/decouplio/errors/aide_finish_him_error.rb
 - lib/decouplio/errors/base_error.rb
-- lib/decouplio/errors/deny_can_not_be_first_step_error.rb
+- lib/decouplio/errors/doby_controversial_keys_error.rb
+- lib/decouplio/errors/doby_finish_him_error.rb
 - lib/decouplio/errors/error_store_error.rb
 - lib/decouplio/errors/extra_key_for_fail_error.rb
 - lib/decouplio/errors/extra_key_for_octo_error.rb
@@ -205,6 +211,8 @@ files:
 - lib/decouplio/errors/resq_handler_method_error.rb
 - lib/decouplio/errors/step_controversial_keys_error.rb
 - lib/decouplio/errors/step_finish_him_error.rb
+- lib/decouplio/errors/step_is_not_defined_for_aide_error.rb
+- lib/decouplio/errors/step_is_not_defined_for_doby_error.rb
 - lib/decouplio/errors/step_is_not_defined_for_fail_error.rb
 - lib/decouplio/errors/step_is_not_defined_for_step_error.rb
 - lib/decouplio/errors/step_is_not_defined_for_wrap_error.rb
@@ -219,9 +227,9 @@ files:
 - lib/decouplio/octo_options_validator.rb
 - lib/decouplio/options_validator.rb
 - lib/decouplio/processor.rb
+- lib/decouplio/steps/aide.rb
 - lib/decouplio/steps/base_resq.rb
 - lib/decouplio/steps/base_step.rb
-- lib/decouplio/steps/deny.rb
 - lib/decouplio/steps/doby.rb
 - lib/decouplio/steps/fail.rb
 - lib/decouplio/steps/if_condition_fail.rb

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

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Decouplio
-  module Const
-    module Validations
-      module Deny
-        FIRST_STEP = '"deny" can not be the first step'
-      end
-    end
-  end
-end

data/lib/decouplio/steps/deny.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base_step'
-
-module Decouplio
-  module Steps
-    class Deny < Decouplio::Steps::BaseStep
-      def initialize(name:, deny_class:, deny_options:)
-        super()
-        @name = name
-        @deny_class = deny_class
-        @deny_options = deny_options
-      end
-
-      def process(instance:)
-        instance.append_railway_flow(@name)
-        @deny_class.call(
-          ctx: instance.ctx,
-          error_store: instance.error_store,
-          **@deny_options
-        )
-        resolve(instance: instance)
-      end
-
-      def resolve(instance:)
-        instance.fail_action
-        Decouplio::Const::Results::FAIL
-      end
-    end
-  end
-end