dry-validation 1.5.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83395b144bcdc666d13ac3cb100e2a7488ba9caa638067f03beee031964da26a
-  data.tar.gz: fa5f1480a6bff63238c76ffc6ee8c574ccc113048843d5f79c9fdc216b899d23
+  metadata.gz: 9df6f1e542743b8e5af8438caec2b5fe705f3bba96ed9f4791eacb1efc2a627d
+  data.tar.gz: d027d77079c1771691f11d8f143ceb9e92834b03fb4123cdcdf48e3711dd2fba
 SHA512:
-  metadata.gz: 7d14bcf252cbf7cd6a2d58f936d65da3e71343388b87924f51f56cd7812fecff33bab17f4193cf354cc76fd7d3bbbd2081e847b0c8b54b466c1781599aeba25b
-  data.tar.gz: 11d241432260233c0b7f8fe03b69e1a2cd44e0e7fd241a90ba5f3eb65eff4f21e7c8c88e3fa5c903dc65dbbd78de537a03368ba47cf714a295c7da8784286af8
+  metadata.gz: 76059d5e724680569c71ab794849379e2404b63053073fbe57394ed6031cfd0aff67b210f92b15f985feef77a986cafa7f442397e91ec3deac436f289379b126
+  data.tar.gz: e5e1a9a3ae536767cbba5584061e04dc01a065bccd9936b8d30482b499e4a865309400c3eff5f589a5661ba25ed1403e4a77cadc83f215b8fd6cf588dd217aa7

data/CHANGELOG.md

@@ -1,15 +1,79 @@
-## 1.5.1 2020-06-18
+## 1.6.0 
+
+
+### Added
+
+- You can now pass a key name or path to `rule_error?` predicate (issue #658 closed via #673) (@moofkit)
+- You can now pass initial context object to `Contract#call` (issue #674 via #675) (@pyromaniac)
+
+### Fixed
+
+- Checking `key?` within a rule no longer crashes when value is `nil` or an empty string (issue #670 fixed via #672) (@alexxty7)
+
+
+[Compare v1.5.6...master](https://github.com/dry-rb/dry-validation/compare/v1.5.6...master)
+
+## 1.5.6 2020-09-04
+
+
+### Fixed
+
+- Dependency on dry-schema was bumped to >= 1.5.1. This time for real (@solnic)
+
+
+[Compare v1.5.5...v1.5.6](https://github.com/dry-rb/dry-validation/compare/v1.5.5...v1.5.6)
+
+## 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...v1.5.5](https://github.com/dry-rb/dry-validation/compare/v1.5.4...v1.5.5)
+
+## 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
 
-- 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)
 - `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.1](https://github.com/dry-rb/dry-validation/compare/v1.5.1...v1.5.1)
+[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
 
@@ -18,8 +82,7 @@
 
 - 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)
-- `key?` predicate in rules no longer crashes when the rule path points to a non-existent array value (issue #653 fixed via #654) (@solnic)
+- 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)

data/README.md

@@ -21,7 +21,7 @@
 
 This library officially supports the following Ruby versions:
 
-* MRI >= `2.4`
+* MRI >= `2.5`
 * jruby >= `9.2`
 
 ## License

data/dry-validation.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.metadata['source_code_uri']   = 'https://github.com/dry-rb/dry-validation'
   spec.metadata['bug_tracker_uri']   = 'https://github.com/dry-rb/dry-validation/issues'
 
-  spec.required_ruby_version = ">= 2.4.0"
+  spec.required_ruby_version = ">= 2.5.0"
 
   # to update dependencies edit project.yml
   spec.add_runtime_dependency "concurrent-ruby", "~> 1.0"
@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "dry-core", "~> 0.4"
   spec.add_runtime_dependency "dry-equalizer", "~> 0.2"
   spec.add_runtime_dependency "dry-initializer", "~> 3.0"
-  spec.add_runtime_dependency "dry-schema", "~> 1.5"
+  spec.add_runtime_dependency "dry-schema", "~> 1.5", ">= 1.5.2"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"

data/lib/dry/validation/contract.rb

@@ -68,6 +68,11 @@ module Dry
       #   @api public
       option :macros, default: -> { config.macros }
 
+      # @!attribute [r] default_context
+      #   @return [Hash] Default context for rules
+      #   @api public
+      option :default_context, default: -> { EMPTY_HASH }
+
       # @!attribute [r] schema
       #   @return [Dry::Schema::Params, Dry::Schema::JSON, Dry::Schema::Processor]
       #   @api private
@@ -86,12 +91,18 @@ module Dry
       # Apply the contract to an input
       #
       # @param [Hash] input The input to validate
+      # @param [Hash] context Initial context for rules
       #
       # @return [Result]
       #
       # @api public
-      def call(input)
-        Result.new(schema.(input), Concurrent::Map.new) do |result|
+      def call(input, context = EMPTY_HASH)
+        context_map = Concurrent::Map.new.tap do |map|
+          default_context.each { |key, value| map[key] = value }
+          context.each { |key, value| map[key] = value }
+        end
+
+        Result.new(schema.(input), context_map) do |result|
           rules.each do |rule|
             next if rule.keys.any? { |key| error?(result, key) }
 
@@ -123,14 +134,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

@@ -155,16 +155,23 @@ 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
@@ -175,16 +182,22 @@ module Dry
       #
       # @api public
       def schema_error?(path)
-        result.error?(path)
+        result.schema_error?(path)
       end
 
       # Check if there are any errors on the current rule
       #
+      # @param path [Symbol, String, Array] A Path-compatible spec
+      #
       # @return [Boolean]
       #
       # @api public
-      def rule_error?
-        !key(path).empty?
+      def rule_error?(path = nil)
+        if path.nil?
+          !key(self.path).empty?
+        else
+          result.rule_error?(path)
+        end
       end
 
       # @api private

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[->(**opts) { [message_text(message, path, **opts), meta] }, path, meta]
+            Message[->(**opts) { [message_text(message, path: path, **opts), meta] }, path, meta]
           when Hash
             meta = message.dup
             text = meta.delete(:text) { |key|
@@ -51,18 +54,6 @@ module Dry
         end
         alias_method :[], :call
 
-        # Resolve a message
-        #
-        # @return String
-        #
-        # @api public
-        def message_text(message, path, locale: nil, full: false, **opts)
-          keys = path.to_a.compact
-          msg_opts = EMPTY_HASH.merge(path: keys, locale: locale || messages.default_locale)
-
-          full ? "#{messages.rule(keys.last, msg_opts) || keys.last} #{message}" : message
-        end
-
         # Resolve a message
         #
         # @return [String]
@@ -81,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
@@ -90,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,11 +101,25 @@ 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
 
+      # Check if the rules includes an error for the provided key
+      #
+      # @api private
+      def rule_error?(key)
+        !schema_error?(key) && error?(key)
+      end
+
       # Check if there's any error for the provided key
       #
       # This does not consider errors from the nested values
@@ -116,7 +130,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

@@ -70,6 +70,10 @@ module Dry
             return result
           elsif e.is_a?(Symbol) && a.is_a?(Array)
             return false
+          elsif a.nil?
+            return false
+          elsif a.is_a?(String)
+            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.2"
+    VERSION = "1.6.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-validation
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-14 00:00:00.000000000 Z
+date: 2020-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -93,6 +93,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -100,6 +103,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -192,14 +198,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Validation library