decouplio 1.0.0alpha1 → 1.0.0alpha4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 455ba12276135c618f5d53a9ff53bf8d3c7ec8074e387ea4790f2307e344c4ec
-  data.tar.gz: 126488804cc9391fdb0fe3f9a0d2ac4060fa42bbe1d733af64bec5681e9f890d
+  metadata.gz: 837f903aec27c7a95ab61c92f4072e040fa4c2dfc74ebcafe0f740428b3cce59
+  data.tar.gz: faeef52b5bc5f8f1abdd419c13cd7871576c86a23e9d5d00c8aa9ab12a150b05
 SHA512:
-  metadata.gz: '00912905816c9e9393e907185347ddd3d9fb2de753a2fa3d7aeaae704ef8d93e26ff5f3ae62a7589384921717b9d764af2e2502b7c43866fb503f63837079999'
-  data.tar.gz: 50d1d117ee1ec34f94f750c1f2d1aad73f41127e8585bd01ee32209b361d067b6fa054b242878e18bfa01682344388badb386dc6a39883a1957516ccfc4a202f
+  metadata.gz: 5df71fc94709fc03625e36281d5458043616200153deee80fb5e2013900d85f8412a0adb30ce1516a90633e4ecef8aa9ff37d7ff5b7cdfc1aca1b2179aee7e0c
+  data.tar.gz: b39a6be930ed5ce6adf0257537fd5b99392259d889fc236457ed4d9b6f5e69a868648cf2a945f064be25d6978d8ad158001554d0b24da2e32cd92c1fe39a217c

data/.circleci/config.yml

@@ -3,7 +3,7 @@ version: 2.1
 executors:
   test_executor:
     docker:
-      - image: circleci/ruby:${RUBY_VERSION}
+      - image: cimg/ruby:${RUBY_VERSION}
     working_directory: ~/decouplio
 
 jobs:
@@ -51,3 +51,13 @@ workflows:
           name: 'ruby 3.0.3'
           ruby_version: 3.0.3
           bundler_version: 2.2.32
+      # TODO: Currently rspec-mocks has some issue, or maybe decouplio has an issue
+      # needs to be investigated
+      # 3 specs are failing
+      # rspec ./spec/resq_spec.rb:174
+      # rspec ./spec/resq_spec.rb:286
+      # rspec ./spec/resq_spec.rb:398
+      # - build:
+      #     name: 'ruby 3.1.2'
+      #     ruby_version: 3.1.2
+      #     bundler_version: 2.2.32

data/.rubocop.yml

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

data/README.md

@@ -14,15 +14,24 @@ 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
+
+### [Documentation is HERE](https://differencialx.github.io/decouplio.github.io/)
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/differencialx/decouplio.
+Bug reports and pull requests are welcome on GitHub at https://github.com/differencialx/decouplio/issues.
+
+More detailed description for contribution process will be added later.
 
 ## License
 

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,13 +12,13 @@ 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      = 'https://github.com/differencialx/decouplio'
+  spec.homepage      = 'https://github.com/differencialx/decouplio/blob/master/docs'
   spec.license       = 'MIT'
 
   if spec.respond_to?(:metadata)
     spec.metadata['homepage_uri'] = spec.homepage
-    spec.metadata['source_code_uri'] = 'https://github.com/differencialx/decouplio'
-    spec.metadata['changelog_uri'] = 'https://github.com/differencialx/decouplio/CHANGELOG.md'
+    spec.metadata['source_code_uri'] = 'https://github.com/differencialx/decouplio/blob/master/docs'
+    spec.metadata['changelog_uri'] = 'https://github.com/differencialx/decouplio/blob/master/docs/CHANGELOG.md'
   else
     raise 'RubyGems 2.0 or newer is required to protect against ' \
       'public gem pushes.'
@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 2'
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake', '>= 12.3.2'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec', '3.10'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-rspec'
 end

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/lib/decouplio/action.rb

@@ -7,15 +7,19 @@ 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 'errors/execution_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 +47,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 +63,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
 
@@ -80,6 +100,17 @@ module Decouplio
         instance
       end
 
+      def call!(**params)
+        instance = call(**params)
+        if instance.failure?
+          raise Decouplio::Errors::ExecutionError.new(
+            action: instance
+          )
+        else
+          instance
+        end
+      end
+
       private
 
       def inherited(child_class)