trailblazer-macro 2.1.5 → 2.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d1d66ce0e6bf576b852792bdee95a0d67148cee1fbb21fdb791e83984154b1f
-  data.tar.gz: d274da669e987828fbfbf8b45b677d5596558e22e7729f882a35546fd3244e74
+  metadata.gz: d789d88096949c41a15147feed363efab5c86e586b4f76c819e12f6e8f2d4a70
+  data.tar.gz: fbe7775b4330bc7b607058da66c896fe461e73b1337e747c23eb87acb04b8d30
 SHA512:
-  metadata.gz: 10aac4d11e1b286e27101955722ff1ae581df1608dd268f40dcfb8a559db0b91f2cc2a0a72ace708a9a83f34ec3c55efb059d0117e3605df012fd81800714a84
-  data.tar.gz: 6227e472b59a584de223884a8111b7da5b43bfa3e5f07a5522caef1ff7cf765fb1801aff192f070214513d61cfe0d23b0c66cf2298e6532a9fb04dc6fd06efd0
+  metadata.gz: df7f0de0c1107ea8c9b3803e8343907c0deb78e943ac2298a114db9fedb6de88252f5055a247b516fa3c80a2432f52913fd6d84ceb189779b58c87da6204a20f
+  data.tar.gz: a1e7a11851d02b26badfbff8aa6932810bc2e32ae3d1f4ce5fd73f2bf26284bff62a88b1fd27d29f5b82a7962e61fd0655b97f483483ff6df5cffdb3326f51e0

data/.github/workflows/ci.yml

@@ -0,0 +1,17 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
+        ruby: [2.5, 2.6, 2.7, '3.0', head, jruby, jruby-head]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - run: bundle exec rake

data/CHANGES.md

@@ -1,3 +1,7 @@
+# 2.1.6
+
+* Allow connecting ends of the dynamically selected activity for `Nested()` using `:auto_wire`.
+
 # 2.1.5
 
 * Support for Ruby 3.0.

data/lib/trailblazer/macro/nested.rb

@@ -2,14 +2,14 @@
 module Trailblazer
   module Macro
     # {Nested} macro.
-    def self.Nested(callable, id: "Nested(#{callable})")
+    def self.Nested(callable, id: "Nested(#{callable})", auto_wire: [])
       if callable.is_a?(Class) && callable < Nested.operation_class
         warn %{[Trailblazer] Using the `Nested()` macro with operations and activities is deprecated. Replace `Nested(Create)` with `Subprocess(Create)`.}
         return Nested.operation_class.Subprocess(callable)
       end
 
       # dynamic
