trailblazer-operation 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d9e1d5b133331e52c4daa858d788d4a040be8d732b9038e6a8294e1ae868ba7
-  data.tar.gz: 07b4cfe11ffb833ad8b1681207eabaad2b4937fe0422eb920799fb3c238f2e39
+  metadata.gz: a9a083756bde5a10353633b2a91b40cb84fe5970a41d626e9ad1602359ed5bc7
+  data.tar.gz: c3a07f086acbb070d540078f5abaf6046b06a63347eb9ac5b602bbfdc0f320a2
 SHA512:
-  metadata.gz: d6e77202fc2c6497d6bc5d9819e6334f8ff5165f6d65eda01ef6efb5e4146e34fc9e7f1205266a652c826ddae525d1f8cc811203cd6be129338611096fe821a9
-  data.tar.gz: fbb8bdb761168cf7d361bb04014026aae6ecee8aa481294aca3e05732f769cb78a747176d59099d9468802e37a292a4c6a964d401154b810d98ee57717dda1b2
+  metadata.gz: 3af0ad462ec4085e622431ddbd752739b5e44ac3eb8c61547933e3e1cc76a6a3cdb2eb34130f0bf4f248639d7bd46c64d7b08b3c2cef6724705507c9550c3599
+  data.tar.gz: 19b63e1cb5778279b4d4dbc0cbe3deccaf935e60c724a2ccec35e99ea6018b586293edaa874a8f417b1a54a98d9c245d6a210c650fb95f9e9718ae10307aef96

data/CHANGES.md

@@ -14,6 +14,17 @@ lots of work on the DSL specific parts.
 
 params:, rest: ..
 
+## 0.3.0
+
+* Use `activity` 0.6.0.
+* Remove `Operation::__call__` in favor of one `call` that dispatches to either
+    * `call_with_public_interface` this implements the complicated public `Operation.()` semantic and will be faded out with the rise of workflow engines.
+    * `call_with_circuit_interface` is the circuit-compatible version that will be invoked on nested operations.
+
+    This might seem a bit "magical" but simplifies the interface a lot. In better languages, you could use method overloading for that, in Ruby, we have to
+    do that ourselves. This decision was made with the deprecation of `Operation.()` in mind. In the future, operations will mostly be invoked from
+    workflow engines and not directly, where the engine takes care of applying the correct interface.
+
 ## 0.2.5
 
 * Minor fixes for activity 0.5.2.

data/Gemfile

@@ -10,14 +10,6 @@ gem "dry-auto_inject"
 gem "minitest-line"
 gem "benchmark-ips"
 
-# gem "trailblazer-circuit", git: "https://github.com/trailblazer/trailblazer-circuit"
-# gem "trailblazer-activity", path: "../trailblazer-activity"
 # gem "trailblazer-developer", path: "../developer"
 # gem "trailblazer-developer", git: "https://github.com/trailblazer/trailblazer-developer"
-# gem "representable", path: "../representable"
-
-# gem "raise", path: "../raise"
-
-# gem "declarative", path: "../declarative"
-
-# gem "trailblazer-activity", path: "../trailblazer-circuit"
+gem "trailblazer-activity", path: "../trailblazer-activity"

data/lib/trailblazer/operation.rb

@@ -14,7 +14,7 @@ require "trailblazer/operation/callable"
 
 require "trailblazer/operation/heritage"
 require "trailblazer/operation/public_call"      # TODO: Remove in 3.0.
-require "trailblazer/operation/skill"
+require "trailblazer/operation/class_dependencies"
 require "trailblazer/operation/deprecated_macro" # TODO: remove in 2.2.
 require "trailblazer/operation/result"
 require "trailblazer/operation/railway"
@@ -57,17 +57,6 @@ module Trailblazer
     extend Activity::Interface
 
     module Process
-      # Call the actual {Process} with the options prepared in PublicCall.
-      #
-      # @private
-      def __call__(args, argumenter: [], **circuit_options)
-        @activity.( args, circuit_options.merge(
-            exec_context: new,
-            argumenter:  argumenter + [ Activity::TaskWrap.method(:arguments_for_call) ], # FIXME: should we move this outside?
-          )
-        )
-      end
-
       def to_h
         @activity.to_h.merge( activity: @activity )
       end
@@ -80,7 +69,7 @@ module Trailblazer
     class << self
       extend Forwardable # TODO: test those helpers
       def_delegators :@activity, :Path, :Output, :End, :Track
-      def_delegators :@activity, :outputs, :debug
+      def_delegators :@activity, :outputs
 
       def step(task, options={}, &block); add_task!(:step, task, options, &block) end
       def pass(task, options={}, &block); add_task!(:pass, task, options, &block) end

data/lib/trailblazer/operation/{skill.rb → class_dependencies.rb}

@@ -16,7 +16,7 @@ class Trailblazer::Operation
   # The use of this module is 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 __call__( (ctx, flow_options), **circuit_options )
+    def call_with_circuit_interface( (ctx, flow_options), **circuit_options )
       @skills.each { |name, value| ctx[name] ||= value } # this resembles the behavior in 2.0. we didn't say we liked it.
 
       super

data/lib/trailblazer/operation/public_call.rb

@@ -1,5 +1,5 @@
-class Trailblazer::Operation
-  module PublicCall
+module Trailblazer
+  module Operation::PublicCall
     # This is the outer-most public `call` method that gets invoked when calling `Create.()`.
     # The signature of this is `params, options, *containers`. This was a mistake, as the
     # first argument could've been part of `options` hash in the first place.
@@ -14,13 +14,29 @@ class Trailblazer::Operation
     # @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(*args)
-      ctx = PublicCall.options_for_public_call(*args)
+      return call_with_circuit_interface(*args) if args.any? && args[0].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.
+      call_with_public_interface(*args)
+    end
+
+    def call_with_public_interface(*args)
+      ctx = Operation::PublicCall.options_for_public_call(*args)
 
       # call the activity.
-      last_signal, (options, flow_options) = __call__( [ctx, {}] ) # Railway::call # DISCUSS: this could be ::call_with_context.
+      # This will result in invoking {::call_with_circuit_interface}.
+      last_signal, (options, flow_options) = Activity::TaskWrap.invoke(self, [ctx, {}], {})
 
       # Result is successful if the activity ended with an End event derived from Railway::End::Success.
-      Railway::Result(last_signal, options, flow_options)
+      Operation::Railway::Result(last_signal, options, flow_options)
+    end
+
+    # This interface is used for all nested OPs (and the outer-most, too).
+    def call_with_circuit_interface(args, circuit_options)
+      @activity.(
+        args,
+        circuit_options.merge(
+          exec_context: new
+        )
+      )
     end
 
     # Compile a Context object to be passed into the Activity::call.

data/lib/trailblazer/operation/trace.rb

@@ -6,18 +6,11 @@ module Trailblazer
         ctx = PublicCall.options_for_public_call(*args)   # redundant with PublicCall::call.
 
         # Prepare the tracing-specific arguments. This is only run once for the entire circuit!
-        operation, (options, flow_options), circuit_options = Trailblazer::Activity::Trace.arguments_for_call( operation, [ctx, {}], {} )
+        operation, *args = Trailblazer::Activity::Trace.arguments_for_call( operation, [ctx, {}], {} )
 
-        circuit_options = circuit_options.merge({ argumenter: [ Trailblazer::Activity::Introspect.method(:arguments_for_call) ] }) # this is called for every Activity.
+        last_signal, (ctx, flow_options) = Activity::TaskWrap.invoke(operation, *args )
 
-
-        last_signal, (options, flow_options) =
-          operation.__call__( # FIXME: this is the only problem.
-            [options, flow_options],
-            circuit_options
-          )
-
-        result = Railway::Result(last_signal, options)    # redundant with PublicCall::call.
+        result = Railway::Result(last_signal, ctx)    # redundant with PublicCall::call.
 
         Result.new(result, flow_options[:stack].to_a)
       end

data/lib/trailblazer/operation/version.rb

@@ -1,5 +1,5 @@
 module Trailblazer
   class Operation
-    VERSION = "0.2.5"
+    VERSION = "0.3.0"
   end
 end

data/test/callable_test.rb

@@ -96,7 +96,7 @@ class CallableHelper < Minitest::Spec
       Module.new do
         extend Activity::Path()
 
-        task task: Operation::Callable( _blog, task: Blog::Next ), _blog.outputs[:success] => Track(:success)
+        task task: Operation::Callable( _blog, start_task: Blog::Next ), _blog.outputs[:success] => Track(:success)
         task task: User::Relax
       end
     end

data/test/fast_track_test.rb

@@ -78,7 +78,7 @@ class FailFastBangTest < Minitest::Spec
   end
 
   # without proper configuration, emitting a FastTrack signal is illegal.
-  it { assert_raises(Trailblazer::Circuit::IllegalOutputSignalError) { Create.().inspect("x", "y", "a").must_equal %{<Result:false [true, nil, nil] >} } }
+  it { assert_raises(Trailblazer::Circuit::IllegalSignalError) { Create.().inspect("x", "y", "a").must_equal %{<Result:false [true, nil, nil] >} } }
 
   class Update < Trailblazer::Operation
     step ->(options, *) { options["x"] = true; Railway.fail_fast! }, fast_track: true
@@ -126,7 +126,7 @@ class NestedFastTrackTest < Minitest::Spec
   describe "Nested, fast_track: true and all its outputs given" do
     let(:update) do
       Class.new(Trailblazer::Operation) do
-        step task: Trailblazer::Operation::Callable( Edit, call: :__call__ ), id: "Callable/",
+        step task: Trailblazer::Operation::Callable( Edit, call: :call_with_circuit_interface ), id: "Callable/",
           outputs: Edit.outputs ,
           fast_track: true
         step :b
@@ -151,7 +151,7 @@ class NestedFastTrackTest < Minitest::Spec
       Class.new(Trailblazer::Operation) do
         include Steps
 
-        step task: Trailblazer::Operation::Callable( Edit, call: :__call__ ), id: "Callable/",
+        step task: Trailblazer::Operation::Callable( Edit, call: :call_with_circuit_interface ), id: "Callable/",
           outputs: Edit.outputs  # all outputs given means it "works"
         step :b
         fail :f
@@ -173,7 +173,7 @@ class NestedFastTrackTest < Minitest::Spec
       Class.new(Trailblazer::Operation) do
         include Steps
 
