decouplio 1.0.0alpha3 → 1.0.0alpha7

data/lib/decouplio/steps/service_fail.rb

@@ -6,10 +6,11 @@ require_relative 'shared/fail_resolver'
 module Decouplio
   module Steps
     class ServiceFail < Decouplio::Steps::BaseStep
-      def initialize(name:, service:, on_success_type:, on_failure_type:)
+      def initialize(name:, service:, args:, on_success_type:, on_failure_type:)
         super()
         @name = name
         @service = service
+        @args = args
         @on_success_type = on_success_type
         @on_failure_type = on_failure_type
       end
@@ -18,7 +19,8 @@ module Decouplio
         instance.append_railway_flow(@name)
         result = @service.call(
           ctx: instance.ctx,
-          error_store: instance.error_store
+          error_store: instance.error_store,
+          **@args
         )
 
         resolve(result: result, instance: instance)

data/lib/decouplio/steps/service_pass.rb

@@ -5,10 +5,11 @@ require_relative 'base_step'
 module Decouplio
   module Steps
     class ServicePass < Decouplio::Steps::BaseStep
-      def initialize(name:, service:, on_success_type:, on_failure_type:)
+      def initialize(name:, service:, args:, on_success_type:, on_failure_type:)
         super()
         @name = name
         @service = service
+        @args = args
         @on_success_type = on_success_type
         @on_failure_type = on_failure_type
       end
@@ -17,7 +18,8 @@ module Decouplio
         instance.append_railway_flow(@name)
         @service.call(
           ctx: instance.ctx,
-          error_store: instance.error_store
+          error_store: instance.error_store,
+          **@args
         )
 
         resolve(instance: instance)

data/lib/decouplio/steps/service_step.rb

@@ -6,10 +6,11 @@ require_relative 'shared/step_resolver'
 module Decouplio
   module Steps
     class ServiceStep < Decouplio::Steps::BaseStep
-      def initialize(name:, service:, on_success_type:, on_failure_type:)
+      def initialize(name:, service:, args:, on_success_type:, on_failure_type:)
         super()
         @name = name
         @service = service
+        @args = args
         @on_success_type = on_success_type
         @on_failure_type = on_failure_type
       end
@@ -18,7 +19,8 @@ module Decouplio
         instance.append_railway_flow(@name)
         result = @service.call(
           ctx: instance.ctx,
-          error_store: instance.error_store
+          error_store: instance.error_store,
+          **@args
         )
 
         resolve(result: result, instance: instance)

data/lib/decouplio/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Decouplio
-  VERSION = '1.0.0alpha3'
+  VERSION = '1.0.0alpha7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: decouplio
 version: !ruby/object:Gem::Version
-  version: 1.0.0alpha3
+  version: 1.0.0alpha7
 platform: ruby
 authors:
 - Alex Bal
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-09 00:00:00.000000000 Z
+date: 2022-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,16 +56,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -126,42 +126,15 @@ files:
 - bin/setup
 - decouplio.gemspec
 - docker-compose.yml
-- docs/_config.yml
-- docs/aide.rb
-- docs/benchmarks.md
-- docs/context.md
-- docs/context.rb
-- docs/doby.rb
-- docs/doby_aide.md
-- docs/error_store.md
-- docs/error_store.rb
-- docs/fail.md
-- docs/fail.rb
-- docs/index.md
-- docs/inner_action.md
-- docs/inner_action.rb
-- docs/logic_block.md
-- docs/octo.md
-- docs/octo.rb
-- docs/pass.md
-- docs/pass.rb
-- docs/quick_start.md
-- docs/quick_start.rb
-- docs/resq.md
-- docs/resq.rb
-- docs/step.md
-- docs/step.rb
-- docs/step_as_a_service.md
-- docs/step_as_a_service.rb
-- docs/wrap.md
-- docs/wrap.rb
 - lib/decouplio.rb
 - lib/decouplio/action.rb
 - lib/decouplio/composer.rb
 - lib/decouplio/const/colors.rb
 - lib/decouplio/const/doby_aide_options.rb
+- lib/decouplio/const/error_messages.rb
 - lib/decouplio/const/reserved_methods.rb
 - lib/decouplio/const/results.rb
+- lib/decouplio/const/step_options.rb
 - lib/decouplio/const/types.rb
 - lib/decouplio/const/validations/action_option_class.rb
 - lib/decouplio/const/validations/aide.rb
@@ -184,6 +157,7 @@ files:
 - lib/decouplio/errors/doby_controversial_keys_error.rb
 - lib/decouplio/errors/doby_finish_him_error.rb
 - lib/decouplio/errors/error_store_error.rb
+- lib/decouplio/errors/execution_error.rb
 - lib/decouplio/errors/extra_key_for_fail_error.rb
 - lib/decouplio/errors/extra_key_for_octo_error.rb
 - lib/decouplio/errors/extra_key_for_pass_error.rb
@@ -214,6 +188,7 @@ files:
 - lib/decouplio/errors/step_is_not_defined_for_aide_error.rb
 - lib/decouplio/errors/step_is_not_defined_for_doby_error.rb
 - lib/decouplio/errors/step_is_not_defined_for_fail_error.rb
+- lib/decouplio/errors/step_is_not_defined_for_pass_error.rb
 - lib/decouplio/errors/step_is_not_defined_for_step_error.rb
 - lib/decouplio/errors/step_is_not_defined_for_wrap_error.rb
 - lib/decouplio/errors/step_name_error.rb
@@ -252,13 +227,13 @@ files:
 - lib/decouplio/steps/wrap.rb
 - lib/decouplio/validators/condition.rb
 - lib/decouplio/version.rb
-homepage: https://github.com/differencialx/decouplio
+homepage: https://differencialx.github.io/decouplio.github.io/
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/differencialx/decouplio
-  source_code_uri: https://github.com/differencialx/decouplio
-  changelog_uri: https://github.com/differencialx/decouplio/CHANGELOG.md
+  homepage_uri: https://differencialx.github.io/decouplio.github.io/
+  source_code_uri: https://github.com/differencialx/decouplio/blob/master/docs
+  changelog_uri: https://github.com/differencialx/decouplio/blob/master/docs/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:

data/docs/_config.yml

@@ -1 +0,0 @@
-theme: jekyll-theme-cayman

data/docs/aide.rb

@@ -1,59 +0,0 @@
-require_relative '../lib/decouplio'
-
-class SemanticAide
-  def self.call(ctx:, error_store:, semantic:, error_message:)
-    ctx[:semantic] = semantic
-    error_store.add_error(semantic, error_message)
-  end
-end
-
-class SomeAction < Decouplio::Action
-  logic do
-    step :step_one
-    aide SemanticAide, semantic: :bad_request, error_message: 'Bad request'
-    step :step_two
-  end
-
-  def step_one(step_one_param:, **)
-    ctx[:step_one] = step_one_param
-  end
-
-  def step_two(**)
-    ctx[:step_two] = 'Success'
-  end
-
-  def fail_one(**)
-    ctx[:fail_one] = 'Failure'
-  end
-end
-
-success_action = SomeAction.call(step_one_param: true)
-failure_action = SomeAction.call(step_one_param: false)
-
-success_action # =>
-# Result: success
-
-# Railway Flow:
-#   step_one -> step_two
-
-# Context:
-#   :step_one_param => true
-#   :step_one => true
-#   :step_two => "Success"
-
-# Errors:
-#   None
-
-failure_action # =>
-# Result: failure
-
-# Railway Flow:
-#   step_one -> SemanticAide
-
-# Context:
-#   :step_one_param => false
-#   :step_one => false
-#   :semantic => :bad_request
-
-# Errors:
-#   :bad_request => ["Bad request"]

data/docs/benchmarks.md

@@ -1 +0,0 @@
-## Benchmarks

data/docs/context.md

@@ -1,74 +0,0 @@
-# Context
-
-Currently context is a simple `Hash` which can be accessed by step methods.
-
-```ruby
-require 'decouplio'
-
-class SomeAction < Decouplio::Action
-  logic do
-    step :step_one
-    step :step_two
-  end
-
-  def step_one(**)
-    ctx[:step_one] = 'Step one ctx value'
-  end
-
-  # step method receives ctx as an argument
-  def step_two(step_one:, **)
-    ctx[:step_two] = step_one
-  end
-end
-
-action = SomeAction.call
-
-action # =>
-# Result: success
-
-# Railway Flow:
-#   step_one -> step_two
-
-# Context:
-#   {:step_one=>"Step one ctx value", :step_two=>"Step one ctx value"}
-
-# Errors:
-#   {}
-```
-
-All key values passed into `call` method will be automatically assigned to action context.
-
-```ruby
-require 'decouplio'
-
-class SomeActionCtx < Decouplio::Action
-  logic do
-    step :step_one
-  end
-
-  def step_one(**)
-    puts ctx
-    ctx[:result] = ctx[:one] + ctx[:two]
-  end
-end
-
-action = SomeActionCtx.call(
-  one: 1,
-  two: 2
-) # =>
-# {:one=>1, :two=>2}
-
-action[:result] # => 3
-
-action # =>
-# Result: success
-
-# Railway Flow:
-#   step_one
-
-# Context:
-#   {:one=>1, :two=>2, :result=>3}
-
-# Errors:
-#   {}
-```

data/docs/context.rb

@@ -1,62 +0,0 @@
-require_relative '../lib/decouplio'
-
-class SomeAction < Decouplio::Action
-  logic do
-    step :step_one
-    step :step_two
-  end
-
-  def step_one(**)
-    ctx[:step_one] = 'Step one ctx value'
-  end
-
-  # step method receives ctx as an argument
-  def step_two(step_one:, **)
-    ctx[:step_two] = step_one
-  end
-end
-
-action = SomeAction.call
-
-puts action # =>
-# Result: success
-
-# Railway Flow:
-#   step_one -> step_two
-
-# Context:
-#   {:step_one=>"Step one ctx value", :step_two=>"Step one ctx value"}
-
-# Errors:
-#   {}
-
-
-class SomeActionCtx < Decouplio::Action
-  logic do
-    step :step_one
-  end
-
-  def step_one(**)
-    puts ctx
-    ctx[:result] = ctx[:one] + ctx[:two]
-  end
-end
-
-action = SomeActionCtx.call(
-  one: 1,
-  two: 2
-)
-
-action[:result] # => 3
-
-puts action # =>
-# Result: success
-
-# Railway Flow:
-#   step_one
-
-# Context:
-#   {:one=>1, :two=>2, :result=>3}
-
-# Errors:
-#   {}

data/docs/doby.rb

@@ -1,38 +0,0 @@
-require_relative '../lib/decouplio'
-
-class AssignDoby
-  def self.call(ctx:, to:, from: nil, value: nil, **)
-    raise 'from/value is empty' unless from || value
-
-    ctx[to] = value || ctx[from]
-  end
-end
-
-class SomeAction < Decouplio::Action
-  logic do
-    step :user
-    doby AssignDoby, to: :current_user, from: :user
-  end
-
-  def user(id:, **)
-    ctx[:user] = "User with id: #{id}"
-  end
-end
-
-action = SomeAction.call(id: 1)
-
-puts action[:user] # => "User with id: 1"
-
-puts action[:current_user] # => "User with id: 1"
-
-puts action # =>
-# Result: success
-
-# Railway Flow:
-#   user -> AssignDoby
-
-# Context:
-#   {:id=>1, :user=>"User with id: 1", :current_user=>"User with id: 1"}
-
-# Errors:
-#   {}

data/docs/doby_aide.md

