trailblazer-operation 0.6.5 → 0.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2908ffe1d690d0bd75b1e936b1351a4139405ed43ea43ce560c5b44c6c782e73
-  data.tar.gz: ee5ee4538ea0d59e266c7600f2ff2de20c79a9d66209063f1bdcb8530e296243
+  metadata.gz: bf82f1aa3080dfea1c9165859fdd6de207c9333cc3af7fb8c2e52fff55811ba2
+  data.tar.gz: c53369fe71b53e3ac3be42746d438c648b312a4d03956f483abd2d1e7e39cebb
 SHA512:
-  metadata.gz: a15078c7427fe6927af8e9782dbd919f60115fa5b4fb7c5aed039c5b3e3cb0ef2737373c797f0937a689b10c50e5089850a1c95d6ba6085483cc6a26d07e718b
-  data.tar.gz: 5e1a92c16c7ed05500dc28dfa1dccbc352a0d0d9efea28663cb93ff56a4b6e583474fa66062eb88b9fd6008dc84bd56008ebe2f83c8f73d76a688ddaf1fe7fb3
+  metadata.gz: 98b29781915fdb5b40921dfd621a59dc580ce708e7ddaaf44b3123ee5a838ffde6a96cbe9b2d0cb24b15b60db3d2f5e166339253612786b96ebf5c5073e28fe6
+  data.tar.gz: 1481d504865240aeeee2bd254cfbc927156da7d465a408e42fc8936579984a95a80926356e6b5757d67ce8d814879f6aa22fc1678cd869345ac7be38b40d2e68

data/CHANGES.md

@@ -1,3 +1,8 @@
+## 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:

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)
+    def self.options_for_public_call(options, flow_options = {})
       Trailblazer::Context(options, {}, flow_options[:context_options])
     end
 
     # @semi=public
-    def flow_options
-      {}
+    def flow_options_for_public_call(options = {})
+      options
     end
   end
 end

data/lib/trailblazer/operation/version.rb

@@ -1,7 +1,7 @@
 module Trailblazer
   module Version
     module Operation
-      VERSION = "0.6.5"
+      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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-operation
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.6.6
 platform: ruby
 authors:
 - Nick Sutterer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-20 00:00:00.000000000 Z
+date: 2021-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trailblazer-activity-dsl-linear
@@ -177,7 +177,7 @@ homepage: http://trailblazer.to
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -193,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: