trailblazer-operation 0.7.3 → 0.8.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2bed59ccc4a6af470ef0413dfd4c5132c138a2ed68e1e7ed390ea7637c8db4e
-  data.tar.gz: '074982e69ce025d63cc256964b8c334ad6405f792357201778beea2694668f93'
+  metadata.gz: 5bbb0fa15c5191698a061f5bb8b93a5eace67064ea2fbcbf0e470fac0cd753ae
+  data.tar.gz: 8e2936aa292319ae85ff536b52a7804d458490789cf899993bcad735f127e737
 SHA512:
-  metadata.gz: 9b74fd06391e9035c5a82ff85b281e4b87445f18b0c238d5f939dfdb80e4541cd484743523a474371dfa2dd803068c6bb415732a40bea25dfa67fd777134dc3c
-  data.tar.gz: 79eb31f4211e4a6521c3c06f879df49bf32b57f5b020b0f3a4273efb8c12fc047812f9a75f0987034c78fc6952945d5e4e24d08ac820b6c31222657490d4ea68
+  metadata.gz: aa828e7e9ca916cd4d312925407e7a723831a13d08f4f8bc4eddae6b0f0867bd8f7c23929e5f385fde91a7dad9ed706b96cbb54010adbec607f7c315eb928725
+  data.tar.gz: ec3ecc37e71550152747ce598e4a1e44ac17beac712dbde45463a08e357673c3835539c6122e5047a6381b9440be32829f1a9f986d894715204bf5a39332d5a7

data/.github/workflows/ci.yml

@@ -6,7 +6,7 @@ jobs:
       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]
+        ruby: [2.5, 2.6, 2.7, '3.0', '3.1', head, jruby]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2

data/CHANGES.md

@@ -1,3 +1,15 @@
+## 0.8.0
+
+* Use `trailblazer-activity-dsl-linear` 1.0.0.
+
+## 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.

data/Gemfile

@@ -16,3 +16,8 @@ gem "minitest-line"
 # gem "trailblazer-context", path: "../trailblazer-context"
 # gem "trailblazer-activity-dsl-linear", path: "../trailblazer-activity-dsl-linear"
 # gem "trailblazer-activity", github: "trailblazer/trailblazer-activity"
+
+# gem "trailblazer-macro", path: "../trailblazer-macro"
+# gem "trailblazer-activity", path: "../trailblazer-activity"
+# gem "trailblazer-activity-dsl-linear", path: "../trailblazer-activity-dsl-linear"
+# gem "trailblazer-declarative"

data/lib/trailblazer/operation/class_dependencies.rb

@@ -2,14 +2,17 @@
 class Trailblazer::Operation
   # The use of this module is currently not encouraged and it is only here for backward-compatibility.
   # Instead, please pass dependencies via containers, locals, or macros into the respective steps.
+  #
   module ClassDependencies
     def [](field)
-      @state.to_h[:fields][field]
+      class_fields[field]
     end
 
+    # Store a field on @state, which is provided by {Strategy}.
     def []=(field, value)
-      options = @state.to_h[:fields].merge(field => value)
-      @state.update_options(options)
+      @state.update!(:fields) do |fields|
+        fields.merge(field => value)
+      end
     end
 
     def options_for_public_call(options, flow_options)
@@ -18,7 +21,7 @@ class Trailblazer::Operation
     end
 
     private def class_fields
-      @state.to_h[:fields]
+      @state.get(:fields)
     end
 
     private def context_for_fields(fields, (ctx, flow_options), **)

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
@@ -40,7 +40,8 @@ module Trailblazer
       signal, (ctx, flow_options) = invoke_class.invoke(
         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.
@@ -79,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([Activity::TaskWrap::Pipeline.Row("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/trace.rb

@@ -38,10 +38,12 @@ module Trailblazer
           @stack = stack
         end
 
+        # TODO: deprecate!
         def wtf
           Developer::Trace::Present.(@stack)
         end
 
+        # TODO: deprecate!
         def wtf?
           puts wtf
         end

data/lib/trailblazer/operation/version.rb

@@ -1,7 +1,7 @@
 module Trailblazer
   module Version
     module Operation
-      VERSION = "0.7.3"
+      VERSION = "0.8.0.beta1"
     end
   end
 end

data/lib/trailblazer/operation.rb

@@ -1,12 +1,11 @@
+require "trailblazer/activity/dsl/linear"
 require 'forwardable'
 require 'trailblazer/operation/version'
-require "trailblazer/option"
-require "trailblazer/context"
-
-require "trailblazer/activity/dsl/linear"
 
 module Trailblazer
-  # DISCUSS: I don't know where else to put this. It's not part of the {Activity} concept
+  # As opposed to {Activity::Railway} and {Activity::FastTrack} an operation
+  # maintains different terminus subclasses.
+  # DISCUSS: remove this, at some point in time!
   class Activity
     class Railway
       module End
@@ -31,6 +30,7 @@ module Trailblazer
     end
   end
 
+  # DISCUSS: where do we need this?
   def self.Operation(options)
     Class.new(Activity::FastTrack( Activity::Operation.OptionsForState.merge(options) )) do
       extend Operation::PublicCall
@@ -38,16 +38,14 @@ module Trailblazer
   end
 
   # The Trailblazer-style operation.
-  # Note that you don't have to use our "opinionated" version with result object, skills, etc.
-  class Operation < Activity::FastTrack(Activity::Operation.OptionsForState)
-    # extend Skill::Accessors # ::[] and ::[]= # TODO: fade out this usage.
-
+  # Note that you don't have to use our "opinionated" version with result object, etc.
+  class Operation < Activity::FastTrack(**Activity::Operation.OptionsForState)
     class << self
       alias_method :strategy_call, :call
     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/test/class_dependencies_test.rb

@@ -8,16 +8,43 @@ class ClassDependenciesTest < Minitest::Spec
 
     self["model.class"] = Module
 
-    step ->(options, **) { options["a"] = options["model.class"] }
+    step ->(ctx, **) { ctx["a"] = ctx["model.class"] }
   end
 
   it { Index.({}).inspect("a", "model.class").must_equal %{<Result:true [Module, Module] >} }
 
   it "creates separate ctx for circuit interface" do
+    # raise "this can't work since the OP is run without TaskWrap.invoke"
     signal, (ctx, _) = Index.([{}, {}], {})
 
-    ctx["model.class"].inspect.must_equal %{Module} # FIXME: should this be here?
     ctx[:a].inspect.must_equal %{Module}
+    ctx["model.class"].inspect.must_equal %{Module} # FIXME: should this be here?
+  end
+
+# nested OPs
+  it "injects class dependencies for nested OP" do
+    class Home < Trailblazer::Operation
+      step Subprocess(Index)
+    end
+
+    # "model.class" gets injected automatically just before {Index}.
+    Home.({params: {}}).inspect.must_equal %{<Result:true #<Trailblazer::Context::Container wrapped_options={\"model.class\"=>Module} mutable_options=#<Trailblazer::Context::Container wrapped_options={:params=>{}} mutable_options={\"a\"=>Module}>> >}
+
+    # "model.class" gets injected by user and overrides class dependencies.
+    Home.({params: {}, "model.class" => Symbol}).inspect.must_equal %{<Result:true #<Trailblazer::Context::Container wrapped_options={\"model.class\"=>Module} mutable_options=#<Trailblazer::Context::Container wrapped_options={:params=>{}, \"model.class\"=>Symbol} mutable_options={\"a\"=>Symbol}>> >}
+
+
+    class Dashboard < Trailblazer::Operation
+      extend ClassDependencies
+      self["model.class"] = Float # this overrides {Index}'es dependency
+
+      pass ->(ctx, **) { ctx[:Dashboard] = ctx["model.class"] }
+      step Subprocess(Index)
+    end
+
+  # TODO: "model.class" gets injected automatically in {Dashboard} and overrides the {Index} input.
+    Dashboard.({params: {}}).inspect.must_equal %{<Result:true #<Trailblazer::Context::Container wrapped_options={\"model.class\"=>Module} mutable_options=#<Trailblazer::Context::Container wrapped_options={\"model.class\"=>Float} mutable_options=#<Trailblazer::Context::Container wrapped_options={\"model.class\"=>Float} mutable_options=#<Trailblazer::Context::Container wrapped_options={:params=>{}} mutable_options={:Dashboard=>Float, \"a\"=>Float}>>>> >}
+
   end
 
   describe "inheritance" do

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
 

data/test/step_test.rb

@@ -177,13 +177,13 @@ class StepTest < Minitest::Spec
   #-
   # not existent :name
   it do
-    op = assert_raises Trailblazer::Activity::DSL::Linear::Sequence::IndexError do
+    op = assert_raises Trailblazer::Activity::Adds::IndexError do
       class InvalidStep < Trailblazer::Operation
         step :a, before: "I don't exist!"
       end
     end
 
-    error_message = %{#<Trailblazer::Activity::DSL::Linear::Sequence::IndexError: StepTest::InvalidStep:
+    error_message = %{#<Trailblazer::Activity::Adds::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\"

data/trailblazer-operation.gemspec

@@ -17,8 +17,8 @@ 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-developer", ">= 0.0.21", "< 1.0.0"
+  spec.add_dependency "trailblazer-activity-dsl-linear",  ">= 1.0.0.beta1", "< 1.1.0"
+  spec.add_dependency "trailblazer-developer",            ">= 0.0.26"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "minitest"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-operation
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.8.0.beta1
 platform: ruby
 authors:
 - Nick Sutterer
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-12 00:00:00.000000000 Z
+date: 2022-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trailblazer-activity-dsl-linear
@@ -16,40 +16,34 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 1.0.0.beta1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 1.0.0.beta1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   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
+        version: 0.0.26
   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
+        version: 0.0.26
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -161,7 +155,7 @@ homepage: http://trailblazer.to
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -172,12 +166,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.8
-signing_key:
+rubygems_version: 3.2.3
+signing_key: 
 specification_version: 4
 summary: Trailblazer's operation object with railway flow and integrated error handling.
 test_files: