trailblazer-operation 0.4.1 → 0.5.0

data/trailblazer-operation.gemspec

@@ -4,11 +4,11 @@ require 'trailblazer/operation/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "trailblazer-operation"
-  spec.version       = Trailblazer::Operation::VERSION
+  spec.version       = Trailblazer::Version::Operation::VERSION
   spec.authors       = ["Nick Sutterer"]
   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.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.license       = "MIT"
 
@@ -17,12 +17,13 @@ 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.7.1", "< 0.8.0"
+  spec.add_dependency "trailblazer-activity-dsl-linear", ">= 0.1.5", "< 1.0.0"
   spec.add_dependency "trailblazer-context", ">= 0.1.1", "< 0.3.0"
 
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop"
 
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = ">= 2.1.0"
 end

metadata

@@ -1,35 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-operation
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-18 00:00:00.000000000 Z
+date: 2019-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: trailblazer-activity
+  name: trailblazer-activity-dsl-linear
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.1.5
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.1.5
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: trailblazer-context
   requirement: !ruby/object:Gem::Requirement
@@ -64,6 +64,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -79,7 +93,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -100,6 +114,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - CHANGES.md
 - Gemfile
@@ -108,16 +124,12 @@ files:
 - lib/trailblazer/operation.rb
 - lib/trailblazer/operation/callable.rb
 - lib/trailblazer/operation/class_dependencies.rb
+- lib/trailblazer/operation/container.rb
 - lib/trailblazer/operation/deprecated_macro.rb
-- lib/trailblazer/operation/heritage.rb
-- lib/trailblazer/operation/inject.rb
 - lib/trailblazer/operation/inspect.rb
 - lib/trailblazer/operation/public_call.rb
 - lib/trailblazer/operation/railway.rb
-- lib/trailblazer/operation/railway/fast_track.rb
 - lib/trailblazer/operation/railway/macaroni.rb
-- lib/trailblazer/operation/railway/normalizer.rb
-- lib/trailblazer/operation/railway/task_builder.rb
 - lib/trailblazer/operation/result.rb
 - lib/trailblazer/operation/trace.rb
 - lib/trailblazer/operation/version.rb
@@ -138,14 +150,12 @@ files:
 - test/inheritance_test.rb
 - test/inspect_test.rb
 - test/introspect_test.rb
-- test/macro_test.rb
 - test/operation_test.rb
 - test/result_test.rb
 - test/ruby-2.0.0/operation_test.rb
 - test/ruby-2.0.0/step_test.rb
 - test/skill_test.rb
 - test/step_test.rb
-- test/task_wrap_test.rb
 - test/test_helper.rb
 - test/trace_test.rb
 - test/wire_test.rb
@@ -164,7 +174,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -194,14 +204,12 @@ test_files:
 - test/inheritance_test.rb
 - test/inspect_test.rb
 - test/introspect_test.rb
-- test/macro_test.rb
 - test/operation_test.rb
 - test/result_test.rb
 - test/ruby-2.0.0/operation_test.rb
 - test/ruby-2.0.0/step_test.rb
 - test/skill_test.rb
 - test/step_test.rb
-- test/task_wrap_test.rb
 - test/test_helper.rb
 - test/trace_test.rb
 - test/wire_test.rb

data/lib/trailblazer/operation/heritage.rb

@@ -1,30 +0,0 @@
-module Trailblazer
-  # This is copied from the Declarative gem. This might get removed in favor of a real heritage gem.
-  class Operation
-    class Heritage < Array
-      # Record inheritable assignments for replay in an inheriting class.
-      def record(method, *args, &block)
-        self << { method: method, args: args, block: block }
-      end
-
-      # Replay the recorded assignments on inheritor.
-      # Accepts a block that will allow processing the arguments for every recorded statement.
-      def call(inheritor, &block)
-        each { |cfg| call!(inheritor, cfg, &block) }
-      end
-
-    private
-      def call!(inheritor, cfg)
-        yield cfg if block_given? # allow messing around with recorded arguments.
-
-        inheritor.send(cfg[:method], *cfg[:args], &cfg[:block])
-      end
-
-      module Accessor
-        def heritage
-          @heritage ||= Heritage.new
-        end
-      end
-    end
-  end
-end

data/lib/trailblazer/operation/inject.rb

@@ -1,36 +0,0 @@
-module Trailblazer
-  module Operation::Wrap
-    module Inject
-      # Returns an Alteration wirings that, when applied, inserts the {ReverseMergeDefaults} task
-      # before the {Wrap::Call} task. This is meant for macros and steps that accept a dependency
-      # injection but need a default parameter to be set if not injected.
-      # @returns ADDS
-      def self.Defaults(default_dependencies)
-        Module.new do
-          extend Activity::Path::Plan()
-
-          task ReverseMergeDefaults.new( default_dependencies ),
-            id:     "ReverseMergeDefaults#{default_dependencies}",
-            before: "task_wrap.call_task"
-        end
-      end
-
-      # @api private
-      # @returns Task
-      # @param Hash list of key/value that should be set if not already assigned/set before (or injected from the outside).
-      class ReverseMergeDefaults
-        def initialize(defaults)
-          @defaults = defaults
-        end
-
-        def call((wrap_ctx, original_args), **circuit_options)
-          ctx = original_args[0][0]
-
-          @defaults.each { |k, v| ctx[k] ||= v }
-
-          return Activity::Right, [ wrap_ctx, original_args ]
-        end
-      end
-    end # Inject
-  end
-end

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

@@ -1,13 +0,0 @@
-module Trailblazer
-  module Operation::Railway
-    def self.fail!     ; Activity::Left  end
-    def self.pass!     ; Activity::Right end
-    def self.fail_fast!; Activity::FastTrack::FailFast end
-    def self.pass_fast!; Activity::FastTrack::PassFast end
-
-    module End
-      FailFast = Class.new(Operation::Railway::End::Failure)
-      PassFast = Class.new(Operation::Railway::End::Success)
-    end
-  end
-end

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

@@ -1,58 +0,0 @@
-module Trailblazer
-  module Operation::Railway
-    # The {Normalizer} is called for every DSL call (step/pass/fail etc.) and normalizes/defaults
-    # the user options, such as setting `:id`, connecting the task's outputs or wrapping the user's
-    # task via {TaskBuilder} in order to translate true/false to `Right` or `Left`.
-    #
-    # The Normalizer sits in the `@builder`, which receives all DSL calls from the Operation subclass.
-    module Normalizer
-      Pipeline = Activity::Magnetic::Normalizer::Pipeline.clone
-
-      Pipeline.module_eval do
-        # Handle the :override option which is specific to Operation.
-        def self.override(ctx, task:, options:, sequence_options:, **)
-          options, locals  = Activity::Magnetic::Options.normalize(options, [:override])
-          sequence_options = sequence_options.merge( replace: options[:id] ) if locals[:override]
-
-          ctx[:options], ctx[:sequence_options] = options, sequence_options
-        end
-
-        # TODO remove in 2.2
-        def self.deprecate_macro_with_two_args(ctx, task:, **)
-          return true unless task.is_a?(Array) # TODO remove in 2.2
-
-          ctx[:options] = Operation::DeprecatedMacro.( *task )
-        end
-
-        # TODO remove in 2.2
-        def self.deprecate_name(ctx, local_options:, connection_options:, **)
-          connection_options, deprecated_options = Activity::Magnetic::Options.normalize(connection_options, [:name])
-          local_options, _deprecated_options     = Activity::Magnetic::Options.normalize(local_options, [:name])
-
-          deprecated_options = deprecated_options.merge(_deprecated_options)
-
-          local_options = local_options.merge( name: deprecated_options[:name] ) if deprecated_options[:name]
-
-          local_options, locals = Activity::Magnetic::Options.normalize(local_options, [:name])
-          if locals[:name]
-            warn "[Trailblazer] The :name option for #step, #success and #failure has been renamed to :id."
-            local_options = local_options.merge(id: locals[:name])
-          end
-
-          ctx[:local_options], ctx[:connection_options] = local_options, connection_options
-        end
-
-        def self.raise_on_missing_id(ctx, local_options:, **)
-          raise "No :id given for #{local_options[:task]}" unless local_options[:id]
-          true
-        end
-
-        # add more normalization tasks to the existing Magnetic::Normalizer::Pipeline
-        task Activity::TaskBuilder::Binary( method(:deprecate_macro_with_two_args) ), before: "split_options"
-        task Activity::TaskBuilder::Binary( method(:deprecate_name) )
-        task Activity::TaskBuilder::Binary( method(:override) )
-        task Activity::TaskBuilder::Binary( method(:raise_on_missing_id) )
-      end
-    end # Normalizer
-  end
-end

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

@@ -1,37 +0,0 @@
-module Trailblazer
-  module Operation::Railway
-    # every step is wrapped by this proc/decider. this is executed in the circuit as the actual task.
-    # Step calls step.(options, **options, flow_options)
-    # Output direction binary: true=>Right, false=>Left.
-    # Passes through all subclasses of Direction.~~~~~~~~~~~~~~~~~
-    module TaskBuilder
-      def self.call(user_proc)
-        Task.new( Trailblazer::Option::KW( user_proc ), user_proc )
-      end
-
-      # Translates the return value of the user step into a valid signal.
-      # Note that it passes through subclasses of {Signal}.
-      def self.binary_direction_for(result, on_true, on_false)
-        result.is_a?(Class) && result < Activity::Signal ? result : (result ? on_true : on_false)
-      end
-    end
-
-    class Task
-      def initialize(task, user_proc)
-        @task      = task
-        @user_proc = user_proc
-        freeze
-      end
-
-      def call( (options, *args), **circuit_args )
-        # Execute the user step with TRB's kw args.
-        result = @task.( options, **circuit_args ) # circuit_args contains :exec_context.
-
-        # Return an appropriate signal which direction to go next.
-        direction = TaskBuilder.binary_direction_for( result, Activity::Right, Activity::Left )
-
-        [ direction, [ options, *args ], **circuit_args ]
-      end
-    end
-  end
-end

data/test/macro_test.rb

@@ -1,60 +0,0 @@
-require "test_helper"
-#- test
-# macro [ task, {name} ]
-# macro [ task, {name}, { alteration: } ] # see task_wrap_test.rb
-# macro [ task, {name}, { alteration: }, {task_outputs} ] # for eg. nested
-
-class MacroTest < Minitest::Spec
-  MacroB = ->(( options, *args ), **) do
-    options[:B] = true # we were here!
-
-    [ options[:MacroB_return], [ options, *args ] ]
-  end
-
-  it "raises exception when macro doesn't provide :id" do
-    assert_raises do
-
-      Class.new(Trailblazer::Operation) do
-        step( task: "<some macro>" )
-      end
-
-    end.message.must_equal %{No :id given for <some macro>}
-  end
-
-
-  class Create < Trailblazer::Operation
-    step :a
-    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
-    def c(options, **); options[:c] = true end
-  end
-
-  # MacroB returns Allgood and is wired to the :success edge (right track).
-  it { Create.( {}, MacroB_return: "Allgood" ).inspect(:a, :B, :c).must_equal %{<Result:true [true, true, true] >} }
-  # MacroB returns Fail! and is wired to the :failure edge (left track).
-  it { Create.( {}, MacroB_return: "Fail!" ).inspect(:a, :B, :c).must_equal %{<Result:false [true, true, nil] >} }
-  # MacroB returns Winning and is wired to the :pass_fast edge.
-  it { Create.( {}, MacroB_return: "Winning" ).inspect(:a, :B, :c).must_equal %{<Result:true [true, true, nil] >} }
-
-  #- user overrides :plus_poles
-  class Update < Trailblazer::Operation
-    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, 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
-    def c(options, **); options[:c] = true end
-  end
-
-  # MacroB returns Allgood and is wired to the :failure edge.
-  it { Update.( {}, MacroB_return: "Allgood" ).inspect(:a, :B, :c).must_equal %{<Result:false [true, true, nil] >} }
-  # MacroB returns Fail! and is wired to the :success edge.
-  it { Update.( {}, MacroB_return: "Fail!" ).inspect(:a, :B, :c).must_equal %{<Result:true [true, true, true] >} }
-  # MacroB returns Winning and is wired to the :fail_fast edge.
-  it { Update.( {}, MacroB_return: "Winning" ).inspect(:a, :B, :c).must_equal %{<Result:false [true, true, nil] >} }
-end

data/test/task_wrap_test.rb

@@ -1,97 +0,0 @@
-require "test_helper"
-
-require "trailblazer/operation/inject" # an optional feature.com.
-
-class TaskWrapTest < Minitest::Spec
-  MyMacro = ->( (options, *args), *) do
-    options["MyMacro.contract"] = options[:contract]
-    [ Trailblazer::Activity::Right, [options, *args] ]
-  end
-
-  class Create < Trailblazer::Operation
-    step :model!
-    # step [ MyMacro, { name: "MyMacro" }, { dependencies: { "contract" => :external_maybe } }]
-    step(
-      task: MyMacro,
-      id: "MyMacro",
-
-      Trailblazer::Activity::DSL::Extension.new(
-        Trailblazer::Activity::TaskWrap::Merge.new(
-          Module.new do
-            extend Trailblazer::Activity::Path::Plan()
-
-            task Trailblazer::Operation::Wrap::Inject::ReverseMergeDefaults.new( contract: "MyDefaultContract" ),
-              id:     "inject.my_default",
-              before: "task_wrap.call_task"
-          end
-        )
-      ) => true
-    )
-
-    def model!(options, **)
-      options["options.contract"] = options[:contract]
-      true
-    end
-  end
-
-  # 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
-  end
-
-  #-
-  # default gets set by Injection.
-  it do
-    result = Create.call( {} )
-
-    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
-    result = Create.call( { :contract=>"MyExternalContract" } )
-
-    inspect_hash(result, "options.contract", :contract, "MyMacro.contract").
-      must_equal %{{"options.contract"=>"MyExternalContract", :contract=>"MyExternalContract", "MyMacro.contract"=>"MyExternalContract"}}
-  end
-
-  #- Nested task_wraps should not override the outer.
-  AnotherMacro = ->( (options, *args), *) do
-    options["AnotherMacro.another_contract"] = options[:another_contract]
-    [ Trailblazer::Activity::Right, [options, *args] ]
-  end
-
-  class Update < Trailblazer::Operation
-    step(
-      task: ->( (options, *args), circuit_options ) {
-          _d, *o = Create.call( [ options, *args ], circuit_options )
-
-          [ Trailblazer::Activity::Right, *o ]
-        },
-      id: "Create"
-    )
-    step(
-      task:           AnotherMacro,
-      id:             "AnotherMacro",
-      Trailblazer::Activity::DSL::Extension.new(
-        Trailblazer::Activity::TaskWrap::Merge.new(
-          Module.new do
-            extend Trailblazer::Activity::Path::Plan()
-
-            task Trailblazer::Operation::Wrap::Inject::ReverseMergeDefaults.new( another_contract: "AnotherDefaultContract" ), id: "inject.my_default",
-            before: "task_wrap.call_task"
-          end
-        )
-      ) => true,
-    )
-  end
-
-  it do
-    result = Update.call( {} )
-
-    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