decouplio 1.0.0alpha → 1.0.0alpha3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afefc75848ee14208adf083e6b83fc8e2427f55632228aa473ea2d3d408b4eb7
-  data.tar.gz: 78d7a9cd4707a737349f2c1d2cfde11ba556f53099ae7d1af2059d212e340fc6
+  metadata.gz: b52142f648d5043e84d6daa6b36026f33d01a6bd9197d5e6f65ac0fb51abac81
+  data.tar.gz: 7825cc21ae535df0c950c7b5eaf34264d37f6fe13f346282bc3a15e88e4e8b8e
 SHA512:
-  metadata.gz: c4e97739d4fd9da01f4d73b8e0c41131c9799e3e538f1acf76d2b7b5784ee6a9929bac2d813c4233ad11f91ad583b8c5af44118287e28c60db176e10b25ee930
-  data.tar.gz: 709c075259f47063a2ea0751ab1bdc6d7ad39d35b57650da5ace8c30c6992300c67229e446f784686f61fc32c64db75c03812dbba8f677487dfb6bd498003684
+  metadata.gz: 395c7ca0d0618abd369307426edba5ada1d4dc002f55ff8c0906205e08924a07ec60b0905fd2031860a7b32effbe88265139faf397972ea1359448b5c1572ebb
+  data.tar.gz: 0fa93d697696700e24758eb3b774d183b1e24486a5846273c24d6ff7dc3684876b587e0afb90165bdb3f8bde8deeee938fc78d90361b4d0d2c193eeec7870ac0

data/.rubocop.yml

@@ -104,3 +104,7 @@ RSpec/MultipleMemoizedHelpers:
 Naming/PredicateName:
   Exclude:
     - lib/decouplio/step.rb
+
+Naming/MethodParameterName:
+  Exclude:
+  - spec/support/cases/**/*

data/README.md

@@ -14,16 +14,40 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it by yourself:
 
     $ gem install decouplio
 
