RubyGems - decouplio - Versions diffs - 1.0.0alpha2 → 1.0.0alpha5 - Mend

decouplio 1.0.0alpha2 → 1.0.0alpha5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (66) hide show

checksums.yaml +4 -4
data/.circleci/config.yml +11 -1
data/.rubocop.yml +6 -0
data/.ruby-version +1 -1
data/README.md +2 -17
data/benchmarks/multi_step_benchmark.rb +11 -10
data/benchmarks/single_step_benchmark.rb +1 -1
data/decouplio.gemspec +4 -4
data/lib/decouplio/action.rb +12 -0
data/lib/decouplio/composer.rb +47 -24
data/lib/decouplio/const/doby_aide_options.rb +16 -0
data/lib/decouplio/const/error_messages.rb +9 -0
data/lib/decouplio/const/types.rb +14 -6
data/lib/decouplio/const/validations/aide.rb +38 -0
data/lib/decouplio/const/validations/doby.rb +36 -0
data/lib/decouplio/const/validations/fail.rb +4 -0
data/lib/decouplio/const/validations/octo.rb +2 -1
data/lib/decouplio/errors/{deny_can_not_be_first_step_error.rb → aide_can_not_be_first_step_error.rb} +3 -3
data/lib/decouplio/errors/aide_controversial_keys_error.rb +26 -0
data/lib/decouplio/errors/aide_finish_him_error.rb +26 -0
data/lib/decouplio/errors/doby_controversial_keys_error.rb +26 -0
data/lib/decouplio/errors/doby_finish_him_error.rb +26 -0
data/lib/decouplio/errors/execution_error.rb +20 -0
data/lib/decouplio/errors/step_is_not_defined_for_aide_error.rb +26 -0
data/lib/decouplio/errors/step_is_not_defined_for_doby_error.rb +27 -0
data/lib/decouplio/errors/step_is_not_defined_for_pass_error.rb +27 -0
data/lib/decouplio/logic_dsl.rb +23 -8
data/lib/decouplio/options_validator.rb +157 -13
data/lib/decouplio/steps/aide.rb +37 -0
data/lib/decouplio/steps/base_resq.rb +13 -3
data/lib/decouplio/steps/doby.rb +9 -8
data/lib/decouplio/steps/octo.rb +7 -2
data/lib/decouplio/validators/condition.rb +10 -0
data/lib/decouplio/version.rb +1 -1
metadata +24 -42
data/docs/_config.yml +0 -1
data/docs/benchmarks.md +0 -1
data/docs/context.md +0 -74
data/docs/context.rb +0 -62
data/docs/deny.rb +0 -59
data/docs/doby.rb +0 -38
data/docs/doby_deny.md +0 -171
data/docs/error_store.md +0 -347
data/docs/error_store.rb +0 -202
data/docs/fail.md +0 -1159
data/docs/fail.rb +0 -859
data/docs/index.md +0 -25
data/docs/inner_action.md +0 -63
data/docs/inner_action.rb +0 -43
data/docs/logic_block.md +0 -25
data/docs/octo.md +0 -269
data/docs/octo.rb +0 -164
data/docs/pass.md +0 -309
data/docs/pass.rb +0 -213
data/docs/quick_start.md +0 -71
data/docs/quick_start.rb +0 -38
data/docs/resq.md +0 -263
data/docs/resq.rb +0 -176
data/docs/step.md +0 -885
data/docs/step.rb +0 -627
data/docs/step_as_a_service.md +0 -123
data/docs/step_as_a_service.rb +0 -77
data/docs/wrap.md +0 -240
data/docs/wrap.rb +0 -137
data/lib/decouplio/const/validations/deny.rb +0 -11
data/lib/decouplio/steps/deny.rb +0 -31

data/docs/fail.rb DELETED Viewed

