decouplio 1.0.0alpha2 → 1.0.0alpha5

data/docs/error_store.md

@@ -1,347 +0,0 @@
-# Error store
-
-It's an object to store errors. By default `Decouplio::DefaultErrorHandler` is used for `Decouplio::Action`
-
-```ruby
-module Decouplio
-  class DefaultErrorHandler
-    attr_reader :errors
-
-    def initialize
-      @errors = {}
-    end
-
-    def add_error(key, message)
-      @errors.store(
-        key,
-        (@errors[key] || []) + [message].flatten
-      )
-    end
-
-    def merge(error_store)
-      @errors = @errors.merge(error_store.errors) do |_key, this_val, other_val|
-        this_val + other_val
-      end
-    end
-  end
-end
-```
-
-## How to use
-Inside step method you can call `#add_error` method
-
-```ruby
-add_error(key, message)
-```
-
-```ruby
-require 'decouplio'
-
-class SomeAction < Decouplio::Action
-  logic do
-    step :step_one
-    fail :fail_one
-  end
-
-  def step_one(**)
-    false
-  end
-
-  def fail_one(**)
-    add_error(:something_went_wrong, 'Something went wrong')
-  end
-end
-
-action = SomeAction.call
-
-action # =>
-# Result: failure
-
-# Railway Flow:
-#   step_one -> fail_one
-
-# Context:
-#   {}
-
-# Errors:
-#   {:something_went_wrong=>["Something went wrong"]}
-
-action.errors # =>
-# {:something_went_wrong=>["Something went wrong"]}
-```
-
-## Behavior
-
- - If error was added, it doesn't mean that action result is `failure`, action can be `success` and have errors, so basically `error store` is just a container for errors. Such behavior was implemented to provide more freedom.
- - Error store for parent an inner action should be the same. It's because different error stores may have different `add_error` method signature and error hash structure.
-
-## Custom error store
-
-If you want to use your own custom error store then you can do it in this way:
-
- - Define our own class with two public methods
-    - `#add_error(<signature you want>)` - method which adds error to `error_store`
-    - `#merge(error_store_to_merge)` - will be used by `Decouplio` to merge errors from inner actions to parent action.
-    - should have `attr_reader :errors`
-
-<details><summary><b>EXAMPLE (CLICK ME)</b></summary>
-<p>
-
-  ```ruby
-    require 'decouplio'
-
-    class CustomErrorStore
-      attr_reader :errors
-
-      def initialize
-        @errors = {}
-      end
-
-      def add_error(key:, message:, namespace: :root)
-        @errors[namespace] ||= {}
-        @errors[namespace].store(
-          key,
-          (@errors[namespace][key] || []) + [message].flatten
-        )
-      end
-
-      def merge(error_store)
-        @errors = deep_merge(@errors, error_store.errors)
-      end
-
-      private
-
-      def deep_merge(this_hash, other_hash)
-        this_hash.merge(other_hash) do |_key, this_val, other_val|
-          if this_val.is_a?(Hash) && other_val.is_a?(Hash)
-            deep_merge(this_val, other_val)
-          else
-            this_val + other_val
-          end
-        end
-      end
-    end
-
-    class SomeActionWithCustomErrorStore < Decouplio::Action
-      error_store_class CustomErrorStore
-
-      logic do
-        step :step_one
-        step :step_two
-      end
-
-      def step_one(**)
-        add_error(
-          key: :under_root,
-          message: 'Error Message One'
-        )
-      end
-
-      def step_two(**)
-        add_error(
-          namespace: :step_two,
-          key: :error_happened,
-          message: 'Error Message Two'
-        )
-      end
-    end
-
-    action = SomeActionWithCustomErrorStore.call
-
-    action  # =>
-    # Result: success
-
-    # Railway Flow:
-    #   step_one -> step_two
-
-    # Context:
-    #   {}
-
-    # Errors:
-      # {:root=>{:under_root=>["Error Message One"]}, :step_two=>{:error_happened=>["Error Message Two"]}}
-
-    action.errors  # =>
-    # {:root=>{:under_root=>["Error Message One"]}, :step_two=>{:error_happened=>["Error Message Two"]}}
-  ```
-
-</p>
-</details>
-
-***
-
-## Custom error store and inner action
-
-### When error store is the same for parent and inner action
-<details><summary><b>EXAMPLE (CLICK ME)</b></summary>
-<p>
-
-  ```ruby
-    require 'decouplio'
-
-    class CustomErrorStore
-      attr_reader :errors
-
-      def initialize
-        @errors = {}
-      end
-
-      def add_error(key:, message:, namespace: :root)
-        @errors[namespace] ||= {}
-        @errors[namespace].store(
-          key,
-          (@errors[namespace][key] || []) + [message].flatten
-        )
-      end
-
-      def merge(error_store)
-        @errors = deep_merge(@errors, error_store.errors)
-      end
-
-      private
-
-      def deep_merge(this_hash, other_hash)
-        this_hash.merge(other_hash) do |_key, this_val, other_val|
-          if this_val.is_a?(Hash) && other_val.is_a?(Hash)
-            deep_merge(this_val, other_val)
-          else
-            this_val + other_val
-          end
-        end
-      end
-    end
-
-    class InnerActionWithCustomErrorStore < Decouplio::Action
-      error_store_class CustomErrorStore
-
-      logic do
-        step :inner_step
-      end
-
-      def inner_step(**)
-        add_error(
-          namespace: :inner,
-          key: :inner_key,
-          message: 'Somebody was told me...'
-        )
-      end
-    end
-
-    class ParentActionWithCustomErrorStore < Decouplio::Action
-      error_store_class CustomErrorStore
-
-      logic do
-        step :step_one, action: InnerActionWithCustomErrorStore
-        step :step_two
-      end
-
-      def step_two(**)
-        add_error(
-          namespace: :parent,
-          key: :error_happened,
-          message: 'Message'
-        )
-      end
-    end
-
-    action = ParentActionWithCustomErrorStore.call
-
-    puts action  # =>
-    # Result: success
-
-    # Railway Flow:
-    #   step_one -> inner_step -> step_two
-
-    # Context:
-    #   {}
-
-    # Errors:
-    #   {:inner=>{:inner_key=>["Somebody was told me..."]}, :parent=>{:error_happened=>["Message"]}}
-
-    puts action.errors  # =>
-    # {:inner=>{:inner_key=>["Somebody was told me..."]}, :parent=>{:error_happened=>["Message"]}}
-
-  ```
-
-</p>
-</details>
-
-***
-
-### When error store is different for parent and inner action
-If inner action error store is different from parent action error store then error will be raised.
-
-<details><summary><b>EXAMPLE (CLICK ME)</b></summary>
-<p>
-
-  ```ruby
-    require 'decouplio'
-
-    class CustomErrorStore
-      attr_reader :errors
-
-      def initialize
-        @errors = {}
-      end
-
-      def add_error(key:, message:, namespace: :root)
-        @errors[namespace] ||= {}
-        @errors[namespace].store(
-          key,
-          (@errors[namespace][key] || []) + [message].flatten
-        )
-      end
-
-      def merge(error_store)
-        @errors = deep_merge(@errors, error_store.errors)
-      end
-
-      private
-
-      def deep_merge(this_hash, other_hash)
-        this_hash.merge(other_hash) do |_key, this_val, other_val|
-          if this_val.is_a?(Hash) && other_val.is_a?(Hash)
-            deep_merge(this_val, other_val)
-          else
-            this_val + other_val
-          end
-        end
-      end
-    end
-
-    class InnerActionWithDefaultErrorStore < Decouplio::Action
-      logic do
-        step :inner_step
-      end
-
-      def inner_step(**)
-        add_error(
-          key: :inner_key,
-          message: 'Somebody was told me...'
-        )
-      end
-    end
-
-    class ParentActionForInnerActionDefaultErrorStore < Decouplio::Action
-      error_store_class CustomErrorStore
-
-      logic do
-        step :step_one, action: InnerActionWithDefaultErrorStore
-        step :step_two
-      end
-
-      def step_two(**)
-        add_error(
-          namespace: :parent,
-          key: :error_happened,
-          message: 'Message'
-        )
-      end
-    end # =>
-    # Error store for action and inner action should be the same. (Decouplio::Errors::ErrorStoreError)
-
-  ```
-
-</p>
-</details>
-
-***

