trailblazer-operation 0.9.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c019f1fb62cb71a67f95393c340495f3cd512c7914dffae69b8a8789a41b0a5
-  data.tar.gz: 79e8ef13bbc5193d66e5bd522e3991215f97b581c202bb8b78fde79e877e204e
+  metadata.gz: 00f1e4d05147c0c9434d2a72017c7ea452cd06a5bf5e90985f7f809f5246ac9b
+  data.tar.gz: 6508179d1158e4719f90e7e6a219676b47780468d99f58b6c4178f423415f6ca
 SHA512:
-  metadata.gz: 26a554047293b40351fccc08b2f06877d142d6c1e81f6aa1cec0e51e6c4fb8f33f680cf90d5a35437b62e1eb3549d3504f45c601fcb707c2765e286e4de87ff9
-  data.tar.gz: 30c55dd1a0d0edc75d4c1ff8bd5b66edb14250506eab46d9db090d1d4dbc35f8b0cd38d0abcdaa99d0f156578576461de281479014ac2028892ce31cefcdf519
+  metadata.gz: bc578ee53cf1f1ecbef264943841734cb250902c329f7866eec533553e720c58ac1d5f8edf3bf84405a138aa37f25a7abf01153458ce3d177833fe0e51f83801
+  data.tar.gz: b1972a63eddccb14fb5814c0e973543757feb56d62a0400be18da49ef8c0ca3ddda40aaef8d28983177783a48aa2345b8d86f4eaf52a43a098638956914ef60c

data/.github/workflows/ci.yml

@@ -1,6 +1,3 @@
-## This file is managed by Terraform.
-## Do not modify this file directly, as it may be overwritten.
-## Please open an issue instead.
 name: CI
 on: [push, pull_request]
 jobs:
@@ -8,7 +5,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.7, '3.0', '3.1']
+        ruby: [2.5, 2.6, 2.7, '3.0', '3.1', '3.2', 'jruby']
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3

data/CHANGES.md

@@ -1,3 +1,16 @@
+## 0.10.1
+
+* Deprecate `Operation.trace` and `Result#wtf?` in favor of `Operation.wtf?`.
+* Use `trailblazer-developer-0.1.0`.
+
+## 0.10.0
+
+* Require `trailblazer-activity-dsl-linear-1.2.0`.
+* Remove `Railway::Macaroni`.
+* Remove `Operation::Callable`.
+* Introduce `Operation::INITIAL_WRAP_STATIC` that is computed once at compile-time, not
+  with every `#call`.
+
 ## 0.9.0
 
 * Use `trailblazer-activity-dsl-linear` 1.1.0.

data/Gemfile

@@ -3,16 +3,9 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in trailblazer.gemspec
 gemspec
 
-gem "multi_json"
+# gem "trailblazer-developer",            path: "../trailblazer-developer"
+# gem "trailblazer-activity",             path: "../trailblazer-activity"
+# gem "trailblazer-activity-dsl-linear",  path: "../trailblazer-activity-dsl-linear"
 
-gem "dry-auto_inject"
-
-gem "benchmark-ips"
-gem "minitest-line"
-
-# gem "trailblazer-developer", path: "../trailblazer-developer"
-# gem "trailblazer-developer", git: "https://github.com/trailblazer/trailblazer-developer"
-# gem "trailblazer-activity", path: "../trailblazer-activity"
-# 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-activity",           github: "trailblazer/trailblazer-activity"
+# gem "trailblazer-developer",            github: "trailblazer/trailblazer-developer"

data/lib/trailblazer/operation/public_call.rb

@@ -77,16 +77,14 @@ module Trailblazer
     end
 
     # TODO: remove when we stop supporting < 3.0.
+    #       alternatively, ctx aliasing is only available for Ruby > 2.7.
     def call_with_flow_options(options, flow_options)
       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}.
+    # @private
+    def self.call_task(wrap_ctx, original_args) # DISCUSS: copied from {TaskWrap.call_task}.
       op = wrap_ctx[:task]
 
       original_arguments, original_circuit_options = original_args
@@ -100,5 +98,11 @@ module Trailblazer
 
       return wrap_ctx, original_args
     end
+
+    INITIAL_WRAP_STATIC = Activity::TaskWrap::Pipeline.new([Activity::TaskWrap::Pipeline.Row("task_wrap.call_task", method(:call_task))])
+
+    def initial_wrap_static
+      INITIAL_WRAP_STATIC
+    end
   end
 end

data/lib/trailblazer/operation/trace.rb

@@ -1,4 +1,4 @@
-require 'delegate'
+require "delegate"
 require "trailblazer/developer"
 
 module Trailblazer
@@ -13,7 +13,7 @@ module Trailblazer
 
         result = Railway::Result(signal, ctx) # redundant with PublicCall::call.
 
-        Result.new(result, stack.to_a)
+        Result.new(result, stack)
       end
 
       # `Operation::trace` is included for simple tracing of the flow.
@@ -22,7 +22,11 @@ module Trailblazer
       # @public
       #
       #   Operation.trace(params, current_user: current_user).wtf
+      # TODO: remove in 0.11.0.
       def trace(options)
+        Activity::Deprecate.warn Trace.find_caller_location_for_deprecated, %(Using `Operation.trace` is deprecated and will be removed in {trailblazer-operation-0.11.0}.
+  Please use `#{self}.wtf?` as documented here: https://trailblazer.to/2.1/docs/trailblazer#trailblazer-developer-wtf-)
+
         Trace.(self, options)
       end
 
@@ -30,6 +34,14 @@ module Trailblazer
         call_with_public_interface(options, {}, invoke_class: Developer::Wtf)
       end
 
+      # TODO: remove in 0.11.0.
+      def self.find_caller_location_for_deprecated
+        our_caller_locations = caller_locations.to_a
+        caller_location = our_caller_locations.reverse.find { |line| line.to_s =~ /operation\/trace/ }
+
+        _caller_location = our_caller_locations[our_caller_locations.index(caller_location)+1]
+      end
+
       # Presentation of the traced stack via the returned result object.
       # This object is wrapped around the original result in {Trace.call}.
       class Result < ::SimpleDelegator
@@ -38,12 +50,14 @@ module Trailblazer
           @stack = stack
         end
 
-        # TODO: deprecate!
+        # TODO: remove in 0.11.0.
         def wtf
+          Activity::Deprecate.warn Trace.find_caller_location_for_deprecated, %(Using `result.wtf?` is deprecated. Please use `#{@stack.to_a[0].task}.wtf?` and have a nice day.)
+
           Developer::Trace::Present.(@stack)
         end
 
-        # TODO: deprecate!
+        # TODO: remove in 0.11.0.
         def wtf?
           puts wtf
         end

data/lib/trailblazer/operation/version.rb

@@ -1,7 +1,7 @@
 module Trailblazer
   module Version
     module Operation
-      VERSION = "0.9.0"
+      VERSION = "0.10.1"
     end
   end
 end

data/lib/trailblazer/operation.rb

@@ -2,6 +2,9 @@ require "trailblazer/activity/dsl/linear"
 require 'forwardable'
 require 'trailblazer/operation/version'
 
+#
+# Developer's docs: https://trailblazer.to/2.1/docs/internals.html#internals-operation
+#
 module Trailblazer
   # As opposed to {Activity::Railway} and {Activity::FastTrack} an operation
   # maintains different terminus subclasses.
@@ -57,5 +60,3 @@ require "trailblazer/operation/deprecated_macro" # TODO: remove in 2.2.
 
 require "trailblazer/operation/result"
 require "trailblazer/operation/railway"
-
-require "trailblazer/operation/railway/macaroni"

data/test/step_test.rb

@@ -1,5 +1,7 @@
 require "test_helper"
 
+# TODO: throw away this test, most of it is tested in {dsl}.
+
 # Tests
 # ---  step ->(*) { snippet }
 # ---  step Callable
@@ -40,10 +42,18 @@ class StepTest < Minitest::Spec
 
   it { Create.(a: 1, b: 2, c: 3, d: 4, e: 5).inspect("a", "b", "c", "d", "e").must_equal "<Result:true [1, 2, 3, 4, 5] >" }
 
-  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.7.0")
-    it { Trailblazer::Developer.railway(Create).gsub(/0x.+?step_test.rb/, "").gsub(/\)\s.+?step_test.rb/, ") test/step_test.rb").must_equal %{[>#<Proc::30 (lambda)>,>StepTest::Callable,>#<Method: StepTest::Implementation.c(options, c: ..., **) test/step_test.rb:18>,>d,>MyMacro]} }
-  else
-    it { Trailblazer::Developer.railway(Create).gsub(/0x.+?step_test.rb/, "").must_equal %{[>#<Proc::30 (lambda)>,>StepTest::Callable,>#<Method: StepTest::Implementation.c>,>d,>MyMacro]} }
+  it "allows {Developer.railway}" do
+    output = Trailblazer::Developer.railway(Create)
+      .gsub(/0x.+?step_test.rb/, "")
+      .gsub(/\)\s.+?step_test.rb/, ") test/step_test.rb")
+
+    if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3.2.0")
+      assert_equal output, %([>#<Proc::32 (lambda)>,>StepTest::Callable,>#<Method: StepTest::Implementation.c(options, c: ...) test/step_test.rb:20>,>d,>MyMacro])
+    elsif Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.7.0")
+      assert_equal output, %([>#<Proc::32 (lambda)>,>StepTest::Callable,>#<Method: StepTest::Implementation.c(options, c: ..., **) test/step_test.rb:20>,>d,>MyMacro])
+    else
+      assert_equal output, %([>#<Proc::32 (lambda)>,>StepTest::Callable,>#<Method: StepTest::Implementation.c>,>d,>MyMacro])
+    end
   end
 
   #---
@@ -173,27 +183,6 @@ class StepTest < Minitest::Spec
   # FIXME: we have all fast track ends here.
   it { skip; Ii["__activity__"].circuit.instance_variable_get(:@map).size.must_equal 6 }
 
-  #---
-  #-
-  # not existent :name
-  it 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::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\"
-\"End.pass_fast\"
-\"End.fail_fast\"
-\"End.failure\"\e[0m>}
-
-    assert_match error_message, op.inspect
-  end
-
   #---
   #- :name
   #-   step :whatever, id: :validate

data/test/trace_test.rb

@@ -8,11 +8,35 @@ class TraceTest < Minitest::Spec
 
   class Create < Trailblazer::Operation
     step ->(options, a_return:, **) { options[:a] = a_return }, id: "Create.task.a"
-    step({task: B, id: "MyNested"}, B.to_h[:outputs][0] => Track(:success))
+    step Subprocess(B), id: "MyNested"
     step ->(options, **) { options[:c] = true }, id: "Create.task.c"
     step ->(_options, params:, **) { params.any? }, id: "Create.task.params"
   end
-  # raise Create["__task_wraps__"].inspect
+
+  it "deprecates {result.wtf?} and {Operation.trace}" do
+    output, warning = capture_io do
+      result = Create.trace({a_return: true, params: {}})
+      result.wtf?
+    end
+    line_no = __LINE__ - 2
+
+    assert_equal warning, %([Trailblazer] #{File.realpath(__FILE__)}:#{line_no - 1} Using `Operation.trace` is deprecated and will be removed in {trailblazer-operation-0.11.0}.
+  Please use `TraceTest::Create.wtf?` as documented here: https://trailblazer.to/2.1/docs/trailblazer#trailblazer-developer-wtf-
+[Trailblazer] #{File.realpath(__FILE__)}:#{line_no} Using `result.wtf?` is deprecated. Please use `TraceTest::Create.wtf?` and have a nice day.
+)
+    assert_equal output, %(TraceTest::Create
+|-- Start.default
+|-- Create.task.a
+|-- MyNested
+|   |-- Start.default
+|   |-- B.task.b
+|   |-- B.task.e
+|   `-- End.success
+|-- Create.task.c
+|-- Create.task.params
+`-- End.failure
+)
+  end
 
   it "allows using low-level Operation::Trace" do
     result = Trailblazer::Operation::Trace.(

data/trailblazer-operation.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["apotonick@gmail.com"]
   spec.description   = %q(Trailblazer's operation object.)
   spec.summary       = %q(Trailblazer's operation object with railway flow and integrated error handling.)
-  spec.homepage      = "http://trailblazer.to"
+  spec.homepage      = "https://trailblazer.to/2.1/docs/operation.html"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -17,13 +17,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "trailblazer-activity-dsl-linear",  ">= 1.1.0", "< 1.2.0"
-  spec.add_dependency "trailblazer-developer",            ">= 0.0.26"
+  spec.add_dependency "trailblazer-activity-dsl-linear",  ">= 1.2.0", "< 1.4.0"
+  spec.add_dependency "trailblazer-developer", ">= 0.1.0", "< 0.2.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-line"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rubocop"
 
-  spec.required_ruby_version = ">= 2.1.0"
+  spec.required_ruby_version = ">= 2.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-operation
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-14 00:00:00.000000000 Z
+date: 2023-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trailblazer-activity-dsl-linear
@@ -16,34 +16,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: trailblazer-developer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.26
+        version: 0.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.26
+        version: 0.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -73,7 +79,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest-line
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -87,7 +93,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -108,21 +114,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
-- ".github/workflows/ci_jruby.yml"
-- ".github/workflows/ci_legacy.yml"
-- ".github/workflows/ci_truffleruby.yml"
 - ".gitignore"
 - CHANGES.md
 - Gemfile
 - README.md
 - Rakefile
 - lib/trailblazer/operation.rb
-- lib/trailblazer/operation/callable.rb
 - lib/trailblazer/operation/class_dependencies.rb
 - lib/trailblazer/operation/deprecated_macro.rb
 - lib/trailblazer/operation/public_call.rb
 - lib/trailblazer/operation/railway.rb
-- lib/trailblazer/operation/railway/macaroni.rb
 - lib/trailblazer/operation/result.rb
 - lib/trailblazer/operation/trace.rb
 - lib/trailblazer/operation/version.rb
@@ -152,7 +153,7 @@ files:
 - test/wiring/defaults_test.rb
 - test/wiring/subprocess_test.rb
 - trailblazer-operation.gemspec
-homepage: http://trailblazer.to
+homepage: https://trailblazer.to/2.1/docs/operation.html
 licenses:
 - MIT
 metadata: {}
@@ -164,7 +165,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.github/workflows/ci_jruby.yml

@@ -1,19 +0,0 @@
-## This file is managed by Terraform.
-## Do not modify this file directly, as it may be overwritten.
-## Please open an issue instead.
-name: CI JRuby
-on: [push, pull_request]
-jobs:
-  test:
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [jruby, jruby-head]
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v3
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-        bundler-cache: true
-    - run: bundle exec rake

data/.github/workflows/ci_legacy.yml

@@ -1,19 +0,0 @@
-## This file is managed by Terraform.
-## Do not modify this file directly, as it may be overwritten.
-## Please open an issue instead.
-name: CI with EOL ruby versions
-on: [push, pull_request]
-jobs:
-  test:
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [2.5, 2.6]
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v3
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-        bundler-cache: true
-    - run: bundle exec rake

data/.github/workflows/ci_truffleruby.yml

@@ -1,19 +0,0 @@
-## This file is managed by Terraform.
-## Do not modify this file directly, as it may be overwritten.
-## Please open an issue instead.
-name: CI TruffleRuby
-on: [push, pull_request]
-jobs:
-  test:
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [truffleruby, truffleruby-head]
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v3
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-        bundler-cache: true
-    - run: bundle exec rake

data/lib/trailblazer/operation/callable.rb

@@ -1,42 +0,0 @@
-module Trailblazer
-  class Operation
-    # Use {Callable} if you have an operation or any other callable object that does
-    # _not_ expose an {Activity interface}. For example, {Operation.call} isn't compatible
-    # with activities, hence you need to decorate it using {Callable}. The returned object
-    # exposes an {Activity interface}.
-    #
-    # @param :call [Symbol] Method name to call
-    # @param options [Hash] Hash to merge into {circuit_options}, e.g. {:start_task}.
-    #
-    # @example Create and use a Callable instance.
-    #   callable = Trailblazer::Operation::Callable( Memo::Create, call: :__call__ )
-    #   callable.( [ctx, {}] ) #=> Activity interface, ::call will invoke Memo::Create.__call__.
-    def self.Callable(*args)
-      Callable.new(*args)
-    end
-
-    # Subprocess allows to have tasks with a different call interface and start event.
-    # @param activity any object with an {Activity interface}
-    class Callable
-      include Activity::Interface
-
-      def initialize(activity, call: :call, **options)
-        @activity = activity
-        @options  = options
-        @call     = call
-      end
-
-      def call(args, **circuit_options)
-        @activity.public_send(@call, args, circuit_options.merge(@options))
-      end
-
-      extend Forwardable
-      # @private
-      def_delegators :@activity, :to_h, :debug
-
-      def to_s
-        %{#<Trailblazer::Activity::Callable activity=#{@activity}>}
-      end
-    end
-  end
-end

data/lib/trailblazer/operation/railway/macaroni.rb

@@ -1,23 +0,0 @@
-module Trailblazer
-  module Operation::Railway
-    # Call the user's steps with a differing API (inspired by Maciej Mensfeld) that
-    # only receives keyword args. The `options` keyword is the stateful context object
-    #
-    #   def my_step( params:, ** )
-    #   def my_step( params:, options:, ** )
-    module Macaroni
-      def self.call(user_proc)
-        Activity::TaskBuilder::Task.new(Trailblazer::Option.build(Macaroni::Option, user_proc), user_proc)
-      end
-
-      class Option < Trailblazer::Option
-        # The Option#call! method prepares the arguments.
-        def self.call!(proc, options, *)
-          proc.(**options.to_hash.merge(options: options))
-        end
-      end
-    end
-
-    KwSignature = Macaroni
-  end
-end