trailblazer-operation 0.7.0 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a184243cc5650f8905e96a29d4abd248f463dcf8e2c5ec28d3a68de6391ae4e
-  data.tar.gz: 8c8eeb9c36d0065096e1c9be60872254c0776ecd6dd617d439aa55c3896f020e
+  metadata.gz: e06d73c350844dbfc8a0e2f1e7a6fab4d2943d52bb3efb8b35c51b5f9a042926
+  data.tar.gz: 658a1b5b6d94a14d2f3b6a92c2da8bae5c0b4c157393a5da218fbe3bbdac8caf
 SHA512:
-  metadata.gz: c1abb34f87e18425f77c6189ded96dd0f02c39f9e2ce178b1d2bfff3d2b2e8c2c4dd4d37e88a770ffc8b8457613dbc4e334b8e2e7924395c07bd4a59c6bd3376
-  data.tar.gz: 68fb2740d396b174c7eaa62e0145049755ff593fbf7bdba66825b79caa7908b35b954b8508528b6a6f93883fee3f372e2043a860f968bf5699cb2bceea1c3f17
+  metadata.gz: e9b30666287aa4e737a393266e9be36f2eb8fed6543329fb99c23afc17aa7b5ffd54c765e0adf008f62d673b4d4ff3a9a34e7b81e808c825b8f6faf9e3a0c0fd
+  data.tar.gz: 5a022c81097174f73a9894b6b9a52333eaf5e83e300a1d3054a9abdb1205a7825a0b2da0ec643206f75cc33b35c21140682b2733cd2dccd559a47e0efc0a101a

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,23 @@
+## 0.7.5
+
+* Upgrade `trailblazer-activity` & `trailblazer-activity-dsl-linear` patch versions.
+
+## 0.7.4
+
+* Fix `Operation.call` being called twice before delegating to `call_with_circuit_interface`. This is done via a special `call_task` in the operation's taskWrap.
+
+## 0.7.3
+
+* Revert trailblazer-developer to a runtime dependency.
+
+## 0.7.2
+
+* Bugfix: when calling `Operation.call(params: {}, "current_user" => user)` the stringified variables got lost in Ruby < 3.
+
+## 0.7.1
+
+* In `Operation.call_with_public_interface`, pass `self` and not `@activity` to the `invoke`r. This fixes tracing as it now catches the actual Operation class, not an activity instance.
+
 ## 0.7.0
 
 * Compatible with Ruby 2.4-3.0.

data/lib/trailblazer/operation.rb

@@ -47,7 +47,7 @@ module Trailblazer
     end
 
     require "trailblazer/operation/public_call"      # TODO: Remove in 3.0.
-    extend PublicCall              # ::call(params, { current_user: .. })
+    extend PublicCall              # ::call(params: .., current_user: ..)
 
     require "trailblazer/operation/trace"
     extend Trace                   # ::trace

data/lib/trailblazer/operation/public_call.rb

@@ -14,7 +14,7 @@ module Trailblazer
     # @note Do not override this method as it will be removed in future versions. Also, you will break tracing.
     # @return Operation::Railway::Result binary result object
     def call(options = {}, flow_options = {}, **circuit_options)
-      return call_with_circuit_interface(options, **circuit_options) if options.is_a?(Array) # This is kind of a hack that could be well hidden if Ruby had method overloading. Goal is to simplify the call/__call__ thing as we're fading out Operation::call anyway.
+      return call_with_circuit_interface(options, **circuit_options) if options.is_a?(Array) # This is kind of a hack that could be well hidden if Ruby had method overloading. Goal is to simplify the call thing as we're fading out Operation::public_call anyway.
 
       call_with_public_interface(options, flow_options, **circuit_options)
     end
@@ -29,17 +29,19 @@ module Trailblazer
     def call_with_public_interface(options, flow_options, invoke_class: Activity::TaskWrap, **circuit_options)
       flow_options  = flow_options_for_public_call(flow_options)
 
-      options       = circuit_options.any? ? circuit_options : options # This is needed in Ruby 3 for {Create.(params: {})} calls.
-
+      # In Ruby < 3, calling Op.(params: {}, "current_user" => user) results in both {circuit_options} and {options} containing variables.
+      # In Ruby 3.0, **circuit_options is always empty.
+      options       = circuit_options.any? ? circuit_options.merge(options) : options
 
       ctx           = options_for_public_call(options, flow_options)
 
       # call the activity.
       # This will result in invoking {::call_with_circuit_interface}.
       signal, (ctx, flow_options) = invoke_class.invoke(
-        @activity,
+        self,
         [ctx, flow_options],
-        exec_context: new
+        exec_context: new,
+        wrap_static: initial_wrap_static,
       )
 
       # Result is successful if the activity ended with an End event derived from Railway::End::Success.
@@ -78,5 +80,24 @@ module Trailblazer
       raise "[Trailblazer] `Operation.call_with_flow_options is deprecated in Ruby 3.0. Use `Operation.(options, flow_options)`" if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3.0.0")
       call_with_public_interface(options, flow_options, {invoke_class: Activity::TaskWrap})
     end