@@ -1,208 +0,0 @@
-# Doby/Aide
-
-Steps which make configurable manipulations with action context.
-
-
-## Signature
-
-```ruby
-doby(class_constant, **options)
-aide(class_constant, **options)
-```
-
-## Behavior
-
-### Doby
-
-- `doby` behaves similar to `step`, depending on `.call` method returning value(truthy or falsy) the execution will be moved to `success or failure` track accordingly.
-- `doby` doesn't have `on_success, on_failure, if, unless, finish_him` options.
-- All options passed after class constant will be passed as kwargs for `.call` method.
-
-### Aide
-- `aide` behaves similar to `fail`, no matter which value will be returned by `.call` method, it moves to `failure` track.
-- `aide` doesn't have `on_success, on_failure, if, unless, finish_him` options.
-- All options passed after class constant will be passed as kwargs for `.call` method.
-
-
-## How to use?
-
-Create the ruby class which has `.call` class method.
-
-`.call` method signature:
-```ruby
-# :ctx - it's a ctx from Decouplio::Action
-# :error_store - it's an error_store from Decouplio::Action
-#                you can call #add_error method on it.
-# ** - kwargs passed from action.
-def self.call(ctx:, error_store:, **)
-end
-```
-
-```ruby
-class AssignDoby
-  def self.call(ctx:, to:, from: nil, value: nil, **)
-    raise 'from/value is empty' unless from || value
-
-    ctx[to] = value || ctx[from]
-  end
-end
-
-# OR
-
-class SemanticAide
-  def self.call(ctx:, error_store:, semantic:, error_message:)
-    ctx[:semantic] = semantic
-    error_store.add_error(semantic, error_message)
-  end
-end
-
-# OR
-
-# If you don't need ctx and error_store, you can omit them
-class DummyDoby
-  def self.call(dummy:, **)
-    puts dummy
-  end
-end
-```
-
-`AssignDoby` example.
-```ruby
-require 'decouplio'
-
-class AssignDoby
-  def self.call(ctx:, to:, from: nil, value: nil, **)
-    raise 'from/value is empty' unless from || value
-
-    ctx[to] = value || ctx[from]
-  end
-end
-
-class SomeAction < Decouplio::Action
-  logic do
-    step :user
-    doby AssignDoby, to: :current_user, from: :user
-  end
-
-  def user(id:, **)
-    ctx[:user] = "User with id: #{id}"
-  end
-end
-
-action = SomeAction.call(id: 1)
-
-action[:user] # => "User with id: 1"
-
-action[:current_user] # => "User with id: 1"
-
-action # =>
-# Result: success
-
-# Railway Flow:
-#   user -> AssignDoby
-
-# Context:
-#   {:id=>1, :user=>"User with id: 1", :current_user=>"User with id: 1"}
-
-# Errors:
-#   {}
-```
-`SemanticAide` example.
-```ruby
-require 'decouplio'
-
-class SemanticAide
-  def self.call(ctx:, error_store:, semantic:, error_message:)
-    ctx[:semantic] = semantic
-    error_store.add_error(semantic, error_message)
-  end
-end
-
-class SomeAction < Decouplio::Action
-  logic do
-    step :step_one
-    aide SemanticAide, semantic: :bad_request, error_message: 'Bad request'
-    step :step_two
-  end
-
-  def step_one(step_one_param:, **)
-    ctx[:step_one] = step_one_param
-  end
-
-  def step_two(**)
-    ctx[:step_two] = 'Success'
-  end
-
-  def fail_one(**)
-    ctx[:fail_one] = 'Failure'
-  end
-end
-
-success_action = SomeAction.call(step_one_param: true)
-failure_action = SomeAction.call(step_one_param: false)
-
-success_action # =>
-# Result: success
-
-# Railway Flow:
-#   step_one -> step_two
-
-# Context:
-#   :step_one_param => true
-#   :step_one => true
-#   :step_two => "Success"
-
-# Errors:
-#   None
-
-failure_action # =>
-# Result: failure
-
-# Railway Flow:
-#   step_one -> SemanticAide
-
-# Context:
-#   :step_one_param => false
-#   :step_one => false
-#   :semantic => :bad_request
-
-# Errors:
-#   :bad_request => ["Bad request"]
-```
-
-
-## Options
-
-### Doby
-Has the same options and behavior as [step](https://github.com/differencialx/decouplio/blob/master/docs/step.md), just specify them along with doby class options like here:
-```ruby
-# ...
-
-logic do
-  doby AssignDoby,
-       to: :current_user,
-       from: :user,
-       on_success: :finish_him,
-       if: :condition
-end
-
-# ...
-```
-
-### Aide
-Has the same options and behavior as [fail](https://github.com/differencialx/decouplio/blob/master/docs/fail.md), just specify them along with aide class options like here:
-
-```ruby
-# ...
-
-logic do
-  step :step_one
-  aide SemanticAide,
-       semantic: :bad_request,
-       error_message: 'Bad request',
-       on_failure: :PASS,
-       unless: :condition
-end
-
-# ...
-```