dry-validation 1.5.0 → 1.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c4b57593ac3fd38a26ef3eb26a31b34503bfa75a6fc118358745aa9fb772be1
-  data.tar.gz: 534dc4c9e0a8e83faec7077a78e4b3fd7e7fa5b55b6aa277479999332920bcb5
+  metadata.gz: ab7416252f8c05238652ca9116ec461448e2024c8d68f7c588e3ef401f7a2ed6
+  data.tar.gz: 4137cfee57067480713402f0dd571cb06fde1ef6cafa6feb717596939cbfac1d
 SHA512:
-  metadata.gz: 8268526e70a23bd00ff7825accd0b7f4ca682342a2fefab22051e756e574a8b2834d527e1c1e2cce0a7084308eb9d721dafce92b1500c793588ba9d219499e82
-  data.tar.gz: d1ca0f28f775093521f74330dc4a09142a99c83c693aefcab1571f32343692a72c5f3669bd51baf10865fc9de93074ab3893ddfbb6412edf540bf3f2ac37b47c
+  metadata.gz: 01cae726d99151eed0bb1ef1514e8db05f9d10c8d341ffdb8ef7329de9456b63511f5eb390b25113c4da06241dfb1070ca1110ae24a5e050b6c6d5e03e2100a5
+  data.tar.gz: 849817760314b9a9e4cc120bc618fc42a302cc08150dcc23eb20c726b1a9b79481b19ca0013674f544608600d7d573d5cf1d1436e826bbcf7d25cf9bd3bad3e6

data/CHANGELOG.md

@@ -1,4 +1,69 @@
-## unreleased 
+## 1.5.5 
+
+2020-09-03
+
+### Fixed
+
+- Dependency on dry-schema was bumped to >= 1.5.2 (see #666 for more info) (@artofhuman)
+
+
+[Compare v1.5.4...master](https://github.com/dry-rb/dry-validation/compare/v1.5.4...master)
+
+## 1.5.4 2020-08-21
+
+
+### Added
+
+- You can now pass any key or a path to the rule's `key?` helper (see #664 for more info) (@alassek)
+
+### Fixed
+
+- Full messages work correctly with rule failures now (issue #661 fixed via #662) (@stind)
+- Providing a custom message template for array errors works correctly (issue #663 fixed via #665) (@tadeusz-niemiec)
+
+
+[Compare v1.5.3...v1.5.4](https://github.com/dry-rb/dry-validation/compare/v1.5.3...v1.5.4)
+
+## 1.5.3 2020-07-27
+
+
+### Added
+
+- You can now access current value's index via `rule(:foo).each do |index:|` (issue #606 done via #657) (@mrbongiolo)
+
+### Fixed
+
+- Using `.each(:foo)` works as expected when there are errors related to other keys (issue #659 fixed via #660) (@solnic)
+
+### Changed
+
+- `Result#error?` is now a public API and it takes into consideration both schema and rule errors (issue #655 fixed via #656) (@PragTob)
+
+[Compare v1.5.2...v1.5.3](https://github.com/dry-rb/dry-validation/compare/v1.5.2...v1.5.3)
+
+## 1.5.2 2020-07-14
+
+
+### Fixed
+
+- `key?` predicate in rules no longer crashes when the rule path points to a non-existent array value (issue #653 fixed via #654) (@solnic)
+
+
+[Compare v1.5.1...v1.5.2](https://github.com/dry-rb/dry-validation/compare/v1.5.1...v1.5.2)
+
+## 1.5.1 2020-06-18
+
+
+### Fixed
+
+- dry-monads no longer required for the `:hints` extension (@schokomarie)
+- Using `full: true` option works as expected with custom rule messages (issue #618 fixed via #651) (@sirfilip)
+- Using `locale: ...` option works as expected with hints (issue #589 fixed via 652) (@sirfilip)
+
+
+[Compare v1.5.0...v1.5.1](https://github.com/dry-rb/dry-validation/compare/v1.5.0...v1.5.1)
+
+## 1.5.0 2020-03-11
 
 
 ### Added
@@ -11,7 +76,7 @@
 - dry-schema dependency was bumped to `~> 1.5` (@solnic)
 - [internal] `KeyMap` patches have been removed since dry-schema now provides required functionality (@solnic)
 
-[Compare v1.4.2...master](https://github.com/dry-rb/dry-validation/compare/v1.4.2...master)
+[Compare v1.4.2...v1.5.0](https://github.com/dry-rb/dry-validation/compare/v1.4.2...v1.5.0)
 
 ## 1.4.2 2020-01-18
 

data/lib/dry/validation/contract.rb

@@ -123,14 +123,14 @@ module Dry
           return path.expand.any? { |nested_path| error?(result, nested_path) }
         end
 
-        return true if result.error?(path)
+        return true if result.schema_error?(path)
 
         path
           .to_a[0..-2]
           .any? { |key|
             curr_path = Schema::Path[path.keys[0..path.keys.index(key)]]
 
-            return false unless result.error?(curr_path)
+            return false unless result.schema_error?(curr_path)
 
             result.errors.any? { |err|
               (other = Schema::Path[err.path]).same_root?(curr_path) && other == curr_path

data/lib/dry/validation/evaluator.rb

@@ -146,7 +146,7 @@ module Dry
       #
       # @return [Object]
       #
-      # @public
+      # @api public
       def value
         values[key_name]
       end
@@ -155,27 +155,34 @@ module Dry
       #
       # This is useful when dealing with rules for optional keys
       #
-      # @example
+      # @example use the default key name
       #   rule(:age) do
       #     key.failure(:invalid) if key? && value < 18
       #   end
       #
+      # @example specify the key name
+      #   rule(:start_date, :end_date) do
+      #     if key?(:start_date) && !key?(:end_date)
+      #       key(:end_date).failure("must provide an end_date with start_date")
+      #     end
+      #   end
+      #
       # @return [Boolean]
       #
       # @api public
-      def key?
-        values.key?(key_name)
+      def key?(name = key_name)
+        values.key?(name)
       end
 
       # Check if there are any errors on the schema under the provided path
       #
-      # @param [Symbol, String, Array] A Path-compatible spec
+      # @param path [Symbol, String, Array] A Path-compatible spec
       #
       # @return [Boolean]
       #
       # @api public
       def schema_error?(path)
-        result.error?(path)
+        result.schema_error?(path)
       end
 
       # Check if there are any errors on the current rule

data/lib/dry/validation/extensions/hints.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "dry/monads/result"
-
 module Dry
   module Validation
     # Hints extension
@@ -46,7 +44,7 @@ module Dry
         #
         # @api public
         def messages(new_options = EMPTY_HASH)
-          errors.with(hints.to_a, options.merge(**new_options))
+          errors.with(hints(new_options).to_a, options.merge(**new_options))
         end
 
         # Return hint messages

data/lib/dry/validation/macros.rb

@@ -25,7 +25,7 @@ module Dry
         #   end
         #
         # @param [Symbol] name The name of the macro
-        # @param [Array] *args Optional default arguments for the macro
+        # @param [Array] args Optional default positional arguments for the macro
         #
         # @return [self]
         #

data/lib/dry/validation/message_set.rb

@@ -85,7 +85,7 @@ module Dry
       # @api private
       def freeze
         source_messages.select { |err| err.respond_to?(:evaluate) }.each do |err|
-          idx = source_messages.index(err)
+          idx = messages.index(err) || source_messages.index(err)
           msg = err.evaluate(locale: locale, full: options[:full])
           messages[idx] = msg
         end

data/lib/dry/validation/messages/resolver.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
 require "dry/validation/message"
+require "dry/schema/message_compiler"
 
 module Dry
   module Validation
     module Messages
+      FULL_MESSAGE_WHITESPACE = Dry::Schema::MessageCompiler::FULL_MESSAGE_WHITESPACE
+
       # Resolve translated messages from failure arguments
       #
       # @api public
@@ -33,7 +36,7 @@ module Dry
           when Symbol
             Message[->(**opts) { message(message, path: path, tokens: tokens, **opts) }, path, meta]
           when String
-            Message[message, path, meta]
+            Message[->(**opts) { [message_text(message, path: path, **opts), meta] }, path, meta]
           when Hash
             meta = message.dup
             text = meta.delete(:text) { |key|
@@ -69,6 +72,11 @@ module Dry
             template, meta = messages[rule, msg_opts.merge(path: keys.last)] unless template
           end
 
+          if !template && keys.size > 1
+            non_index_keys = keys.reject { |k| k.is_a?(Integer) }
+            template, meta = messages[rule, msg_opts.merge(path: non_index_keys.join(DOT))]
+          end
+
           unless template
             raise MissingMessageError, <<~STR
               Message template for #{rule.inspect} under #{keys.join(DOT).inspect} was not found
@@ -78,12 +86,29 @@ module Dry
           parsed_tokens = parse_tokens(tokens)
           text = template.(template.data(parsed_tokens))
 
-          [full ? "#{messages.rule(keys.last, msg_opts)} #{text}" : text, meta]
+          [message_text(text, path: path, locale: locale, full: full), meta]
         end
         # rubocop:enable Metrics/AbcSize
 
         private
 
+        def message_text(text, path:, locale: nil, full: false)
+          return text unless full
+
+          key = key_text(path: path, locale: locale)
+
+          [key, text].compact.join(FULL_MESSAGE_WHITESPACE[locale])
+        end
+
+        def key_text(path:, locale: nil)
+          locale ||= messages.default_locale
+
+          keys = path.to_a.compact
+          msg_opts = {path: keys, locale: locale}
+
+          messages.rule(keys.last, msg_opts) || keys.last
+        end
+
         def parse_tokens(tokens)
           Hash[
             tokens.map do |key, token|

data/lib/dry/validation/result.rb

@@ -101,8 +101,15 @@ module Dry
 
       # Check if values include an error for the provided key
       #
-      # @api private
+      # @api public
       def error?(key)
+        errors.any? { |msg| Schema::Path[msg.path].include?(Schema::Path[key]) }
+      end
+
+      # Check if the base schema (without rules) includes an error for the provided key
+      #
+      # @api private
+      def schema_error?(key)
         schema_result.error?(key)
       end
 
@@ -116,7 +123,7 @@ module Dry
           key_path = Schema::Path[key]
           err_path = Schema::Path[error.path]
 
-          return false unless key_path.same_root?(err_path)
+          next unless key_path.same_root?(err_path)
 
           key_path == err_path
         }

data/lib/dry/validation/rule.rb

@@ -65,8 +65,8 @@ module Dry
       # for a given array item.
       #
       # @example
-      #   rule(:nums).each do
-      #     key.failure("must be greater than 0") if value < 0
+      #   rule(:nums).each do |index:|
+      #     key([:number, index]).failure("must be greater than 0") if value < 0
       #   end
       #   rule(:nums).each(min: 3)
       #   rule(address: :city) do
@@ -86,9 +86,9 @@ module Dry
             values[root].each_with_index do |_, idx|
               path = [*Schema::Path[root].to_a, idx]
 
-              next if result.error?(path)
+              next if result.schema_error?(path)
 
-              evaluator = with(macros: macros, keys: [path], &block)
+              evaluator = with(macros: macros, keys: [path], index: idx, &block)
 
               failures.concat(evaluator.failures)
             end

data/lib/dry/validation/values.rb

@@ -35,7 +35,10 @@ module Dry
       #     key.failure('must be > 18') if values[:age] <= 18
       #   end
       #
-      # @param [Symbol] key
+      # @param args [Symbol, String, Hash, Array<Symbol>] If given as a single
+      #   Symbol, String, Array or Hash, build a key array using
+      #   {Dry::Schema::Path} digging for data. If given as positional
+      #   arguments, use these with Hash#dig on the data directly.
       #
       # @return [Object]
       #
@@ -65,6 +68,8 @@ module Dry
           if e.is_a?(Array)
             result = e.all? { |k| key?(k, a) }
             return result
+          elsif e.is_a?(Symbol) && a.is_a?(Array)
+            return false
           else
             return false unless a.is_a?(Array) ? (e >= 0 && e < a.size) : a.key?(e)
           end

data/lib/dry/validation/version.rb

@@ -2,6 +2,6 @@
 
 module Dry
   module Validation
-    VERSION = "1.5.0"
+    VERSION = "1.5.5"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-validation
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.5
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-11 00:00:00.000000000 Z
+date: 2020-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby