trailblazer-macro 2.1.7 → 2.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b94581daf3c1a0afeea2d8a3d9f470393b15fbfe57fe01dc29c5d1f247beb7c
-  data.tar.gz: dff368470d21d9fb0f9522bf610ef1e62b51eebf59f9c41f371298d12d11b8e5
+  metadata.gz: 639ab06bc834f5258e404d9c87e1e53db434884225e6f6c222afcb9df9597154
+  data.tar.gz: b5f08c21b83529cd8a12fed2e6ef3e638a9db546b2d57d651f3a9f9adec8ff3c
 SHA512:
-  metadata.gz: 0a2547701dec5fd643a229313dfeab1d047b1b469208ba54c950cf6f496ef07aa950e6674fb96221fea898dcaff8329f2f3d2ff1f9bec7fa0b758599a96e6329
-  data.tar.gz: a0fb745ffb5a9a313764a08972f5271f66e2f07c097759bd5cccb0521b1f80cf72eadaf3c71ae1dc5abdc8bd311abf0aabf6aed4dbea728328a9c590249d9e24
+  metadata.gz: ebf4969c76b10be6b3e842376ebbb6bb5fd73bd7a3c8fe1f6c61ab1efb9e8d945b3bb13404fcf6cdbead3590deb5cf9aeaf0150a32209d14107e2019981732ed
+  data.tar.gz: 5d485adedac0da50b68f3528ddaf80329f9d33a06cd6768e7a7c1d430c4f7ff05bf5daafbf14eb174fd821bbb5d1108150bbb278fbc7eacb960c26fd8f058cca

data/CHANGES.md

@@ -1,3 +1,12 @@
+# 2.1.9
+
+* Allow omitting `:params` when calling the operation by defaulting it to `{}` in `Model()`.
+* Use `dsl-linear` 0.5.0 and above, which allows removing `Inject()` uses.
+
+# 2.1.8
+
+Yanked due to inconsistency.
+
 # 2.1.7
 
 * Improve `Nested()` warning message.

data/README.md

@@ -2,7 +2,7 @@
 All common Macro's for Trailblazer::Operation, will come here
 
 ## TODO
-Describe the following Macro's:
+Describe the following Macros:
 - Nested
 - Rescue
 - Wrap

data/lib/trailblazer/macro/guard.rb

@@ -8,7 +8,6 @@ module Trailblazer::Macro
       def self.build(callable)
         option = Trailblazer::Option(callable)
 
-        # this gets wrapped in a Operation::Result object.
         ->((ctx, *), **circuit_args) do
           Trailblazer::Operation::Result.new(!!option.call(ctx, keyword_arguments: ctx.to_hash, **circuit_args), {})
         end

data/lib/trailblazer/macro/model.rb

@@ -2,38 +2,39 @@ module Trailblazer::Macro
 
   Linear = Trailblazer::Activity::DSL::Linear
 
-  def self.Model(model_class, action = nil, find_by_key = nil, id: 'model.build', not_found_terminus: false)
+  def self.Model(model_class = nil, action = :new, find_by_key = :id, id: 'model.build', not_found_terminus: false)
     task = Trailblazer::Activity::TaskBuilder::Binary(Model.new)
 
-    injection = Trailblazer::Activity::TaskWrap::Inject::Defaults::Extension(
-      :"model.class"          => model_class,
-      :"model.action"         => action,
-      :"model.find_by_key"    => find_by_key
-    )
+    injections = { # defaulting as per `:inject` API.
+      :"model.class"          => ->(*) { model_class },
+      :"model.action"         => ->(*) { action },
+      :"model.find_by_key"    => ->(*) { find_by_key },
+    }
+
+    options = {task: task, id: id, inject: [:params, injections]} # pass-through {:params} if it's in ctx.
 
-    options = { task: task, id: id, extensions: [injection] }
     options = options.merge(Linear::Output(:failure) => Linear::End(:not_found)) if not_found_terminus
 
     options
   end
 
   class Model
-    def call(options, params: nil,  **)
+    def call(ctx, params: {}, **)
       builder                 = Model::Builder.new
-      options[:model]         = model = builder.call(options, params)
-      options[:"result.model"] = result = Trailblazer::Operation::Result.new(!model.nil?, {})
+      ctx[:model]         = model = builder.call(ctx, params)
+      ctx[:"result.model"] = result = Trailblazer::Operation::Result.new(!model.nil?, {})
 
       result.success?
     end
 
     class Builder
-      def call(options, params)
-        action        = options[:"model.action"] || :new
-        model_class   = options[:"model.class"]
-        find_by_key   = options[:"model.find_by_key"] || :id
+      def call(ctx, params)
+        action        = ctx[:"model.action"]
+        model_class   = ctx[:"model.class"]
+        find_by_key   = ctx[:"model.find_by_key"]
         action        = :pass_through unless %i[new find_by].include?(action)
 
-        send("#{action}!", model_class, params, options[:"model.action"], find_by_key)
+        send("#{action}!", model_class, params, ctx[:"model.action"], find_by_key)
       end
 
       def new!(model_class, params, *)

data/lib/trailblazer/macro/policy.rb

@@ -8,35 +8,36 @@ module Trailblazer::Macro
         @path = path
       end
 
-      # incoming low-level {Task API}.
+      # incoming low-level {circuit interface}.
       # outgoing Task::Binary API.
-      def call((options, flow_options), **circuit_options)
-        condition = options[@path] # this allows dependency injection.
-        result    = condition.([options, flow_options], **circuit_options)
+      #
+      # Retrieve the injectable {condition}, execute it and interpret its {Result} object.
+      def call((ctx, flow_options), **circuit_options)
+        condition = ctx[@path] # this allows dependency injection.
+        result    = condition.([ctx, flow_options], **circuit_options)
 
-        options[:"policy.#{@name}"]        = result[:policy] # assign the policy as a skill.
-        options[:"result.policy.#{@name}"] = result
+        ctx[:"policy.#{@name}"]        = result[:policy] # assign the policy as a ctx variable.
+        ctx[:"result.policy.#{@name}"] = result
 
         # flow control
-        signal = result.success? ? Trailblazer::Activity::Right : Trailblazer::Activity::Left # since we & this, it's only executed OnRight and the return boolean decides the direction, input is passed straight through.
+        signal = result.success? ? Trailblazer::Activity::Right : Trailblazer::Activity::Left
 
-        return signal, [options, flow_options]
+        return signal, [ctx, flow_options]
       end
     end
 
-    # Adds the `yield` result to the pipe and treats it like a
+    # Adds the `yield` result to the Railway and treats it like a
     # policy-compatible  object at runtime.
-    def self.step(condition, options, &block)
-      name = options[:name]
+    def self.step(condition, name: nil, &block)
       path = :"policy.#{name}.eval"
-
       task = Eval.new(name: name, path: path)
 
-      injection = Trailblazer::Activity::TaskWrap::Inject::Defaults::Extension(
-        path => condition
-      )
+      injections = {
+        # :"policy.default.eval"
+        path => ->(*) { condition }
+      }
 
-      {task: task, id: path, extensions: [injection]}
+      {task: task, id: path, inject: [injections]}
     end
   end
 end

data/lib/trailblazer/macro/version.rb

@@ -1,7 +1,7 @@
 module Trailblazer
   module Version
     module Macro
-      VERSION = "2.1.7"
+      VERSION = "2.1.9"
     end
   end
 end

data/test/docs/model_test.rb

@@ -21,6 +21,17 @@ class DocsModelTest < Minitest::Spec
   end
   #:op end
 
+
+  it "defaults {:params} to empty hash when not passed" do
+    result = Create.({})
+    assert_equal true, result.success?
+    assert_equal %{#<struct DocsModelTest::Song id=nil, title=nil>}, result[:model].inspect
+
+    result = Update.({})
+    assert_equal false, result.success?
+    assert_equal "nil", result[:model].inspect
+  end
+
   it do
     #:create
     result = Create.(params: {})
@@ -126,13 +137,38 @@ class DocsModelTest < Minitest::Spec
     class Hit < Song
     end
 
+    #:di-model-class
     result = Create.(params: {}, :"model.class" => Hit)
+    #:di-model-class end
 
     result[:model].inspect.must_equal %{#<struct DocsModelTest::Hit id=nil, title=nil>}
 
   # inject all variables
-    result = Create.(params: {title: "Olympia"}, "model.class": Hit, "model.action": :find_by, "model.find_by_key": :title)
+    #:di-all
+    result = Create.(
+      params:               {title: "Olympia"}, # some random variable.
+      "model.class":        Hit,
+      "model.action":       :find_by,
+      "model.find_by_key": :title
+    )
+    #:di-all end
 
     result[:model].inspect.must_equal %{#<struct DocsModelTest::Hit id=2, title="Olympia">}
+
+  # use empty Model() and inject {model.class} and {model.action}
+    module A
+      #:op-model-empty
+      class Create < Trailblazer::Operation
+        step Model()
+        # ..
+      end
+      #:op-model-empty end
+    end # A
+
+    result = A::Create.(params: {}, :"model.class" => Hit)
+
+    result[:model].inspect.must_equal %{#<struct DocsModelTest::Hit id=nil, title=nil>}
+
+
   end
 end

data/trailblazer-macro.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "roar"
   spec.add_development_dependency "trailblazer-developer"
 
-  spec.add_dependency "trailblazer-activity-dsl-linear", ">= 0.4.0", "< 0.5.0"
+  spec.add_dependency "trailblazer-activity-dsl-linear", ">= 0.5.0", "< 0.6.0"
   spec.add_dependency "trailblazer-operation", ">= 0.7.0" # TODO: this dependency will be removed.
 
   spec.required_ruby_version = ">= 2.2.0"

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-macro
 version: !ruby/object:Gem::Version
-  version: 2.1.7
+  version: 2.1.9
 platform: ruby
 authors:
 - Nick Sutterer
 - Marc Tich
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-09 00:00:00.000000000 Z
+date: 2021-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -101,20 +101,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: trailblazer-operation
   requirement: !ruby/object:Gem::Requirement
@@ -173,7 +173,7 @@ homepage: http://trailblazer.to
 licenses:
 - LGPL-3.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -188,8 +188,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key:
+rubygems_version: 3.2.3
+signing_key: 
 specification_version: 4
 summary: 'Macros for Trailblazer''s operation: Policy, Wrap, Rescue and more.'
 test_files: