dry-validation 0.13.3 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d569600e476b1c0830184bea7e9393f333693e11c1a9d8b074e2b2329deeba7a
-  data.tar.gz: 4811db9bc4e1cc3f398df8717333683355779116a72314532b10bc2d49a87333
+  metadata.gz: f61fe3205cc418d53bd0f2217bdd49a0e49119a69cae87ecf24e76a89567f845
+  data.tar.gz: 4ca306db1fd196c3253a78a6376fe0d4c197c5c8d625636bc37038b9caa3278b
 SHA512:
-  metadata.gz: c497db70c2bf78e3355c685176361b06357ee9d9f17a2c867127d4d575865f0e6cb1f5bafae4b595e1db3af8748fc6122e6522177a152e17e8e6119006591b3c
-  data.tar.gz: 2b93c44b453e47f6a68ec05bedaec9d2f48d001a6dc9d0f62f2f2d7b70de5f8c1a7130bfc33c558fff1129fceb69d37f33f341d38c96549570a684d7279d24b0
+  metadata.gz: d0c6a082c4a7077bd428e1bbe2f8ec4677950ea0f073d15cb955568307e2924b75e9d4bfb0f023b65739df7d061569e1aa8a3941968c263d68f4fd3fe12a61d5
+  data.tar.gz: 50fa2999ebe80ce40fe244b10bac6cf3644f4dd7e7825913726e8cc2587a901f0d2d164d1c29e17b55f613bd7258dc13d672a5787334f90afc4059d0480312b9

data/CHANGELOG.md

@@ -1,31 +1,244 @@
-# v0.13.3 2019-05-21
+# v1.3.1 2019-08-16
+
+### Changed
+
+* You can now set an external schema without providing a block (alassek)
+
+[Compare v1.3.0...v1.3.1](https://github.com/dry-rb/dry-validation/compare/v1.3.0...v1.3.1)
+
+# v1.3.0 2019-08-14
+
+### Added
+
+* Support for setting an external schema (that can be extended too) (fixed #574) (@solnic)
+
+### Fixed
+
+* Using a hash spec to define rule keys with more than one value is properly handled by rule guard now (fixed #576) (@solnic)
+
+### Changed
+
+* `values` within rules uses `Hash#fetch_values` internally now, which improves performance (@esparta)
+
+[Compare v1.2.1...v1.3.0](https://github.com/dry-rb/dry-validation/compare/v1.2.1...v1.3.0)
+
+# v1.2.1 2019-07-16
+
+### Fixed
+
+* Defining an abstract contract class that has no schema no longer crashes (issue #565) (@solnic)
+* Fixed an issue where `Rule#each` would crash when the value is not an array (issue #567) (@solnic)
+* Fixed an issue where guarding a rule would crash when keys are missing in the input (issue #569) (@solnic)
+* Added missing "pathname" require (issue #570) (@solnic)
+
+[Compare v1.2.0...v1.2.1](https://github.com/dry-rb/dry-validation/compare/v1.2.0...v1.2.1)
+
+# v1.2.0 2019-07-08
+
+### Added
+
+* New extension `:predicates_as_macros` (@waiting-for-dev)
+
+### Fixed
+
+* Guarding rules for nested keys works correctly (issue #560) (@solnic)
+
+### Changed
+
+* `dry-schema` dependency was bumped to `>= 1.3.1` (@solnic)
+
+[Compare v1.1.1...v1.2.0](https://github.com/dry-rb/dry-validation/compare/v1.1.1...v1.2.0)
+
+# v1.1.1 2019-06-24
+
+### Fixed
+
+* `Rule#each` works with array values from nested hashes (@mustardnoise)
+
+[Compare v1.1.0...v1.1.1](https://github.com/dry-rb/dry-validation/compare/v1.1.0...v1.1.1)
+
+# v1.1.0 2019-06-14
+
+### Added
+
+* `key?` method available within rules, that can be used to check if there's a value under the rule's default key (refs #540) (@solnic)
+* `value` supports hash-based path specifications now (refs #547) (@solnic)
+* `value` can read multiple values when the key points to them, ie in case of `rule(geo: [:lat, :lon])` it would return an array with `lat` and `lon` (@solnic)
+
+### Fixed
+
+* Passing multiple macro names to `validate` or `each` works correctly (fixed #538 #541) (@jandudulski)
+
+[Compare v1.0.0...v1.1.0](https://github.com/dry-rb/dry-validation/compare/v1.0.0...v1.1.0)
+
+# v1.0.0 2019-06-10
+
+This release is a complete rewrite on top of `dry-schema` that uses contract classes to define schema and validation rules. It's **not backward-compatible**. This release addressed over 150 known issues, including bugs and missing features.
+
+See [the list of all addressed issues](https://github.com/dry-rb/dry-validation/issues?utf8=✓&q=is%3Aissue+is%3Aclosed+closed%3A%3E%3D2019-01-01+) as well as issues that were moved to dry-schema and [addressed there](https://github.com/dry-rb/dry-schema/issues?q=is%3Aissue+is%3Aclosed+dry-validation+milestone%3A1.0.0).
+
+### :sparkles: Release highlights :sparkles:
+
+- New `Dry::Validation::Contract` API for defining contract classes with schemas and validation rules
+- Improved message backends with support for `key` and `base` messages, and arbitrary meta-data (like error codes etc.)
+- Support for defining rules for array elements ie `rule(:items).each { ... }`
+- Support for macros that encapsulate common rule logic
+- Built-in `:acceptance` macro
+
+[Compare v0.13.3...v1.0.0](https://github.com/dry-rb/dry-validation/compare/v0.13.3...v1.0.0)
+
+# v1.0.0 2019-06-10 (compared to 1.0.0.rc3)
+
+### Added
+
+- Support for defining rules for each element of an array via `rule(:items).each { ... }` (solnic)
+- Support for parameterized macros via `rule(:foo).validate(my_macro: :some_option)` (solnic)
+- `values#[]` is now compatible with path specs (symbol, array with keys or dot-notation) (issue #528) (solnic)
+- `value` shortcut for accessing the value found under the first key specified by a rule. ie `rule(:foo) { value }` returns `values[:foo]` (solnic)
+
+### Fixed
+
+- Contract's `config.locale` option was replaced by `config.messages.default_locale` to avoid conflicts with run-time `:locale` option and/or whatever is set via `I18n` gem (solnic)
+- Macros no longer mutate `Dry::Validation::Contract.macros` when using inheritance (solnic)
+- Missing dependency on `dry-container` was added (solnic)
+
+### Changed
+
+- `rule` will raise `InvalidKeysError` when specified keys are not defined by the schema (solnic)
+- `Contract.new` will raise `SchemaMissingError` when the class doesn't have schema defined (solnic)
+- Contracts no longer support `:locale` option in the constructor. Use `Result#errors(locale: :pl)` to change locale at run-time (solnic)
+
+[Compare v1.0.0.rc3...v1.0.0](https://github.com/dry-rb/dry-validation/compare/v1.0.0.rc3...v1.0.0)
+
+# v1.0.0.rc3 2019-05-06
+
+### Added
+
+* [EXPERIMENTAL] `Validation.register_macro` for registering global macros (solnic)
+* [EXPERIMENTAL] `Contract.register_macro` for registering macros available to specific contract classes (solnic)
+* `Dry::Validation.Contract` shortcut for quickly defining a contract and getting its instance back (solnic)
+* New configuration option `config.locale` for setting the default locale (solnic)
 
 ### Fixed
 
-* Fixed regression with caching templates that rely on predicate arguments (solnic)
-* Removed ugly workaround for template evaluation with extra tokens (solnic)
+* `config/errors.yml` are now bundled with the gem, **`rc2` was broken because of this** (solnic)
+
+[Compare v1.0.0.rc2...v1.0.0.rc3](https://github.com/dry-rb/dry-validation/compare/v1.0.0.rc2...v1.0.0.rc3)
+
+# v1.0.0.rc2 2019-05-04
+
+This was **yanked** on rubygems.org because the bundled gem was missing `config` directory, thus it was not possible to require it. It was fixed in `rc3`.
+
+### Added
+
+* [EXPERIMENTAL] support for registering macros via `Dry::Validation::Macros.register(:your_macro, &block)` (solnic)
+* [EXPERIMENTAL] `:acceptance` as the first built-in macro (issue #157) (solnic)
+
+### Fixed
+
+* Passing invalid argument to `failure` will raise a meaningful error instead of crashing (solnic)
 
 ### Changed
 
-* [internal] `Messages::Abstract#call` returns a `Template` object now, this was backported from dry-schema (solnic)
+* In rule validation blocks, `values` is now an instance of a hash-like `Dry::Validation::Values` class, rather than `Dry::Schema::Result`. This gives more convenient access to data within rules (solnic)
+* Dependency on `dry-schema` was updated to `~> 1.0` (solnic)
 
-[Compare v0.13.2...v0.13.3](https://github.com/dry-rb/dry-validation/compare/v0.13.2...v0.13.3)
+[Compare v1.0.0.rc1...v1.0.0.rc2](https://github.com/dry-rb/dry-validation/compare/v1.0.0.rc1...v1.0.0.rc2)
 
-# v0.13.2 2019-05-12
+# v1.0.0.rc1 2019-04-26
+
+### Added
+
+* `:hints` extension is back (solnic)
+* `Result` objects have access to the context object which is shared between rules (flash-gordon)
 
 ### Fixed
 
-* Caching message templates uses restricted set of known keys to calculate cache keys (solnic)
+* Multiple hint messages no longer crash message set (flash-gordon)
+* `Contract#inspect` no longer crashes (solnic)
+
+### Changed
+
+* Dependency on `dry-schema` was bumped to `~> 0.6` - this pulls in `dry-types 1.0.0` and `dry-logic 1.0.0` (solnic)
+* Dependency on `dry-initializer` was bumped to `~> 3.0` (solnic)
+
+[Compare v1.0.0.beta2...v1.0.0.rc1](https://github.com/dry-rb/dry-validation/compare/v1.0.0.beta2...v1.0.0.rc1)
+
+# v1.0.0.beta2 2019-04-04
+
+### Added
+
+* Support for arbitrary meta-data in failures, ie:
+
+  ```ruby
+  class NewUserContract < Dry::Validation::Contract
+    params do
+      required(:login).filled(:string)
+    end
 
-[Compare v0.13.1...v0.13.2](https://github.com/dry-rb/dry-validation/compare/v0.13.1...v0.13.2)
+    rule(:login) do
+      key.failure(text: 'is taken', code: 123) unless db.unique?(values[:login])
+    end
+  end
+  ```
 
-# v0.13.1 2019-03-22
+  Now your error hash will include `{ login: [{ text: 'is taken', code: 123 }] }` (solnic + flash-gordon)
 
 ### Changed
 
-- `dry-types` was locked to `~> 0.14.0` (flash-gordon)
+* [BREAKING] `Error` was renamed to `Message` as it is a more generic concept (solnic)
+* [BREAKING] `ErrorSet` was renamed to `MessageSet` for consistency (solnic)
+* [BREAKING] `:monads` extension wraps entire result objects in `Success` or `Failure` (flash-gordon)
 
-[Compare v0.13.0...v0.13.1](https://github.com/dry-rb/dry-validation/compare/v0.13.0...v0.13.1)
+[Compare v1.0.0.beta1...v1.0.0.beta2](https://github.com/dry-rb/dry-validation/compare/v1.0.0.beta1...v1.0.0.beta2)
+
+# v1.0.0.beta1 2019-03-26
+
+### Added
+
+* New API for setting failures `base.failure` for base errors and `key.failure` for key errors (solnic)
+* Support for `base` errors associated with a key even when child keys have errors too (solnic)
+* Support for `base` errors not associated with any key (solnic)
+* Result objects use `ErrorSet` object now for managing messages (solnic)
+* Nested keys are properly handled when generating messages hash (issue #489) (flash-gordon + solnic)
+* Result objects support `locale` and `full` options now (solnic)
+* Ability to configure `top_namespace` for messages, which will be used for both schema and rule localization (solnic)
+* Rule blocks receive a context object that you can use to share data between rules (solnic)
+
+### Changed
+
+* [BREAKING] `Result#errors` returns an instance of `ErrorSet` now, it's an enumerable, coerible to a hash (solnic)
+* [BREAKING] `failure` was removed in favor of `key.failure` or `key(:foo).failure` (solnic)
+* [BREAKING] `Result#to_hash` was removed (flash-gordon)
+
+[Compare v1.0.0.alpha2...v1.0.0.beta1](https://github.com/dry-rb/dry-validation/compare/v1.0.0.alpha2...v1.0.0.beta1)
+
+# v1.0.0.alpha2 2019-03-05
+
+First round of bug fixes. Thanks for testing <3!
+
+### Fixed
+
+* Errors with nested messages are correctly built (flash-gordon)
+* Messages for nested keys are correctly resolved (solnic)
+* A message for a nested key is resolved when it's defined under `errors.rule.%{key}` too, but a message under nested key will override it (solnic)
+
+### Changed
+
+* When a message template is not found a more meaningful error is raised that includes both rule identifier and key path (solnic)
+
+[Compare v1.0.0.alpha1...v1.0.0.alpha2](https://github.com/dry-rb/dry-validation/compare/v1.0.0.alpha1...v1.0.0.alpha2)
+
+# v1.0.0.alpha1 2019-03-04
+
+Complete rewrite on top of `dry-schema`.
+
+### Added
+
+* [BREAKING] `Dry::Validation::Contract` as a replacement for validation schemas (solnic)
+* [BREAKING] New `rule` DSL with an improved API for setting error messages (solnic)
+
+[Compare v0.13.0...v1.0.0.alpha1](https://github.com/dry-rb/dry-validation/compare/v0.13.0...v1.0.0.alpha1)
 
 # v0.13.0 2019-01-29
 
@@ -38,7 +251,15 @@
 
 - Warning about method redefined (amatsuda)
 
-[Compare v0.12.2...v0.13.0](https://github.com/dry-rb/dry-validation/compare/v0.12.2...v0.13.0)
+[Compare v0.12.3...v0.13.0](https://github.com/dry-rb/dry-validation/compare/v0.12.3...v0.13.0)
+
+# v0.12.3 2019-01-29
+
+### Changed
+
+* [internal] dry-logic was pinned to `~> 0.4.2` (flash-gordon)
+
+[Compare v0.12.2...v0.12.3](https://github.com/dry-rb/dry-validation/compare/v0.12.2...v0.12.3)
 
 # v0.12.2 2018-08-29
 

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Dryrb Team
+Copyright (c) 2015-2019 dry-rb team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/README.md

@@ -1,26 +1,30 @@
 [gem]: https://rubygems.org/gems/dry-validation
-[travis]: https://travis-ci.org/dry-rb/dry-validation
+[travis]: https://travis-ci.com/dry-rb/dry-validation
 [codeclimate]: https://codeclimate.com/github/dry-rb/dry-validation
-[coveralls]: https://coveralls.io/r/dry-rb/dry-validation
+[chat]: https://dry-rb.zulipchat.com
 [inchpages]: http://inch-ci.org/github/dry-rb/dry-validation
 
-# dry-validation [![Join the chat at https://gitter.im/dry-rb/chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dry-rb/chat)
+# dry-validation [![Join the chat at https://dry-rb.zulipchat.com](https://img.shields.io/badge/dry--rb-join%20chat-%23346b7a.svg)][chat]
 
 [![Gem Version](https://badge.fury.io/rb/dry-validation.svg)][gem]
-[![Build Status](https://travis-ci.org/dry-rb/dry-validation.svg?branch=master)][travis]
+[![Build Status](https://travis-ci.com/dry-rb/dry-validation.svg?branch=master)][travis]
 [![Code Climate](https://codeclimate.com/github/dry-rb/dry-validation/badges/gpa.svg)][codeclimate]
 [![Test Coverage](https://codeclimate.com/github/dry-rb/dry-validation/badges/coverage.svg)][codeclimate]
 [![Inline docs](http://inch-ci.org/github/dry-rb/dry-validation.svg?branch=master)][inchpages]
 
-## Status
-
-We're working on a new foundation for dry-validation, called dry-schema. You can see progress in [this PR](https://github.com/dry-rb/dry-schema/pull/3). This will result in a partial rewrite for 1.0.0 version. Currently known bugs/issues will be addressed in 1.0.0, **not in 0.x** due to lack of time. More info about 1.0.0 plans can be found [in this thread](https://discourse.dry-rb.org/t/plans-for-dry-validation-dry-schema-a-new-gem/215/3).
-
 ## Links
 
-* [Documentation](http://dry-rb.org/gems/dry-validation)
+* [User documentation](https://dry-rb.org/gems/dry-validation)
+* [API documentation](http://rubydoc.info/gems/dry-validation)
 * [Guidelines for contributing](CONTRIBUTING.md)
 
+## Supported Ruby versions
+
+This library officially supports following Ruby versions:
+
+* MRI >= `2.4`
+* jruby >= `9.2`
+
 ## License
 
 See `LICENSE` file.

data/config/errors.yml

@@ -1,89 +1,4 @@
 en:
-  errors:
-    or: "or"
-    array?: "must be an array"
-
-    empty?: "must be empty"
-
-    excludes?: "must not include %{value}"
-
-    excluded_from?:
-      arg:
-        default: "must not be one of: %{list}"
-        range: "must not be one of: %{list_left} - %{list_right}"
-    exclusion?: "must not be one of: %{list}"
-
-    eql?: "must be equal to %{left}"
-
-    not_eql?: "must not be equal to %{left}"
-
-    filled?: "must be filled"
-
-    format?: "is in invalid format"
-
-    number?: "must be a number"
-
-    odd?: "must be odd"
-
-    even?: "must be even"
-
-    gt?: "must be greater than %{num}"
-
-    gteq?: "must be greater than or equal to %{num}"
-
-    hash?: "must be a hash"
-
-    included_in?:
-      arg:
-        default: "must be one of: %{list}"
-        range: "must be one of: %{list_left} - %{list_right}"
-    inclusion?: "must be one of: %{list}"
-
-    includes?: "must include %{value}"
-
-    bool?: "must be boolean"
-
-    true?: "must be true"
-
-    false?: "must be false"
-
-    int?: "must be an integer"
-
-    float?: "must be a float"
-
-    decimal?: "must be a decimal"
-
-    date?: "must be a date"
-
-    date_time?: "must be a date time"
-
-    time?: "must be a time"
-
-    key?: "is missing"
-
-    attr?: "is missing"
-
-    lt?: "must be less than %{num}"
-
-    lteq?: "must be less than or equal to %{num}"
-
-    max_size?: "size cannot be greater than %{num}"
-
-    min_size?: "size cannot be less than %{num}"
-
-    none?: "cannot be defined"
-
-    str?: "must be a string"
-
-    type?: "must be %{type}"
-
-    size?:
-      arg:
-        default: "size must be %{size}"
-        range: "size must be within %{size_left} - %{size_right}"
-
-      value:
-        string:
-          arg:
-            default: "length must be %{size}"
-            range: "length must be within %{size_left} - %{size_right}"
+  dry_validation:
+    errors:
+      acceptance: "must accept %{key}"

data/lib/dry-validation.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'dry/validation'

data/lib/dry/validation.rb

@@ -1,43 +1,62 @@
-require 'dry/core/extensions'
-require 'dry/core/constants'
+# frozen_string_literal: true
 
+require 'dry/validation/constants'
+require 'dry/validation/contract'
+require 'dry/validation/macros'
+
+# Main namespace
+#
+# @api public
 module Dry
+  # Main library namespace
+  #
+  # @api public
   module Validation
     extend Dry::Core::Extensions
-    include Dry::Core::Constants
-
-    MissingMessageError = Class.new(StandardError)
-    InvalidSchemaError = Class.new(StandardError)
+    extend Macros::Registrar
 
-    def self.messages_paths
-      Messages::Abstract.config.paths
+    register_extension(:monads) do
+      require 'dry/validation/extensions/monads'
     end
 
-    def self.Schema(base = Schema, **options, &block)
-      schema_class = Class.new(base.is_a?(Schema) ? base.class : base)
-      klass = schema_class.define(options.merge(schema_class: schema_class), &block)
+    register_extension(:hints) do
+      require 'dry/validation/extensions/hints'
+    end
 
-      if options[:build] == false
-        klass
-      else
-        klass.new
-      end
+    register_extension(:predicates_as_macros) do
+      require 'dry/validation/extensions/predicates_as_macros'
     end
 
-    def self.Params(base = nil, **options, &block)
-      klass = base ? Schema::Params.configure(Class.new(base)) : Schema::Params
-      Validation.Schema(klass, options, &block)
+    # Define a contract and build its instance
+    #
+    # @example
+    #   my_contract = Dry::Validation.Contract do
+    #     params do
+    #       required(:name).filled(:string)
+    #     end
+    #   end
+    #
+    #   my_contract.call(name: "Jane")
+    #
+    # @param [Hash] options Contract options
+    #
+    # @see Contract
+    #
+    # @return [Contract]
+    #
+    # @api public
+    #
+    # rubocop:disable Naming/MethodName
+    def self.Contract(options = EMPTY_HASH, &block)
+      Contract.build(options, &block)
     end
+    # rubocop:enable Naming/MethodName
 
-    def self.JSON(base = Schema::JSON, **options, &block)
-      klass = base ? Schema::JSON.configure(Class.new(base)) : Schema::JSON
-      Validation.Schema(klass, options, &block)
+    # This is needed by Macros::Registrar
+    #
+    # @api private
+    def self.macros
+      Macros
     end
   end
 end
-
-require 'dry/validation/schema'
-require 'dry/validation/schema/params'
-require 'dry/validation/schema/json'
-require 'dry/validation/extensions'
-require 'dry/validation/version'