decouplio 1.0.0alpha1 → 1.0.0alpha2

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

data/lib/decouplio/action.rb

@@ -7,15 +7,18 @@ require_relative 'default_error_handler'
 require_relative 'errors/logic_redefinition_error'
 require_relative 'errors/logic_is_not_defined_error'
 require_relative 'errors/error_store_error'
+require_relative 'const/results'
 
 module Decouplio
   class Action
+    PREVIOUS_STEP_INDEX = -2
+
     extend Forwardable
     def_delegators :@error_store, :errors, :add_error
     attr_reader :railway_flow, :ctx, :error_store
 
     def initialize(
-      parent_railway_flow: nil, parent_ctx: nil, wrapper: false, error_store:, **params
+      parent_railway_flow: nil, parent_ctx: nil, error_store:, **params
     )
       @error_store = error_store
       @ctx = parent_ctx || params
@@ -43,6 +46,10 @@ module Decouplio
       @failure = false
     end
 
+    def previous_step
+      railway_flow[PREVIOUS_STEP_INDEX]
+    end
+
     def append_railway_flow(stp)
       railway_flow << stp
     end
@@ -55,10 +62,22 @@ module Decouplio
           #{railway_flow.join(' -> ')}
 
         Context:
-          #{ctx}
+          #{ctx.map { |k, v| "#{k.inspect} => #{v.inspect}" }.join("\n  ")}
 
         Errors:
-          #{errors}
+          #{
+            if errors.is_a?(Hash)
+              if errors.empty?
+                'None'
+              else
+                errors.map do |k, v|
+                  "#{k.inspect} => #{v.inspect}"
+                end.join("\n  ")
+              end
+            else
+              errors
+            end
+          }
       INSPECT
     end