-# [>>>>>>>DOCS HERE<<<<<<<](https://github.com/differencialx/decouplio/blob/master/docs/index.md)
+## Currently decouplio is in alpha testing, more features will come soon.
+
+### Compatibility
+  Ruby:
+ - 2.7
+ - 3.0
+
+ ### Docs
+
+- [Quick start](https://github.com/differencialx/decouplio/blob/master/docs/quick_start.md)
+- [Logic block](https://github.com/differencialx/decouplio/blob/master/docs/logic_block.md)
+  - [Context](https://github.com/differencialx/decouplio/blob/master/docs/context.md)
+  - [Step](https://github.com/differencialx/decouplio/blob/master/docs/step.md)
+  - [Fail](https://github.com/differencialx/decouplio/blob/master/docs/fail.md)
+  - [Pass](https://github.com/differencialx/decouplio/blob/master/docs/pass.md)
+  - [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)
+  - [Inner action](https://github.com/differencialx/decouplio/blob/master/docs/inner_action.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)
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/differencialx/decouplio.
 
+More detailed description for contribution process will be added later.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/benchmarks/Gemfile

@@ -3,7 +3,8 @@
 source 'https://rubygems.org'
 
 gem 'active_interaction', '~> 4.1'
-gem 'decouplio', path: '../'
+gem 'benchmark-ips'
+gem 'decouplio'
 gem 'interactor', '~> 3.0'
 gem 'mutations'
 gem 'pry-byebug'

data/benchmarks/multi_step_benchmark.rb

@@ -0,0 +1,336 @@
+# frozen_string_literal: true
+
+require 'active_interaction'
+require 'interactor'
+require 'mutations'
+require 'trailblazer'
+require 'decouplio'
+require 'benchmark/ips'
+
+class RegularServiceTest
+  attr_accessor :ctx, :param1
+
+  def self.call(param1:)
+    new(param1: param1).call
+  end
+
+  def initialize(param1:)
+    @param1 = param1
+    @ctx = {}
+  end
+
+  def call
+    step_one
+    step_two
+    step_three
+    step_four
+    step_five
+    step_six
+    step_seven
+    step_eight
+    step_nine
+    self
+  end
+
+  def step_one
+    ctx[:step_one] = param1
+  end
+
+  def step_two
+    ctx[:step_two] = ctx[:step_one]
+  end
+
+  def step_three
+    ctx[:step_three] = ctx[:step_two]
+  end
+
+  def step_four
+    ctx[:step_four] = ctx[:step_three]
+  end
+
+  def step_five
+    ctx[:step_five] = ctx[:step_four]
+  end
+
+  def step_six
+    ctx[:step_six] = ctx[:step_five]
+  end
+
+  def step_seven
+    ctx[:step_seven] = ctx[:step_six]
+  end
+
+  def step_eight
+    ctx[:step_eight] = ctx[:step_seven]
+  end
+
+  def step_nine
+    ctx[:step_nine] = ctx[:step_eight]
+  end
+end
+
+class DecouplioTestSeveralSteps < Decouplio::Action
+  logic do
+    step :step_one
+    step :step_two
+    step :step_three
+    step :step_four
+    step :step_five
+    step :step_six
+    step :step_seven
+    step :step_eight
+    step :step_nine
+  end
+
+  def step_one(param1:, **)
+    ctx[:step_one] = param1
+  end
+
+  def step_two(step_one:, **)
+    ctx[:step_two] = step_one
+  end
+
+  def step_three(step_two:, **)
+    ctx[:step_three] = step_two
+  end
+
+  def step_four(step_three:, **)
+    ctx[:step_four] = step_three
+  end
+
+  def step_five(step_four:, **)
+    ctx[:step_five] = step_four
+  end
+
+  def step_six(step_five:, **)
+    ctx[:step_six] = step_five
+  end
+
+  def step_seven(step_six:, **)
+    ctx[:step_seven] = step_six
+  end
+
+  def step_eight(step_seven:, **)
+    ctx[:step_eight] = step_seven
+  end
+
+  def step_nine(step_eight:, **)
+    ctx[:step_nine] = step_eight
+  end
+end
+
+class StepOne
+  include Interactor
+
+  def call
+    context.step_one = context.param1
+  end
+end
+
+class StepTwo
+  include Interactor
+
+  def call
+    context.step_two = context.step_one
+  end
+end
+
+class StepThree
+  include Interactor
+
+  def call
+    context.step_three = context.step_two
+  end
+end
+
+class StepFour
+  include Interactor
+
+  def call
+    context.step_four = context.step_three
+  end
+end
+
+class StepFive
+  include Interactor
+
+  def call
+    context.step_five = context.step_four
+  end
+end
+
+class StepSix
+  include Interactor
+
+  def call
+    context.step_six = context.step_five
+  end
+end
+
+class StepSeven
+  include Interactor
+
+  def call
+    context.step_seven = context.step_six
+  end
+end
+
+class StepEight
+  include Interactor
+
+  def call
+    context.step_eight = context.step_seven
+  end
+end
+
+class StepNine
+  include Interactor
+
+  def call
+    context.step_nine = context.step_eight
+  end
+end
+
+class InteractorTestOrganizer
+  include Interactor::Organizer
+
+  organize StepOne,
+           StepTwo,
+           StepThree,
+           StepFour,
+           StepFive,
+           StepSix,
+           StepSeven,
+           StepEight,
+           StepNine
+end
+
+class TrailblazerTestSeveralSteps < Trailblazer::Activity::Railway
+  step :step_one
+  step :step_two
+  step :step_three
+  step :step_four
+  step :step_five
+  step :step_six
+  step :step_seven
+  step :step_eight
+  step :step_nine
+
+  def step_one(ctx, param1:, **)
+    ctx[:step_one] = param1
+  end
+
+  def step_two(ctx, step_one:, **)
+    ctx[:step_two] = step_one
+  end
+
+  def step_three(ctx, step_two:, **)
+    ctx[:step_three] = step_two
+  end
+
+  def step_four(ctx, step_three:, **)
+    ctx[:step_four] = step_three
+  end
+
+  def step_five(ctx, step_four:, **)
+    ctx[:step_five] = step_four
+  end
+
+  def step_six(ctx, step_five:, **)
+    ctx[:step_six] = step_five
+  end
+
+  def step_seven(ctx, step_six:, **)
+    ctx[:step_seven] = step_six
+  end
+
+  def step_eight(ctx, step_seven:, **)
+    ctx[:step_eight] = step_seven
+  end
+
+  def step_nine(ctx, step_eight:, **)
+    ctx[:step_nine] = step_eight
+  end
+end
+
+class DecouplioStepOne
+  def self.call(ctx:, **)
+    ctx[:step_one] = ctx[:param1]
+  end
+end
+
+class DecouplioStepTwo
+  def self.call(ctx:, **)
+    ctx[:step_two] = ctx[:step_one]
+  end
+end
+
+class DecouplioStepThree
+  def self.call(ctx:, **)
+    ctx[:step_three] = ctx[:step_two]
+  end
+end
+
+class DecouplioStepFour
+  def self.call(ctx:, **)
+    ctx[:step_four] = ctx[:step_three]
+  end
+end
+
+class DecouplioStepFive
+  def self.call(ctx:, **)
+    ctx[:step_five] = ctx[:step_four]
+  end
+end
+
+class DecouplioStepSix
+  def self.call(ctx:, **)
+    ctx[:step_six] = ctx[:step_five]
+  end
+end
+
+class DecouplioStepSeven
+  def self.call(ctx:, **)
+    ctx[:step_seven] = ctx[:step_six]
+  end
+end
+
+class DecouplioStepEight
+  def self.call(ctx:, **)
+    ctx[:step_eight] = ctx[:step_seven]
+  end
+end
+
+class DecouplioStepNine
+  def self.call(ctx:, **)
+    ctx[:step_nine] = ctx[:step_eight]
+  end
+end
+
+class DecouplioServiceStepsTest < Decouplio::Action
+  logic do
+    step DecouplioStepOne
+    step DecouplioStepTwo
+    step DecouplioStepThree
+    step DecouplioStepFour
+    step DecouplioStepFive
+    step DecouplioStepSix
+    step DecouplioStepSeven
+    step DecouplioStepEight
+    step DecouplioStepNine
+  end
+end
+
+iteration_count = 100_00
+
+Benchmark.ips do |x|
+  x.report('RegularService') { iteration_count.times { RegularServiceTest.call(param1: 'param1') } }
+  x.report('Decouplio several steps') { iteration_count.times { DecouplioTestSeveralSteps.call(param1: 'param1') } }
+  x.report('Decouplio service steps') { iteration_count.times { DecouplioServiceStepsTest.call(param1: 'param1') } }
+  x.report('Trailblazer several steps') { iteration_count.times { TrailblazerTestSeveralSteps.call(param1: 'param1') } }
+  x.report('Interactor several interactions with organizer') do
+    iteration_count.times { InteractorTestOrganizer.call(param1: 'param1') }
+  end
+
+  x.compare!
+end

data/benchmarks/single_step_benchmark.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require 'active_interaction'
+require 'interactor'
+require 'mutations'
+require 'trailblazer'
+require 'decouplio'
+require 'benchmark/ips'
+
+class MutationTest < Mutations::Command
+  optional do
+    string :param1
+  end
+
+  def execute
+    @context = {}
+    @context[:step_one] = param1
+    @context[:step_two] = @context[:step_one]
+    @context[:step_three] = @context[:step_two]
+    @context[:step_four] = @context[:step_three]
+    @context[:step_five] = @context[:step_four]
+    @context[:step_six] = @context[:step_five]
+    @context[:step_seven] = @context[:step_six]
+    @context[:step_eight] = @context[:step_seven]
+    @context[:step_nine] = @context[:step_eight]
+
+    @context
+  end
+end
+
+class ActiveInteractionTest < ActiveInteraction::Base
+  string :param1
+
+  def execute
+    @context = {}
+    @context[:step_one] = param1
+    @context[:step_two] = @context[:step_one]
+    @context[:step_three] = @context[:step_two]
+    @context[:step_four] = @context[:step_three]
+    @context[:step_five] = @context[:step_four]
+    @context[:step_six] = @context[:step_five]
+    @context[:step_seven] = @context[:step_six]
+    @context[:step_eight] = @context[:step_seven]
+    @context[:step_nine] = @context[:step_eight]
+
+    @context
+  end
+end
+
+class DecouplioTestOneStep < Decouplio::Action
+  logic do
+    step :step_one
+  end
+
+  def step_one(param1:, **)
+    ctx[:step_one] = param1
+    ctx[:step_two] = ctx[:step_one]
+    ctx[:step_three] = ctx[:step_two]
+    ctx[:step_four] = ctx[:step_three]
+    ctx[:step_five] = ctx[:step_four]
+    ctx[:step_six] = ctx[:step_five]
+    ctx[:step_seven] = ctx[:step_six]
+    ctx[:step_eight] = ctx[:step_seven]
+    ctx[:step_nine] = ctx[:step_eight]
+  end
+end
+
+class InteractorWithoutOrganizer
+  include Interactor
+
+  def call
+    context.step_one = context.param1
+    context.step_two = context.step_one
+    context.step_three = context.step_two
+    context.step_four = context.step_three
+    context.step_five = context.step_four
+    context.step_six = context.step_five
+    context.step_seven = context.step_six
+    context.step_eight = context.step_seven
+    context.step_nine = context.step_eight
+  end
+end
+
+class RegularServiceTest
+  attr_accessor :ctx, :param1
+
+  def self.call(param1:)
+    new(param1: param1).call
+  end
+
+  def initialize(param1:)
+    @param1 = param1
+    @ctx = {}
+  end
+
+  def call
+    ctx[:step_one] = param1
+    ctx[:step_two] = ctx[:step_one]
+    ctx[:step_three] = ctx[:step_two]
+    ctx[:step_four] = ctx[:step_three]
+    ctx[:step_five] = ctx[:step_four]
+    ctx[:step_six] = ctx[:step_five]
+    ctx[:step_seven] = ctx[:step_six]
+    ctx[:step_eight] = ctx[:step_seven]
+    ctx[:step_nine] = ctx[:step_eight]
+  end
+end
+
+class TrailblazerTestOneStep < Trailblazer::Activity::Railway
+  step :step_one
+
+  def step_one(ctx, param1:, **)
+    ctx[:step_one] = param1
+    ctx[:step_two] = ctx[:step_one]
+    ctx[:step_three] = ctx[:step_two]
+    ctx[:step_four] = ctx[:step_three]
+    ctx[:step_five] = ctx[:step_four]
+    ctx[:step_six] = ctx[:step_five]
+    ctx[:step_seven] = ctx[:step_six]
+    ctx[:step_eight] = ctx[:step_seven]
+    ctx[:step_nine] = ctx[:step_eight]
+  end
+end
+
+class ServiceAsStep
+  def self.call(ctx:, **)
+    ctx[:step_one] = ctx[:param1]
+    ctx[:step_two] = ctx[:step_one]
+    ctx[:step_three] = ctx[:step_two]
+    ctx[:step_four] = ctx[:step_three]
+    ctx[:step_five] = ctx[:step_four]
+    ctx[:step_six] = ctx[:step_five]
+    ctx[:step_seven] = ctx[:step_six]
+    ctx[:step_eight] = ctx[:step_seven]
+    ctx[:step_nine] = ctx[:step_eight]
+  end
+end
+
+class DecouplioTestOneStepAsService < Decouplio::Action
+  logic do
+    step ServiceAsStep
+  end
+end
+
+iteration_count = 100_000
+
+Benchmark.ips do |x|
+  x.report('Mutation') { iteration_count.times { MutationTest.run(param1: 'param1') } }
+  x.report('ActiveInteraction') { iteration_count.times { ActiveInteractionTest.run(param1: 'param1') } }
+  x.report('Trailblazer one step') { iteration_count.times { TrailblazerTestOneStep.call(param1: 'param1') } }
+  x.report('Interactor one interactor') { iteration_count.times { InteractorWithoutOrganizer.call(param1: 'param1') } }
+  x.report('RegularService') { iteration_count.times { RegularServiceTest.call(param1: 'param1') } }
+  x.report('Decouplio one step') { iteration_count.times { DecouplioTestOneStep.call(param1: 'param1') } }
+  x.report('Decouplio one step as service') do
+    iteration_count.times { DecouplioTestOneStepAsService.call(param1: 'param1') }
+  end
+
+  x.compare!
+end

data/decouplio.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Gem for business logic encapsulation'
   spec.description   = "Decouplio is a zero dependency, thread safe and framework agnostic gem designed to encapsulate application business logic. It's reverse engineered through TDD and inspired by such frameworks and gems like Trailblazer, Interactor."
-  spec.homepage      = 'http://nohomepage.com'
+  spec.homepage      = 'https://github.com/differencialx/decouplio'
   spec.license       = 'MIT'
 
   if spec.respond_to?(:metadata)

data/docker-compose.yml

@@ -1,11 +1,22 @@
 version: "3.7"
 
 services:
-  benchmark:
+  benchmark_single_step:
     build:
       dockerfile: benchmarks/Dockerfile
       context: .
-    command: "ruby benchmarks.rb"
+    command: "ruby single_step_benchmark.rb"
+    deploy:
+      resources:
+        limits:
+          cpus: '1'
+          memory: 400M
+
+  benchmark_multi_step:
+    build:
+      dockerfile: benchmarks/Dockerfile
+      context: .
+    command: "ruby multi_step_benchmark.rb"
     deploy:
       resources:
         limits:

data/docs/aide.rb

@@ -0,0 +1,59 @@
+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/doby.rb

@@ -1,7 +1,7 @@
 require_relative '../lib/decouplio'
 
 class AssignDoby
-  def self.call(ctx:, to:, from: nil, value: nil)
+  def self.call(ctx:, to:, from: nil, value: nil, **)
     raise 'from/value is empty' unless from || value
 
     ctx[to] = value || ctx[from]