-      task = Nested::Dynamic.new(callable)
+      task = Nested::Dynamic.new(callable, auto_wire: auto_wire)
 
       merge = [
         [Activity::TaskWrap::Pipeline.method(:insert_before), "task_wrap.call_task", ["Nested.compute_nested_activity", task.method(:compute_nested_activity)]],
@@ -33,17 +33,24 @@ module Trailblazer
       end
 
       # For dynamic `Nested`s that do not expose an {Activity} interface.
-      # Since we do not know its outputs, we have to map them to :success and :failure, only.
       #
-      # This is what {Nested} in 2.0 used to do, where the outcome could only be true/false (or success/failure).
+      # Dynamic doesn't automatically connect outputs of runtime {Activity}
+      # at compile time (as we don't know which activity will be nested, obviously).
+      # So by default, it only connects good old success/failure ends. But it is also
+      # possible to connect all the ends of all possible dynamic activities
+      # by passing their list to {:auto_wire} option.
+      #
+      # step Nested(:compute_nested, auto_wire: [Create, Update])
       class Dynamic
-        def initialize(nested_activity_decider)
-          @nested_activity_decider = Trailblazer::Option(nested_activity_decider)
+        STATIC_OUTPUTS = {
+          :success => Activity::Output(Activity::Railway::End::Success.new(semantic: :success), :success),
+          :failure => Activity::Output(Activity::Railway::End::Failure.new(semantic: :failure), :failure),
+        }
 
-          @outputs         = {
-            :success => Activity::Output(Activity::Railway::End::Success.new(semantic: :success), :success),
-            :failure => Activity::Output(Activity::Railway::End::Failure.new(semantic: :failure), :failure)
-          }
+        def initialize(nested_activity_decider, auto_wire: [])
+          @nested_activity_decider  = Trailblazer::Option(nested_activity_decider)
+          @known_activities         = Array(auto_wire)
+          @outputs                  = compute_task_outputs
         end
 
         attr_reader :outputs
@@ -63,13 +70,28 @@ module Trailblazer
         end
 
         def compute_return_signal(wrap_ctx, original_args)
-          # Translate the genuine nested signal to the generic Dynamic end (success/failure, only).
-          # Note that here we lose information about what specific event was emitted.
-          wrap_ctx[:return_signal] = wrap_ctx[:return_signal].kind_of?(Activity::Railway::End::Success) ?
-            @outputs[:success].signal : @outputs[:failure].signal
+          # NOOP when @known_activities are present as all possible signals have been registered already.
+          if @known_activities.empty?
+            # Translate the genuine nested signal to the generic Dynamic end (success/failure, only).
+            # Note that here we lose information about what specific event was emitted.
+            wrap_ctx[:return_signal] = wrap_ctx[:return_signal].kind_of?(Activity::Railway::End::Success) ?
+              @outputs[:success].signal : @outputs[:failure].signal
+          end
 
           return wrap_ctx, original_args
         end
+
+        private def compute_task_outputs
+          # If :auto_wire is empty, we map outputs to :success and :failure only, for backward compatibility.
+          # This is what {Nested} in 2.0 used to do, where the outcome could only be true/false (or success/failure).
+          return STATIC_OUTPUTS if @known_activities.empty?
+
+          # Merge activity#outputs from all given auto_wirable activities to wire up for this dynamic task.
+          @known_activities.map do |activity|
+            # TODO: Replace this when it's helper gets added.
+            Hash[activity.to_h[:outputs].collect{ |output| [output.semantic, output] }]
+          end.inject(:merge)
+        end
       end
     end
   end

data/lib/trailblazer/macro/version.rb

@@ -1,7 +1,7 @@
 module Trailblazer
   module Version
     module Macro
-      VERSION = "2.1.5"
+      VERSION = "2.1.6"
     end
   end
 end

data/test/docs/nested_test.rb

@@ -22,6 +22,11 @@ class NestedInput < Minitest::Spec
     include T.def_steps(:validate)
   end
 
+  class JsonValidate < Validate
+    step :json
+    include T.def_steps(:json)
+  end
+
   it "Nested(Edit), without any options" do
       module A
 
@@ -79,11 +84,6 @@ class NestedInput < Minitest::Spec
         #~meths end
       end
       #:nested-dynamic end
-
-      class JsonValidate < Validate
-        step :json
-        include T.def_steps(:json)
-      end
     # `edit` and `update` can be called from Nested()
 
   # edit/success
@@ -119,11 +119,6 @@ class NestedInput < Minitest::Spec
       end
       #:nested-dynamic end
 
-      class JsonValidate < Validate
-        step :json
-        include T.def_steps(:json)
-      end
-
     # `edit` and `update` can be called from Nested()
     end
 
@@ -161,29 +156,34 @@ class NestedInput < Minitest::Spec
     end
   end
 
-  let(:compute_edit) {
-    ->(ctx, what:, **) { what }
-  }
-
-  it "Nested(:method), :pass_fast => :fail_fast doesn't work with standard wiring" do
-    skip "we need to allow adding :outputs"
+  it "Nested(:method, auto_wire: *activities) with :pass_fast => End()" do
+    module E
+      class JsonValidate < Trailblazer::Operation
+        step :validate, Output(:success) => End(:json_validate)
+        include T.def_steps(:validate)
+      end
 
-    compute_edit = self.compute_edit
+      #:nested-with-auto-wire
+      class Create < Trailblazer::Operation
+        step :create
+        step Nested(:compute_nested, auto_wire: [Validate, JsonValidate]),
+          Output(:json_validate) => End(:jsoned)
 
-    pass_fast = Class.new(Trailblazer::Operation) do
-      step :p, pass_fast: true
-      include T.def_steps(:p)
-    end
+        #~meths
+        def compute_nested(ctx, what:, **)
+          what
+        end
 
-    create = Class.new(Trailblazer::Operation) do
-      step :a
-      step Nested(compute_edit, auto_wire: [pass_fast]), Output(:pass_fast) => Track(:fail_fast)
-      step :b
-      include T.def_steps(:a, :b)
-    end
+        include T.def_steps(:create)
+        #~meths end
+      end
+      #:nested-with-auto-wire end
 
+      result = Create.(seq: [], what: JsonValidate)
 
-    create.(seq: [], what: pass_fast).inspect(:seq).must_equal %{<Result:false [[:a, :c]] >}
+      result.inspect(:seq).must_equal %{<Result:false [[:create, :validate]] >}
+      result.event.inspect.must_equal %{#<Trailblazer::Activity::End semantic=:jsoned>}
+    end
   end
 end
 

data/test/operation/nested_test.rb

@@ -0,0 +1,65 @@
+require 'test_helper'
+
+class NestedTest < Minitest::Spec
+  DatabaseError = Class.new(Trailblazer::Activity::Signal)
+
+  class SignUp < Trailblazer::Operation
+    def self.b(ctx, **)
+      ctx[:seq] << :b
+      return DatabaseError
+    end
+
+    step method(:b), Output(DatabaseError, :db_error) => End(:db_error)
+  end
+
+  class SignIn < Trailblazer::Operation
+    include T.def_steps(:c)
+    step :c
+  end
+
+  it "allows connection with custom output of a nested activity" do
+    create = Class.new(Trailblazer::Operation) do
+      include T.def_steps(:a, :d)
+
+      step :a
+      step Nested(SignUp), Output(:db_error) => Track(:no_user)
+      step :d, magnetic_to: :no_user
+    end
+
+    result = create.(seq: [])
+    result.inspect(:seq).must_equal %{<Result:true [[:a, :b, :d]] >}
+    result.event.inspect.must_equal %{#<Trailblazer::Activity::Railway::End::Success semantic=:success>}
+  end
+
+  it "allows connecting dynamically nested activities with custom output when auto wired" do
+    create = Class.new(Trailblazer::Operation) do
+      def compute_nested(ctx, what:, **)
+        what
+      end
+
+      include T.def_steps(:a, :d)
+
+      step :a
+      step Nested(:compute_nested, auto_wire: [SignUp, SignIn]), Output(:db_error) => Track(:no_user)
+      step :d, magnetic_to: :no_user
+    end
+
+    result = create.(seq: [], what: SignUp)
+    result.inspect(:seq).must_equal %{<Result:true [[:a, :b, :d]] >}
+    result.event.inspect.must_equal %{#<Trailblazer::Activity::Railway::End::Success semantic=:success>}
+  end
+
+  it "raises RuntimeError if dynamically nested activities with custom output are not auto wired" do
+    exception = assert_raises RuntimeError do
+      Class.new(Trailblazer::Operation) do
+        def compute_nested(ctx, what:, **)
+          what
+        end
+
+        step Nested(:compute_nested), Output(:db_error) => Track(:no_user)
+      end
+    end
+
+    exception.inspect.must_match 'No `db_error` output found'
+  end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-macro
 version: !ruby/object:Gem::Version
-  version: 2.1.5
+  version: 2.1.6
 platform: ruby
 authors:
 - Nick Sutterer
 - Marc Tich
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-03 00:00:00.000000000 Z
+date: 2021-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -137,10 +137,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
 - CHANGES.md
 - Gemfile
 - LICENSE
@@ -165,6 +165,7 @@ files:
 - test/docs/wrap_test.rb
 - test/operation/integration_test.rb
 - test/operation/model_test.rb
+- test/operation/nested_test.rb
 - test/operation/pundit_test.rb
 - test/test_helper.rb
 - trailblazer-macro.gemspec
@@ -172,7 +173,7 @@ homepage: http://trailblazer.to
 licenses:
 - LGPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -188,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: 'Macros for Trailblazer''s operation: Policy, Wrap, Rescue and more.'
 test_files:
@@ -201,5 +202,6 @@ test_files:
 - test/docs/wrap_test.rb
 - test/operation/integration_test.rb
 - test/operation/model_test.rb
+- test/operation/nested_test.rb
 - test/operation/pundit_test.rb
 - test/test_helper.rb

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-rvm:
-  - ruby-head
-  - 2.7
-  - 2.6
-  - 2.5
-  - 2.4
-cache: bundler
-jobs:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: 2.7