decouplio 1.0.0alpha2 → 1.0.0alpha5

data/docs/step_as_a_service.md

@@ -1,123 +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)
-```
-
-## 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 - 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:, **)
-    new(ctx: ctx).call
-  end
-
-  def initialize(ctx:)
-    @ctx = ctx
-  end
-
-  def call
-    @ctx[:result] = @ctx[:one] + @ctx[:two]
-  end
-end
-
-# OR
-
-# :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:, **)
-    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
-
-```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:
-#   {}
-
-```

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:
-#   {}

data/docs/wrap.md

@@ -1,240 +0,0 @@
-# Wrap
-
-`wrap` is the type of step, that behaves like `step`, but can wrap several steps with block to make some pre/post actions or to [rescue an error](https://github.com/differencialx/decouplio/blob/master/docs/resq.md).
-
-## Signature
-
-```ruby
-wrap(wrap_name, **options) do
-  # steps to wrap
-end
-```
-
-## Behavior
-
-- all steps inside `wrap` step will be perceived as [inner action](https://github.com/differencialx/decouplio/blob/master/docs/inner_action.md). So depending on inner action result the `wrap` step will be move to success or failure track
-
-<details><summary><b>EXAMPLE (CLICK ME)</b></summary>
-<p>
-
-  ```ruby
-    require 'decouplio'
-
-    class SomeAction < Decouplio::Action
-      logic do
-        step :step_one
-
-        wrap :wrap_one do
-          step :step_two
-          fail :fail_one
-        end
-
-        step :step_three
-        fail :fail_two
-      end
-
-      def step_one(param_for_step_one:, **)
-        ctx[:step_one] = param_for_step_one
-      end
-
-      def step_two(param_for_step_two:, **)
-        ctx[:step_two]= param_for_step_two
-      end
-
-      def fail_one(**)
-        ctx[:fail_one] = 'Fail one failure'
-      end
-
-      def step_three(**)
-        ctx[:step_three] = 'Success'
-      end
-
-      def fail_two(**)
-        ctx[:fail_two] = 'Fail two failure'
-      end
-    end
-
-    success_wrap_success = SomeAction.call(
-      param_for_step_one: true,
-      param_for_step_two: true
-    )
-    success_wrap_failure = SomeAction.call(
-      param_for_step_one: true,
-      param_for_step_two: false
-    )
-    failure = SomeAction.call(
-      param_for_step_one: false
-    )
-
-    success_wrap_success # =>
-    # Result: success
-
-    # Railway Flow:
-    #   step_one -> wrap_one -> step_two -> step_three
-
-    # Context:
-    #   {:param_for_step_one=>true, :param_for_step_two=>true, :step_one=>true, :step_two=>true, :step_three=>"Success"}
-
-    # Errors:
-    #   {}
-
-
-    success_wrap_failure # =>
-    # Result: failure
-
-    # Railway Flow:
-    #   step_one -> wrap_one -> step_two -> fail_one -> fail_two
-
-    # Context:
-    #   {:param_for_step_one=>true, :param_for_step_two=>false, :step_one=>true, :step_two=>false, :fail_one=>"Fail one failure", :fail_two=>"Fail two failure"}
-
-    # Errors:
-    #   {}
-
-    failure # =>
-    # Result: failure
-
-    # Railway Flow:
-    #   step_one -> fail_two
-
-    # Context:
-    #   {:param_for_step_one=>false, :step_one=>false, :fail_two=>"Fail two failure"}
-
-    # Errors:
-    #   {}
-  ```
-
-  ```mermaid
-    flowchart LR
-        1(start)-->2(step_one);
-        2(step_one)-->|success track|3(wrap_one);
-        subgraph wrap action;
-        3(wrap_one)-->|success track|4(start);
-        4(start)-->5(step_two);
-        5(step_two)-->|success track|6(finish success);
-        5(step_two)-->|failure track|9(fail_one);
-        9(fail_one)-->|failure track|10(finish failure);
-        end;
-        6(finish success)-->|success track|7(step_three);
-        7(step_three)-->|success track|8(finish success);
-        10(finish failure)-->|failure track|11(fail_two);
-        11(fail_two)-->|failure track|12(finish failure);
-        2(step_one)-->|failure track|11(fail_two)
-  ```
-
-</p>
-</details>
-
-***
-
-## Options
-
-### klass: some class, method: method to call on class
-
-|Option|Requirements|Description|
-|-|-|-|
-|:klass|:method option|The class which implements `method` for wrap|
-|:method|:klass option|The method which receives block as an argument|
-
-<details><summary><b>EXAMPLE (CLICK ME)</b></summary>
-<p>
-
-  ```ruby
-    require 'decouplio'
-
-    class WrapperClass
-      def self.some_wrapper_method(&block)
-        if block_given?
-          puts 'Before wrapper action execution'
-          block.call
-          puts 'After wrapper action execution'
-        end
-      end
-    end
-
-    class SomeActionWrapKlassMethod < Decouplio::Action
-      logic do
-        wrap :wrap_one, klass: WrapperClass, method: :some_wrapper_method do
-          step :step_one
-          step :step_two
-        end
-      end
-
-      def step_one(**)
-        puts 'Step one'
-        ctx[:step_one] = 'Success'
-      end
-
-      def step_two(**)
-        puts 'Step two'
-        ctx[:step_two] = 'Success'
-      end
-    end
-
-    action = SomeActionWrapKlassMethod.call # =>
-    # Before wrapper action execution
-    # Step one
-    # Step two
-    # After wrapper action execution
-
-    action # =>
-    # Result: success
-
-    # Railway Flow:
-    #   wrap_one -> step_one -> step_two
-
-    # Context:
-    #   {:step_one=>"Success", :step_two=>"Success"}
-
-    # Errors:
-    #   {}
-  ```
-
-  ```mermaid
-    flowchart LR
-        1(start)-->2(wrap_one);
-        subgraph wrap action;
-        2(wrap_one)-->|success track|3(step_one);
-        3(step_one)-->|success track|4(step_two);
-        4(step_two)-->|success track|5(finish success);
-        end;
-        5(finish success)-->|success track|6(finish success)
-  ```
-
-</p>
-</details>
-
-***
-
-### on_success:
-The same as for [step](https://github.com/differencialx/decouplio/blob/master/docs/step.md)
-### on_success: :finish_him
-The same as for [step](https://github.com/differencialx/decouplio/blob/master/docs/step.md)
-### on_success: next success track step
-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
-The same as for [step](https://github.com/differencialx/decouplio/blob/master/docs/step.md)
-### on_failure: next success track step
-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
-The same as for [step](https://github.com/differencialx/decouplio/blob/master/docs/step.md)
-### finish_him: :on_success
-The same as for [step](https://github.com/differencialx/decouplio/blob/master/docs/step.md)
-### finish_him: :on_failure
-The same as for [step](https://github.com/differencialx/decouplio/blob/master/docs/step.md)

data/docs/wrap.rb

@@ -1,137 +0,0 @@
-# Behavior
-
-require_relative '../lib/decouplio'
-
-class SomeAction < Decouplio::Action
-  logic do
-    step :step_one
-
-    wrap :wrap_one do
-      step :step_two
-      fail :fail_one
-    end
-
-    step :step_three
-    fail :fail_two
-  end
-
-  def step_one(param_for_step_one:, **)
-    ctx[:step_one] = param_for_step_one
-  end
-
-  def step_two(param_for_step_two:, **)
-    ctx[:step_two]= param_for_step_two
-  end
-
-  def fail_one(**)
-    ctx[:fail_one] = 'Fail one failure'
-  end
-
-  def step_three(**)
-    ctx[:step_three] = 'Success'
-  end
-
-  def fail_two(**)
-    ctx[:fail_two] = 'Fail two failure'
-  end
-end
-
-success_wrap_success = SomeAction.call(
-  param_for_step_one: true,
-  param_for_step_two: true
-)
-success_wrap_failure = SomeAction.call(
-  param_for_step_one: true,
-  param_for_step_two: false
-)
-failure = SomeAction.call(
-  param_for_step_one: false
-)
-
-puts success_wrap_success # =>
-# Result: success
-
-# Railway Flow:
-#   step_one -> wrap_one -> step_two -> step_three
-
-# Context:
-#   {:param_for_step_one=>true, :param_for_step_two=>true, :step_one=>true, :step_two=>true, :step_three=>"Success"}
-
-# Errors:
-#   {}
-
-
-puts success_wrap_failure # =>
-# Result: failure
-
-# Railway Flow:
-#   step_one -> wrap_one -> step_two -> fail_one -> fail_two
-
-# Context:
-#   {:param_for_step_one=>true, :param_for_step_two=>false, :step_one=>true, :step_two=>false, :fail_one=>"Fail one failure", :fail_two=>"Fail two failure"}
-
-# Errors:
-#   {}
-
-puts failure # =>
-# Result: failure
-
-# Railway Flow:
-#   step_one -> fail_two
-
-# Context:
-#   {:param_for_step_one=>false, :step_one=>false, :fail_two=>"Fail two failure"}
-
-# Errors:
-#   {}
-
-
-
-
-# klass: some class, method: method to call on class
-class WrapperClass
-  def self.some_wrapper_method(&block)
-    if block_given?
-      puts 'Before wrapper action execution'
-      block.call
-      puts 'After wrapper action execution'
-    end
-  end
-end
-
-class SomeActionWrapKlassMethod < Decouplio::Action
-  logic do
-    wrap :wrap_one, klass: WrapperClass, method: :some_wrapper_method do
-      step :step_one
-      step :step_two
-    end
-  end
-
-  def step_one(**)
-    puts 'Step one'
-    ctx[:step_one] = 'Success'
-  end
-
-  def step_two(**)
-    puts 'Step two'
-    ctx[:step_two] = 'Success'
-  end
-end
-
-action = SomeActionWrapKlassMethod.call # =>
-# Before wrapper action execution
-# Step one
-# Step two
-# After wrapper action execution
-
-puts action # =>
-# Result: success
-
-# Railway Flow:
-#   wrap_one -> step_one -> step_two
-
-# Context:
-#   {:step_one=>"Success", :step_two=>"Success"}
-
-# Errors:
-#   {}

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

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Decouplio
-  module Const
-    module Validations
-      module Deny
-        FIRST_STEP = '"deny" can not be the first step'
-      end
-    end
-  end
-end

data/lib/decouplio/steps/deny.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base_step'
-
-module Decouplio
-  module Steps
-    class Deny < Decouplio::Steps::BaseStep
-      def initialize(name:, deny_class:, deny_options:)
-        super()
-        @name = name
-        @deny_class = deny_class
-        @deny_options = deny_options
-      end
-
-      def process(instance:)
-        instance.append_railway_flow(@name)
-        @deny_class.call(
-          ctx: instance.ctx,
-          error_store: instance.error_store,
-          **@deny_options
-        )
-        resolve(instance: instance)
-      end
-
-      def resolve(instance:)
-        instance.fail_action
-        Decouplio::Const::Results::FAIL
-      end
-    end
-  end
-end