-        step({task: Trailblazer::Operation::Callable( Edit, call: :__call__ ), id: "Callable/",
+        step({task: Trailblazer::Operation::Callable( Edit, call: :call_with_circuit_interface ), id: "Callable/",
                   outputs: Edit.outputs },
           {Output(:pass_fast) => Track(:success), Output(:fail_fast) => Track(:failure)} )# manually rewire the fast-track outputs to "conventional" railway ends.
 

data/test/task_wrap_test.rb

@@ -15,7 +15,7 @@ class TaskWrapTest < Minitest::Spec
       task: MyMacro,
       id: "MyMacro",
 
-      extension: [
+      Trailblazer::Activity::DSL::Extension.new(
         Trailblazer::Activity::TaskWrap::Merge.new(
           Module.new do
             extend Trailblazer::Activity::Path::Plan()
@@ -25,7 +25,7 @@ class TaskWrapTest < Minitest::Spec
               before: "task_wrap.call_task"
           end
         )
-      ]
+      ) => true
     )
 
     def model!(options, **)
@@ -34,7 +34,7 @@ class TaskWrapTest < Minitest::Spec
     end
   end
 
-  # it { Create.__call__("adsf", options={}, {}).inspect("MyMacro.contract", "options.contract").must_equal %{} }
+  # it { Create.call("adsf", options={}, {}).inspect("MyMacro.contract", "options.contract").must_equal %{} }
 
   def inspect_hash(hash, *keys)
     Hash[ keys.collect { |key| [key, hash[key]] } ].inspect
@@ -43,17 +43,17 @@ class TaskWrapTest < Minitest::Spec
   #-
   # default gets set by Injection.
   it do
-    direction, (options, _) = Create.__call__( [{}, {}] )
+    result = Create.call( {} )
 
-    inspect_hash(options, "options.contract", :contract, "MyMacro.contract").
+    inspect_hash(result, "options.contract", :contract, "MyMacro.contract").
       must_equal %{{"options.contract"=>nil, :contract=>"MyDefaultContract", "MyMacro.contract"=>"MyDefaultContract"}}
   end
 
   # injected from outside, Injection skips.
   it do
-    direction, (options, _) = Create.__call__( [ { :contract=>"MyExternalContract" }, {} ] )
+    result = Create.call( { :contract=>"MyExternalContract" } )
 
-    inspect_hash(options, "options.contract", :contract, "MyMacro.contract").
+    inspect_hash(result, "options.contract", :contract, "MyMacro.contract").
       must_equal %{{"options.contract"=>"MyExternalContract", :contract=>"MyExternalContract", "MyMacro.contract"=>"MyExternalContract"}}
   end
 
@@ -65,8 +65,8 @@ class TaskWrapTest < Minitest::Spec
 
   class Update < Trailblazer::Operation
     step(
-      task: ->( (options, *args), * ) {
-          _d, *o = Create.__call__( [ options, *args ] )
+      task: ->( (options, *args), circuit_options ) {
+          _d, *o = Create.call( [ options, *args ], circuit_options )
 
           [ Trailblazer::Activity::Right, *o ]
         },
@@ -75,7 +75,7 @@ class TaskWrapTest < Minitest::Spec
     step(
       task:           AnotherMacro,
       id:             "AnotherMacro",
-      extension: [
+      Trailblazer::Activity::DSL::Extension.new(
         Trailblazer::Activity::TaskWrap::Merge.new(
           Module.new do
             extend Trailblazer::Activity::Path::Plan()
@@ -84,14 +84,14 @@ class TaskWrapTest < Minitest::Spec
             before: "task_wrap.call_task"
           end
         )
-      ]
+      ) => true,
     )
   end
 
   it do
-    direction, (options, _) = Update.__call__( [ {}, {} ] )
+    result = Update.call( {} )
 
-    inspect_hash(options, "options.contract", :contract, "MyMacro.contract", "AnotherMacro.another_contract").
+    inspect_hash(result, "options.contract", :contract, "MyMacro.contract", "AnotherMacro.another_contract").
       must_equal %{{"options.contract"=>nil, :contract=>"MyDefaultContract", "MyMacro.contract"=>"MyDefaultContract", "AnotherMacro.another_contract"=>"AnotherDefaultContract"}}
   end
 end

data/test/trace_test.rb

@@ -4,10 +4,6 @@ class TraceTest < Minitest::Spec
   class B < Trailblazer::Operation
     step ->(options, **) { options[:b] = true }, id: "B.task.b"
     step ->(options, **) { options[:e] = true }, id: "B.task.e"
-
-    def self.call( (options, flow_options), **circuit_options )
-      __call__( [Trailblazer::Context(options), flow_options], circuit_options )
-    end
   end
 
   class Create < Trailblazer::Operation
@@ -15,10 +11,6 @@ class TraceTest < Minitest::Spec
     step( {task: B, id: "MyNested"}, B.outputs[:success] => Track(:success) )
     step ->(options, **) { options[:c] = true }, id: "Create.task.c"
     step ->(options, params:, **) { params.any? }, id: "Create.task.params"
-
-    def self.call( (options, flow_options), **circuit_options )
-      __call__( [Trailblazer::Context(options), flow_options], circuit_options ) # FIXME.
-    end
   end
   # raise Create["__task_wraps__"].inspect
 
@@ -35,29 +27,31 @@ class TraceTest < Minitest::Spec
 
     puts output = Trailblazer::Activity::Trace::Present.tree(stack)
 
-    output.gsub(/0x\w+/, "").gsub(/@.+_test/, "").must_equal %{|-- #<Trailblazer::Activity::Start semantic=:default>
-|-- Create.task.a
-|-- MyNested
-|   |-- #<Trailblazer::Activity::Start semantic=:default>
-|   |-- B.task.b
-|   |-- B.task.e
-|   `-- #<Trailblazer::Operation::Railway::End::Success semantic=:success>
-|-- Create.task.c
-|-- Create.task.params
-`-- #<Trailblazer::Operation::Railway::End::Failure semantic=:failure>}
+    output.gsub(/0x\w+/, "").gsub(/@.+_test/, "").must_equal %{`-- 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 "Operation::trace" do
     result = Create.trace({ params: { x: 1 }, a_return: true })
-    result.wtf.gsub(/0x\w+/, "").gsub(/@.+_test/, "").must_equal %{|-- #<Trailblazer::Activity::Start semantic=:default>
-|-- Create.task.a
-|-- MyNested
-|   |-- #<Trailblazer::Activity::Start semantic=:default>
-|   |-- B.task.b
-|   |-- B.task.e
-|   `-- #<Trailblazer::Operation::Railway::End::Success semantic=:success>
-|-- Create.task.c
-|-- Create.task.params
-`-- #<Trailblazer::Operation::Railway::End::Success semantic=:success>}
+    result.wtf.gsub(/0x\w+/, "").gsub(/@.+_test/, "").must_equal %{`-- 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.success}
   end
 end

data/test/variable_mapping_test.rb

@@ -54,20 +54,17 @@ class VariableMappingTest < Minitest::Spec
         task Activity::TaskWrap::Output.new( uuid_output ), id: "task_wrap.output", before: "End.success", group: :end
       end
 
-      signal, (options, flow_options) = activity.(
-      [
-        options = { "a" => 1 },
-        {},
-      ],
-
-      wrap_runtime: runtime, # dynamic additions from the outside (e.g. tracing), also per task.
-      runner: Activity::TaskWrap::Runner,
-      argumenters: [ Activity::TaskWrap::NonStatic.method(:arguments_for_call) ],
-      wrap_static: Hash.new( Activity::TaskWrap.initial_activity ),
-    )
-
-    signal.must_equal activity.outputs[:success].signal
-    options.must_equal({"a"=>1, "model.a"=>4, "uuid.a" => 7 })
+      signal, (options, flow_options) = Activity::TaskWrap.invoke(activity,
+        [
+          options = { "a" => 1 },
+          {},
+        ],
+
+        wrap_runtime: runtime, # dynamic additions from the outside (e.g. tracing), also per task.
+      )
+
+      signal.must_equal activity.outputs[:success].signal
+      options.must_equal({"a"=>1, "model.a"=>4, "uuid.a" => 7 })
     end
   end
 end

data/trailblazer-operation.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "trailblazer-activity", ">= 0.5.2", "< 0.7.0"
+  spec.add_dependency "trailblazer-activity", ">= 0.6.0", "< 0.7.0"
   spec.add_dependency "trailblazer-context", ">= 0.1.1", "< 0.3.0"
 
   spec.add_development_dependency "bundler"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-operation
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-23 00:00:00.000000000 Z
+date: 2018-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trailblazer-activity
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: 0.6.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 0.7.0
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: 0.6.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 0.7.0
@@ -107,6 +107,7 @@ files:
 - 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/heritage.rb
 - lib/trailblazer/operation/inject.rb
@@ -118,7 +119,6 @@ files:
 - lib/trailblazer/operation/railway/normalizer.rb
 - lib/trailblazer/operation/railway/task_builder.rb
 - lib/trailblazer/operation/result.rb
-- lib/trailblazer/operation/skill.rb
 - lib/trailblazer/operation/trace.rb
 - lib/trailblazer/operation/variable_mapping.rb
 - lib/trailblazer/operation/version.rb