trailblazer-operation 0.6.1 → 0.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 569ffef484d0783c9f16d35ce6848f8506687140e3fede28f15ab506d832ad5c
-  data.tar.gz: e646b0c9b05dbaba40c136d8345c896727b30cfeba1ee62b5f180e87ff6c05b8
+  metadata.gz: bf82f1aa3080dfea1c9165859fdd6de207c9333cc3af7fb8c2e52fff55811ba2
+  data.tar.gz: c53369fe71b53e3ac3be42746d438c648b312a4d03956f483abd2d1e7e39cebb
 SHA512:
-  metadata.gz: 4d1f804fb97272a858374a5204b033e4ef3ee0a8fe29e29a36e6c3c9f0314b1059b4731b32e9aaf35a9e921b3158cfed53302e6b58fa3070bd3b89b239e49365
-  data.tar.gz: 03353eadeaa413e25ba9deb4847ddedf07827f8b71d16f943a5bf980c499eed231fa8158e60e4492bf449bdbc341c711c109c4fbbb77ade2c858e816a7aff0c9
+  metadata.gz: 98b29781915fdb5b40921dfd621a59dc580ce708e7ddaaf44b3123ee5a838ffde6a96cbe9b2d0cb24b15b60db3d2f5e166339253612786b96ebf5c5073e28fe6
+  data.tar.gz: 1481d504865240aeeee2bd254cfbc927156da7d465a408e42fc8936579984a95a80926356e6b5757d67ce8d814879f6aa22fc1678cd869345ac7be38b40d2e68

data/.gitignore

@@ -15,3 +15,4 @@ test/tmp
 test/version_tmp
 tmp
 /**/*.log
+.rubocop-*yml

data/.travis.yml

@@ -1,16 +1,13 @@
 language: ruby
 before_install:
   - gem install bundler -v 1.17.3
-matrix:
-  include:
-    # - rvm: 2.1.0
-    #   gemfile: Gemfile
-    - rvm: 2.2.4
-      gemfile: Gemfile
-    - rvm: 2.3.3
-      gemfile: Gemfile
-    - rvm: 2.4.0
-      gemfile: Gemfile
-    - rvm: 2.5.0
-      gemfile: Gemfile
-      script: bundle exec rake test
+rvm:
+  - ruby-head
+  - 2.7
+  - 2.6
+  - 2.5
+  - 2.4
+jobs:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: 2.7

data/CHANGES.md

@@ -1,3 +1,24 @@
+## 0.6.6
+
+* Rename `Operation.flow_options` to `Operation.flow_options_for_public_call`.
+* Operations can also accept `flow_options` at run-time now :beers:, giving them precedence over `Operation.flow_options_for_public_call`.
+
+## 0.6.5
+
+* Upgrade `trailblazer-activity` & `trailblazer-activity-dsl-linear` versions to utilise new `trailblazer-context` :drum:
+
+## 0.6.4
+
+* Remove container support. Containers should be part of `ctx` itself
+
+## 0.6.3
+
+* Require forwardable module from standard lib.
+
+## 0.6.2
+
+* Fix Trace so it works with Ruby <= 2.4
+
 ## 0.6.1
 
 * Reintroduce `ClassDependencies` by leveraging `State.fields`.

data/README.md

@@ -15,6 +15,6 @@ An operation can be used exaclty like an activity, including nesting, tracing, e
 
 ## Copyright
 
-Copyright (c) 2016 Nick Sutterer <apotonick@gmail.com>
+Copyright (c) 2016-2020 Nick Sutterer <apotonick@gmail.com>
 
 `trailblazer-operation` is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/lib/trailblazer/operation.rb

@@ -1,10 +1,10 @@
+require 'forwardable'
+require 'trailblazer/operation/version'
 require "trailblazer/option"
 require "trailblazer/context"
-require "trailblazer/container_chain"
 
 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
   class Activity
@@ -51,13 +51,6 @@ module Trailblazer
 
     require "trailblazer/operation/trace"
     extend Trace                   # ::trace
-
-    module 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
-    end
   end
 end
 
@@ -67,9 +60,4 @@ require "trailblazer/operation/deprecated_macro" # TODO: remove in 2.2.
 require "trailblazer/operation/result"
 require "trailblazer/operation/railway"
 
-require "trailblazer/developer"
-require "trailblazer/operation/trace"
-
 require "trailblazer/operation/railway/macaroni"
-
-require "trailblazer/operation/container"

data/lib/trailblazer/operation/class_dependencies.rb

@@ -12,21 +12,21 @@ class Trailblazer::Operation
       @state.update_options(options)
     end
 
-    def options_for_public_call(options, *)
+    def options_for_public_call(options, **flow_options)
       ctx = super
-      context_for_fields(class_fields, ctx)
+      context_for_fields(class_fields, [ctx, flow_options], {})
     end
 
     private def class_fields
       @state.to_h[:fields]
     end
 
-    private def context_for_fields(fields, ctx)
-      ctx_with_fields = Trailblazer::Context.implementation.build(fields, ctx, [ctx, {}], {}) # TODO: redundant to otions_for_public_call. how to inject aliasing etc?
+    private def context_for_fields(fields, (ctx, flow_options), **)
+      ctx_with_fields = Trailblazer::Context(fields, ctx, flow_options[:context_options]) # TODO: redundant to otions_for_public_call.
     end
 
     def call_with_circuit_interface((ctx, flow_options), **circuit_options)
-      ctx_with_fields = context_for_fields(class_fields, ctx)
+      ctx_with_fields = context_for_fields(class_fields, [ctx, flow_options], circuit_options)
 
       super([ctx_with_fields, flow_options], circuit_options) # FIXME: should we unwrap here?
     end

data/lib/trailblazer/operation/public_call.rb

@@ -19,15 +19,23 @@ module Trailblazer
       call_with_public_interface(options, *args)
     end
 
-    def call_with_public_interface(*args)
-      ctx = options_for_public_call(*args, flow_options())
+    # Default {@activity} call interface which doesn't accept {circuit_options}
+    #
+    # @param [Array] args => [ctx, flow_options]
+    #
+    # @return [Operation::Railway::Result]
+    #
+    # @private
+    def call_with_public_interface(options, flow_options = {})
+      flow_options  = flow_options_for_public_call(flow_options)
+      ctx           = options_for_public_call(options, flow_options)
 
       # call the activity.
       # This will result in invoking {::call_with_circuit_interface}.
       # last_signal, (options, flow_options) = Activity::TaskWrap.invoke(self, [ctx, {}], {})
       signal, (ctx, flow_options) = Activity::TaskWrap.invoke(
         @activity,
-        [ctx, flow_options()],
+        [ctx, flow_options],
         exec_context: new
       )
 
@@ -36,6 +44,13 @@ module Trailblazer
     end
 
     # This interface is used for all nested OPs (and the outer-most, too).
+    #
+    # @param [Array] args - Contains [ctx, flow_options]
+    # @param [Hash]  circuit_options - Options to configure activity circuit
+    #
+    # @return [signal, [ctx, flow_options]]
+    #
+    # @private
     def call_with_circuit_interface(args, circuit_options)
       strategy_call(args, circuit_options) # FastTrack#call
     end
@@ -46,13 +61,13 @@ module Trailblazer
 
     # Compile a Context object to be passed into the Activity::call.
     # @private
-    def self.options_for_public_call(options, **flow_options)
-      Trailblazer::Context.for_circuit(options, {}, [options, flow_options], {})
+    def self.options_for_public_call(options, flow_options = {})
+      Trailblazer::Context(options, {}, flow_options[:context_options])
     end
 
     # @semi=public
-    def flow_options
-      {context_alias: {}}
+    def flow_options_for_public_call(options = {})
+      options
     end
   end
 end

data/lib/trailblazer/operation/railway.rb

@@ -5,6 +5,10 @@ module Trailblazer
   class Operation
     # End event: All subclasses of End:::Success are interpreted as "success".
     module 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
       # @param options Context
       # @param end_event The last emitted signal in a circuit is usually the end event.
       def self.Result(end_event, options, *)

data/lib/trailblazer/operation/trace.rb

@@ -1,3 +1,6 @@
+require 'delegate'
+require "trailblazer/developer"
+
 module Trailblazer
   class Operation
     module Trace
@@ -31,7 +34,7 @@ module Trailblazer
         end
 
         def wtf
-          Trailblazer::Developer::Trace::Present.(@stack)
+          Developer::Trace::Present.(@stack)
         end
 
         def wtf?

data/lib/trailblazer/operation/version.rb

@@ -1,7 +1,7 @@
 module Trailblazer
   module Version
     module Operation
-      VERSION = "0.6.1"
+      VERSION = "0.6.6"
     end
   end
 end

data/test/docs/operation_test.rb

@@ -24,7 +24,6 @@ class DocsActivityTest < Minitest::Spec
     signal.inspect.must_equal %{#<Trailblazer::Activity::Railway::End::Success semantic=:success>}
   end
 
-  #:describe
   describe Memo::Create do
     it "creates a sane Memo instance" do
       #:call-public
@@ -39,8 +38,64 @@ class DocsActivityTest < Minitest::Spec
       result.success?.must_equal true
       result[:model].text.must_equal "Enjoy an IPA"
     end
+
+    it "allows indifferent access for ctx keys" do
+      #:ctx-indifferent-access
+      result = Memo::Create.(params: { text: "Enjoy an IPA" })
+
+      result[:params]     # => { text: "Enjoy an IPA" }
+      result['params']    # => { text: "Enjoy an IPA" }
+      #:ctx-indifferent-access end
+
+      result.success?.must_equal true
+      result[:params].must_equal({ text: "Enjoy an IPA" })
+      result['params'].must_equal({ text: "Enjoy an IPA" })
+    end
+
+    it "allows defining aliases for ctx keys" do
+      module AliasesExample
+        Memo = Struct.new(:text)
+
+        module Memo::Contract
+          Create = Struct.new(:sync)
+        end
+
+        #:ctx-aliases-step
+        class Memo::Create < Trailblazer::Operation
+          #~flow
+          step ->(ctx, **) { ctx[:'contract.default'] = Memo::Contract::Create.new }
+          #~flow end
+
+          pass :sync
+
+          def sync(ctx, contract:, **)
+            # ctx['contract.default'] == ctx[:contract]
+            contract.sync
+          end
+        end
+        #:ctx-aliases-step end
+      end
+
+      #:ctx-aliases
+      options = { params: { text: "Enjoy an IPA" } }
+      flow_options = {
+        context_options: {
+          aliases: { 'contract.default': :contract, 'policy.default': :policy },
+          container_class: Trailblazer::Context::Container::WithAliases,
+        }
+      }
+
+      result = AliasesExample::Memo::Create.(options, flow_options)
+
+      result['contract.default']  # => Memo::Contract::Create
+      result[:contract]           # => Memo::Contract::Create
+      #:ctx-aliases end
+
+      result.success?.must_equal true
+      _(result[:contract].class).must_equal AliasesExample::Memo::Contract::Create
+      _(result['contract.default']).must_equal result[:contract]
+    end
   end
-  #:describe end
 
   it do
     module J

data/test/docs/wiring_test.rb

@@ -245,9 +245,8 @@ describe all options :pass_fast, :fast_track and emiting signals directly, like
   end
 
   it "runs #create_model, only" do
-    Memo = FastTrack::Memo
     #:ft-call
-    result = Memo::Create.(create_empty_model: true)
+    result = FastTrack::Memo::Create.(create_empty_model: true)
     puts result.success?        #=> true
     puts result[:model].inspect #=> #<Memo text=nil>
     #:ft-call end
@@ -257,9 +256,8 @@ describe all options :pass_fast, :fast_track and emiting signals directly, like
   end
 
   it "fast-tracks in #assign_errors" do
-    Memo = FastTrack::Memo
     #:ft-call-err
-    result = Memo::Create.({})
+    result = FastTrack::Memo::Create.({})
     puts result.success?          #=> false
     puts result[:model].inspect   #=> #<Memo text=nil>
     puts result[:errors].inspect  #=> "Something went wrong!"
@@ -271,16 +269,15 @@ describe all options :pass_fast, :fast_track and emiting signals directly, like
   end
 
   it "goes till #save by emitting signals directly" do
-    Memo = FastTrack::Memo
-    result = Memo::Create.(params: {text: "Punk is not dead!"})
+    result = FastTrack::Memo::Create.(params: {text: "Punk is not dead!"})
     result.success?.must_equal true
     result[:model].id.must_equal 1
     result[:errors].must_be_nil
   end
 
+
   it "goes till #save by using signal helper" do
-    Memo = FastTrack::Memo
-    result = Memo::Create2.(params: {text: "Punk is not dead!"})
+    result = FastTrack::Memo::Create2.(params: {text: "Punk is not dead!"})
     result.success?.must_equal true
     result[:model].id.must_equal 1
     result[:errors].must_be_nil

data/test/operation_test.rb

@@ -79,8 +79,51 @@ class DeclarativeApiTest < Minitest::Spec
     step ->(options, **) { options["e"] = 2 }
   end
 
+  class Aliases < Update
+    def self.flow_options_for_public_call(*)
+      {
+        context_options: {
+          aliases: { 'b' => :settle },
+          container_class: Trailblazer::Context::Container::WithAliases,
+        }
+      }
+    end
+  end
+
   it "allows to inherit" do
     Upsert.("params" => {decide: true}).inspect("a", "b", "c", "d", "e").must_equal %{<Result:true [false, true, nil, 1, nil] >}
     Unset. ("params" => {decide: true}).inspect("a", "b", "c", "d", "e").must_equal %{<Result:true [false, true, nil, 1, 2] >}
   end
+
+  #---
+  #- ctx container
+  it do
+    options = { "params" => {decide: true} }
+
+    # Default call
+    result = Update.(options)
+    result.inspect("a", "b", "c").must_equal %{<Result:true [false, true, nil] >}
+
+    # Circuit interface call
+    signal, (ctx, _) = Update.([Update.options_for_public_call(options), {}], {})
+
+    signal.inspect.must_equal %{#<Trailblazer::Activity::Railway::End::Success semantic=:success>}
+    ctx.inspect.must_equal %{#<Trailblazer::Context::Container wrapped_options={\"params\"=>{:decide=>true}} mutable_options={\"a\"=>false, \"b\"=>true}>}
+
+    # Call by passing aliases as an argument.
+    result = Update.(
+      options,
+      {
+        context_options: {
+          aliases: { 'b' => :settle },
+          container_class: Trailblazer::Context::Container::WithAliases,
+        }
+      }
+    )
+    result[:settle].must_equal true
+
+    # Set aliases by overriding `flow_options` at the compile time.
+    result = Aliases.(options)
+    result[:settle].must_equal true
+  end
 end

data/test/step_test.rb

@@ -173,11 +173,12 @@ class StepTest < Minitest::Spec
   #-
   # not existent :name
   it do
-    assert_raises Trailblazer::Activity::DSL::Linear::Sequence::IndexError do
+    op = assert_raises Trailblazer::Activity::DSL::Linear::Sequence::IndexError do
       Class.new(Trailblazer::Operation) do
         step :a, before: "I don't exist!"
       end
-    end.inspect.must_equal %{#<Trailblazer::Activity::DSL::Linear::Sequence::IndexError: "I don't exist!">}
+    end
+    assert_match /<Trailblazer::Activity::DSL::Linear::Sequence::IndexError: "I don't exist!" is not a valid step ID. Did you mean any of these ?/, op.inspect
   end
 
   #---

data/test/test_helper.rb

@@ -1,7 +1,9 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "trailblazer/operation"
+
 require "pp"
 
 require "minitest/autorun"
-require "trailblazer/operation"
 require "trailblazer/activity/testing"
 require "trailblazer/developer/render/linear"
 

data/test/trace_test.rb

@@ -14,18 +14,13 @@ class TraceTest < Minitest::Spec
   end
   # raise Create["__task_wraps__"].inspect
 
-  it "allows using low-level Activity::Trace" do
-    ->(*args) { puts "@@@@@ #{args.last.inspect}"; Create.__call__(*args) }
-
-    stack, = Trailblazer::Developer::Trace.(
+  it "allows using low-level Operation::Trace" do
+    result = Trailblazer::Operation::Trace.(
       Create,
-      [
-        {a_return: true, params: {}},
-        {}
-      ]
+      { a_return: true, params: {} },
     )
 
-    puts output = Trailblazer::Developer::Trace::Present.(stack)
+    output = result.wtf
 
     output.gsub(/0x\w+/, "").gsub(/@.+_test/, "").must_equal %{`-- TraceTest::Create
     |-- Start.default

data/trailblazer-operation.gemspec

@@ -14,11 +14,11 @@ Gem::Specification.new do |spec|
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.test_files    = spec.files.grep(%r{^(test)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "trailblazer-activity-dsl-linear", ">= 0.2.6", "< 1.0.0"
-  spec.add_dependency "trailblazer-activity", ">= 0.10.0", "< 1.0.0"
+  spec.add_dependency "trailblazer-activity-dsl-linear", ">= 0.3.2", "< 1.0.0"
+  spec.add_dependency "trailblazer-activity", ">= 0.11.2", "< 1.0.0"
   spec.add_dependency "trailblazer-developer", ">= 0.0.8"
 
   spec.add_development_dependency "bundler"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-operation
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.6
 platform: ruby
 authors:
 - Nick Sutterer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-17 00:00:00.000000000 Z
+date: 2021-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trailblazer-activity-dsl-linear
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: 0.3.2
     - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: 0.3.2
     - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -36,7 +36,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.11.2
     - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -46,7 +46,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.11.2
     - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -138,7 +138,6 @@ 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/public_call.rb
 - lib/trailblazer/operation/railway.rb
@@ -155,7 +154,6 @@ files:
 - 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
 - test/gemfiles/Gemfile.ruby-1.9
 - test/gemfiles/Gemfile.ruby-2.0
@@ -179,7 +177,7 @@ homepage: http://trailblazer.to
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -195,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.8
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Trailblazer's operation object with railway flow and integrated error handling.
 test_files:
@@ -208,7 +206,6 @@ test_files:
 - 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
 - test/gemfiles/Gemfile.ruby-1.9
 - test/gemfiles/Gemfile.ruby-2.0

data/lib/trailblazer/operation/container.rb

@@ -1,14 +0,0 @@
-module Trailblazer
-  module Operation::Container
-    def options_for_public_call(options={}, *containers)
-      # generate the skill hash that embraces runtime options plus potential containers, the so called Runtime options.
-      # This wrapping is supposed to happen once in the entire system.
-
-      hash_transformer = ->(containers) { containers[0].to_hash } # FIXME: don't transform any containers into kw args.
-
-      immutable_options = Trailblazer::Context::ContainerChain.new([options, *containers], to_hash: hash_transformer)
-
-      Trailblazer::Context(immutable_options)
-    end
-  end
-end

data/test/dry_container_test.rb

@@ -1,25 +0,0 @@
-require "test_helper"
-require "dry/container"
-
-class DryContainerTest < Minitest::Spec
-  my_container = Dry::Container.new
-  my_container.register("user_repository", -> { Object })
-  my_container.namespace("contract") do
-    register("create") { Array }
-  end
-
-  class Create < Trailblazer::Operation
-    extend Trailblazer::Operation::Container
-  end
-
-  it "allows 2.2 call style" do
-    Create.({}, my_container)["user_repository"].must_equal Object
-  end
-
-  it { Create.({}, {}, my_container)["user_repository"].must_equal Object }
-  it { Create.({}, {}, my_container)["contract.create"].must_equal Array }
-  # also allows our own options PLUS containers.
-  it { Create.({}, {"model" => String}, my_container)["model"].must_equal String }
-  it { Create.({}, {"model" => String}, my_container)["user_repository"].must_equal Object }
-  it { Create.({}, {"user_repository" => Integer}, my_container)["user_repository"].must_equal Integer }
-end