trailblazer-operation 0.10.1 → 0.11.0

data/test/docs/autogenerated/subprocess_test.rb

@@ -0,0 +1,257 @@
+# THIS FILE IS AUTOGENERATED FROM trailblazer-activity-dsl-linear/test/docs/subprocess_test.rb
+require "test_helper"
+
+class SubprocessDocsTest < Minitest::Spec
+  Memo = Class.new
+  #:nested
+  module Memo::Operation
+    class Validate < Trailblazer::Operation
+      step :check_params
+      step :text_present?
+      #~meths
+      include T.def_steps(:check_params, :text_present?)
+      #~meths end
+    end
+  end
+  #:nested end
+
+  #:container
+  module Memo::Operation
+    class Create < Trailblazer::Operation
+      step Subprocess(Validate)
+      step :save
+      left :handle_errors
+      step :notify
+      #~meths
+      include T.def_steps(:validate, :save, :handle_errors, :notify)
+      #~meths end
+    end
+  end
+  #:container end
+
+  it "what" do
+    assert_invoke Memo::Operation::Create, seq: "[:check_params, :text_present?, :save, :notify]"
+    assert_invoke Memo::Operation::Create, seq: "[:check_params, :text_present?, :save, :handle_errors]", save: false, terminus: :failure
+    assert_invoke Memo::Operation::Create, seq: "[:check_params, :text_present?, :handle_errors]", text_present?: false, terminus: :failure
+    assert_invoke Memo::Operation::Create, seq: "[:check_params, :handle_errors]", check_params: false, terminus: :failure
+  end
+end
+
+class Output_SubprocessDocsTest < Minitest::Spec
+  Memo = Class.new
+
+  module Memo::Operation
+    class Validate < Trailblazer::Operation
+      step :check_params
+      step :text_present?
+      #~meths
+      include T.def_steps(:check_params, :text_present?)
+      #~meths end
+    end
+  end
+
+  #:container-output
+  module Memo::Operation
+    class Create < Trailblazer::Operation
+      step Subprocess(Validate),
+        Output(:failure) => Id(:notify)
+      step :save
+      left :handle_errors
+      step :notify
+      #~meths
+      include T.def_steps(:validate, :save, :handle_errors, :notify)
+      #~meths end
+    end
+  end
+  #:container-output end
+
+  it "what" do
+    assert_invoke Memo::Operation::Create, seq: "[:check_params, :text_present?, :save, :notify]"
+    assert_invoke Memo::Operation::Create, seq: "[:check_params, :text_present?, :save, :handle_errors]", save: false, terminus: :failure
+    assert_invoke Memo::Operation::Create, seq: "[:check_params, :text_present?, :notify]", text_present?: false
+    assert_invoke Memo::Operation::Create, seq: "[:check_params, :notify]", check_params: false
+  end
+end
+
+class SubprocessDocsTest < Minitest::Spec
+  Memo = Class.new
+  #:nested-terminus
+  module Memo::Operation
+    class Validate < Trailblazer::Operation
+      step :check_params,
+        Output(:failure) => End(:invalid)
+      step :text_present?
+      #~meths
+      include T.def_steps(:check_params, :text_present?)
+      #~meths end
+    end
+  end
+  #:nested-terminus end
+
+  #:container-terminus
+  module Memo::Operation
+    class Create < Trailblazer::Operation
+      step Subprocess(Validate),
+        Output(:invalid) => Track(:failure)
+      step :save
+      left :handle_errors
+      step :notify
+      #~meths
+      include T.def_steps(:validate, :save, :handle_errors, :notify)
+      #~meths end
+    end
+  end
+  #:container-terminus end
+
+  it "what" do
+    assert_invoke Memo::Operation::Create, seq: "[:check_params, :text_present?, :save, :notify]"
+    assert_invoke Memo::Operation::Create, seq: "[:check_params, :text_present?, :save, :handle_errors]", save: false, terminus: :failure
+    assert_invoke Memo::Operation::Create, seq: "[:check_params, :text_present?, :handle_errors]", text_present?: false, terminus: :failure
+    assert_invoke Memo::Operation::Create, seq: "[:check_params, :handle_errors]", check_params: false, terminus: :failure
+  end
+end
+
+#~ignore end
+
+class Strict_SubprocessDocsTest < Minitest::Spec
+  Memo = Class.new
+
+  module Memo::Operation
+    class Validate < Trailblazer::Operation
+      step :check_params,
+        Output(:failure) => End(:invalid)
+      step :text_present?
+      #~meths
+      include T.def_steps(:check_params, :text_present?)
+      #~meths end
+    end
+  end
+
+  module Memo::Operation
+    class Create < Trailblazer::Operation
+      step Subprocess(Validate, strict: true) # no wiring of {:invalid} terminus.
+      step :save
+      left :handle_errors
+      step :notify
+      #~meths
+      include T.def_steps(:validate, :save, :handle_errors, :notify)
+      #~meths end
+    end
+  end
+
+  it "raises {IllegalSignalError} at runtime when not connected" do
+    skip "see https://github.com/trailblazer/trailblazer-activity-dsl-linear/issues/59"
+
+    assert_invoke Memo::Operation::Create, seq: "[:check_params, :text_present?, :save, :notify]"
+    assert_invoke Memo::Operation::Create, seq: "[:check_params, :text_present?, :save, :handle_errors]", save: false, terminus: :failure
+    assert_invoke Memo::Operation::Create, seq: "[:check_params, :text_present?, :handle_errors]", text_present?: false, terminus: :failure
+    # exception = assert_raises Trailblazer::Operation::Circuit::IllegalSignalError do
+      assert_invoke Memo::Operation::Create, seq: "[:check_params, :handle_errors]", check_params: false, terminus: :failure
+    # end
+
+    # assert_equal exception.message.split("\n")[1][0..82], %(\e[31mUnrecognized Signal `#<Trailblazer::Operation::End semantic=:invalid>` returned)
+  end
+end
+
+class FixmeSubprocess_FailFast_DocsTest < Minitest::Spec
+  Memo = Class.new
+  module Memo::Operation
+    class Create < Trailblazer::Operation
+      step :validate,
+        fail_fast: true
+      step :save
+      #~meths
+      include T.def_steps(:validate, :save)
+      #~meths end
+    end
+  end
+
+  it do
+    assert_invoke Memo::Operation::Create, seq: "[:validate, :save]"
+    assert_invoke Memo::Operation::Create, seq: "[:validate]", terminus: :fail_fast, validate: false
+  end
+end
+
+class Subprocess_FailFast_DocsTest < Minitest::Spec
+  Memo = Struct.new(:id)
+
+  module Memo::Operation
+    class Validate < Trailblazer::Operation # Validate is a {Railway}
+      step :validate
+      include T.def_steps(:validate)
+    end
+  end
+
+  module Memo::Operation
+    class Create < Trailblazer::Operation
+      step Subprocess(Validate), fail_fast: true
+      step :save
+      #~meths
+      include T.def_steps(:save)
+      #~meths end
+    end
+  end
+
+  it do
+    assert_invoke Memo::Operation::Create, seq: "[:validate, :save]"
+    assert_invoke Memo::Operation::Create, seq: "[:validate]", terminus: :fail_fast, validate: false
+  end
+end
+
+class Subprocess_PassFast_DocsTest < Minitest::Spec
+  Memo = Struct.new(:id)
+
+  module Memo::Operation
+    class Validate < Trailblazer::Operation
+      step :validate
+      include T.def_steps(:validate)
+    end
+  end
+
+  module Memo::Operation
+    class Create < Trailblazer::Operation
+      step Subprocess(Validate), pass_fast: true
+      step :save
+      #~meths
+      include T.def_steps(:save)
+      #~meths end
+    end
+  end
+
+  it do
+    assert_invoke Memo::Operation::Create, seq: "[:validate]", terminus: :pass_fast
+    assert_invoke Memo::Operation::Create, seq: "[:validate]", terminus: :failure, validate: false
+  end
+end
+
+class Subprocess_FastTrack_DocsTest < Minitest::Spec
+  Memo = Struct.new(:id)
+
+  module Memo::Operation
+    class Validate < Trailblazer::Operation
+      step :validate, fast_track: true
+      include T.def_steps(:validate)
+    end
+  end
+
+  #:subprocess-fast-track
+  module Memo::Operation
+    class Create < Trailblazer::Operation
+      step Subprocess(Validate), fast_track: true
+      step :save
+      left :handle_errors
+      step :notify
+      #~meths
+      include T.def_steps(:save, :handle_errors, :notify)
+      #~meths end
+    end
+  end
+  #:subprocess-fast-track end
+
+  it do
+    assert_invoke Memo::Operation::Create, seq: "[:validate, :save, :notify]" # validate returns {true}.
+    assert_invoke Memo::Operation::Create, seq: "[:validate, :handle_errors]", validate: false, terminus: :failure # validate returns {false}.
+    assert_invoke Memo::Operation::Create, seq: "[:validate]", validate: Trailblazer::Activity::FastTrack::PassFast, terminus: :pass_fast # validate returns {pass_fast!}.
+    assert_invoke Memo::Operation::Create, seq: "[:validate]", validate: Trailblazer::Activity::FastTrack::FailFast, terminus: :fail_fast # validate returns {fail_fast!}.
+  end
+end

data/test/docs/autogenerated/wiring_api_test.rb

@@ -0,0 +1,435 @@
+# THIS FILE IS AUTOGENERATED FROM trailblazer-activity-dsl-linear/test/docs/wiring_api_test.rb
+require "test_helper"
+
+#@ original Memo::Operation::Create
+class Vanilla_WiringApiDocsTest < Minitest::Spec
+  Memo = Class.new
+  module Memo::Operation
+    class Create < Trailblazer::Operation
+      step :validate
+      step :save
+      left :handle_errors
+      step :notify
+      #~meths
+      include T.def_steps(:validate, :save, :handle_errors, :notify)
+    end
+  end
+
+  it "what" do
+=begin
+#:render
+puts Trailblazer::Developer.render(Memo::Operation::Create)
+
+#<Start/:default>
+ {Trailblazer::Operation::Right} => #<Trailblazer::Operation::TaskBuilder::Task user_proc=validate>
+#<Trailblazer::Operation::TaskBuilder::Task user_proc=validate>
+ {Trailblazer::Operation::Left} => #<Trailblazer::Operation::TaskBuilder::Task user_proc=handle_errors>
+ {Trailblazer::Operation::Right} => #<Trailblazer::Operation::TaskBuilder::Task user_proc=save>
+#<Trailblazer::Operation::TaskBuilder::Task user_proc=save>
+ {Trailblazer::Operation::Left} => #<Trailblazer::Operation::TaskBuilder::Task user_proc=handle_errors>
+ {Trailblazer::Operation::Right} => #<Trailblazer::Operation::TaskBuilder::Task user_proc=notify>
+#<Trailblazer::Operation::TaskBuilder::Task user_proc=handle_errors>
+ {Trailblazer::Operation::Left} => #<End/:failure>
+ {Trailblazer::Operation::Right} => #<End/:failure>
+#<Trailblazer::Operation::TaskBuilder::Task user_proc=notify>
+ {Trailblazer::Operation::Left} => #<End/:failure>
+ {Trailblazer::Operation::Right} => #<End/:success>
+#<End/:success>
+
+#<End/:failure>
+#:render end
+=end
+  end
+end
+
+#@ Output => End
+class Output_WiringApiDocsTest < Minitest::Spec
+  Memo = Class.new
+  module Memo::Operation
+    class Create < Trailblazer::Operation
+      step :validate
+      step :save,
+        Output(:failure) => End(:db_error)
+      left :handle_errors
+      step :notify
+      #~meths
+      include T.def_steps(:validate, :save, :handle_errors, :notify)
+    end
+  end
+
+  it "what" do
+    assert_invoke Memo::Operation::Create, seq: "[:validate, :save, :notify]"
+    assert_invoke Memo::Operation::Create, seq: "[:validate, :save]", save: false, terminus: :db_error
+  end
+end
+
+#@ failure/Output => End
+class OutputOnLeft_WiringApiDocsTest < Minitest::Spec
+  Memo = Class.new
+  #:left
+  module Memo::Operation
+    class Create < Trailblazer::Operation
+      step :validate
+      step :save
+      left :handle_errors,
+        Output(:success) => Track(:success)
+      step :notify
+      #~meths
+      include T.def_steps(:validate, :save, :handle_errors, :notify)
+      #~meths end
+    end
+  end
+  #:left end
+
+  it "what" do
+    assert_invoke Memo::Operation::Create, seq: "[:validate, :save, :notify]"
+    assert_invoke Memo::Operation::Create, seq: "[:validate, :save, :handle_errors, :notify]", save: false
+    assert_invoke Memo::Operation::Create, seq: "[:validate, :save, :handle_errors]", save: false, handle_errors: false, terminus: :failure
+  end
+end
+
+#@ Output => Track
+class OutputToSuccess_WiringApiDocsTest < Minitest::Spec
+  Memo = Class.new
+  #:output-track
+  module Memo::Operation
+    class Create < Trailblazer::Operation
+      step :validate
+      step :save,
+        Output(:failure) => Track(:success)
+      left :handle_errors
+      step :notify
+      #~meths
+      include T.def_steps(:validate, :save, :handle_errors, :notify)
+      #~meths end
+    end
+  end
+  #:output-track end
+
+  it "what" do
+    assert_invoke Memo::Operation::Create, seq: "[:validate, :save, :notify]"
+    assert_invoke Memo::Operation::Create, seq: "[:validate, :save, :notify]", save: false
+  end
+end
+
+#@ Output => Id
+class OutputToId_WiringApiDocsTest < Minitest::Spec
+  Memo = Class.new
+  #:output-id
+  module Memo::Operation
+    class Create < Trailblazer::Operation
+      step :validate,
+        Output(:failure) => Id(:notify)
+      step :save
+      left :handle_errors
+      step :notify
+      #~meths
+      include T.def_steps(:validate, :save, :handle_errors, :notify)
+      #~meths end
+    end
+  end
+  #:output-id end
+
+  it "what" do
+    assert_invoke Memo::Operation::Create, seq: "[:validate, :save, :notify]"
+    assert_invoke Memo::Operation::Create, seq: "[:validate, :notify]", validate: false
+  end
+end
+
+#@ Output(semantic, Signal) => Track
+class ExplicitOutput_WiringApiDocsTest < Minitest::Spec
+  Memo = Struct.new(:save_result) do
+    def save; self.save_result;  end
+  end
+
+  #:output-explicit
+  module Memo::Operation
+    class Create < Trailblazer::Operation
+      class DbError < Trailblazer::Activity::Signal; end
+
+      step :validate
+      step :save,
+        Output(DbError, :database_error) => Track(:failure)
+      left :handle_errors
+      step :notify
+      #~meths
+      include T.def_steps(:validate, :handle_errors, :notify)
+      def save(ctx, model:, **)
+        #~code
+        database_broken = ctx[:database_broken]
+        #~code end
+        return DbError if database_broken
+
+        model.save
+      end
+      #~meths end
+    end
+  end
+  #:output-explicit end
+
+  it "what" do
+    assert_invoke Memo::Operation::Create, seq: "[:validate, :handle_errors]", validate: false, terminus: :failure
+    assert_invoke Memo::Operation::Create, seq: "[:validate, :notify]", model: Memo.new(true)
+    assert_invoke Memo::Operation::Create, seq: "[:validate, :handle_errors]", model: Memo.new(false), terminus: :failure
+    assert_invoke Memo::Operation::Create, seq: "[:validate, :handle_errors]", model: Memo.new(true), database_broken: true, terminus: :failure
+  end
+end
+
+#@ Output => End
+class OutputToEnd_WiringApiDocsTest < Minitest::Spec
+  Memo = Class.new
+  #:output-end
+  module Memo::Operation
+    class Create < Trailblazer::Operation
+      step :validate
+      step :save,
+        Output(:failure) => End(:db_error)
+      left :handle_errors
+      step :notify
+      #~meths
+      include T.def_steps(:validate, :save, :handle_errors, :notify)
+      #~meths end
+    end
+  end
+  #:output-end end
+
+  it "what" do
+    assert_invoke Memo::Operation::Create, seq: "[:validate, :save, :notify]"
+    assert_invoke Memo::Operation::Create, seq: "[:validate, :save]", save: false, terminus: :db_error
+  end
+end
+
+#@ #terminus
+class Terminus_WiringApiDocsTest < Minitest::Spec
+  Memo = Class.new
+  #:terminus
+  module Memo::Operation
+    class CRUD < Trailblazer::Operation
+      step :validate
+      step :save
+      terminus :db_error
+      #~meths
+      include T.def_steps(:validate, :save, :handle_errors, :notify)
+      #~meths end
+    end
+  end
+  #:terminus end
+
+  #:terminus-sub
+  module Memo::Operation
+    class Create < CRUD
+      step :notify,
+        Output(:failure) => End(:db_error)
+      #~meths
+      include T.def_steps(:validate, :save, :handle_errors, :notify)
+      #~meths end
+    end
+  end
+  #:terminus-sub end
+
+  it "what" do
+    assert_invoke Memo::Operation::Create, seq: "[:validate, :save, :notify]"
+    assert_invoke Memo::Operation::Create, seq: "[:validate, :save]", save: false, terminus: :failure
+    assert_invoke Memo::Operation::Create, seq: "[:validate, :save, :notify]", notify: false, terminus: :db_error
+  end
+end
+
+#@ Track()
+class Track_WiringApiDocsTest < Minitest::Spec
+  Memo = Class.new
+  #:custom-track
+  module Memo::Operation
+    class Charge < Trailblazer::Operation
+      terminus :paypal # add a custom terminus (if you need it)
+      step :validate
+      step :find_provider,
+        Output(:failure) => Track(:paypal)
+      step :charge_paypal,
+        magnetic_to: :paypal, Output(:success) => Track(:paypal)
+      step :charge_default
+      #~meths
+      include T.def_steps(:validate, :find_provider, :charge_paypal, :charge_default)
+      #~meths end
+    end
+  end
+  #:custom-track end
+
+  it "what" do
+    assert_invoke Memo::Operation::Charge, seq: "[:validate, :find_provider, :charge_default]"
+    assert_invoke Memo::Operation::Charge, seq: "[:validate, :find_provider, :charge_paypal]", find_provider: false, terminus: :paypal
+    assert_invoke Memo::Operation::Charge, seq: "[:validate, :find_provider, :charge_paypal]", find_provider: false, charge_paypal: false, terminus: :failure
+  end
+end
+
+#@ Path()
+class Path_WiringApiDocsTest < Minitest::Spec
+  Memo = Class.new
+  #:path-helper
+  module Memo::Operation
+    class Charge < Trailblazer::Operation
+      step :validate
+      step :find_provider,
+        Output(:failure) => Path(terminus: :paypal) do
+          # step :authorize # you can have multiple steps on a path.
+          step :charge_paypal
+        end
+      step :charge_default
+      #~meths
+      include T.def_steps(:validate, :find_provider, :charge_paypal, :charge_default)
+      #~meths end
+    end
+  end
+  #:path-helper end
+
+  it "what" do
+    assert_invoke Memo::Operation::Charge, seq: "[:validate, :find_provider, :charge_default]"
+    assert_invoke Memo::Operation::Charge, seq: "[:validate, :find_provider, :charge_paypal]", find_provider: false, terminus: :paypal
+    # TODO: this doesn't add a {failure} output.
+    # assert_invoke Memo::Operation::Charge, seq: "[:validate, :find_provider, :charge_paypal]", find_provider: false, charge_paypal: false, terminus: :failure
+  end
+end
+
+#@ Path() with error handling: Output()
+# class Path_WiringApiDocsTest < Minitest::Spec
+#   Memo = Class.new
+#   #:path-helper-failure
+#   module Memo::Operation
+#     class Charge < Trailblazer::Operation
+#       step :validate
+#       step :find_provider,
+#         Output(:failure) => Path(terminus: :paypal) do
+#           step :charge_paypal, Output(:failure) => Track(:failure) # route to the "global" failure track.
+#         end
+#       step :charge_default
+
+#       #~meths
+#       include T.def_steps(:validate, :find_provider, :charge_paypal, :charge_default)
+#       #~meths end
+#     end
+#   end
+#   #:path-helper-failure end
+
+#   it "what" do
+#     assert_invoke Memo::Operation::Charge, seq: "[:validate, :find_provider, :charge_default]"
+#     assert_invoke Memo::Operation::Charge, seq: "[:validate, :find_provider, :charge_paypal]", find_provider: false, terminus: :paypal
+#     assert_invoke Memo::Operation::Charge, seq: "[:validate, :find_provider, :charge_paypal]", find_provider: false, charge_paypal: false, terminus: :failure
+#   end
+# end
+
+#@ Path(:connect_to)
+class PathConnectTo_WiringApiDocsTest < Minitest::Spec
+  Memo = Class.new
+  #:path-helper-connect-to
+  module Memo::Operation
+    class Charge < Trailblazer::Operation
+      step :validate
+      step :find_provider,
+        Output(:failure) => Path(connect_to: Id(:finalize)) do
+          # step :authorize # you can have multiple steps on a path.
+          step :charge_paypal
+        end
+      step :charge_default
+      step :finalize
+      #~meths
+      include T.def_steps(:validate, :find_provider, :charge_paypal, :charge_default, :finalize)
+      #~meths end
+    end
+  end
+  #:path-helper-connect-to end
+
+  it "what" do
+    assert_invoke Memo::Operation::Charge, seq: "[:validate, :find_provider, :charge_default, :finalize]"
+    assert_invoke Memo::Operation::Charge, seq: "[:validate, :find_provider, :charge_paypal, :finalize]", find_provider: false
+    # TODO: this doesn't add a {failure} output.
+    # assert_invoke Memo::Operation::Charge, seq: "[:validate, :find_provider, :charge_paypal]", find_provider: false, charge_paypal: false, terminus: :failure
+  end
+end
+
+class WiringApiDocsTest < Minitest::Spec
+# {#terminus} 1.0
+  module A
+    class Payment
+      module Operation
+      end
+    end
+
+    #:terminus-
+    module Payment::Operation
+      class Create < Trailblazer::Operation
+        step :find_provider
+
+        terminus :provider_invalid # , id: "End.provider_invalid", magnetic_to: :provider_invalid
+        #~meths
+        include T.def_steps(:find_provider)
+        #~meths end
+      end
+    end
+    #:terminus- end
+    # @diagram wiring-terminus
+  end
+
+  #@ we cannot route to {End.provider_invalid}
+  it { assert_invoke A::Payment::Operation::Create, seq: "[:find_provider]" }
+  it { assert_invoke A::Payment::Operation::Create, find_provider: false, seq: "[:find_provider]", terminus: :failure }
+
+# {#terminus} 1.1
+  module B
+    class Payment
+      module Operation
+      end
+    end
+
+    #:terminus-track
+    module Payment::Operation
+      class Create < Trailblazer::Operation
+        step :find_provider,
+          # connect {failure} to the next element that is magnetic_to {:provider_invalid}.
+          Output(:failure) => Track(:provider_invalid)
+
+        terminus :provider_invalid
+        #~meths
+        include T.def_steps(:find_provider)
+        #~meths end
+      end
+    end
+    #:terminus-track end
+  end
+
+  #@ failure routes to {End.provider_invalid}
+  it { assert_invoke B::Payment::Operation::Create, seq: "[:find_provider]" }
+  it { assert_invoke B::Payment::Operation::Create, find_provider: false, seq: "[:find_provider]", terminus: :provider_invalid }
+
+  it do
+    result = B::Payment::Operation::Create.(find_provider: false, seq: [])
+    assert_equal result.event.to_h[:semantic], :provider_invalid
+=begin
+    #:terminus-invalid
+    result = Payment::Operation::Create.(provider: "bla-unknown")
+    puts signal.to_h[:semantic] #=> :provider_invalid
+    #:terminus-invalid end
+=end
+
+  end
+end
+
+#@ :magnetic_to
+module A
+  class MagneticTo_DocsTest < Minitest::Spec
+    Memo = Class.new
+    #:magnetic_to
+    module Memo::Operation
+      class Create < Trailblazer::Operation
+        step :validate
+        step :payment_provider, Output(:failure) => Track(:paypal)
+        step :charge_paypal, magnetic_to: :paypal
+        step :save
+      end
+    end
+    #:magnetic_to end
+
+    it "what" do
+#~ignore end
+    end
+
+  end
+end