decouplio 1.0.0alpha → 1.0.0alpha3

data/docs/index.md

@@ -19,7 +19,7 @@ Decouplio is a zero dependency, thread safe and framework agnostic gem designed
   - [Wrap](https://github.com/differencialx/decouplio/blob/master/docs/wrap.md)
   - [Resq](https://github.com/differencialx/decouplio/blob/master/docs/resq.md)
   - [Inner action](https://github.com/differencialx/decouplio/blob/master/docs/inner_action.md)
-  - [Doby](https://github.com/differencialx/decouplio/blob/master/docs/doby.md)
+  - [Doby/Aide](https://github.com/differencialx/decouplio/blob/master/docs/doby_aide.md)
   - [Step as a service](https://github.com/differencialx/decouplio/blob/master/docs/step_as_a_service.md)
 - [Error store](https://github.com/differencialx/decouplio/blob/master/docs/error_store.md)
 - [Benchmarks](https://github.com/differencialx/decouplio/blob/master/docs/benchmarks.md)

data/docs/logic_block.md

@@ -23,3 +23,7 @@ Possible logic steps:
 |octo|[--->>>](https://github.com/differencialx/decouplio/blob/master/docs/octo.md)|
 |wrap|[--->>>](https://github.com/differencialx/decouplio/blob/master/docs/wrap.md)|
 |resq|[--->>>](https://github.com/differencialx/decouplio/blob/master/docs/resq.md)|
+|doby|[--->>>](https://github.com/differencialx/decouplio/blob/master/docs/doby_aide.md)|
+|aide|[--->>>](https://github.com/differencialx/decouplio/blob/master/docs/doby_aide.md)|
+|inner action|[--->>>](https://github.com/differencialx/decouplio/blob/master/docs/inner_action.md)|
+|step as service|[--->>>](https://github.com/differencialx/decouplio/blob/master/docs/step_as_a_service.md)|

data/docs/octo.md

@@ -5,7 +5,7 @@ It's a step type which helps to implement strategy pattern.
 ## Signature
 
 ```ruby
-octo(octo_name, ctx_key:, **options) do
+octo(octo_name, ctx_key:, method:, **options) do
   on :key1, palp: :palp_name_one
   on :key2, palp: :palp_name_two
   on :key3, palp: :palp_name_three
@@ -14,7 +14,11 @@ end
 
 ## Behavior
 
-- depending on the value inside `ctx_key` in context `octo` will perform flow defined for this key. So basically `octo` will be replaces with flow you defined.
+- Depending on some value you can perform different flow. Imagine that `octo` will be replaced with another flow.
+- You have two options to set value for octo. By `ctx_key` and `method` options.
+- `ctx_key` and `method` options are controversial, so you can use only one of them.
+- with `ctx_key` you can specify the key inside action context with value for `octo`
+- with `method` you can specify method name symbol, which will be called to retrieve `octo` value, like we do for `if` and `unless` options.
 ```ruby
 logic do
   palp :palp_name_one do
@@ -263,7 +267,60 @@ Currently only one possibility is present to define flow for `octo`, it's `palp`
 ***
 ## Options
 
+### ctx_key: context key with octo value
+
+See examples above
+
+***
+
+### method: method symbol which returns octo value
+<details><summary><b>EXAMPLE (CLICK ME)</b></summary>
+<p>
+
+  ```ruby
+    require 'decouplio'
+
+    class SomeAction < Decouplio::Action
+      logic do
+        palp :palp_one do
+          step :step_one
+        end
+
+        palp :palp_two do
+          step :step_two
+        end
+
+        octo :octo_name, method: :what_is_next? do
+          on :option_one, palp: :palp_one
+          on :option_two, palp: :palp_two
+        end
+      end
+
+      def step_one(**)
+        # ...
+      end
+
+      def step_two(**)
+        # ...
+      end
+
+      def what_is_next?(connection:, url:)
+        connection.get(url).body[:decision]
+      end
+    end
+  ```
+
+</p>
+</details>
+
+***
+
 ### if: condition method name
 The same as for [step](https://github.com/differencialx/decouplio/blob/master/docs/step.md)
+
+***
+
 ### unless: condition method name
 The same as for [step](https://github.com/differencialx/decouplio/blob/master/docs/step.md)
+
+***

data/docs/quick_start.md

@@ -66,6 +66,6 @@ Learn more about all features:
   - [Wrap](https://github.com/differencialx/decouplio/blob/master/docs/wrap.md)
   - [Resq](https://github.com/differencialx/decouplio/blob/master/docs/resq.md)
   - [Inner action](https://github.com/differencialx/decouplio/blob/master/docs/inner_action.md)
-  - [Doby](https://github.com/differencialx/decouplio/blob/master/docs/doby.md)
+  - [Doby/Aide](https://github.com/differencialx/decouplio/blob/master/docs/doby_aide.md)
   - [Step as a service](https://github.com/differencialx/decouplio/blob/master/docs/step_as_a_service.md)
 - [Error store](https://github.com/differencialx/decouplio/blob/master/docs/error_store.md)

data/docs/resq.md

@@ -41,7 +41,7 @@ resq(**options)
 
 ## Behavior
 
-When `resq` step is defined after allowed step then it will catch error with class specified in options and call handler method.
+When `resq` step is defined after allowed step then it will catch error with class specified in options and call handler method. `resq` applies only for step which is defined above.
 
 <details><summary><b>EXAMPLE (CLICK ME)</b></summary>
 <p>
@@ -143,7 +143,7 @@ When `resq` step is defined after allowed step then it will catch error with cla
       logic do
         step :step_one
         resq handler_method_one: [ArgumentError, NoMethodError],
-            handler_method_two: NotImplementedError
+             handler_method_two: NotImplementedError
         step :step_two
         fail :fail_one
       end

data/docs/step.md

@@ -88,6 +88,8 @@ step(step_name, **options)
 |-|-|
 |:finish_him|action stops execution if `step` method returns truthy value|
 |symbol with next step name|step with specified symbol name performs if step method returns truthy value|
+|:PASS|will direct execution flow to nearest success track step. If current step is the last step when action will finish as `success`|
+|:FAIL|will direct execution flow to nearest failure track step. If current step is the last step when action will finish as `failure`|
 
 ### on_success: :finish_him
 
@@ -312,11 +314,83 @@ Can be used if for some reason you need to jump to fail step
 
 ***
 
+### on_success: :PASS
+It will perform like regular `step`, just move to next success track step.
+
+### on_success: :FAIL
+<details><summary><b>EXAMPLE (CLICK ME)</b></summary>
+<p>
+
+  ```ruby
+    require 'decouplio'
+
+    class SomeActionOnSuccessFail < Decouplio::Action
+      logic do
+        step :step_one
+        step :step_two, on_success: :FAIL
+      end
+
+      def step_one(**)
+        ctx[:step_one] = 'Success'
+      end
+
+      def step_two(step_two_param:, **)
+        ctx[:step_two] = step_two_param
+      end
+    end
+
+    success_action = SomeActionOnSuccessFail.call(step_two_param: true)
+    failure_action = SomeActionOnSuccessFail.call(step_two_param: false)
+
+    success_action # =>
+    # Result: failure
+
+    # Railway Flow:
+    #   step_one -> step_two
+
+    # Context:
+    #   :step_two_param => true
+    #   :step_one => "Success"
+    #   :step_two => true
+
+    # Errors:
+    #   {}
+
+    failure_action # =>
+    # Result: failure
+
+    # Railway Flow:
+    #   step_one -> step_two
+
+    # Context:
+    #   :step_two_param => false
+    #   :step_one => "Success"
+    #   :step_two => false
+
+    # Errors:
+    #   {}
+  ```
+
+  ```mermaid
+  flowchart LR
+      1(start)-->2(step_one);
+      2(step_one)-->|success track|3(step_two);
+      3(step_two)-->|success track|4(finish_failure);
+      3(step_two)-->|failure track|4(finish_failure);
+  ```
+</p>
+</details>
+
+***
+
+
 ### on_failure:
 |Allowed values|Description|
 |-|-|
 |:finish_him|action stops execution if `step` method returns falsy value|
 |symbol with next step name|step with specified symbol name performs if step method returns falsy value|
+|:PASS|will direct execution flow to nearest success track step. If current step is the last step when action will finish as `success`|
+|:FAIL|will direct execution flow to nearest failure track step. If current step is the last step when action will finish as `failure`|
 
 ### on_failure: :finish_him
 
@@ -550,6 +624,80 @@ Can be used in case if you need to come back to success track
 
 ***
 
+### on_failure: :PASS
+<details><summary><b>EXAMPLE (CLICK ME)</b></summary>
+<p>
+
+  ```ruby
+    require 'decouplio'
+
+    class SomeActionOnFailurePass < Decouplio::Action
+      logic do
+        step :step_one
+        step :step_two, on_failure: :PASS
+      end
+
+      def step_one(**)
+        ctx[:step_one] = true
+      end
+
+      def step_two(step_two_param:, **)
+        ctx[:step_two] = step_two_param
+      end
+    end
+
+
+    success_action = SomeActionOnFailurePass.call(step_two_param: true)
+    failure_action = SomeActionOnFailurePass.call(step_two_param: false)
+
+    success_action # =>
+    # Result: success
+
+    # Railway Flow:
+    #   step_one -> step_two
+
+    # Context:
+    #   :step_two_param => true
+    #   :step_one => true
+    #   :step_two => true
+
+    # Errors:
+    #   {}
+
+    failure_action # =>
+    # Result: success
+
+    # Railway Flow:
+    #   step_one -> step_two
+
+    # Context:
+    #   :step_two_param => false
+    #   :step_one => true
+    #   :step_two => false
+
+    # Errors:
+    #   {}
+
+  ```
+
+  ```mermaid
+  flowchart LR
+      1(start)-->2(step_one);
+      2(step_one)-->|success track|3(step_two);
+      3(step_two)-->|success track|4(finish_success);
+      3(step_two)-->|failure track|4(finish_success);
+  ```
+</p>
+</details>
+
+***
+
+
+### on_failure: :FAIL
+It will perform like regular `step`, just move to next failure track step.
+
+***
+
 ### if: condition method name
 Can be used in case if for some reason step shouldn't be executed
 

data/docs/step.rb

@@ -26,7 +26,7 @@ end
 success_action = SomeAction.call(param_for_step_one: true)
 failure_action = SomeAction.call(param_for_step_one: false)
 
-puts success_action # =>
+success_action # =>
 # Result: success
 
 # Railway Flow:
@@ -38,7 +38,7 @@ puts success_action # =>
 # Errors:
 #   {}
 
-puts failure_action # =>
+failure_action # =>
 # Result: failure
 
 # Railway Flow:
@@ -76,7 +76,7 @@ end
 success_action = SomeActionOnSuccessFinishHim.call(param_for_step_one: true)
 failure_action = SomeActionOnSuccessFinishHim.call(param_for_step_one: false)
 
-puts success_action # =>
+success_action # =>
 # Result: success
 
 # Railway Flow:
@@ -88,7 +88,7 @@ puts success_action # =>
 # Errors:
 #   {}
 
-puts failure_action # =>
+failure_action # =>
 # Result: failure
 
 # Railway Flow:
@@ -130,7 +130,7 @@ end
 
 success_action = SomeActionOnSuccessToSuccessTrack.call(param_for_step_one: true)
 failure_action = SomeActionOnSuccessToSuccessTrack.call(param_for_step_one: false)
-puts success_action # =>
+success_action # =>
 # Result: success
 
 # Railway Flow:
@@ -143,7 +143,7 @@ puts success_action # =>
 #   {}
 
 
-puts failure_action # =>
+failure_action # =>
 # Result: failure
 
 # Railway Flow:
@@ -190,7 +190,7 @@ end
 
 success_action = SomeActionOnSuccessToFailureTrack.call(param_for_step_one: true)
 failure_action = SomeActionOnSuccessToFailureTrack.call(param_for_step_one: false)
-puts success_action # =>
+success_action # =>
 # Result: failure
 
 # Railway Flow:
@@ -202,7 +202,7 @@ puts success_action # =>
 # Errors:
 #   {}
 
-puts failure_action # =>
+failure_action # =>
 # Result: failure
 
 # Railway Flow:
@@ -216,6 +216,56 @@ puts failure_action # =>
 
 
 
+# on_success: :FAIL
+
+class SomeActionOnSuccessFail < Decouplio::Action
+  logic do
+    step :step_one
+    step :step_two, on_success: :FAIL
+  end
+
+  def step_one(**)
+    ctx[:step_one] = 'Success'
+  end
+
+  def step_two(step_two_param:, **)
+    ctx[:step_two] = step_two_param
+  end
+end
+
+success_action = SomeActionOnSuccessFail.call(step_two_param: true)
+failure_action = SomeActionOnSuccessFail.call(step_two_param: false)
+
+success_action # =>
+# Result: failure
+
+# Railway Flow:
+#   step_one -> step_two
+
+# Context:
+#   :step_two_param => true
+#   :step_one => "Success"
+#   :step_two => true
+
+# Errors:
+#   {}
+
+failure_action # =>
+# Result: failure
+
+# Railway Flow:
+#   step_one -> step_two
+
+# Context:
+#   :step_two_param => false
+#   :step_one => "Success"
+#   :step_two => false
+
+# Errors:
+#   {}
+
+
+
 # on_failure: :finish_him
 class SomeActionOnFailureFinishHim < Decouplio::Action
   logic do
@@ -244,7 +294,7 @@ end
 
 success_action = SomeActionOnFailureFinishHim.call(param_for_step_one: true)
 failure_action = SomeActionOnFailureFinishHim.call(param_for_step_one: false)
-puts success_action # =>
+success_action # =>
 # Result: success
 
 # Railway Flow:
@@ -256,7 +306,7 @@ puts success_action # =>
 # Errors:
 #   {}
 
-puts failure_action # =>
+failure_action # =>
 # Result: failure
 
 # Railway Flow:
@@ -303,7 +353,7 @@ end
 
 success_action = SomeActionOnFailureToSuccessTrack.call(param_for_step_one: true)
 failure_action = SomeActionOnFailureToSuccessTrack.call(param_for_step_one: false)
-puts success_action # =>
+success_action # =>
 # Result: success
 
 # Railway Flow:
@@ -316,7 +366,7 @@ puts success_action # =>
 #   {}
 
 
-puts failure_action # =>
+failure_action # =>
 # Result: success
 
 # Railway Flow:
@@ -363,7 +413,7 @@ end
 
 success_action = SomeActionOnFailureToFailureTrack.call(param_for_step_one: true)
 failure_action = SomeActionOnFailureToFailureTrack.call(param_for_step_one: false)
-puts success_action # =>
+success_action # =>
 # Result: success
 
 # Railway Flow:
@@ -375,7 +425,7 @@ puts success_action # =>
 # Errors:
 #   {}
 
-puts failure_action # =>
+failure_action # =>
 # Result: failure
 
 # Railway Flow:
@@ -389,6 +439,57 @@ puts failure_action # =>
 
 
 
+# on_failure: :PASS
+class SomeActionOnFailurePass < Decouplio::Action
+  logic do
+    step :step_one
+    step :step_two, on_failure: :PASS
+  end
+
+  def step_one(**)
+    ctx[:step_one] = true
+  end
+
+  def step_two(step_two_param:, **)
+    ctx[:step_two] = step_two_param
+  end
+end
+
+
+success_action = SomeActionOnFailurePass.call(step_two_param: true)
+failure_action = SomeActionOnFailurePass.call(step_two_param: false)
+
+success_action # =>
+# Result: success
+
+# Railway Flow:
+#   step_one -> step_two
+
+# Context:
+#   :step_two_param => true
+#   :step_one => true
+#   :step_two => true
+
+# Errors:
+#   {}
+
+failure_action # =>
+# Result: success
+
+# Railway Flow:
+#   step_one -> step_two
+
+# Context:
+#   :step_two_param => false
+#   :step_one => true
+#   :step_two => false
+
+# Errors:
+#   {}
+
+
+
+
 # if: condition method name
 class SomeActionOnIfCondition < Decouplio::Action
   logic do
@@ -432,7 +533,7 @@ condition_negative = SomeActionOnIfCondition.call(
   param_for_step_one: true,
   step_condition_param: false
 )
-puts condition_positive # =>
+condition_positive # =>
 # Result: success
 
 # Railway Flow:
@@ -444,7 +545,7 @@ puts condition_positive # =>
 # Errors:
 #   {}
 
-puts condition_negative # =>
+condition_negative # =>
 # Result: success
 
 # Railway Flow:
@@ -501,7 +602,7 @@ condition_negative = SomeActionOnUnlessCondition.call(
   param_for_step_one: true,
   step_condition_param: false
 )
-puts condition_positive # =>
+condition_positive # =>
 # Result: success
 
 # Railway Flow:
@@ -513,7 +614,7 @@ puts condition_positive # =>
 # Errors:
 #   {}
 
-puts condition_negative # =>
+condition_negative # =>
 # Result: success
 
 # Railway Flow:

data/docs/step_as_a_service.md

@@ -8,14 +8,23 @@ It's similar to [Inner action](https://github.com/differencialx/decouplio/blob/m
 (step|fail|pass)(service_class, **options)
 ```
 
+## 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 for [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.
+
 ## How to use?
 
 Create a PORO class with `.call` class method.
 
 ```ruby
-# :ctx - is the required kwarg
+# :ctx - it's a ctx from Decouplio::Action
+# :error_store - it's an error_store from Decouplio::Action,
+#                you can call #add_error on it
 class Concat
-  def self.call(ctx:)
+  def self.call(ctx:, **)
     new(ctx: ctx).call
   end
 
@@ -30,12 +39,24 @@ end
 
 # OR
 
-# :ctx - is the required kwarg
+# :ctx - it's a ctx from Decouplio::Action
+# :error_store - it's an error_store from Decouplio::Action,
+#                you can call #add_error on it
 class Subtract
-  def self.call(ctx:)
+  def self.call(ctx:, **)
     ctx[:result] = ctx[:one] - ctx[:two]
   end
 end
+
+# OR
+
+class MakeRequest
+  def self.call(ctx:, error_store:)
+    ctx[:client].get(ctx[:url])
+  rescue Net::OpenTimeout => error
+    error_store.add_error(:connection_error, error.message)
+  end
+end
 ```
 
 Now you can use these classes as a `step|fail|pass` step
@@ -100,10 +121,3 @@ puts action # =>
 #   {}
 
 ```
-
-## 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,7 +1,7 @@
 require_relative '../lib/decouplio'
 
 class Concat
-  def self.call(ctx:)
+  def self.call(ctx:, **)
     new(ctx: ctx).call
   end
 
@@ -15,7 +15,7 @@ class Concat
 end
 
 class Subtract
-  def self.call(ctx:)
+  def self.call(ctx:, **)
     ctx[:result] = ctx[:one] - ctx[:two]
   end
 end

data/docs/wrap.md

@@ -214,6 +214,10 @@ The same as for [step](https://github.com/differencialx/decouplio/blob/master/do
 The same as for [step](https://github.com/differencialx/decouplio/blob/master/docs/step.md)
 ### on_success: next failure track step
 The same as for [step](https://github.com/differencialx/decouplio/blob/master/docs/step.md)
+### on_success: :PASS
+The same as for [step](https://github.com/differencialx/decouplio/blob/master/docs/step.md)
+### on_success: :FAIL
+The same as for [step](https://github.com/differencialx/decouplio/blob/master/docs/step.md)
 ### on_failure:
 The same as for [step](https://github.com/differencialx/decouplio/blob/master/docs/step.md)
 ### on_failure: :finish_him
@@ -222,6 +226,10 @@ The same as for [step](https://github.com/differencialx/decouplio/blob/master/do
 The same as for [step](https://github.com/differencialx/decouplio/blob/master/docs/step.md)
 ### on_failure: next failure track step
 The same as for [step](https://github.com/differencialx/decouplio/blob/master/docs/step.md)
+### on_failure: :PASS
+The same as for [step](https://github.com/differencialx/decouplio/blob/master/docs/step.md)
+### on_failure: :FAIL
+The same as for [step](https://github.com/differencialx/decouplio/blob/master/docs/step.md)
 ### if: condition method name
 The same as for [step](https://github.com/differencialx/decouplio/blob/master/docs/step.md)
 ### unless: condition method name