+
+    def initial_wrap_static(*)
+      Activity::TaskWrap::Pipeline.new([["task_wrap.call_task", method(:call_task)]])
+    end
+
+    def call_task(wrap_ctx, original_args) # DISCUSS: copied from {TaskWrap.call_task}.
+      op = wrap_ctx[:task]
+
+      original_arguments, original_circuit_options = original_args
+
+      # Call the actual task we're wrapping here.
+      # puts "~~~~wrap.call: #{task}"
+      return_signal, return_args = op.call_with_circuit_interface(original_arguments, **original_circuit_options)
+
+      # DISCUSS: do we want original_args here to be passed on, or the "effective" return_args which are different to original_args now?
+      wrap_ctx = wrap_ctx.merge(return_signal: return_signal, return_args: return_args)
+
+      return wrap_ctx, original_args
+    end
   end
 end

data/lib/trailblazer/operation/version.rb

@@ -1,7 +1,7 @@
 module Trailblazer
   module Version
     module Operation
-      VERSION = "0.7.0"
+      VERSION = "0.7.5"
     end
   end
 end

data/test/operation_test.rb

@@ -1,6 +1,28 @@
 require "test_helper"
 
 class DeclarativeApiTest < Minitest::Spec
+  it "doesn't invoke {call} twice when using public interface" do
+    class MyOp < Trailblazer::Operation
+      @@GLOBAL = []
+      def self.global; @@GLOBAL; end
+
+
+      def self.call(*args)
+        @@GLOBAL << :call
+        super
+      end
+
+      pass :model
+
+      def model(ctx, **)
+        @@GLOBAL << :model
+      end
+    end
+
+    MyOp.({})
+    MyOp.global.inspect.must_equal %{[:call, :model]}
+  end
+
   #---
   #- step, pass, fail
 
@@ -95,6 +117,17 @@ class DeclarativeApiTest < Minitest::Spec
     Unset. ("params" => {decide: true}).inspect("a", "b", "c", "d", "e").must_equal %{<Result:true [false, true, nil, 1, 2] >}
   end
 
+# Mixing keywords and string keys in {Operation.call}.
+# Test that {.(params: {}, "current_user" => user)} is processed properly
+  class Collect < Trailblazer::Operation
+    # step ->(ctx, **) { ctx[:keys] }
+  end
+
+  it "contains all keys from {call}" do
+    result = Collect.(params: {}, "current_user" => Module)
+    _(result.inspect).must_equal %{<Result:true #<Trailblazer::Context::Container wrapped_options={:params=>{}, \"current_user\"=>Module} mutable_options={}> >}
+  end
+
   #---
   #- ctx container
   it do

data/test/step_test.rb

@@ -178,12 +178,20 @@ class StepTest < Minitest::Spec
   # not existent :name
   it do
     op = assert_raises Trailblazer::Activity::DSL::Linear::Sequence::IndexError do
-      Class.new(Trailblazer::Operation) do
+      class InvalidStep < Trailblazer::Operation
         step :a, before: "I don't exist!"
       end
     end
-    assert_equal Trailblazer::Activity::DSL::Linear::Sequence::IndexError, op.class
-    # assert_match /<Trailblazer::Activity::DSL::Linear::Sequence::IndexError: .+ is not a valid step ID. Did you mean any of these ?/, op.inspect
+
+    error_message = %{#<Trailblazer::Activity::DSL::Linear::Sequence::IndexError: StepTest::InvalidStep:
+\e[31m\"I don't exist!\" is not a valid step ID. Did you mean any of these ?\e[0m
+\e[32m\"Start.default\"
+\"End.success\"
+\"End.pass_fast\"
+\"End.fail_fast\"
+\"End.failure\"\e[0m>}
+
+    assert_match error_message, op.inspect
   end
 
   #---

data/test/trace_test.rb

@@ -56,7 +56,7 @@ class TraceTest < Minitest::Spec
       result = Create.wtf?(params: {x: 1}, a_return: true)
     end
 
-    output.gsub(/0x\w+/, "").gsub(/@.+_test/, "").must_equal %{`-- #<Trailblazer::Activity:>
+    output.gsub(/0x\w+/, "").gsub(/@.+_test/, "").must_equal %{`-- TraceTest::Create
     |-- \e[32mStart.default\e[0m
     |-- \e[32mCreate.task.a\e[0m
     |-- MyNested

data/trailblazer-operation.gemspec

@@ -17,13 +17,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "trailblazer-activity-dsl-linear", ">= 0.4.0", "< 1.0.0"
+  spec.add_dependency "trailblazer-activity-dsl-linear", ">= 0.4.1", "< 1.0.0"
+  spec.add_dependency "trailblazer-activity", ">= 0.12.2", "< 1.0.0"
+  spec.add_dependency "trailblazer-developer", ">= 0.0.21", "< 1.0.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "trailblazer-developer"
 
   spec.required_ruby_version = ">= 2.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-operation
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.5
 platform: ruby
 authors:
 - Nick Sutterer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-03 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trailblazer-activity-dsl-linear
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.4.1
     - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -26,26 +26,52 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.4.1
     - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: trailblazer-activity
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 0.12.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.12.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: trailblazer-developer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.21
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.21
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -59,7 +85,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -73,7 +99,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -87,7 +113,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: trailblazer-developer
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -107,10 +133,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
 - CHANGES.md
 - Gemfile
 - README.md
@@ -155,7 +181,7 @@ homepage: http://trailblazer.to
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -170,8 +196,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Trailblazer's operation object with railway flow and integrated error handling.
 test_files:

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-rvm:
-  - ruby-head
-  - 3.0
-  - 2.7
-  - 2.6
-  - 2.5
-  - 2.4
-jobs:
-  allow_failures:
-    - rvm: ruby-head