decouplio 1.0.0alpha1 → 1.0.0alpha4

data/docs/step.rb

@@ -1,526 +0,0 @@
-require_relative '../lib/decouplio'
-
-
-
-# Behavior
-class SomeAction < Decouplio::Action
-  logic do
-    step :step_one
-    fail :fail_one
-    step :step_two
-  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[:result] = 'Success'
-  end
-end
-
-success_action = SomeAction.call(param_for_step_one: true)
-failure_action = SomeAction.call(param_for_step_one: false)
-
-puts success_action # =>
-# Result: success
-
-# Railway Flow:
-#   step_one -> step_two
-
-# Context:
-#   {:param_for_step_one=>true, :result=>"Success"}
-
-# Errors:
-#   {}
-
-puts failure_action # =>
-# Result: failure
-
-# Railway Flow:
-#   step_one -> fail_one
-
-# Context:
-#   {:param_for_step_one=>false, :action_failed=>true}
-
-# Errors:
-#   {}
-
-
-
-# on_success: :finish_him
-class SomeActionOnSuccessFinishHim < Decouplio::Action
-  logic do
-    step :step_one, on_success: :finish_him
-    fail :fail_one
-    step :step_two
-  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[:result] = 'Success'
-  end
-end
-
-success_action = SomeActionOnSuccessFinishHim.call(param_for_step_one: true)
-failure_action = SomeActionOnSuccessFinishHim.call(param_for_step_one: false)
-
-puts success_action # =>
-# Result: success
-
-# Railway Flow:
-#   step_one
-
-# Context:
-#   {:param_for_step_one=>true}
-
-# Errors:
-#   {}
-
-puts failure_action # =>
-# Result: failure
-
-# Railway Flow:
-#   step_one -> fail_one
-
-# Context:
-#   {:param_for_step_one=>false, :action_failed=>true}
-
-# Errors:
-#   {}
-
-
-
-# on_success: next success track step
-class SomeActionOnSuccessToSuccessTrack < Decouplio::Action
-  logic do
-    step :step_one, on_success: :step_three
-    fail :fail_one
-    step :step_two
-    step :step_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 step_three(**)
-    ctx[:result] = 'Result'
-  end
-end
-
-success_action = SomeActionOnSuccessToSuccessTrack.call(param_for_step_one: true)
-failure_action = SomeActionOnSuccessToSuccessTrack.call(param_for_step_one: false)
-puts success_action # =>
-# Result: success
-
-# Railway Flow:
-#   step_one -> step_three
-
-# Context:
-#   {:param_for_step_one=>true, :result=>"Result"}
-
-# Errors:
-#   {}
-
-
-puts failure_action # =>
-# Result: failure
-
-# Railway Flow:
-#   step_one -> fail_one
-
-# Context:
-#   {:param_for_step_one=>false, :action_failed=>true}
-
-# Errors:
-#   {}
-
-
-
-# on_success: next failure track step
-class SomeActionOnSuccessToFailureTrack < Decouplio::Action
-  logic do
-    step :step_one, on_success: :fail_two
-    fail :fail_one
-    step :step_two
-    step :step_three
-    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 step_two(**)
-    ctx[:step_two] = 'Success'
-  end
-
-  def step_three(**)
-    ctx[:result] = 'Result'
-  end
-
-  def fail_two(**)
-    ctx[:fail_two] = 'Failure'
-  end
-end
-
-success_action = SomeActionOnSuccessToFailureTrack.call(param_for_step_one: true)
-failure_action = SomeActionOnSuccessToFailureTrack.call(param_for_step_one: false)
-puts success_action # =>
-# Result: failure
-
-# Railway Flow:
-#   step_one -> fail_two
-
-# Context:
-#   {:param_for_step_one=>true, :fail_two=>"Failure"}
-
-# Errors:
-#   {}
-
-puts 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_failure: :finish_him
-class SomeActionOnFailureFinishHim < Decouplio::Action
-  logic do
-    step :step_one, on_failure: :finish_him
-    fail :fail_one
-    step :step_two
-    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 step_two(**)
-    ctx[:result] = 'Success'
-  end
-
-  def fail_two(**)
-    ctx[:fail_two] = 'failure'
-  end
-end
-
-success_action = SomeActionOnFailureFinishHim.call(param_for_step_one: true)
-failure_action = SomeActionOnFailureFinishHim.call(param_for_step_one: false)
-puts success_action # =>
-# Result: success
-
-# Railway Flow:
-#   step_one -> step_two
-
-# Context:
-#   {:param_for_step_one=>true, :result=>"Success"}
-
-# Errors:
-#   {}
-
-puts failure_action # =>
-# Result: failure
-
-# Railway Flow:
-#   step_one
-
-# Context:
-#   {:param_for_step_one=>false}
-
-# Errors:
-#   {}
-
-
-
-# on_failure: next success track step
-class SomeActionOnFailureToSuccessTrack < Decouplio::Action
-  logic do
-    step :step_one, on_failure: :step_three
-    fail :fail_one
-    step :step_two
-    fail :fail_two
-    step :step_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[:result] = 'Success'
-  end
-
-  def fail_two(**)
-    ctx[:fail_two] = 'failure'
-  end
-
-  def step_three(**)
-    ctx[:step_three] = 'Success'
-  end
-end
-
-success_action = SomeActionOnFailureToSuccessTrack.call(param_for_step_one: true)
-failure_action = SomeActionOnFailureToSuccessTrack.call(param_for_step_one: false)
-puts success_action # =>
-# Result: success
-
-# Railway Flow:
-#   step_one -> step_two -> step_three
-
-# Context:
-#   {:param_for_step_one=>true, :result=>"Success", :step_three=>"Success"}
-
-# Errors:
-#   {}
-
-
-puts failure_action # =>
-# Result: success
-
-# Railway Flow:
-#   step_one -> step_three
-
-# Context:
-#   {:param_for_step_one=>false, :step_three=>"Success"}
-
-# Errors:
-#   {}
-
-
-
-# on_failure: next failure track step
-class SomeActionOnFailureToFailureTrack < Decouplio::Action
-  logic do
-    step :step_one, on_failure: :fail_two
-    fail :fail_one
-    step :step_two
-    fail :fail_two
-    step :step_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[:result] = 'Success'
-  end
-
-  def fail_two(**)
-    ctx[:fail_two] = 'failure'
-  end
-
-  def step_three(**)
-    ctx[:step_three] = 'Success'
-  end
-end
-
-success_action = SomeActionOnFailureToFailureTrack.call(param_for_step_one: true)
-failure_action = SomeActionOnFailureToFailureTrack.call(param_for_step_one: false)
-puts success_action # =>
-# Result: success
-
-# Railway Flow:
-#   step_one -> step_two -> step_three
-
-# Context:
-#   {:param_for_step_one=>true, :result=>"Success", :step_three=>"Success"}
-
-# Errors:
-#   {}
-
-puts failure_action # =>
-# Result: failure
-
-# Railway Flow:
-#   step_one -> fail_two
-
-# Context:
-#   {:param_for_step_one=>false, :fail_two=>"failure"}
-
-# Errors:
-#   {}
-
-
-
-# if: condition method name
-class SomeActionOnIfCondition < Decouplio::Action
-  logic do
-    step :step_one
-    fail :fail_one
-    step :step_two
-    fail :fail_two
-    step :step_three, if: :step_condition?
-  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[:result] = 'Success'
-  end
-
-  def fail_two(**)
-    ctx[:fail_two] = 'failure'
-  end
-
-  def step_three(**)
-    ctx[:step_three] = 'Success'
-  end
-
-  def step_condition?(step_condition_param:, **)
-    step_condition_param
-  end
-end
-
-condition_positive = SomeActionOnIfCondition.call(
-  param_for_step_one: true,
-  step_condition_param: true
-)
-condition_negative = SomeActionOnIfCondition.call(
-  param_for_step_one: true,
-  step_condition_param: false
-)
-puts condition_positive # =>
-# Result: success
-
-# Railway Flow:
-#   step_one -> step_two -> step_three
-
-# Context:
-#   {:param_for_step_one=>true, :step_condition_param=>true, :result=>"Success", :step_three=>"Success"}
-
-# Errors:
-#   {}
-
-puts condition_negative # =>
-# Result: success
-
-# Railway Flow:
-#   step_one -> step_two
-
-# Context:
-#   {:param_for_step_one=>true, :step_condition_param=>false, :result=>"Success"}
-
-# Errors:
-#   {}
-
-
-
-# unless: condition method name
-class SomeActionOnUnlessCondition < Decouplio::Action
-  logic do
-    step :step_one
-    fail :fail_one
-    step :step_two
-    fail :fail_two
-    step :step_three, unless: :step_condition?
-  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[:result] = 'Success'
-  end
-
-  def fail_two(**)
-    ctx[:fail_two] = 'failure'
-  end
-
-  def step_three(**)
-    ctx[:step_three] = 'Success'
-  end
-
-  def step_condition?(step_condition_param:, **)
-    step_condition_param
-  end
-end
-
-condition_positive = SomeActionOnUnlessCondition.call(
-  param_for_step_one: true,
-  step_condition_param: true
-)
-condition_negative = SomeActionOnUnlessCondition.call(
-  param_for_step_one: true,
-  step_condition_param: false
-)
-puts condition_positive # =>
-# Result: success
-
-# Railway Flow:
-#   step_one -> step_two
-
-# Context:
-#   {:param_for_step_one=>true, :step_condition_param=>true, :result=>"Success"}
-
-# Errors:
-#   {}
-
-puts condition_negative # =>
-# Result: success
-
-# Railway Flow:
-#   step_one -> step_two -> step_three
-
-# Context:
-#   {:param_for_step_one=>true, :step_condition_param=>false, :result=>"Success", :step_three=>"Success"}
-
-# Errors:
-#   {}

data/docs/step_as_a_service.md

@@ -1,109 +0,0 @@
-# Step as a service
-
-It's similar to [Inner action](https://github.com/differencialx/decouplio/blob/master/docs/inner_action.md), but instead of using `Decouplio::Action`, you can use PORO class.
-
-## Signature
-
-```ruby
-(step|fail|pass)(service_class, **options)
-```
-
-## How to use?
-
-Create a PORO class with `.call` class method.
-
-```ruby
-# :ctx - is the required kwarg
-class Concat
-  def self.call(ctx:)
-    new(ctx: ctx).call
-  end
-
-  def initialize(ctx:)
-    @ctx = ctx
-  end
-
-  def call
-    @ctx[:result] = @ctx[:one] + @ctx[:two]
-  end
-end
-
-# OR
-
-# :ctx - is the required kwarg
-class Subtract
-  def self.call(ctx:)
-    ctx[:result] = ctx[:one] - ctx[:two]
-  end
-end
-```
-
-Now you can use these classes as a `step|fail|pass` step
-
-```ruby
-class SomeActionConcat < Decouplio::Action
-  logic do
-    step Concat
-  end
-end
-
-action = SomeActionConcat.call(one: 1, two: 2)
-
-puts action[:result] # => 3
-
-puts action # =>
-# Result: success
-
-# Railway Flow:
-#   Concat
-
-# Context:
-#   {:one=>1, :two=>2, :result=>3}
-
-# Errors:
-#   {}
-```
-
-OR
-
-```ruby
-class SomeActionSubtract < Decouplio::Action
-  logic do
-    step :init_one
-    step :init_two
-    step Subtract
-  end
-
-  def init_one(param_one:, **)
-    ctx[:one] = param_one
-  end
-
-  def init_two(param_two:, **)
-    ctx[:two] = param_two
-  end
-end
-
-action = SomeActionSubtract.call(param_one: 5, param_two: 2)
-
-puts action[:result] # => 3
-
-puts action # =>
-# Result: success
-
-# Railway Flow:
-#   init_one -> init_two -> Subtract
-
-# Context:
-#   {:param_one=>5, :param_two=>2, :one=>5, :two=>2, :result=>3}
-
-# Errors:
-#   {}
-
-```
-
-## Behavior
-
-- service class should implement `.call` class method
-- service class can be used as `step` or `fail` or `pass`
-- all options of `step|fail|pass` can be used as [Inner action](https://github.com/differencialx/decouplio/blob/master/docs/inner_action.md)
-- depending on returning value of `.call` method(truthy ot falsy) the execution will be moved to `success or failure` track accordingly.

data/docs/step_as_a_service.rb

@@ -1,77 +0,0 @@
-require_relative '../lib/decouplio'
-
-class Concat
-  def self.call(ctx:)
-    new(ctx: ctx).call
-  end
-
-  def initialize(ctx:)
-    @ctx = ctx
-  end
-
-  def call
-    @ctx[:result] = @ctx[:one] + @ctx[:two]
-  end
-end
-
-class Subtract
-  def self.call(ctx:)
-    ctx[:result] = ctx[:one] - ctx[:two]
-  end
-end
-
-class SomeActionConcat < Decouplio::Action
-  logic do
-    step Concat
-  end
-end
-
-action = SomeActionConcat.call(one: 1, two: 2)
-
-puts action[:result] # => 3
-
-puts action # =>
-# Result: success
-
-# Railway Flow:
-#   Concat
-
-# Context:
-#   {:one=>1, :two=>2, :result=>3}
-
-# Errors:
-#   {}
-
-
-
-class SomeActionSubtract < Decouplio::Action
-  logic do
-    step :init_one
-    step :init_two
-    step Subtract
-  end
-
-  def init_one(param_one:, **)
-    ctx[:one] = param_one
-  end
-
-  def init_two(param_two:, **)
-    ctx[:two] = param_two
-  end
-end
-
-action = SomeActionSubtract.call(param_one: 5, param_two: 2)
-
-puts action[:result] # => 3
-
-puts action # =>
-# Result: success
-
-# Railway Flow:
-#   init_one -> init_two -> Subtract
-
-# Context:
-#   {:param_one=>5, :param_two=>2, :one=>5, :two=>2, :result=>3}
-
-# Errors:
-#   {}