decouplio 1.0.0alpha

data/lib/decouplio/const/types.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+module Decouplio
+  module Const
+    module Types
+      STEP_TYPE = :step
+      FAIL_TYPE = :fail
+      PASS_TYPE = :pass
+      IF_TYPE = :if
+      UNLESS_TYPE = :unless
+      IF_TYPE_PASS = :if_pass
+      UNLESS_TYPE_PASS = :unless_pass
+      IF_TYPE_FAIL = :if_fail
+      UNLESS_TYPE_FAIL = :unless_fail
+      OCTO_TYPE = :octo
+      DOBY_TYPE = :doby
+      ACTION_TYPE_STEP = :action_step
+      ACTION_TYPE_FAIL = :action_fail
+      ACTION_TYPE_PASS = :action_pass
+      SERVICE_TYPE_STEP = :service_step
+      SERVICE_TYPE_FAIL = :service_fail
+      SERVICE_TYPE_PASS = :service_pass
+      WRAP_TYPE = :wrap
+      RESQ_TYPE = :resq
+      RESQ_TYPE_STEP = :resq_step
+      RESQ_TYPE_FAIL = :resq_fail
+      RESQ_TYPE_PASS = :resq_pass
+      STEP_TYPE_TO_CONDITION_TYPE = {
+        STEP_TYPE => {
+          IF_TYPE => IF_TYPE_PASS,
+          UNLESS_TYPE => UNLESS_TYPE_PASS
+        },
+        FAIL_TYPE => {
+          IF_TYPE => IF_TYPE_FAIL,
+          UNLESS_TYPE => UNLESS_TYPE_FAIL
+        },
+        PASS_TYPE => {
+          IF_TYPE => IF_TYPE_PASS,
+          UNLESS_TYPE => UNLESS_TYPE_PASS
+        },
+        OCTO_TYPE => {
+          IF_TYPE => IF_TYPE_PASS,
+          UNLESS_TYPE => UNLESS_TYPE_PASS
+        },
+        WRAP_TYPE => {
+          IF_TYPE => IF_TYPE_PASS,
+          UNLESS_TYPE => UNLESS_TYPE_PASS
+        },
+        RESQ_TYPE_STEP => {
+          IF_TYPE => IF_TYPE_PASS,
+          UNLESS_TYPE => UNLESS_TYPE_PASS
+        },
+        RESQ_TYPE_FAIL => {
+          IF_TYPE => IF_TYPE_FAIL,
+          UNLESS_TYPE => UNLESS_TYPE_FAIL
+        },
+        RESQ_TYPE_PASS => {
+          IF_TYPE => IF_TYPE_PASS,
+          UNLESS_TYPE => UNLESS_TYPE_PASS
+        },
+        ACTION_TYPE_STEP => {
+          IF_TYPE => IF_TYPE_PASS,
+          UNLESS_TYPE => UNLESS_TYPE_PASS
+        },
+        ACTION_TYPE_FAIL => {
+          IF_TYPE => IF_TYPE_FAIL,
+          UNLESS_TYPE => UNLESS_TYPE_FAIL
+        },
+        ACTION_TYPE_PASS => {
+          IF_TYPE => IF_TYPE_PASS,
+          UNLESS_TYPE => UNLESS_TYPE_PASS
+        },
+        SERVICE_TYPE_STEP => {
+          IF_TYPE => IF_TYPE_PASS,
+          UNLESS_TYPE => UNLESS_TYPE_PASS
+        },
+        SERVICE_TYPE_FAIL => {
+          IF_TYPE => IF_TYPE_FAIL,
+          UNLESS_TYPE => UNLESS_TYPE_FAIL
+        },
+        SERVICE_TYPE_PASS => {
+          IF_TYPE => IF_TYPE_PASS,
+          UNLESS_TYPE => UNLESS_TYPE_PASS
+        }
+      }.freeze
+      STEP_TYPE_TO_RESQ_TYPE = {
+        STEP_TYPE => RESQ_TYPE_STEP,
+        FAIL_TYPE => RESQ_TYPE_FAIL,
+        PASS_TYPE => RESQ_TYPE_PASS,
+        OCTO_TYPE => RESQ_TYPE_STEP,
+        WRAP_TYPE => RESQ_TYPE_STEP,
+        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
+      }.freeze
+      STEP_TYPE_TO_INNER_TYPE = {
+        STEP_TYPE => ACTION_TYPE_STEP,
+        FAIL_TYPE => ACTION_TYPE_FAIL,
+        PASS_TYPE => ACTION_TYPE_PASS,
+        RESQ_TYPE_STEP => ACTION_TYPE_STEP,
+        RESQ_TYPE_FAIL => ACTION_TYPE_FAIL,
+        RESQ_TYPE_PASS => ACTION_TYPE_PASS
+      }.freeze
+      STEP_TYPE_TO_SERVICE_TYPE = {
+        STEP_TYPE => SERVICE_TYPE_STEP,
+        FAIL_TYPE => SERVICE_TYPE_FAIL,
+        PASS_TYPE => SERVICE_TYPE_PASS,
+        RESQ_TYPE_STEP => SERVICE_TYPE_STEP,
+        RESQ_TYPE_FAIL => SERVICE_TYPE_FAIL,
+        RESQ_TYPE_PASS => SERVICE_TYPE_PASS
+      }.freeze
+      ACTION_NOT_ALLOWED_STEPS = [
+        OCTO_TYPE,
+        WRAP_TYPE,
+        RESQ_TYPE,
+        DOBY_TYPE
+      ].freeze
+      PASS_FLOW = [
+        STEP_TYPE,
+        PASS_TYPE,
+        OCTO_TYPE,
+        WRAP_TYPE,
+        IF_TYPE_PASS,
+        UNLESS_TYPE_PASS,
+        ACTION_TYPE_PASS,
+        ACTION_TYPE_STEP,
+        SERVICE_TYPE_STEP,
+        SERVICE_TYPE_PASS,
+        DOBY_TYPE
+      ].freeze
+      FAIL_FLOW = [
+        FAIL_TYPE,
+        IF_TYPE_FAIL,
+        UNLESS_TYPE_FAIL,
+        ACTION_TYPE_FAIL,
+        SERVICE_TYPE_FAIL
+      ].freeze
+
+      MAIN_FLOW_TYPES = [
+        STEP_TYPE,
+        FAIL_TYPE,
+        PASS_TYPE,
+        WRAP_TYPE,
+        DOBY_TYPE
+      ].freeze
+      SUCCESS_TRACK_STEP_TYPES = [
+        STEP_TYPE,
+        PASS_TYPE,
+        IF_TYPE_PASS,
+        UNLESS_TYPE_PASS,
+        WRAP_TYPE,
+        ACTION_TYPE_STEP,
+        ACTION_TYPE_PASS,
+        SERVICE_TYPE_STEP,
+        SERVICE_TYPE_PASS,
+        RESQ_TYPE_STEP,
+        RESQ_TYPE_PASS,
+        OCTO_TYPE,
+        DOBY_TYPE
+      ].freeze
+      FAILURE_TRACK_STEP_TYPES = [
+        FAIL_TYPE,
+        IF_TYPE_FAIL,
+        UNLESS_TYPE_FAIL,
+        RESQ_TYPE_FAIL,
+        ACTION_TYPE_FAIL,
+        SERVICE_TYPE_FAIL
+      ].freeze
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Decouplio
+  module Const
+    module Validations
+      module ActionOptionClass
+        VALIDATION_ERROR_MESSAGE = <<~ERROR_MESSAGE
+          Next options are not allowed for "%s":
+          %s
+
+          Details:
+          "action" allows only classes inherited from Decouplio::Action
+        ERROR_MESSAGE
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Decouplio
+  module Const
+    module Validations
+      module Common
+        WRONG_FINISH_HIM_VALUE = '"finish_him" does not allow "%s" value'
+        METHOD_IS_NOT_DEFINED = 'Method "%s" is not defined'
+        STEP_IS_NOT_DEFINED = 'Step "%s" is not defined'
+        STEP_NAME = '"%s" method is reserved by Decouplio, please another name.'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Decouplio
+  module Const
+    module Validations
+      module Fail
+        VALIDATION_ERROR_MESSAGE = <<~ERROR_MESSAGE
+          Next options are not allowed for "fail":
+          %s
+
+          Details:
+          %s
+
+          Allowed options are:
+          %s
+
+          Please read the manual about allowed options here:
+          %s
+        ERROR_MESSAGE
+
+        ALLOWED_OPTIONS_MESSAGE = <<~ALLOWED_OPTIONS
+          finish_him: true
+          if: <instance method symbol>
+          unless: <instance method symbol>
+        ALLOWED_OPTIONS
+        MANUAL_URL = 'https://stub.fail.manual.url'
+        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'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Decouplio
+  module Const
+    module Validations
+      module Logic
+        VALIDATION_ERROR_MESSAGE = <<~ERROR_MESSAGE
+          %s
+        ERROR_MESSAGE
+        REDEFINITION = 'The logic for "%s" class has already been defined.'
+        NOT_DEFINED = 'The logic for "%s" class is not define'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Decouplio
+  module Const
+    module Validations
+      module Octo
+        VALIDATION_ERROR_MESSAGE = <<~ERROR_MESSAGE
+          Next options are not allowed for "octo":
+          %s
+
+          Details:
+          %s
+
+          Allowed options are:
+          %s
+
+          Please read the manual about allowed options here:
+          %s
+        ERROR_MESSAGE
+        REQUIRED_VALIDATION_ERROR_MESSAGE = <<~ERROR_MESSAGE
+          Details:
+          %s
+
+          Allowed options are:
+          %s
+
+          Please read the manual about allowed options here:
+          %s
+        ERROR_MESSAGE
+        ALLOWED_OPTIONS_MESSAGE = <<~ALLOWED_OPTIONS
+          ctx_key: <ctx key with strategy name to be used for strategy mapping> - required
+          if: <instance method symbol>
+          unless: <instance method symbol>
+        ALLOWED_OPTIONS
+        OPTIONS_IS_NOT_ALLOWED = '"%s" option(s) is not allowed for "octo"'
+        MANUAL_URL = 'https://stub.strategy.manual.url'
+        OPTIONS_IS_REQUIRED = 'Next option(s) "%s" are required for "octo"'
+        CONTROVERSIAL_KEYS = '"%s" option(s) is not allowed along with "%s" option(s)'
+        PALPS_IS_NOT_DEFINED = 'Next palp(s): "%s" is not difined'
+        OCTO_BLOCK = 'Block for "octo" is not defined'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decouplio
+  module Const
+    module Validations
+      module Palp
+        VALIDATION_ERROR_MESSAGE = <<~ERROR_MESSAGE
+          Details:
+          %s
+          Please read the manual about allowed options here:
+          %s
+        ERROR_MESSAGE
+
+        DOES_NOT_ALLOW_ANY_OPTION = '"palp" does not allow any options'
+        MANUAL_URL = 'https://stub.palp.manual.url'
+        NOT_DEFINED = 'The palp block is not defined'
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Decouplio
+  module Const
+    module Validations
+      module Resq
+        VALIDATION_ERROR_MESSAGE = <<~ERROR_MESSAGE
+          Next options are not allowed for "resq":
+          %s
+
+          Details:
+          %s
+
+          Allowed options are:
+          %s
+
+          Please read the manual about allowed options here:
+          %s
+        ERROR_MESSAGE
+        ALLOWED_OPTIONS_MESSAGE = <<~ALLOWED_OPTIONS
+          <method name> => <exception class>
+          OR
+          <method name> => [<excpetion class one>, <exception class two>]
+
+          RESQ can have several handler methods, e.g.:
+          logic do
+            step :some_step
+            resq first_handler: [NoMethodError, ArgumentError],
+                second_handler: StandardError
+          end
+
+          def some_step(**)
+            ctx[:result] = <code which may raise an error>
+          end
+
+          def first_handler(error, **)
+            # Error handling code
+          end
+
+          def second_handler(error, **)
+            # Error handling code
+          end
+
+        ALLOWED_OPTIONS
+
+        DEFINITION_ERROR_MESSAGE = <<~ERROR
+          Details:
+          "resq" should be defined only after:
+          %s
+
+          Please read the manual about allowed options here:
+          %s
+        ERROR
+
+        DOES_NOT_ALLOW_OPTIONS = '"resq" does not allow "%s" option(s)'
+        MANUAL_URL = 'https://stub.resq.manual.url'
+        PLEASE_DEFINE_HANDLER_METHOD = 'Please define "%s" method'
+        HANDLER_METHOD_SHOULD_BE_A_SYMBOL = 'Handler method should be a symbol'
+        ERROR_CLASS_INHERITANCE = 'Please use exception class. %s does not inherited from Exception class'
+        INVALID_ERROR_CLASS_VALUE = 'Invalid handler class value "%s"'
+        WRONG_ERROR_CLASS = 'Please specify exception class(es) for "%s"'
+        NOT_ALLOWED_HANDLER_METHOD_VALUE = '"%s" is not allowed as a handler method for "resq"'
+        NOT_ALLOWED_EXCEPTION_CLASS = '"%s" class is not allowed for "resq"'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Decouplio
+  module Const
+    module Validations
+      module Step
+        VALIDATION_ERROR_MESSAGE = <<~ERROR_MESSAGE
+          Next options are not allowed for "step":
+          %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.step.manual.url'
+        EXTRA_KEYS_ARE_NOT_ALLOWED = 'Please check if step option is allowed'
+        METHOD_NOT_DEFINED = 'step :%s'
+        CONTROVERSIAL_KEYS = '"%s" option(s) is not allowed along with "%s" option(s)'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Decouplio
+  module Const
+    module Validations
+      module Wrap
+        VALIDATION_ERROR_MESSAGE = <<~ERROR_MESSAGE
+          Next options are not allowed for "wrap":
+          %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>
+          klass: <class which implements wrap method, "method" option should be present>
+          method: <method name for wrapping, "klass" option should be present>
+        ALLOWED_OPTIONS
+        MANUAL_URL = 'https://stub.wrap.manual.url'
+        EXTRA_KEYS_ARE_NOT_ALLOWED = 'Please check if wrap option is allowed'
+        KLASS_AND_METHOD_PRESENCE = '"klass" options should be passed along with "method" option'
+        METHOD_IS_NOT_DEFINED_FOR_KLASS = 'Method "%s" is not defined for "%s" class'
+        NAME_IS_EMPTY = 'wrap name is empty'
+        SPECIFY_NAME = 'Please specify name for "wrap"'
+        CONTROVERSIAL_KEYS = '"%s" option(s) is not allowed along with "%s" option(s)'
+        NOT_DEFINED = 'The wrap block is not defined'
+      end
+    end
+  end
+end

data/lib/decouplio/default_error_handler.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Decouplio
+  class DefaultErrorHandler
+    attr_reader :errors
+
+    def initialize
+      @errors = {}
+    end
+
+    def add_error(key, message)
+      @errors.store(
+        key,
+        (@errors[key] || []) + [message].flatten
+      )
+    end
+
+    def merge(error_store)
+      @errors = @errors.merge(error_store.errors) do |_key, this_val, other_val|
+        this_val + other_val
+      end
+    end
+  end
+end

data/lib/decouplio/errors/action_class_error.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'base_error'
+require_relative '../const/validations/action_option_class'
+
+module Decouplio
+  module Errors
+    class ActionClassError < Decouplio::Errors::BaseError
+      def initialize(step_type:, errored_option:)
+        super(errored_option: errored_option)
+        @step_type = step_type
+      end
+
+      def template
+        Decouplio::Const::Validations::ActionOptionClass::VALIDATION_ERROR_MESSAGE
+      end
+
+      def interpolation_values
+        [
+          @step_type,
+          @errored_option
+        ]
+      end
+    end
+  end
+end

data/lib/decouplio/errors/base_error.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative '../const/colors'
+require_relative '../const/validations/common'
+
+module Decouplio
+  module Errors
+    class BaseError < StandardError
+      def initialize(errored_option: nil, details: nil)
+        @errored_option = errored_option
+        @details = details
+        super(message)
+      end
+
+      def message
+        template % interpolation_values
+      end
+
+      def template
+        raise NotImplementedError,
+              'Please specify error template'
+      end
+
+      def interpolation_values
+        raise NotImplementedError,
+              'Please specify interpolation values for error template'
+      end
+    end
+  end
+end

data/lib/decouplio/errors/error_store_error.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'base_error'
+
+module Decouplio
+  module Errors
+    class ErrorStoreError < Decouplio::Errors::BaseError
+      def template
+        'Error store for action and inner action should be the same.'
+      end
+
+      def interpolation_values
+        []
+      end
+    end
+  end
+end

data/lib/decouplio/errors/extra_key_for_fail_error.rb

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

data/lib/decouplio/errors/extra_key_for_octo_error.rb

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

data/lib/decouplio/errors/extra_key_for_pass_error.rb

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