trailblazer-macro-contract 2.1.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 523435b29f2464a1677f6b430e8285b62841e4b24f4ebfdf19bcab531239ba70
-  data.tar.gz: 30cda42970110b3d8b280d002b785ada64445cb8212b1a6040432df5218f8fa4
+  metadata.gz: 88187712c7881802a2e78f5b21107505d78cb3a7fec0727503f92b02d6064115
+  data.tar.gz: 4a661ef7c3041fe6abad2222f913e32d86ee705e5c33d13496dd12f067520ee7
 SHA512:
-  metadata.gz: b9922fdf9cfac45598fe3d1d4672e708bacf54e41779b38d35e28dbfbee78de92eafe29bdabcda01369bbcf96265917129d0cdc0d8abcc85b1bf3cb2c3c4bbf3
-  data.tar.gz: bb8f91f57343237ac0995fa8f2516558ccabf799c9b0bf64c0c6024bae6a61285ba867bb97e1d10d2b99fc8e510ad611a6a523bf439d2df01f9ced40c6eeefa7
+  metadata.gz: 929fe8f1bc30baacfea1e0b256bd73f3c522593ffac98c44ff02ebea3a93c9e4e871b2fc426502e98c71f5b0909f04cbc4d2863136da000eec0197b06db83911
+  data.tar.gz: b348716b5567c9288b1909282c9c058c53fb775650cff6b10ed19eb6ad7dac179f379508012fa7ce50dca6f67ca671397d8cb9d546551a0ff07d4d4b35341fca

data/.github/workflows/ci.yml

@@ -0,0 +1,17 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
+        ruby: [2.5, 2.6, 2.7, '3.0', head, jruby, jruby-head]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - run: bundle exec rake

data/.rubocop-https---raw-githubusercontent-com-trailblazer-meta-master-rubocop-yml

@@ -26,6 +26,8 @@ Style/AndOr:
   EnforcedStyle: conditionals
 Style/AutoResourceCleanup:
   Enabled: true
+Style/CollectionMethods:
+  Enabled: true
 Style/Documentation:
   Enabled: false
 Style/EmptyLiteral:
@@ -47,6 +49,13 @@ Style/NumericLiterals:
   Enabled: false
 Style/OptionHash:
   Enabled: true
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    "%w": "[]"
+    "%W": "[]"
+    "%i": "[]"
+    "%I": "[]"
+    "%r": "()"
 Style/ReturnNil:
   Enabled: true
 Style/SafeNavigation:
@@ -85,24 +94,27 @@ Lint/UnreachableCode:
   Enabled: false
 Lint/Void:
   Enabled: false
+Layout/AlignHash:
+  EnforcedLastArgumentHashStyle: ignore_implicit
 Metrics/AbcSize:
   Max: 25
 Style/LambdaCall:
   Enabled: false
 Style/Semicolon:
   Enabled: false
-Naming/MethodParameterName:
+Naming/UncommunicativeMethodParamName:
   Enabled: false
 Style/ClassAndModuleChildren:
   Enabled: false
 Layout/LeadingCommentSpace:
   Exclude:
     - 'test/docs/**/*'
-Layout/HashAlignment:
+Layout/AlignHash:
   EnforcedHashRocketStyle: table
-  EnforcedColonStyle: table
 Style/FrozenStringLiteralComment:
   Enabled: false
+Layout/AlignHash:
+  EnforcedColonStyle: table
 SingleLineMethods:
   Enabled: false
 Style/Lambda:
@@ -120,8 +132,5 @@ Style/PercentLiteralDelimiters:
     "%r": '{}'
     "%w": '[]'
     "%": '{}'
-    "%W": '[]'
-    "%i": '[]'
-    "%I": '[]'
 Style/HashSyntax:
   Enabled: false

data/CHANGES.md

@@ -1,3 +1,9 @@
+# 2.1.2
+
+* Refactor `Contract::Build` to use TRB mechanics:
+    * `:input` and `:inject` to allow injection of the contract class.
+    * an `Option()` to wrap the builder code.
+
 # 2.1.1
 
 * Support for Ruby 3.0.

data/Gemfile

