trailblazer-macro-contract 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3603305c22954cb6b53e94057b4b25c4ae98d1286d5a32b0b0a2292325156086
-  data.tar.gz: 952c4060256225918cfbd41939f2b6fb479cd153b4416967f8ef03682033cb42
+  metadata.gz: 523435b29f2464a1677f6b430e8285b62841e4b24f4ebfdf19bcab531239ba70
+  data.tar.gz: 30cda42970110b3d8b280d002b785ada64445cb8212b1a6040432df5218f8fa4
 SHA512:
-  metadata.gz: 2f1118cf2e91af6c8a95c9c7050ae6bf43a82ebe7fca82b15255b53f7ace0c3a46e76a02efcaaa94195d6003fdba8c4acaeeb8fb30580c7eb09a5c765b44c690
-  data.tar.gz: 55ee53d0e937672aee52552167ad987f4c36f99f669966dd5f2a417c9bfc047c897b6981b4eebceb4dc1e9e1136c0adfa6efb5fea962e1a860abbc2edd01cd51
+  metadata.gz: b9922fdf9cfac45598fe3d1d4672e708bacf54e41779b38d35e28dbfbee78de92eafe29bdabcda01369bbcf96265917129d0cdc0d8abcc85b1bf3cb2c3c4bbf3
+  data.tar.gz: bb8f91f57343237ac0995fa8f2516558ccabf799c9b0bf64c0c6024bae6a61285ba867bb97e1d10d2b99fc8e510ad611a6a523bf439d2df01f9ced40c6eeefa7

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

@@ -26,8 +26,6 @@ Style/AndOr:
   EnforcedStyle: conditionals
 Style/AutoResourceCleanup:
   Enabled: true
-Style/CollectionMethods:
-  Enabled: true
 Style/Documentation:
   Enabled: false
 Style/EmptyLiteral:
@@ -49,13 +47,6 @@ Style/NumericLiterals:
   Enabled: false
 Style/OptionHash:
   Enabled: true
-Style/PercentLiteralDelimiters:
-  PreferredDelimiters:
-    "%w": "[]"
-    "%W": "[]"
-    "%i": "[]"
-    "%I": "[]"
-    "%r": "()"
 Style/ReturnNil:
   Enabled: true
 Style/SafeNavigation:
@@ -94,27 +85,24 @@ 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/UncommunicativeMethodParamName:
+Naming/MethodParameterName:
   Enabled: false
 Style/ClassAndModuleChildren:
   Enabled: false
 Layout/LeadingCommentSpace:
   Exclude:
     - 'test/docs/**/*'
-Layout/AlignHash:
+Layout/HashAlignment:
   EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
 Style/FrozenStringLiteralComment:
   Enabled: false
-Layout/AlignHash:
-  EnforcedColonStyle: table
 SingleLineMethods:
   Enabled: false
 Style/Lambda:
@@ -132,5 +120,8 @@ Style/PercentLiteralDelimiters:
     "%r": '{}'
     "%w": '[]'
     "%": '{}'
+    "%W": '[]'
+    "%i": '[]'
+    "%I": '[]'
 Style/HashSyntax:
   Enabled: false

data/CHANGES.md

@@ -1,3 +1,7 @@
+# 2.1.1
+
+* Support for Ruby 3.0.
+
 # 2.1.0
 
 * Finally.

data/Gemfile

@@ -9,6 +9,7 @@ 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/lib/trailblazer/macro/contract.rb

@@ -1,5 +1,19 @@
-require "reform"
-require "trailblazer/operation"
-require "trailblazer/operation/contract"
-require "trailblazer/operation/validate"
-require "trailblazer/operation/persist"
+require "trailblazer/activity"
+require "trailblazer/activity/dsl/linear"
+
+require "trailblazer/macro/contract/build"
+require "trailblazer/macro/contract/validate"
+require "trailblazer/macro/contract/persist"
+
+module Trailblazer
+  module Macro
+    module Contract
+    end
+  end
+
+  # All macros sit in the {Trailblazer::Macro::Contract} namespace, where we forward calls from
+  # operations and activities to.
+  module Activity::DSL::Linear::Helper
+    Contract = Macro::Contract
+  end
+end

data/lib/trailblazer/{operation/contract.rb → macro/contract/build.rb}

@@ -1,5 +1,7 @@
+require "reform"
+
 module Trailblazer
-  class Operation
+  module Macro
     module Contract
       def self.Build(name: "default", constant: nil, builder: nil)
         task = lambda do |(options, flow_options), **circuit_options|
@@ -27,12 +29,13 @@ module Trailblazer
                           end
         end
 
-        def self.call_builder(options, circuit_options, builder: raise, constant: raise, name: raise)
-          tmp_options = options.to_hash.merge(
+        def self.call_builder(ctx, circuit_options, builder: raise, constant: raise, name: raise)
+          tmp_options = ctx.to_hash.merge(
             constant: constant,
             name:     name
           )
-          Trailblazer::Option(builder).(options, tmp_options, circuit_options)
+
+          Trailblazer::Option(builder).(ctx, keyword_arguments: tmp_options, **circuit_options) # TODO: why can't we build the {builder} at compile time?
         end
       end
 

data/lib/trailblazer/{operation → macro/contract}/persist.rb

@@ -1,5 +1,5 @@
 module Trailblazer
-  class Operation
+  module Macro
     module Contract
       def self.Persist(method: :save, name: "default")
         path = :"contract.#{name}"

data/lib/trailblazer/{operation → macro/contract}/validate.rb

@@ -1,11 +1,11 @@
 module Trailblazer
-  class Operation
+  module Macro
     module Contract
       # result.contract = {..}
       # result.contract.errors = {..}
       # 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) # DISCUSS: should we introduce something like Validate::Deserializer?
+      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.
 
         extract  = Validate::Extract.new(key: key, params_path: params_path).freeze
@@ -23,6 +23,9 @@ module Trailblazer
         # Deviate End.extract_failure to the standard failure track as a default. This can be changed from the user side.
         options = options.merge(activity.Output(:extract_failure) => activity.Track(:failure)) unless skip_extract
 
+        # Halt failure track to End with {contract.name.invalid}.
+        options = options.merge(activity.Output(:failure) => activity.End(:invalid_data)) if invalid_data_terminus
+
         options
       end
 
@@ -33,7 +36,7 @@ module Trailblazer
             @key, @params_path = key, params_path
           end
 
-          def call(ctx, params:, **)
+          def call(ctx, params: {}, **)
             ctx[@params_path] = @key ? params[@key] : params
           end
         end
@@ -46,7 +49,7 @@ module Trailblazer
         def call(ctx, **)
           validate!(
             ctx,
-            representer: ctx["representer.#{@name}.class"] ||= @representer, # FIXME: maybe @representer should use DI.
+            representer: ctx[:"representer.#{@name}.class"] ||= @representer, # FIXME: maybe @representer should use DI.
             params_path: @params_path
           )
         end
@@ -71,5 +74,5 @@ module Trailblazer
         end
       end
     end
-  end # Operation
+  end # Macro
 end

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

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

data/test/docs/contract_test.rb

@@ -57,15 +57,15 @@ class DocsContractOverviewTest < Minitest::Spec
   it "shows 2-level tracing" do
     result = Create.trace( params: { length: "A" } )
     result.wtf.gsub(/0x\w+/, "").must_equal %{`-- DocsContractOverviewTest::Create
-   |-- Start.default
-   |-- model.build
-   |-- contract.build
-   |-- contract.default.validate
-   |   |-- Start.default
-   |   |-- contract.default.params_extract
-   |   |-- contract.default.call
-   |   `-- End.failure
-   `-- End.failure}
+    |-- Start.default
+    |-- model.build
+    |-- contract.build
+    |-- contract.default.validate
+    |   |-- Start.default
+    |   |-- contract.default.params_extract
+    |   |-- contract.default.call
+    |   `-- End.failure
+    `-- End.failure}
   end
 end
 #---
@@ -297,6 +297,46 @@ class DocsContractKeyWithOutputTest < Minitest::Spec
   end
 end
 
+#---
+#- Validate( name: "default", invalid_data_terminus: true )
+class DocsContractInvalidEndTest < Minitest::Spec
+  Song = Class.new(ContractConstantTest::Song)
+
+  module Song::Contract
+    Create = ContractConstantTest::Song::Contract::Create
+  end
+
+  #:invalid-end
+  class Song::Create < Trailblazer::Operation
+    step Model( Song, :new )
+    step Contract::Build( constant: Song::Contract::Create )
+    step Contract::Validate( key: :song, invalid_data_terminus: true )
+    step Contract::Persist( )
+  end
+  #:invalid-end end
+
+  it do
+    result = Song::Create.(params: {song: { title: nil, length: nil }})
+    result.event.inspect.must_equal %{#<Trailblazer::Activity::End semantic=:invalid_data>}
+  end
+
+  it { Song::Create.(params: {song: { title: "SVG", length: 13 }}).inspect(:model).must_equal %{<Result:true [#<struct DocsContractInvalidEndTest::Song title=\"SVG\", length=13>] >} }
+
+  it do
+    #:invalid-end-res
+    result = Song::Create.(params: { title: "Rising Force", length: 13 })
+    result.success? #=> false
+    result.event    #=> #<Trailblazer::Activity::End semantic=:"contract.default.invalid">
+    #:invalid-end-res end
+
+    #:invalid-end-res-false
+    result = Song::Create.(params: { "song" => { title: "Rising Force", length: 13 } })
+    result.success? #=> true
+    #:invalid-end-res-false end
+  end
+end
+
+
 #- Contract::Build[ constant: XXX, name: AAA ]
 class ContractNamedConstantTest < Minitest::Spec
   Song = Class.new(ContractConstantTest::Song)
@@ -367,16 +407,20 @@ class DryValidationContractTest < Minitest::Spec
   class Create < Trailblazer::Operation
     # contract to verify params formally.
     class MyContract < Reform::Form
-      feature Reform::Form::Dry
+      feature Dry
       property :id
       property :title
 
       validation name: :default do
-        required(:id).filled
+        params do
+          required(:id).filled
+        end
       end
 
       validation name: :extra, if: :default do
-        required(:title).filled(min_size?: 2)
+        params do
+          required(:title).filled(min_size?: 2)
+        end
       end
     end
     #~form end
@@ -405,8 +449,10 @@ class DryValidationContractTest < Minitest::Spec
   #---
   # Contract::Validate(constant: DrySchema)
   class OpWithSchema < Trailblazer::Operation
-    Schema = Dry::Validation.Schema do
-      required(:title).filled
+    Schema = Dry::Validation.Contract do
+      params do
+        required(:title).filled
+      end
     end
 
     step Model( Song, :new ) # FIXME.
@@ -420,7 +466,7 @@ class DryValidationContractTest < Minitest::Spec
   it "shows error messages" do
     result = OpWithSchema.(params: {song: { title: nil }})
 
-    result[:"result.contract.default"].errors.must_equal(title: ["must be filled"])
+    result[:"result.contract.default"].errors.inspect.must_equal %{#<Dry::Validation::MessageSet messages=[#<Dry::Schema::Message text=\"must be filled\" path=[:title] predicate=:filled? input=nil>] options={:source=>[#<Dry::Schema::Message text=\"must be filled\" path=[:title] predicate=:filled? input=nil>], :hints=>false}>}
   end
   # key not found
   it { OpWithSchema.(params: {}).success?.must_equal false }

data/test/docs/dry_test.rb

@@ -1,33 +1,33 @@
-require "test_helper"
-require "dry/container"
+# require "test_helper"
+# require "dry/container"
 
-class DryContainerTest < Minitest::Spec
-  Song = Struct.new(:id, :title)
+# class DryContainerTest < Minitest::Spec
+#   Song = Struct.new(:id, :title)
 
-  class MyContract < Reform::Form
-    property :title
-    validates :title, length: 2..33
-  end
+#   class MyContract < Reform::Form
+#     property :title
+#     validates :title, length: 2..33
+#   end
 
-  my_container = Dry::Container.new
-  my_container.register("contract.default.class", MyContract)
-  # my_container.namespace("contract") do
-  #   register("create") { Array }
-  # end
+#   my_container = Dry::Container.new
+#   my_container.register("contract.default.class", MyContract)
+#   # my_container.namespace("contract") do
+#   #   register("create") { Array }
+#   # end
 
-  #---
-  #- dependency injection
-  #- with Dry-container
-  class Create < Trailblazer::Operation
-    extend Trailblazer::Operation::Container
+#   #---
+#   #- dependency injection
+#   #- with Dry-container
+#   class Create < Trailblazer::Operation
+#     extend Trailblazer::Operation::Container
 
-    step Model(Song, :new)
-    step Contract::Build()
-    step Contract::Validate()
-    step Contract::Persist(method: :sync)
-  end
-  #:key end
+#     step Model(Song, :new)
+#     step Contract::Build()
+#     step Contract::Validate()
+#     step Contract::Persist(method: :sync)
+#   end
+#   #:key end
 
-  it { Create.({params: {title: "A" } }, my_container).inspect(:model).must_equal %{<Result:false [#<struct DryContainerTest::Song id=nil, title=nil>] >} }
-  it { Create.({params: {title: "Anthony's Song" } }, my_container).inspect(:model).must_equal %{<Result:true [#<struct DryContainerTest::Song id=nil, title="Anthony's Song">] >} }
-end
+#   it { Create.({params: {title: "A" } }, my_container).inspect(:model).must_equal %{<Result:false [#<struct DryContainerTest::Song id=nil, title=nil>] >} }
+#   it { Create.({params: {title: "Anthony's Song" } }, my_container).inspect(:model).must_equal %{<Result:true [#<struct DryContainerTest::Song id=nil, title="Anthony's Song">] >} }
+# end

data/test/operation/contract_test.rb

@@ -59,6 +59,8 @@ class ContractTest < Minitest::Spec
     it { Upsert.(params: {song: { title: nil }}).success?.must_equal false }
     # key not found
     it { Upsert.(params: {}).success?.must_equal false }
+    # no params passed
+    it { Upsert.().success?.must_equal false } 
 
     #---
     # contract.default.params gets set (TODO: change in 2.1)

data/test/test_helper.rb

@@ -1,9 +1,11 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require "trailblazer-macro-contract"
+
 require "pp"
 require 'delegate'
+require "trailblazer/operation"
 require "trailblazer/developer"
 require "trailblazer/macro"
-require "trailblazer-macro-contract"
-require "trailblazer/developer/render/linear"
 require "minitest/autorun"
 
 # TODO: convert tests to non-rails.

data/trailblazer-macro-contract.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |spec|
   spec.version       = Trailblazer::Version::Macro::Contract::VERSION
   spec.authors       = ["Nick Sutterer"]
   spec.email         = ["apotonick@gmail.com"]
-  spec.description   = 'Trailblazer operation form object specific macros'
-  spec.summary       = 'Macros for form-objects: Build, Validate, Persist'
+  spec.description   = 'Operation macros for form objects'
+  spec.summary       = 'Macros for form objects: Build, Validate, Persist'
   spec.homepage      = "http://trailblazer.to"
   spec.license       = "LGPL-3.0"
 
@@ -21,13 +21,17 @@ Gem::Specification.new do |spec|
   spec.add_dependency "reform", ">= 2.2.0", "< 3.0.0"
 
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "dry-validation", "0.11.1" # FIXME: upgrade example code
+  spec.add_development_dependency "dry-validation"
   spec.add_development_dependency "reform-rails", "~> 0.2.0.rc2"
-  spec.add_development_dependency "trailblazer-macro", ">= 2.1.0", "< 2.2.0"
+  spec.add_development_dependency "trailblazer-operation", ">= 0.6.2"
+  spec.add_development_dependency "trailblazer-macro", ">= 2.1.5"
   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.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.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-23 00:00:00.000000000 Z
+date: 2021-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: reform
@@ -48,16 +48,16 @@ dependencies:
   name: dry-validation
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: reform-rails
   requirement: !ruby/object:Gem::Requirement
@@ -73,25 +73,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.2.0.rc2
 - !ruby/object:Gem::Dependency
-  name: trailblazer-macro
+  name: trailblazer-operation
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 0.6.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
-    - - "<"
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: trailblazer-macro
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.1.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.5
 - !ruby/object:Gem::Dependency
   name: trailblazer-developer
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +114,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -134,7 +156,27 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Trailblazer operation form object specific macros
+- !ruby/object:Gem::Dependency
+  name: trailblazer-activity-dsl-linear
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: Operation macros for form objects
 email:
 - apotonick@gmail.com
 executables: []
@@ -154,10 +196,10 @@ files:
 - Rakefile
 - lib/trailblazer-macro-contract.rb
 - lib/trailblazer/macro/contract.rb
+- lib/trailblazer/macro/contract/build.rb
+- lib/trailblazer/macro/contract/persist.rb
+- lib/trailblazer/macro/contract/validate.rb
 - lib/trailblazer/macro/contract/version.rb
-- lib/trailblazer/operation/contract.rb
-- lib/trailblazer/operation/persist.rb
-- lib/trailblazer/operation/validate.rb
 - test/docs/contract_test.rb
 - test/docs/dry_test.rb
 - test/operation/contract_test.rb
@@ -183,11 +225,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
-summary: 'Macros for form-objects: Build, Validate, Persist'
+summary: 'Macros for form objects: Build, Validate, Persist'
 test_files:
 - test/docs/contract_test.rb
 - test/docs/dry_test.rb