pathway 0.12.2 → 0.12.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29e0024427e53290982fedc6eadaacbbf3555627e94930d1c52d3bdcbb90a5dd
-  data.tar.gz: 98fbe3a72e2aa4c1a3a6b0c1a9ed610231256364b4db44e7840da261bac5a47f
+  metadata.gz: 83205585dcf796cdb4a5da8055163491d12586c48915e6d3ef7efe44ff6533f3
+  data.tar.gz: 1584cfc7dd38e44e14a810a96a658e29b5756aad62f36e1e69671a3c7631a656
 SHA512:
-  metadata.gz: 81ee05e3aec188a87df7b59032099cfcfb7c59e4641ab6b0db8ebe02bcf693d53fec4db3de16bb62d96e8e84cdf6f45e995411429c53818c748b320da7aa06a2
-  data.tar.gz: f64c5e2d2bc08afcca58b62a53dbb98511f59d6f7588e59732c434f0abaae103ac00c2153e76f6b2b2eeb034855bdf1c2561cfa44ce15885ab12be5fa815f1b3
+  metadata.gz: ade86174156600eb76a84af9ca96097eaa28a8760ba52f150fc9ed6c21ca5a69e387157cb7238c97990aa516ff712b98708941acf4885805e9bb4f8d85db2757
+  data.tar.gz: 855252fa3e0639a3d18bd1f0f10f7d379795516723da702c6201076a3767dc3a7f447191260d137f57716bf57915e654270a0209b6b3e36de9896e54faac7927

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [0.12.3] - 2024-08-13
+### Changed
+- Renamed config option `:auto_wire_options` to `:auto_wire` at `:dry_validation` plugin
+- Updated `Pathway::State#use` to accept block with postional parameters
+- Updated `Pathway::State#use` to raise an `ArgumentError` exception on invalid arguments
+### Added
+- Provide alias `Pathway::State#use` to `Pathway::State#unwrap`
+
 ## [0.12.2] - 2024-08-06
 ### Added
 - Add `Pathway::State#unwrap` and `Pathway::State#u` to access internal state

data/README.md

@@ -407,12 +407,12 @@ end
 
 If you are familiar with `dry-validation` you probably know it provides a way to [inject options](https://dry-rb.org/gems/dry-validation/1.4/external-dependencies/) before calling the contract.
 
-In those scenarios, you must either set the `auto_wire_options: true` plugin argument or specify how to map options from the execution state to the contract when calling `step :validate`.
+In those scenarios, you must either set the `auto_wire: true` plugin argument or specify how to map options from the execution state to the contract when calling `step :validate`.
 Lets see and example for the first case:
 
 ```ruby
 class CreateNugget < Pathway::Operation
-  plugin :dry_validation, auto_wire_options: true
+  plugin :dry_validation, auto_wire: true
 
   context :user_name
 
@@ -438,7 +438,7 @@ class CreateNugget < Pathway::Operation
 end
 ```
 
-Here the defined contract needs a `:user_name` option, so we tell the operation to grab the attribute with the same name from the state by activating `:auto_wire_options`, afterwards, when the validation runs, the contract will already have the user name available.
+Here the defined contract needs a `:user_name` option, so we tell the operation to grab the attribute with the same name from the state by activating `:auto_wire`, afterwards, when the validation runs, the contract will already have the user name available.
 
 Mind you, this option is `false` by default, so be sure to set it to `true` at `Pathway::Operation` if you'd rather have it enabled for all your operations.
 

data/lib/pathway/plugins/dry_validation/v0_11.rb

@@ -6,7 +6,10 @@ module Pathway
       module V0_11
         module ClassMethods
           attr_reader :form_class, :form_options
-          attr_accessor :auto_wire_options
+          attr_accessor :auto_wire
+
+          alias_method :auto_wire_options, :auto_wire
+          alias_method :auto_wire_options=, :auto_wire=
 
           def form(base = nil, **opts, &block)
             if block_given?
@@ -32,7 +35,7 @@ module Pathway
           def inherited(subclass)
             super
             subclass.form_class = form_class
-            subclass.auto_wire_options = auto_wire_options
+            subclass.auto_wire  = auto_wire
           end
 
           private
@@ -58,10 +61,11 @@ module Pathway
           extend Forwardable
 
           delegate %i[build_form form_options auto_wire_options] => 'self.class'
-          alias :form :build_form
+          delegate %i[build_form form_options auto_wire_options auto_wire] => 'self.class'
+          alias_method :form, :build_form
 
           def validate(state, with: nil)
-            if auto_wire_options && form_options.any?
+            if auto_wire && form_options.any?
               with ||= form_options.zip(form_options).to_h
             end
             opts = Hash(with).map { |opt, key| [opt, state[key]] }.to_h
@@ -76,9 +80,15 @@ module Pathway
           end
         end
 
-        def self.apply(operation, auto_wire_options: false)
+        def self.apply(operation, auto_wire_options: (auto_wire_options_was_not_used=true; false), auto_wire: auto_wire_options)
+          #:nocov:
+          unless auto_wire_options_was_not_used
+            warn "[DEPRECATION] `auto_wire_options` is deprecated. Please use `auto_wire` instead"
+          end
+          #:nocov:
+
+          operation.auto_wire  = auto_wire
           operation.form_class = Dry::Validation::Schema::Form
-          operation.auto_wire_options = auto_wire_options
         end
       end
     end

data/lib/pathway/plugins/dry_validation/v0_12.rb

@@ -6,7 +6,10 @@ module Pathway
       module V0_12
         module ClassMethods
           attr_reader :form_class, :form_options
-          attr_accessor :auto_wire_options
+          attr_accessor :auto_wire
+
+          alias_method :auto_wire_options, :auto_wire
+          alias_method :auto_wire_options=, :auto_wire=
 
           def form(base = nil, **opts, &block)
             if block_given?
@@ -32,7 +35,7 @@ module Pathway
           def inherited(subclass)
             super
             subclass.form_class = form_class
-            subclass.auto_wire_options = auto_wire_options
+            subclass.auto_wire  = auto_wire
           end
 
           private
@@ -57,11 +60,11 @@ module Pathway
         module InstanceMethods
           extend Forwardable
 
-          delegate %i[build_form form_options auto_wire_options] => 'self.class'
-          alias :form :build_form
+          delegate %i[build_form form_options auto_wire_options auto_wire] => 'self.class'
+          alias_method :form, :build_form
 
           def validate(state, with: nil)
-            if auto_wire_options && form_options.any?
+            if auto_wire && form_options.any?
               with ||= form_options.zip(form_options).to_h
             end
             opts = Hash(with).map { |opt, key| [opt, state[key]] }.to_h
@@ -76,9 +79,15 @@ module Pathway
           end
         end
 
-        def self.apply(operation, auto_wire_options: false)
+        def self.apply(operation, auto_wire_options: (auto_wire_options_was_not_used=true; false), auto_wire: auto_wire_options)
+          #:nocov:
+          unless auto_wire_options_was_not_used
+            warn "[DEPRECATION] `auto_wire_options` is deprecated. Please use `auto_wire` instead"
+          end
+          #:nocov:
+
+          operation.auto_wire  = auto_wire
           operation.form_class = Dry::Validation::Schema::Params
-          operation.auto_wire_options = auto_wire_options
         end
       end
     end

data/lib/pathway/plugins/dry_validation/v1_0.rb

@@ -6,7 +6,10 @@ module Pathway
       module V1_0
         module ClassMethods
           attr_reader :contract_class, :contract_options
-          attr_accessor :auto_wire_options
+          attr_accessor :auto_wire
+
+          alias_method :auto_wire_options, :auto_wire
+          alias_method :auto_wire_options=, :auto_wire=
 
           def contract(base = nil, &block)
             if block_given?
@@ -24,7 +27,7 @@ module Pathway
           end
 
           def contract_class= klass
-            @contract_class = klass
+            @contract_class   = klass
             @contract_options = (klass.dry_initializer.options - Dry::Validation::Contract.dry_initializer.options).map(&:target)
             @builded_contract = @contract_options.empty? && klass.schema ? klass.new : nil
           end
@@ -35,8 +38,8 @@ module Pathway
 
           def inherited(subclass)
             super
+            subclass.auto_wire      = auto_wire
             subclass.contract_class = contract_class
-            subclass.auto_wire_options = auto_wire_options
           end
 
           private
@@ -49,11 +52,11 @@ module Pathway
         module InstanceMethods
           extend Forwardable
 
-          delegate %i[build_contract contract_options auto_wire_options] => 'self.class'
-          alias :contract :build_contract
+          delegate %i[build_contract contract_options auto_wire_options auto_wire] => 'self.class'
+          alias_method :contract, :build_contract
 
           def validate(state, with: nil)
-            if auto_wire_options && contract_options.any?
+            if auto_wire && contract_options.any?
               with ||= contract_options.zip(contract_options).to_h
             end
             opts = Hash(with).map { |to, from| [to, state[from]] }.to_h
@@ -68,9 +71,15 @@ module Pathway
           end
         end
 
-        def self.apply(operation, auto_wire_options: false)
+        def self.apply(operation, auto_wire_options: (auto_wire_options_was_not_used=true; false), auto_wire: auto_wire_options)
+          #:nocov:
+          unless auto_wire_options_was_not_used
+            warn "[DEPRECATION] `auto_wire_options` is deprecated. Please use `auto_wire` instead"
+          end
+          #:nocov:
+
+          operation.auto_wire      = auto_wire
           operation.contract_class = Dry::Validation::Contract
-          operation.auto_wire_options = auto_wire_options
         end
       end
     end

data/lib/pathway/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pathway
-  VERSION = '0.12.2'
+  VERSION = '0.12.3'
 end

data/lib/pathway.rb

@@ -83,23 +83,27 @@ module Pathway
       @hash
     end
 
-    def unwrap(&bl)
-      raise 'a block must be provided' if !block_given?
-      params = bl.parameters
-      unless params.all? { |(type,_)| [:block, :key, :keyreq, :keyrest].member?(type) }
-        raise 'only keyword arguments are supported for unwraping'
+    def use(&bl)
+      raise ArgumentError, 'a block must be provided' if !block_given?
+      if bl.parameters.any? {|(type,_)| type == :keyrest || type == :rest }
+        raise ArgumentError, 'rest arguments are not supported'
       end
 
-      if params.any? {|(type,_)| type == :keyrest }
-        bl.call(**to_hash)
-      else
-        keys = params.select {|(type,_)| type == :key || type == :keyreq }.map(&:last)
+      keys = bl.parameters.select {|(type,_)| type == :key || type == :keyreq }.map(&:last)
+      names = bl.parameters.select {|(type,_)| type == :req || type == :opt }.map(&:last)
+
+      if keys.any? && names.any?
+        raise ArgumentError, 'cannot mix positional and keyword arguments'
+      elsif keys.any?
         bl.call(**to_hash.slice(*keys))
+      else
+        bl.call(*to_hash.values_at(*names))
       end
     end
 
     alias_method :to_h, :to_hash
-    alias_method :u, :unwrap
+    alias_method :u, :use
+    alias_method :unwrap, :use
   end
 
   module Plugins

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pathway
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.12.3
 platform: ruby
 authors:
 - Pablo Herrero
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-06 00:00:00.000000000 Z
+date: 2024-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-inflector
@@ -254,7 +254,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/pabloh/pathway/issues
   source_code_uri: https://github.com/pabloh/pathway
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -270,7 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.10
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Define your business logic in simple steps.
 test_files: []