data/docs/error_store.rb

@@ -1,202 +0,0 @@
-require_relative '../lib/decouplio'
-
-# How to use
-class SomeAction < Decouplio::Action
-  logic do
-    step :step_one
-    fail :fail_one
-  end
-
-  def step_one(**)
-    false
-  end
-
-  def fail_one(**)
-    add_error(:something_went_wrong, 'Something went wrong')
-  end
-end
-
-action = SomeAction.call
-
-puts action # =>
-# Result: failure
-
-# Railway Flow:
-#   step_one -> fail_one
-
-# Context:
-#   {}
-
-# Errors:
-#   {:something_went_wrong=>["Something went wrong"]}
-
-puts action.errors # =>
-# {:something_went_wrong=>["Something went wrong"]}
-
-
-
-
-# Custom error store
-class CustomErrorStore
-  attr_reader :errors
-
-  def initialize
-    @errors = {}
-  end
-
-  def add_error(key:, message:, namespace: :root)
-    @errors[namespace] ||= {}
-    @errors[namespace].store(
-      key,
-      (@errors[namespace][key] || []) + [message].flatten
-    )
-  end
-
-  def merge(error_store)
-    @errors = deep_merge(@errors, error_store.errors)
-  end
-
-  private
-
-  def deep_merge(this_hash, other_hash)
-    this_hash.merge(other_hash) do |_key, this_val, other_val|
-      if this_val.is_a?(Hash) && other_val.is_a?(Hash)
-        deep_merge(this_val, other_val)
-      else
-        this_val + other_val
-      end
-    end
-  end
-end
-
-class SomeActionWithCustomErrorStore < Decouplio::Action
-  error_store_class CustomErrorStore
-
-  logic do
-    step :step_one
-    step :step_two
-  end
-
-  def step_one(**)
-    add_error(
-      key: :under_root,
-      message: 'Error Message One'
-    )
-  end
-
-  def step_two(**)
-    add_error(
-      namespace: :step_two,
-      key: :error_happened,
-      message: 'Error Message Two'
-    )
-  end
-end
-
-action = SomeActionWithCustomErrorStore.call
-
-puts action  # =>
-# Result: success
-
-# Railway Flow:
-#   step_one -> step_two
-
-# Context:
-#   {}
-
-# Errors:
-  # {:root=>{:under_root=>["Error Message One"]}, :step_two=>{:error_happened=>["Error Message Two"]}}
-
-puts action.errors  # =>
-# {:root=>{:under_root=>["Error Message One"]}, :step_two=>{:error_happened=>["Error Message Two"]}}
-
-
-
-
-# When error store is the same for parent and inner action
-
-class InnerActionWithCustomErrorStore < Decouplio::Action
-  error_store_class CustomErrorStore
-
-  logic do
-    step :inner_step
-  end
-
-  def inner_step(**)
-    add_error(
-      namespace: :inner,
-      key: :inner_key,
-      message: 'Somebody was told me...'
-    )
-  end
-end
-
-class ParentActionWithCustomErrorStore < Decouplio::Action
-  error_store_class CustomErrorStore
-
-  logic do
-    step :step_one, action: InnerActionWithCustomErrorStore
-    step :step_two
-  end
-
-  def step_two(**)
-    add_error(
-      namespace: :parent,
-      key: :error_happened,
-      message: 'Message'
-    )
-  end
-end
-
-action = ParentActionWithCustomErrorStore.call
-
-puts action  # =>
-# Result: success
-
-# Railway Flow:
-#   step_one -> inner_step -> step_two
-
-# Context:
-#   {}
-
-# Errors:
-#   {:inner=>{:inner_key=>["Somebody was told me..."]}, :parent=>{:error_happened=>["Message"]}}
-
-puts action.errors  # =>
-# {:inner=>{:inner_key=>["Somebody was told me..."]}, :parent=>{:error_happened=>["Message"]}}
-
-
-
-
-# When error store is different for parent and inner action
-
-class InnerActionWithDefaultErrorStore < Decouplio::Action
-  logic do
-    step :inner_step
-  end
-
-  def inner_step(**)
-    add_error(
-      key: :inner_key,
-      message: 'Somebody was told me...'
-    )
-  end
-end
-
-class ParentActionForInnerActionDefaultErrorStore < Decouplio::Action
-  error_store_class CustomErrorStore
-
-  logic do
-    step :step_one, action: InnerActionWithDefaultErrorStore
-    step :step_two
-  end
-
-  def step_two(**)
-    add_error(
-      namespace: :parent,
-      key: :error_happened,
-      message: 'Message'
-    )
-  end
-end # =>
-# Error store for action and inner action should be the same. (Decouplio::Errors::ErrorStoreError)