@@ -1,859 +0,0 @@
-require_relative '../lib/decouplio'
-# Behavior
-class SomeAction < Decouplio::Action
-  logic do
-    step :step_one
-    fail :fail_one
-    fail :fail_two
-  end
-  def step_one(param_for_step_one:, **)
-    param_for_step_one
-  end
-  def fail_one(**)
-    ctx[:action_failed] = true
-  end
-  def fail_two(**)
-    ctx[:fail_two] = 'Failure'
-  end
-end
-success_action = SomeAction.call(param_for_step_one: true)
-failure_action = SomeAction.call(param_for_step_one: false)
-success_action # =>
-# Result: success
-# Railway Flow:
-#   step_one
-# Context:
-#   {:param_for_step_one=>true}
-# Errors:
-#   {}
-failure_action # =>
-# Result: failure
-# Railway Flow:
-#   step_one -> fail_one -> fail_two
-# Context:
-#   {:param_for_step_one=>false, :action_failed=>true, :fail_two=>"Failure"}
-# Errors:
-#   {}
-# on_success: :finish_him
-class SomeActionOnSuccessFinishHim < Decouplio::Action
-  logic do
-    step :step_one
-    fail :fail_one, on_success: :finish_him
-    fail :fail_two
-  end
-  def step_one(param_for_step_one:, **)
-    param_for_step_one
-  end
-  def fail_one(fail_one_param:, **)
-    ctx[:action_failed] = fail_one_param
-  end
-  def fail_two(**)
-    ctx[:fail_two] = 'Failure'
-  end
-end
-success_action = SomeActionOnSuccessFinishHim.call(
-  param_for_step_one: true
-)
-fail_step_success = SomeActionOnSuccessFinishHim.call(
-  param_for_step_one: false,
-  fail_one_param: true
-)
-fail_step_failure = SomeActionOnSuccessFinishHim.call(
-  param_for_step_one: false,
-  fail_one_param: false
-)
-success_action # =>
-# Result: success
-# Railway Flow:
-#   step_one
-# Context:
-#   {:param_for_step_one=>true}
-# Errors:
-#   {}
-fail_step_success # =>
-# Result: failure
-# Railway Flow:
-#   step_one -> fail_one
-# Context:
-#   {:param_for_step_one=>false, :fail_one_param=>true, :action_failed=>true}
-# Errors:
-#   {}
-fail_step_failure  # =>
-# Result: failure
-# Railway Flow:
-#   step_one -> fail_one -> fail_two
-# Context:
-#   {:param_for_step_one=>false, :fail_one_param=>false, :action_failed=>false, :fail_two=>"Failure"}
-# Errors:
-#   {}
-# on_success: next success track step
-class SomeActionOnSuccessToSuccessTrack < Decouplio::Action
-  logic do
-    step :step_one
-    fail :fail_one, on_success: :step_two
-    step :step_two
-    fail :fail_two
-  end
-  def step_one(param_for_step_one:, **)
-    param_for_step_one
-  end
-  def fail_one(fail_one_param:, **)
-    ctx[:action_failed] = fail_one_param
-  end
-  def step_two(**)
-    ctx[:step_two] = 'Success'
-  end
-  def fail_two(**)
-    ctx[:fail_two] = 'Failure'
-  end
-end
-success_action = SomeActionOnSuccessToSuccessTrack.call(
-  param_for_step_one: true
-)
-fail_step_success = SomeActionOnSuccessToSuccessTrack.call(
-  param_for_step_one: false,
-  fail_one_param: true
-)
-fail_step_failure = SomeActionOnSuccessToSuccessTrack.call(
-  param_for_step_one: false,
-  fail_one_param: false
-)
-success_action # =>
-# Result: success
-# Railway Flow:
-#   step_one -> step_two
-# Context:
-#   {:param_for_step_one=>true, :step_two=>"Success"}
-# Errors:
-#   {}
-fail_step_success # =>
-# Result: success
-# Railway Flow:
-#   step_one -> fail_one -> step_two
-# Context:
-#   {:param_for_step_one=>false, :fail_one_param=>true, :action_failed=>true, :step_two=>"Success"}
-# Errors:
-#   {}
-fail_step_failure  # =>
-# Result: failure
-# Railway Flow:
-#   step_one -> fail_one -> fail_two
-# Context:
-#   {:param_for_step_one=>false, :fail_one_param=>false, :action_failed=>false, :fail_two=>"Failure"}
-# Errors:
-#   {}
-# on_success: next failure track step
-class SomeActionOnSuccessToFailureTrack < Decouplio::Action
-  logic do
-    step :step_one
-    fail :fail_one, on_success: :fail_three
-    step :step_two
-    fail :fail_two
-    fail :fail_three
-  end
-  def step_one(param_for_step_one:, **)
-    param_for_step_one
-  end
-  def fail_one(fail_one_param:, **)
-    ctx[:action_failed] = fail_one_param
-  end
-  def step_two(**)
-    ctx[:step_two] = 'Success'
-  end
-  def fail_two(**)
-    ctx[:fail_two] = 'Failure'
-  end
-  def fail_three(**)
-    ctx[:fail_three] = 'Failure'
-  end
-end
-success_action = SomeActionOnSuccessToFailureTrack.call(
-  param_for_step_one: true
-)
-fail_step_success = SomeActionOnSuccessToFailureTrack.call(
-  param_for_step_one: false,
-  fail_one_param: true
-)
-fail_step_failure = SomeActionOnSuccessToFailureTrack.call(
-  param_for_step_one: false,
-  fail_one_param: false
-)
-success_action # =>
-# Result: success
-# Railway Flow:
-#   step_one -> step_two
-# Context:
-#   {:param_for_step_one=>true, :step_two=>"Success"}
-# Errors:
-#   {}
-fail_step_success # =>
-# Result: failure
-# Railway Flow:
-#   step_one -> fail_one -> fail_three
-# Context:
-#   {:param_for_step_one=>false, :fail_one_param=>true, :action_failed=>true, :fail_three=>"Failure"}
-# Errors:
-#   {}
-fail_step_failure  # =>
-# Result: failure
-# Railway Flow:
-#   step_one -> fail_one -> fail_two -> fail_three
-# Context:
-#   {:param_for_step_one=>false, :fail_one_param=>false, :action_failed=>false, :fail_two=>"Failure", :fail_three=>"Failure"}
-# Errors:
-#   {}
-# on_success: :PASS
-class SomeActionOnSuccessPass < Decouplio::Action
-  logic do
-    step :step_one
-    fail :fail_one, on_success: :PASS
-  end
-  def step_one(**)
-    ctx[:step_one] = false
-  end
-  def fail_one(fail_one_param:, **)
-    ctx[:fail_one] = fail_one_param
-  end
-end
-fail_step_success = SomeActionOnSuccessPass.call(fail_one_param: true)
-fail_step_failure = SomeActionOnSuccessPass.call(fail_one_param: false)
-fail_step_success # =>
-# Result: success
-# Railway Flow:
-#   step_one -> fail_one
-# Context:
-#   :fail_one_param => true
-#   :step_one => false
-#   :fail_one => true
-# Errors:
-#   {}
-fail_step_failure # =>
-# Result: failure
-# Railway Flow:
-#   step_one -> fail_one
-# Context:
-#   :fail_one_param => false
-#   :step_one => false
-#   :fail_one => false
-# Errors:
-#   {}
-# on_failure: :finish_him
-class SomeActionOnFailureFinishHim < Decouplio::Action
-  logic do
-    step :step_one
-    fail :fail_one, on_failure: :finish_him
-    step :step_two
-    fail :fail_two
-  end
-  def step_one(param_for_step_one:, **)
-    param_for_step_one
-  end
-  def fail_one(fail_one_param:, **)
-    ctx[:action_failed] = fail_one_param
-  end
-  def step_two(**)
-    ctx[:step_two] = 'Success'
-  end
-  def fail_two(**)
-    ctx[:fail_two] = 'Failure'
-  end
-end
-success_action = SomeActionOnFailureFinishHim.call(
-  param_for_step_one: true
-)
-fail_step_success = SomeActionOnFailureFinishHim.call(
-  param_for_step_one: false,
-  fail_one_param: true
-)
-fail_step_failure = SomeActionOnFailureFinishHim.call(
-  param_for_step_one: false,
-  fail_one_param: false
-)
-success_action # =>
-# Result: success
-# Railway Flow:
-#   step_one -> step_two
-# Context:
-#   {:param_for_step_one=>true, :step_two=>"Success"}
-# Errors:
-#   {}
-fail_step_success # =>
-# Result: failure
-# Railway Flow:
-#   step_one -> fail_one -> fail_two
-# Context:
-#   {:param_for_step_one=>false, :fail_one_param=>true, :action_failed=>true, :fail_two=>"Failure"}
-# Errors:
-#   {}
-fail_step_failure  # =>
-# Result: failure
-# Railway Flow:
-#   step_one -> fail_one
-# Context:
-#   {:param_for_step_one=>false, :fail_one_param=>false, :action_failed=>false}
-# Errors:
-#   {}
-# on_failure: next success track step
-class SomeActionOnFailureToSuccessTrack < Decouplio::Action
-  logic do
-    step :step_one
-    fail :fail_one, on_failure: :step_two
-    step :step_two
-    fail :fail_two
-  end
-  def step_one(param_for_step_one:, **)
-    param_for_step_one
-  end
-  def fail_one(fail_one_param:, **)
-    ctx[:action_failed] = fail_one_param
-  end
-  def step_two(**)
-    ctx[:step_two] = 'Success'
-  end
-  def fail_two(**)
-    ctx[:fail_two] = 'Failure'
-  end
-end
-success_action = SomeActionOnFailureToSuccessTrack.call(
-  param_for_step_one: true
-)
-fail_step_success = SomeActionOnFailureToSuccessTrack.call(
-  param_for_step_one: false,
-  fail_one_param: true
-)
-fail_step_failure = SomeActionOnFailureToSuccessTrack.call(
-  param_for_step_one: false,
-  fail_one_param: false
-)
-success_action # =>
-# Result: success
-# Railway Flow:
-#   step_one -> step_two
-# Context:
-#   {:param_for_step_one=>true, :step_two=>"Success"}
-# Errors:
-#   {}
-fail_step_success # =>
-# Result: failure
-# Railway Flow:
-#   step_one -> fail_one -> fail_two
-# Context:
-#   {:param_for_step_one=>false, :fail_one_param=>true, :action_failed=>true, :fail_two=>"Failure"}
-# Errors:
-#   {}
-fail_step_failure  # =>
-# Result: success
-# Railway Flow:
-#   step_one -> fail_one -> step_two
-# Context:
-#   {:param_for_step_one=>false, :fail_one_param=>false, :action_failed=>false, :step_two=>"Success"}
-# Errors:
-#   {}
-# on_failure: next failure track step
-class SomeActionOnFailureToFailureTrack < Decouplio::Action
-  logic do
-    step :step_one
-    fail :fail_one, on_failure: :fail_three
-    step :step_two
-    fail :fail_two
-    fail :fail_three
-  end
-  def step_one(param_for_step_one:, **)
-    param_for_step_one
-  end
-  def fail_one(fail_one_param:, **)
-    ctx[:action_failed] = fail_one_param
-  end
-  def step_two(**)
-    ctx[:step_two] = 'Success'
-  end
-  def fail_two(**)
-    ctx[:fail_two] = 'Failure'
-  end
-  def fail_three(**)
-    ctx[:fail_three] = 'Failure'
-  end
-end
-success_action = SomeActionOnFailureToFailureTrack.call(
-  param_for_step_one: true
-)
-fail_step_success = SomeActionOnFailureToFailureTrack.call(
-  param_for_step_one: false,
-  fail_one_param: true
-)
-fail_step_failure = SomeActionOnFailureToFailureTrack.call(
-  param_for_step_one: false,
-  fail_one_param: false
-)
-success_action # =>
-# Result: success
-# Railway Flow:
-#   step_one -> step_two
-# Context:
-#   {:param_for_step_one=>true, :step_two=>"Success"}
-# Errors:
-#   {}
-fail_step_success # =>
-# Result: failure
-# Railway Flow:
-#   step_one -> fail_one -> fail_two -> fail_three
-# Context:
-#   {:param_for_step_one=>false, :fail_one_param=>true, :action_failed=>true, :fail_two=>"Failure", :fail_three=>"Failure"}
-# Errors:
-#   {}
-fail_step_failure  # =>
-# Result: failure
-# Railway Flow:
-#   step_one -> fail_one -> fail_three
-# Context:
-#   {:param_for_step_one=>false, :fail_one_param=>false, :action_failed=>false, :fail_three=>"Failure"}
-# Errors:
-#   {}
-# on_failure: :PASS
-class SomeActionOnFailurePass < Decouplio::Action
-  logic do
-    step :step_one
-    fail :fail_one, on_failure: :PASS
-  end
-  def step_one(**)
-    false
-  end
-  def fail_one(fail_one_param:, **)
-    ctx[:fail_one] = fail_one_param
-  end
-end
-fail_step_success = SomeActionOnFailurePass.call(fail_one_param: true)
-fail_step_failure = SomeActionOnFailurePass.call(fail_one_param: false)
-fail_step_success # =>
-# Result: failure
-# Railway Flow:
-#   step_one -> fail_one
-# Context:
-#   :fail_one_param => true
-#   :fail_one => true
-# Errors:
-#   {}
-fail_step_failure # =>
-# Result: success
-# Railway Flow:
-#   step_one -> fail_one
-# Context:
-#   :fail_one_param => false
-#   :fail_one => false
-# Errors:
-#   {}
-# if: condition method name
-class SomeActionOnIfCondition < Decouplio::Action
-  logic do
-    step :step_one
-    fail :fail_one
-    step :step_two
-    fail :fail_two, if: :some_condition?
-    fail :fail_three
-  end
-  def step_one(param_for_step_one:, **)
-    param_for_step_one
-  end
-  def fail_one(**)
-    ctx[:action_failed] = true
-  end
-  def step_two(**)
-    ctx[:step_two] = 'Success'
-  end
-  def fail_two(**)
-    ctx[:fail_two] = 'Failure'
-  end
-  def fail_three(**)
-    ctx[:fail_three] = 'Failure'
-  end
-  def some_condition?(if_condition_param:, **)
-    if_condition_param
-  end
-end
-success_action = SomeActionOnIfCondition.call(
-  param_for_step_one: true
-)
-fail_condition_positive = SomeActionOnIfCondition.call(
-  param_for_step_one: false,
-  if_condition_param: true
-)
-fail_condition_negative = SomeActionOnIfCondition.call(
-  param_for_step_one: false,
-  if_condition_param: false
-)
-success_action # =>
-# Result: success
-# Railway Flow:
-#   step_one -> step_two
-# Context:
-#   {:param_for_step_one=>true, :step_two=>"Success"}
-# Errors:
-#   {}
-fail_condition_positive # =>
-# Result: failure
-# Railway Flow:
-#   step_one -> fail_one -> fail_two -> fail_three
-# Context:
-#   {:param_for_step_one=>false, :if_condition_param=>true, :action_failed=>true, :fail_two=>"Failure", :fail_three=>"Failure"}
-# Errors:
-#   {}
-fail_condition_negative  # =>
-# Result: failure
-# Railway Flow:
-#   step_one -> fail_one -> fail_three
-# Context:
-#   {:param_for_step_one=>false, :if_condition_param=>false, :action_failed=>true, :fail_three=>"Failure"}
-# Errors:
-#   {}
-# unless: condition method name
-class SomeActionOnUnlessCondition < Decouplio::Action
-  logic do
-    step :step_one
-    fail :fail_one
-    step :step_two
-    fail :fail_two, unless: :some_condition?
-    fail :fail_three
-  end
-  def step_one(param_for_step_one:, **)
-    param_for_step_one
-  end
-  def fail_one(**)
-    ctx[:action_failed] = true
-  end
-  def step_two(**)
-    ctx[:step_two] = 'Success'
-  end
-  def fail_two(**)
-    ctx[:fail_two] = 'Failure'
-  end
-  def fail_three(**)
-    ctx[:fail_three] = 'Failure'
-  end
-  def some_condition?(if_condition_param:, **)
-    if_condition_param
-  end
-end
-success_action = SomeActionOnUnlessCondition.call(
-  param_for_step_one: true
-)
-fail_condition_positive = SomeActionOnUnlessCondition.call(
-  param_for_step_one: false,
-  if_condition_param: false
-)
-fail_condition_negative = SomeActionOnUnlessCondition.call(
-  param_for_step_one: false,
-  if_condition_param: true
-)
-success_action # =>
-# Result: success
-# Railway Flow:
-#   step_one -> step_two
-# Context:
-#   {:param_for_step_one=>true, :step_two=>"Success"}
-# Errors:
-#   {}
-fail_condition_positive # =>
-# Result: failure
-# Railway Flow:
-#   step_one -> fail_one -> fail_two -> fail_three
-# Context:
-#   {:param_for_step_one=>false, :if_condition_param=>false, :action_failed=>true, :fail_two=>"Failure", :fail_three=>"Failure"}
-# Errors:
-#   {}
-fail_condition_negative  # =>
-# Result: failure
-# Railway Flow:
-#   step_one -> fail_one -> fail_three
-# Context:
-#   {:param_for_step_one=>false, :if_condition_param=>true, :action_failed=>true, :fail_three=>"Failure"}
-# Errors:
-#   {}
-# finish_him: true
-class SomeActionFinishHimTrue < Decouplio::Action
-  logic do
-    step :step_one
-    fail :fail_one, finish_him: true
-    step :step_two
-    fail :fail_two
-  end
-  def step_one(param_for_step_one:, **)
-    param_for_step_one
-  end
-  def fail_one(fail_one_param:, **)
-    ctx[:action_failed] = fail_one_param
-  end
-  def step_two(**)
-    ctx[:step_two] = 'Success'
-  end
-  def fail_two(**)
-    ctx[:fail_two] = 'Failure'
-  end
-end
-success_action = SomeActionFinishHimTrue.call(
-  param_for_step_one: true
-)
-fail_step_success = SomeActionFinishHimTrue.call(
-  param_for_step_one: false,
-  fail_one_param: true
-)
-fail_step_failure = SomeActionFinishHimTrue.call(
-  param_for_step_one: false,
-  fail_one_param: false
-)
-success_action # =>
-# Result: success
-# Railway Flow:
-#   step_one -> step_two
-# Context:
-#   {:param_for_step_one=>true, :step_two=>"Success"}
-# Errors:
-#   {}
-fail_step_success # =>
-# Result: failure
-# Railway Flow:
-#   step_one -> fail_one
-# Context:
-#   {:param_for_step_one=>false, :fail_one_param=>true, :action_failed=>true}
-# Errors:
-#   {}
-fail_step_failure  # =>
-# Result: failure
-# Railway Flow:
-#   step_one -> fail_one
-# Context:
-#   {:param_for_step_one=>false, :fail_one_param=>false, :action_failed=>false}
-# Errors:
-#   {}