decouplio 1.0.0alpha1 → 1.0.0alpha4

data/benchmarks/benchmarks.rb

@@ -1,527 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_interaction'
-require 'interactor'
-require 'mutations'
-require 'trailblazer'
-require_relative '../lib/decouplio'
-require 'pry'
-require 'benchmark'
-require 'ruby-prof'
-
-class MutationTest < Mutations::Command
-  required do
-    string :param1
-  end
-
-  def execute
-    @param1 = 'param1'
-    @context = {}
-    step_one
-    step_two
-    step_three
-    step_four
-    step_five
-    step_six
-    step_seven
-    step_eight
-    step_nine
-
-    @context
-  end
-
-  def step_one
-    @context[:step_one] = @param1
-  end
-
-  def step_two
-    @context[:step_two] = @context[:step_one]
-  end
-
-  def step_three
-    @context[:step_three] = @context[:step_two]
-  end
-
-  def step_four
-    @context[:step_four] = @context[:step_three]
-  end
-
-  def step_five
-    @context[:step_five] = @context[:step_four]
-  end
-
-  def step_six
-    @context[:step_six] = @context[:step_five]
-  end
-
-  def step_seven
-    @context[:step_seven] = @context[:step_six]
-  end
-
-  def step_eight
-    @context[:step_eight] = @context[:step_seven]
-  end
-
-  def step_nine
-    @context[:step_nine] = @context[:step_eight]
-  end
-end
-
-class ActiveInteractionTest < ActiveInteraction::Base
-  string :param1
-
-  def execute
-    @context = {}
-    step_one
-    step_two
-    step_three
-    step_four
-    step_five
-    step_six
-    step_seven
-    step_eight
-    step_nine
-
-    @context
-  end
-
-  def step_one
-    @context[:step_one] = param1
-  end
-
-  def step_two
-    @context[:step_two] = @context[:step_one]
-  end
-
-  def step_three
-    @context[:step_three] = @context[:step_two]
-  end
-
-  def step_four
-    @context[:step_four] = @context[:step_three]
-  end
-
-  def step_five
-    @context[:step_five] = @context[:step_four]
-  end
-
-  def step_six
-    @context[:step_six] = @context[:step_five]
-  end
-
-  def step_seven
-    @context[:step_seven] = @context[:step_six]
-  end
-
-  def step_eight
-    @context[:step_eight] = @context[:step_seven]
-  end
-
-  def step_nine
-    @context[:step_nine] = @context[: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 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 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 InteractorWithoutOrganizer
-  include Interactor
-
-  def call
-    step_one
-    step_two
-    step_three
-    step_four
-    step_five
-    step_six
-    step_seven
-    step_eight
-    step_nine
-  end
-
-  def step_one
-    context.step_one = context.param1
-  end
-
-  def step_two
-    context.step_two = context.step_one
-  end
-
-  def step_three
-    context.step_three = context.step_two
-  end
-
-  def step_four
-    context.step_four = context.step_three
-  end
-
-  def step_five
-    context.step_five = context.step_four
-  end
-
-  def step_six
-    context.step_six = context.step_five
-  end
-
-  def step_seven
-    context.step_seven = context.step_six
-  end
-
-  def step_eight
-    context.step_eight = context.step_seven
-  end
-
-  def step_nine
-    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
-    step_one
-    step_two
-    step_three
-    step_four
-    step_five
-    step_six
-    step_seven
-    step_eight
-    step_nine
-  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 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 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
-
-iteration_count = 1_000_000
-
-# result = RubyProf.profile do
-#   iteration_count.times { InteractorTestOrganizer.call(param1: 'param1') }
-# end
-
-# class Two
-#   def initialize
-#     @ctx = {}
-#   end
-
-#   def one
-#     @ctx[:one] = 'one'
-#   end
-
-#   def two
-#     @ctx[:two] = @ctx[:one]
-#   end
-
-#   def three
-#     @ctx[:three] = @ctx[:two]
-#   end
-# end
-
-# instance = Two.new
-
-# Benchmark.bmbm do |x|
-#   x.report("PublicSend") { iteration_count.times { instance.public_send(:one) } }
-#   x.report("Send") { iteration_count.times { instance.send(:one) } }
-#   x.report("call instance method") { iteration_count.times { instance.one } }
-# end
-
-# array_one = []
-# array_two = []
-
-# Benchmark.bmbm do |x|
-#   x.report("<<") { iteration_count.times { array_one << 1 } }
-#   x.report("push") { iteration_count.times { array_two << 1 } }
-# end
-
-# result = RubyProf.profile do
-# iteration_count.times { DecouplioTest.call(param1: 'param1') }
-# end
-# result = RubyProf.profile do
-#   iteration_count.times { RegularServiceTest.call(param1: 'param1') }
-# end
-# result = RubyProf.profile do
-#   iteration_count.times { TrailblazerTest.call(param1: 'param1') }
-# end
-# result = RubyProf.profile do
-#   iteration_count.times { ActiveInteractionTest.run(param1: 'param1') }
-# end
-# result = RubyProf.profile do
-#   iteration_count.times { MutationTest.run(param1: 'param1') }
-# end
-
-# printer = RubyProf::GraphPrinter.new(result)
-# printer.print(STDOUT, {})
-
-Benchmark.bmbm do |x|
-  x.report('RegularService') { iteration_count.times { RegularServiceTest.call(param1: 'param1') } }
-  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('Decouplio one step') { iteration_count.times { DecouplioTestOneStep.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.report('Decouplio several steps') { iteration_count.times { DecouplioTestSeveralSteps.call(param1: 'param1') } }
-end

data/docs/_config.yml

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

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