@@ -9,7 +9,6 @@ gem "dry-matcher"
 # gem "trailblazer-macro", path: "../trailblazer-macro"
 # gem "trailblazer-activity", path: "../trailblazer-activity"
 # gem "trailblazer-activity-dsl-linear", path: "../trailblazer-activity-dsl-linear"
-# gem "reform", path: "../reform"
 
 gem "minitest-line"
 

data/Rakefile

@@ -2,7 +2,7 @@ require "bundler/gem_tasks"
 require "rake/testtask"
 require "rubocop/rake_task"
 
-task :default => %i[test rubocop]
+task :default => %i[test]
 
 Rake::TestTask.new(:test) do |test|
   test.libs << 'test'

data/lib/trailblazer/macro/contract/build.rb

@@ -2,41 +2,51 @@ require "reform"
 
 module Trailblazer
   module Macro
-    module Contract
-      def self.Build(name: "default", constant: nil, builder: nil)
-        task = lambda do |(options, flow_options), **circuit_options|
-          result = Build.(options, circuit_options, name: name, constant: constant, builder: builder)
+    # This Circuit-task calls the {task} Option, then allows
+    # to run an arbitary block to process the option's result.
+    # @private
+    class CircuitTaskWithResultProcessing < Activity::TaskBuilder::Task # DISCUSS: extract to public?
+      def initialize(task, user_proc, block)
+        @block = block
+        super(task, user_proc)
+      end
 
-          return Activity::TaskBuilder.binary_signal_for(result, Activity::Right, Activity::Left),
-              [options, flow_options]
-        end
+      def call_option(task_with_option_interface, (ctx, flow_options), **circuit_options)
+        result = super
 
-        {task: task, id: "contract.build"}
+        @block.call(result, ctx)
       end
+    end
 
-      module Build
-        # Build contract at runtime.
-        def self.call(options, circuit_options, name: "default", constant: nil, builder: nil)
-          # TODO: we could probably clean this up a bit at some point.
-          contract_class = constant || options[:"contract.#{name}.class"] # DISCUSS: Injection possible here?
-          model          = options[:model]
-          name           = :"contract.#{name}"
+    module Contract
+      def self.Build(name: "default", constant: nil, builder: nil)
+        contract_path     = :"contract.#{name}"
 
-          options[name] = if builder
-                            call_builder(options, circuit_options, builder: builder, constant: contract_class, name: name)
-                          else
-                            contract_class.new(model)
-                          end
-        end
+        build_injections  = {"#{contract_path}.class": ->(*) { constant }} # default to {constant} if not injected.
 
-        def self.call_builder(ctx, circuit_options, builder: raise, constant: raise, name: raise)
-          tmp_options = ctx.to_hash.merge(
+        input = ->(ctx, **) do
+          ctx.to_hash.merge(
             constant: constant,
-            name:     name
+            name:     contract_path
           )
-
-          Trailblazer::Option(builder).(ctx, keyword_arguments: tmp_options, **circuit_options) # TODO: why can't we build the {builder} at compile time?
         end
+
+        default_contract_builder = ->(ctx, model: nil, **) { ctx[:"#{contract_path}.class"].new(model) }
+
+        # proc is called via {Option()}.
+        task_option_proc = builder ? builder : default_contract_builder
+
+        # after the builder proc is run, assign its result to {:"contract.default"}.
+        ctx_assign_block = ->(result, ctx) { ctx[contract_path] = result }
+
+        task = CircuitTaskWithResultProcessing.new(Trailblazer::Option(task_option_proc), task_option_proc, ctx_assign_block)
+
+        {
+          task:   task, id: "contract.build",
+          inject: [build_injections],
+          input:  input,
+          output: [contract_path]
+        }
       end
 
       module DSL

data/lib/trailblazer/macro/contract/validate.rb

@@ -6,15 +6,22 @@ module Trailblazer
       # Deviate to left track if optional key is not found in params.
       # Deviate to left if validation result falsey.
       def self.Validate(skip_extract: false, name: "default", representer: false, key: nil, constant: nil, invalid_data_terminus: false) # DISCUSS: should we introduce something like Validate::Deserializer?
-        params_path = :"contract.#{name}.params" # extract_params! save extracted params here.
+        contract_path = :"contract.#{name}" # the contract instance
+        params_path   = :"contract.#{name}.params" # extract_params! save extracted params here.
+        key_path      = :"contract.#{name}.extract_key"
 
-        extract  = Validate::Extract.new(key: key, params_path: params_path).freeze
-        validate = Validate.new(name: name, representer: representer, params_path: params_path, constant: constant).freeze
+        extract  = Validate::Extract.new(key_path: key_path, params_path: params_path)
+        validate = Validate.new(name: name, representer: representer, params_path: params_path, contract_path: contract_path)
+
+        # These are defaulting dependency injection, more here
+        # https://trailblazer.to/2.1/docs/activity.html#activity-dependency-injection-inject-defaulting
+        extract_injections  = {key_path => ->(*) { key }} # default to {key} if not injected.
+        validate_injections = {contract_path => ->(*) { constant }} # default the contract instance to {constant}, if not injected (or passed down from {Build()})
 
         # Build a simple Railway {Activity} for the internal flow.
         activity = Class.new(Activity::Railway(name: "Contract::Validate")) do
-          step extract,  id: "#{params_path}_extract", Output(:failure) => End(:extract_failure) unless skip_extract# || representer
-          step validate, id: "contract.#{name}.call"
+          step extract,  id: "#{params_path}_extract", Output(:failure) => End(:extract_failure), inject: [extract_injections] unless skip_extract# || representer
+          step validate, id: "contract.#{name}.call", inject: [validate_injections]
         end
 
         options = activity.Subprocess(activity)
@@ -32,17 +39,18 @@ module Trailblazer
       class Validate
         # Task: extract the contract's input from params by reading `:key`.
         class Extract
-          def initialize(key: nil, params_path: nil)
-            @key, @params_path = key, params_path
+          def initialize(key_path: nil, params_path: nil)
+            @key_path, @params_path = key_path, params_path
           end
 
           def call(ctx, params: {}, **)
-            ctx[@params_path] = @key ? params[@key] : params
+            key = ctx[@key_path] # e.g. {:song}.
+            ctx[@params_path] = key ? params[key] : params
           end
         end
 
-        def initialize(name: "default", representer: false, params_path: nil, constant: nil)
-          @name, @representer, @params_path, @constant = name, representer, params_path, constant
+        def initialize(name: "default", representer: false, params_path: nil, contract_path: )
+          @name, @representer, @params_path, @contract_path = name, representer, params_path, contract_path
         end
 
         # Task: Validates contract `:name`.
@@ -54,20 +62,19 @@ module Trailblazer
           )
         end
 
-        def validate!(options, representer: false, from: :document, params_path: nil)
-          path     = :"contract.#{@name}"
-          contract = @constant || options[path]
+        def validate!(ctx, representer: false, from: :document, params_path: nil)
+          contract = ctx[@contract_path] # grab contract instance from "contract.default" (usually set in {Contract::Build()})
 
           # this is for 1.1-style compatibility and should be removed once we have Deserializer in place:
-          options[:"result.#{path}"] = result =
+          ctx[:"result.#{@contract_path}"] = result =
             if representer
               # use :document as the body and let the representer deserialize to the contract.
               # this will be simplified once we have Deserializer.
               # translates to contract.("{document: bla}") { MyRepresenter.new(contract).from_json .. }
-              contract.(options[from]) { |document| representer.new(contract).parse(document) }
+              contract.(ctx[from]) { |document| representer.new(contract).parse(document) }
             else
               # let Reform handle the deserialization.
-              contract.(options[params_path])
+              contract.(ctx[params_path])
             end
 
           result.success?

data/lib/trailblazer/macro/contract/version.rb

@@ -2,7 +2,7 @@ module Trailblazer
   module Version
     module Macro
       module Contract
-      VERSION = "2.1.1"
+        VERSION = "2.1.2"
       end
     end
   end

data/test/docs/contract_test.rb

@@ -67,7 +67,11 @@ class DocsContractOverviewTest < Minitest::Spec
     |   `-- End.failure
     `-- End.failure}
   end
+
+  # internal variables from {:builder} are excluded in public ctx.
+  it { Create.(params: {}).keys.inspect.must_equal %{[:params, :model, :\"result.model\", :\"contract.default\", :\"contract.default.params\", :\"representer.default.class\", :\"result.contract.default\"]} }
 end
+
 #---
 # contract MyContract
 class DocsContractExplicitTest < Minitest::Spec
@@ -257,6 +261,42 @@ class DocsContractKeyTest < Minitest::Spec
   end
 end
 
+#---
+#- Validate() with injected {:"contract.default.extract_key"}
+class DocsContractInjectedKeyTest < Minitest::Spec
+  Song = Class.new(ContractConstantTest::Song)
+
+  module Song::Contract
+    Create = ContractConstantTest::Song::Contract::Create
+  end
+
+  #:inject-key-op
+  class Song::Create < Trailblazer::Operation
+    #~meths
+    step Model(Song, :new)
+    step Contract::Build(constant: Song::Contract::Create)
+    #~meths end
+    step Contract::Validate() # we don't define a key here! E.g. {key: "song"}
+    step Contract::Persist()
+  end
+  #:inject-key-op end
+
+  # empty {:params}, validation fails
+  it { Song::Create.(params: {}).inspect(:model, "result.contract.default.extract").must_equal %{<Result:false [#<struct DocsContractInjectedKeyTest::Song title=nil, length=nil>, nil] >} }
+  # no {:key} injected/defined, we don't find the data in {params}.
+  it { Song::Create.(params: {"song" => { title: "SVG", length: 13 }}).inspect(:model, "result.contract.default.extract").must_equal %{<Result:false [#<struct DocsContractInjectedKeyTest::Song title=nil, length=nil>, nil] >} }
+  # {:key} defined and everything works smoothly
+  it {
+    params = {"song" => { title: "SVG", length: 13 }}
+    #:inject-key-call
+    res = Song::Create.(
+      params:                         params,
+      "contract.default.extract_key": "song"
+    )
+    #:inject-key-call end
+    .inspect(:model).must_equal %{<Result:true [#<struct DocsContractInjectedKeyTest::Song title=\"SVG\", length=13>] >} }
+end
+
 #---
 #- Validate( key: :song ), Output(:extract_failure) => End(:my_new_end)
 class DocsContractKeyWithOutputTest < Minitest::Spec
@@ -297,6 +337,37 @@ class DocsContractKeyWithOutputTest < Minitest::Spec
   end
 end
 
+#---
+#- Validate() with injected {:"contract.default"} and no `Build()`.
+class DocsContractInjectedContractTest < Minitest::Spec
+  Song = Class.new(ContractConstantTest::Song)
+
+  module Song::Contract
+    Create = ContractConstantTest::Song::Contract::Create
+  end
+
+  #:inject-contract-op
+  class Song::Create < Trailblazer::Operation
+    # we omit the {Model()} call as the run-time contract contains the model.
+    # we don't have a {Contract::Build()} step here.
+    step Contract::Validate(key: "song") # you could use an injection here, too!
+    step Contract::Persist()
+  end
+  #:inject-contract-op end
+
+  it {
+    params = {"song" => { title: "SVG", length: 13 }}
+    #:inject-contract-call
+    res = Song::Create.(
+      params:             params,
+      "contract.default": Song::Contract::Create.new(Song.new) # we build the contract ourselves!
+    )
+    #:inject-contract-call end
+    res.inspect(:model).must_equal %{<Result:true [nil] >}
+    res[:"contract.default"].model.inspect.must_equal %{#<struct DocsContractInjectedContractTest::Song title=\"SVG\", length=13>}
+  }
+end
+
 #---
 #- Validate( name: "default", invalid_data_terminus: true )
 class DocsContractInvalidEndTest < Minitest::Spec
@@ -377,24 +448,24 @@ class ContractInjectConstantTest < Minitest::Spec
   end
   #:di-constant-contract end
   #:di-constant
-  class Create < Trailblazer::Operation
-    step Model( Song, :new )
-    step Contract::Build()
+  class Song::Create < Trailblazer::Operation
+    step Model(Song, :new)
+    step Contract::Build() # no constant provided here!
     step Contract::Validate()
-    step Contract::Persist( method: :sync )
+    step Contract::Persist(method: :sync)
   end
   #:di-constant end
 
   it do
     #:di-contract-call
-    Create.(
-      params: { title: "Anthony's Song" },
-      :"contract.default.class" => MyContract
+    Song::Create.(
+      params:                   { title: "Anthony's Song" },
+      "contract.default.class": MyContract # dependency injection!
     )
     #:di-contract-call end
   end
-  it { Create.(params: { title: "A" }, :"contract.default.class" => MyContract).inspect(:model).must_equal %{<Result:false [#<struct ContractInjectConstantTest::Song id=nil, title=nil>] >} }
-  it { Create.(params: { title: "Anthony's Song" }, :"contract.default.class" => MyContract).inspect(:model).must_equal %{<Result:true [#<struct ContractInjectConstantTest::Song id=nil, title="Anthony's Song">] >} }
+  it { Song::Create.(params: { title: "A" }, :"contract.default.class" => MyContract).inspect(:model).must_equal %{<Result:false [#<struct ContractInjectConstantTest::Song id=nil, title=nil>] >} }
+  it { Song::Create.(params: { title: "Anthony's Song" }, :"contract.default.class" => MyContract).inspect(:model).must_equal %{<Result:true [#<struct ContractInjectConstantTest::Song id=nil, title="Anthony's Song">] >} }
 end
 
 class DryValidationContractTest < Minitest::Spec
@@ -505,6 +576,8 @@ class DocContractBuilderTest < Minitest::Spec
 
   it { Create.(params: {}).inspect(:model).must_equal %{<Result:false [#<struct DocContractBuilderTest::Song id=nil, title=nil>] >} }
   it { Create.(params: { title: "title"}, current_user: Module).inspect(:model).must_equal %{<Result:true [#<struct DocContractBuilderTest::Song id=nil, title="title">] >} }
+  # internal variables from {:builder} are excluded in public ctx.
+  it { Create.(params: {}).keys.inspect.must_equal %{[:params, :model, :\"result.model\", :\"contract.default\", :\"contract.default.params\", :\"representer.default.class\", :\"result.contract.default\"]} }
 end
 
 class DocContractTest < Minitest::Spec
@@ -547,3 +620,20 @@ class DocContractTest < Minitest::Spec
 
   it { Break.(params: { id:1, title: "Fame" }).inspect(:model).must_equal %{<Result:true [#<struct DocContractTest::Song id=1, title=nil>] >} }
 end
+
+class ModelMissingTest < Minitest::Spec
+  class Create < Trailblazer::Operation
+    class MyContract < Reform::Form
+      property :duration, virtual: true
+    end
+
+    step Contract::Build(constant: MyContract)
+    step Contract::Validate()
+  end
+
+  it do
+    result = Create.(params: {duration: 18})
+    assert_equal true, result.success?
+    assert_equal 18, result[:"contract.default"].duration
+  end
+end

data/trailblazer-macro-contract.gemspec

@@ -23,15 +23,14 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "dry-validation"
   spec.add_development_dependency "reform-rails", "~> 0.2.0.rc2"
-  spec.add_development_dependency "trailblazer-operation", ">= 0.6.2"
-  spec.add_development_dependency "trailblazer-macro", ">= 2.1.5"
+  spec.add_development_dependency "trailblazer-macro", ">= 2.1.9"
   spec.add_development_dependency "trailblazer-developer"
   spec.add_development_dependency "activemodel", "~> 6.0.0" # FIXME: we still don't support the Rails 6.1 errors object.
 
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "rake"
 
-  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.required_ruby_version = ">= 2.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-macro-contract
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.2
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-03 00:00:00.000000000 Z
+date: 2021-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: reform
@@ -72,34 +72,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0.rc2
-- !ruby/object:Gem::Dependency
-  name: trailblazer-operation
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.6.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.6.2
 - !ruby/object:Gem::Dependency
   name: trailblazer-macro
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.5
+        version: 2.1.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.5
+        version: 2.1.9
 - !ruby/object:Gem::Dependency
   name: trailblazer-developer
   requirement: !ruby/object:Gem::Requirement
@@ -162,20 +148,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
 description: Operation macros for form objects
 email:
 - apotonick@gmail.com
@@ -183,11 +169,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop-https---raw-githubusercontent-com-trailblazer-meta-master-rubocop-yml"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
 - CHANGES.md
 - COMM-LICENSE
 - Gemfile

data/.travis.yml

@@ -1,8 +0,0 @@
-sudo: false
-language: ruby
-before_install: gem install bundler
-rvm:
-  - 2.5.1
-  - 2.4.4
-  - 2.3.7
-  # - 2.2.10