trailblazer-operation 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3374814d5a9e505e40d20d3598a3d67fd868a476659ab7a1c73685aa7a8cc375
-  data.tar.gz: 1e26729cfc2319be1644de1bdb38bcf35715f25adc355ecdb386d7abc5cb158f
+  metadata.gz: 9087723ae9650669c304ea1451156be3a8b1d42cb04a46bd228ab7060b8b321c
+  data.tar.gz: 193d554218c156f0817692a6841ea55ddf5b87b537bc52957b586de5a6487826
 SHA512:
-  metadata.gz: 3d4b658f8f3c97d2b011949fbc19b2e58ea8e2b5ce192dd280540a6040429b20536ddb400f29c0a6be19a7588ab360f928071d2bcef6c69d88c84a24a9470abe
-  data.tar.gz: 05fc186cec428608351635c2e33f196489e4a813913574019ad1f95a1d90d0b974a2e0b33154ed0feb9d785eee962e7fc8205f11c364bf423e058ce484894398
+  metadata.gz: c60ef931a4c9f45be7285700d29e8ac5f5d912634df7fdbae07014283d1c60731469eececbe2aeecfa1bb8c3531ed9703b00d21e99be1d5f4c705624a1ff7821
+  data.tar.gz: d3684f685583bc322efd275fc8b14653cc408c4d56c18ab099753480166b0ad6882ad4cf9fa103bb781ca8d73b4f164f331abd7bc8396c7085bf748e828c3be3

data/Gemfile

@@ -20,4 +20,4 @@ gem "benchmark-ips"
 
 # gem "declarative", path: "../declarative"
 
-gem "trailblazer-activity"#, path: "../circuit"
+gem "trailblazer-activity", path: "../trailblazer-circuit"

data/lib/trailblazer/operation.rb

@@ -6,10 +6,11 @@ require "trailblazer/context"
 require "trailblazer/container_chain"
 
 require "trailblazer/activity"
-require "trailblazer/activity/magnetic"
+require "trailblazer/activity/dsl/magnetic"
 
 
 require "trailblazer/operation/variable_mapping"
+require "trailblazer/operation/callable"
 
 require "trailblazer/operation/heritage"
 require "trailblazer/operation/public_call"      # TODO: Remove in 3.0.
@@ -78,7 +79,7 @@ module Trailblazer
 
     class << self
       extend Forwardable # TODO: test those helpers
-      def_delegators :@activity, :Path, :Output, :End
+      def_delegators :@activity, :Path, :Output, :End, :Track
       def_delegators :@activity, :outputs, :debug
 
       def step(task, options={}, &block); add_task!(:step, task, options, &block) end

data/lib/trailblazer/operation/callable.rb

@@ -0,0 +1,42 @@
+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/version.rb

@@ -1,5 +1,5 @@
 module Trailblazer
   class Operation
-    VERSION = "0.2.2"
+    VERSION = "0.2.3"
   end
 end

data/test/callable_test.rb

@@ -0,0 +1,147 @@
+require "test_helper"
+
+class CallableHelper < Minitest::Spec
+  Operation = Trailblazer::Operation
+  Activity  = Trailblazer::Activity
+
+  module Blog
+    Read    = ->((options, *args), *) { options["Read"] = 1; [ Activity::Right, [options, *args] ] }
+    Next    = ->((options, *args), *) { options["NextPage"] = []; [ options["return"], [options, *args] ] }
+    Comment = ->((options, *args), *) { options["Comment"] = 2; [ Activity::Right, [options, *args] ] }
+  end
+
+  module User
+    Relax   = ->((options, *args), *) { options["Relax"]=true; [ Activity::Right, [options, *args] ] }
+  end
+
+  ### Callable( )
+  ###
+  describe "circuit with 1 level of nesting" do # TODO: test this kind of configuration in dsl_tests somewhere.
+    let(:blog) do
+      Module.new do
+        extend Activity::Path()
+
+        task task: Blog::Read
+        task task: Blog::Next, Output(Activity::Right, :done) => "End.success", Output(Activity::Left, :success) => Track(:success)
+        task task: Blog::Comment
+      end
+    end
+
+    let(:user) do
+      _blog = blog
+
+      Module.new do
+        extend Activity::Path()
+
+        task task: _blog, _blog.outputs[:success] => Track(:success)
+        task task: User::Relax
+      end
+    end
+
+    it "ends before comment, on next_page" do
+      user.( [options = { "return" => Activity::Right }] ).must_equal(
+        [user.outputs[:success].signal, [{"return"=>Trailblazer::Activity::Right, "Read"=>1, "NextPage"=>[], "Relax"=>true}]]
+      )
+
+      options.must_equal({"return"=>Trailblazer::Activity::Right, "Read"=>1, "NextPage"=>[], "Relax"=>true})
+    end
+  end
+
+  ### Callable( End1, End2 )
+  ###
+  describe "circuit with 2 end events in the nested process" do
+    let(:blog) do
+      Module.new do
+        extend Activity::Path()
+
+        task task: Blog::Read
+        task task: Blog::Next, Output(Activity::Right, :success___) => :__success, Output(Activity::Left, :retry___) => _retry=End(:retry)
+      end
+    end
+
+    let(:user) do
+      _blog = blog
+
+      Module.new do
+        extend Activity::Path()
+
+        task task: _blog, _blog.outputs[:success] => Track(:success), _blog.outputs[:retry] => "End.success"
+        task task: User::Relax
+      end
+    end
+
+    it "runs from Callable->default to Relax" do
+      user.( [ options = { "return" => Activity::Right } ] ).must_equal [
+        user.outputs[:success].signal,
+        [ {"return"=>Activity::Right, "Read"=>1, "NextPage"=>[], "Relax"=>true} ]
+      ]
+
+      options.must_equal({"return"=>Activity::Right, "Read"=>1, "NextPage"=>[], "Relax"=>true})
+    end
+
+    it "runs from other Callable end" do
+      user.( [ options = { "return" => Activity::Left } ] ).must_equal [
+        user.outputs[:success].signal,
+        [ {"return"=>Activity::Left, "Read"=>1, "NextPage"=>[]} ]
+      ]
+
+      options.must_equal({"return"=>Activity::Left, "Read"=>1, "NextPage"=>[]})
+    end
+
+    #---
+    #- Callable( activity, start_at )
+    let(:with_nested_and_start_at) do
+      _blog = blog
+
+      Module.new do
+        extend Activity::Path()
+
+        task task: Operation::Callable( _blog, task: Blog::Next ), _blog.outputs[:success] => Track(:success)
+        task task: User::Relax
+      end
+    end
+
+    it "runs Callable from alternative start" do
+      with_nested_and_start_at.( [options = { "return" => Activity::Right }] ).
+        must_equal [
+          with_nested_and_start_at.outputs[:success].signal,
+          [ {"return"=>Activity::Right, "NextPage"=>[], "Relax"=>true} ]
+        ]
+
+      options.must_equal({"return"=>Activity::Right, "NextPage"=>[], "Relax"=>true})
+    end
+
+    #---
+    #- Callable(  activity, call: :__call__ ) { ... }
+    describe "Callable with :call option" do
+      let(:process) do
+        class Workout
+          def self.__call__((options, *args), *)
+            options[:workout]   = 9
+
+            return Activity::Right, [options, *args]
+          end
+        end
+
+        subprocess = Operation::Callable( Workout, call: :__call__ )
+
+        Module.new do
+        extend Activity::Path()
+
+          task task: subprocess
+          task task: User::Relax
+        end
+      end
+
+      it "runs Callable process with __call__" do
+        process.( [options = { "return" => Activity::Right }] ).
+          must_equal [
+            process.outputs[:success].signal,
+            [{"return"=>Activity::Right, :workout=>9, "Relax"=>true}]
+          ]
+
+        options.must_equal({"return"=>Activity::Right, :workout=>9, "Relax"=>true})
+      end
+    end
+  end
+end

data/test/docs/operation_test.rb

@@ -0,0 +1,23 @@
+require "test_helper"
+
+class DocsActivityTest < Minitest::Spec
+  Memo = Struct.new(:body)
+
+  class Memo::Create < Trailblazer::Operation
+    step :create_model
+    def create_model(ctx, params:, **)
+      ctx[:model] = Memo.new(params[:body])
+    end
+  end
+
+  #:describe
+  describe Memo::Create do
+    it "creates a sane Memo instance" do
+      result = Memo::Create.( params: { body: "Enjoy an IPA" } )
+
+      result.success?.must_equal true
+      result[:model].body.must_equal "Enjoy an IPA"
+    end
+  end
+  #:describe end
+end

data/test/docs/wiring_test.rb

@@ -314,7 +314,7 @@ class WiringsDocSeqOptionsTest < Minitest::Spec
     Memo = Id::Memo
     #:id-inspect
     Trailblazer::Operation.introspect( Memo::Create )
-    #=> [>create_model,>validate_params,>save]
+    #=> [>create_memo,>validate_params,>save]
     #:id-inspect end
 
     Trailblazer::Operation.introspect( Memo::Create ).must_equal %{[>create_memo,>validate_params,>save]}
@@ -368,10 +368,10 @@ class WiringsDocRecoverTest < Minitest::Spec
   #:fail-success
   class Memo::Upload < Trailblazer::Operation
     step :upload_to_s3
-    fail :upload_to_azure,  Output(:success) => :success
-    fail :upload_to_b2,     Output(:success) => :success
+    fail :upload_to_azure,  Output(:success) => Track(:success)
+    fail :upload_to_b2,     Output(:success) => Track(:success)
     fail :log_problem
-    #~fail-success-methods
+    #~methods
     #:fail-success-s3
     def upload_to_s3(options, s3:, **)
       options[:s3] = s3 # the actual upload is dispatched here and result collected.
@@ -389,7 +389,7 @@ class WiringsDocRecoverTest < Minitest::Spec
     def log_problem(options, **)
       options[:problem] = "All uploads failed."
     end
-    #~fail-success-methods end
+    #~methods end
   end
   #:fail-success end
 
@@ -477,11 +477,11 @@ class WiringsDocDeciderTest < Minitest::Spec
 
   #:decider
   class Memo::Upsert < Trailblazer::Operation
-    step :find_model, Output(:failure) => :create_route
+    step :find_model, Output(:failure) => Track(:create_route)
     step :update
     step :create, magnetic_to: [:create_route]
     step :save
-    #~decm
+    #~methods
     def find_model(options, id:nil, **)
       options[:model] = Memo.find(id)
     end
@@ -498,7 +498,7 @@ class WiringsDocDeciderTest < Minitest::Spec
     def save(options, **)
       options[:save] = true
     end
-    #~decm end
+    #~methods end
   end
   #:decider end
 

data/test/fast_track_test.rb

@@ -126,8 +126,8 @@ 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::Activity::Subprocess( Edit, call: :__call__ ), id: "Subprocess/",
-          plus_poles: Trailblazer::Activity::Magnetic::DSL::PlusPoles::from_outputs( Edit.outputs ),
+        step task: Trailblazer::Operation::Callable( Edit, call: :__call__ ), id: "Callable/",
+          outputs: Edit.outputs ,
           fast_track: true
         step :b
         fail :f
@@ -151,8 +151,8 @@ class NestedFastTrackTest < Minitest::Spec
       Class.new(Trailblazer::Operation) do
         include Steps
 
-        step task: Trailblazer::Activity::Subprocess( Edit, call: :__call__ ), id: "Subprocess/",
-          plus_poles: Trailblazer::Activity::Magnetic::DSL::PlusPoles::from_outputs( Edit.outputs ) # all outputs given means it "works"
+        step task: Trailblazer::Operation::Callable( Edit, call: :__call__ ), id: "Callable/",
+          outputs: Edit.outputs  # all outputs given means it "works"
         step :b
         fail :f
       end
@@ -173,9 +173,9 @@ class NestedFastTrackTest < Minitest::Spec
       Class.new(Trailblazer::Operation) do
         include Steps
 
-        step({task: Trailblazer::Activity::Subprocess( Edit, call: :__call__ ), id: "Subprocess/",
-                  plus_poles: Trailblazer::Activity::Magnetic::DSL::PlusPoles::from_outputs( Edit.outputs )},
-          {Output(:pass_fast) => :success, Output(:fail_fast) => :failure} )# manually rewire the fast-track outputs to "conventional" railway ends.
+        step({task: Trailblazer::Operation::Callable( Edit, call: :__call__ ), 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.
 
         step :b
         fail :f

data/test/inspect_test.rb

@@ -31,9 +31,9 @@ class InspectTest < Minitest::Spec
  5 ============================>finalize!}
   end
 
-  describe "step with only one plus pole (happens with Nested)" do
+  describe "step with only one output (happens with Nested)" do
     class Present < Trailblazer::Operation
-      pass :ok!, plus_poles: Trailblazer::Activity::Magnetic::DSL::PlusPoles::from_outputs( :success => Trailblazer::Activity.Output("signal", :success) )
+      pass :ok!, outputs: {:success => Trailblazer::Activity::Output("signal", :success)}
     end
 
     it do

data/test/macro_test.rb

@@ -5,8 +5,6 @@ require "test_helper"
 # macro [ task, {name}, { alteration: }, {task_outputs} ] # for eg. nested
 
 class MacroTest < Minitest::Spec
-  PlusPoles = Trailblazer::Activity::Magnetic::DSL::PlusPoles
-
   MacroB = ->(( options, *args ), **) do
     options[:B] = true # we were here!
 
@@ -26,7 +24,7 @@ class MacroTest < Minitest::Spec
 
   class Create < Trailblazer::Operation
     step :a
-    step( task: MacroB, id: :MacroB, plus_poles: Test.plus_poles_for("Allgood" => :success, "Fail!" => :failure, "Winning" => :pass_fast) )
+    step task: MacroB, id: :MacroB, outputs: { :success => Activity::Output("Allgood", :success), :failure => Activity::Output("Fail!", :failure), :pass_fast => Activity::Output("Winning", :pass_fast) }
     step :c
 
     def a(options, **); options[:a] = true end
@@ -42,10 +40,11 @@ class MacroTest < Minitest::Spec
 
   #- user overrides :plus_poles
   class Update < Trailblazer::Operation
-    macro = { task: MacroB, id: :MacroB, plus_poles: Test.plus_poles_for("Allgood" => :success, "Fail!" => :failure, "Winning" => :pass_fast)  }
+    macro = { task: MacroB, id: :MacroB, outputs: { :success => Activity::Output("Allgood", :success), :failure => Activity::Output("Fail!", :failure), :pass_fast => Activity::Output("Winning", :pass_fast) } }
 
     step :a
-    step macro, plus_poles: Test.plus_poles_for("Allgood" => :failure, "Fail!" => :success, "Winning" => :fail_fast)
+    step macro, outputs: { :success => Activity::Output("Fail!", :success), :fail_fast => Activity::Output("Winning", :fail_fast), :failure => Activity::Output("Allgood", :failure) }
+    # plus_poles: Test.plus_poles_for("Allgood" => :failure, "Fail!" => :success, "Winning" => :fail_fast)
     step :c
 
     def a(options, **); options[:a] = true end

data/test/test_helper.rb

@@ -35,5 +35,5 @@ module Test
 end
 
 Minitest::Spec.class_eval do
-
+  Activity = Trailblazer::Activity
 end

data/test/trace_test.rb

@@ -12,7 +12,7 @@ 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.outputs[:success] => :success )
+    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"
 

data/test/wiring/defaults_test.rb

@@ -79,8 +79,8 @@ require "test_helper"
 class WireDefaultsEarlyExitSuccessTest < Minitest::Spec
   class Create < Trailblazer::Operation
     step :a
-    fail :b, Output(:success) => :success #{}"End.success"
-    fail :c, Output(:success) => :success
+    fail :b, Output(:success) => Track(:success) #{}"End.success"
+    fail :c, Output(:success) => Track(:success)
 
     Test.step(self, :a, :b, :c)
   end
@@ -99,7 +99,7 @@ class WireDefaultsEarlyExitSuccessTest < Minitest::Spec
 
 
 #   #---
-#   # with => :success, steps can still be added before End.success and they will be executed.
+#   # with => Track(:success), steps can still be added before End.success and they will be executed.
   class Update < Create
     pass :d
 

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.4.2", "< 0.5.0"
+  spec.add_dependency "trailblazer-activity", ">= 0.5.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.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-24 00:00:00.000000000 Z
+date: 2018-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trailblazer-activity
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.5.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.5.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: trailblazer-context
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +106,7 @@ files:
 - README.md
 - Rakefile
 - lib/trailblazer/operation.rb
+- lib/trailblazer/operation/callable.rb
 - lib/trailblazer/operation/deprecated_macro.rb
 - lib/trailblazer/operation/heritage.rb
 - lib/trailblazer/operation/inject.rb
@@ -123,9 +124,11 @@ files:
 - lib/trailblazer/operation/version.rb
 - test/benchmark/skill_resolver_benchmark.rb
 - test/call_test.rb
+- test/callable_test.rb
 - test/class_dependencies_test.rb
 - test/docs/doormat_test.rb
 - test/docs/macaroni_test.rb
+- test/docs/operation_test.rb
 - test/docs/wiring_test.rb
 - test/dry_container_test.rb
 - test/fast_track_test.rb
@@ -178,9 +181,11 @@ summary: Trailblazer's operation object with railway flow and integrated error h
 test_files:
 - test/benchmark/skill_resolver_benchmark.rb
 - test/call_test.rb
+- test/callable_test.rb
 - test/class_dependencies_test.rb
 - test/docs/doormat_test.rb
 - test/docs/macaroni_test.rb
+- test/docs/operation_test.rb
 - test/docs/wiring_test.rb
 - test/dry_container_test.rb
 - test/fast_track_test.rb