dry-validation 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 341f5b1e89f76e09d7a1d8d2d20cdb68a50a88c1
-  data.tar.gz: 6dada3ab87730f7fe97e600bb73868c2afba511f
+  metadata.gz: 8cb2b0cdd55dfea0aeab8060f8628f55b304c584
+  data.tar.gz: ab8689f62590fe6029e427a9563e9da5a1eafe7d
 SHA512:
-  metadata.gz: 331d2cd4ea7c0f2b3b96046ad46faf7de8746b1538aaaba8f0fdf07a71546088962653d96cc8b71a3ecba0b04850367b19841f0418d083702666e154890bf29c
-  data.tar.gz: ec3ec948092ab30ad982498ca234b385c66e136ec351cc0b8754f041a46a23cc59049b34fae76aec31d2cc46a2f11d91b9f469c862cc991c4605531600d31d39
+  metadata.gz: 35a95e790addbea7fbabd6d60c0ac130db75f30248c0ff7f51583bb893d7422c8fd2b60e6dcb462d5fb7a242e0980dede8cdc6df1076667e60110e69babcc081
+  data.tar.gz: 55cd8947019a5326256afca381c58538c6c272874ecf34ae942809dc5af3ba5d1cb294864701b0ce415b23d2a82ae7765242e8c1bcd79b8b1c20233d0ba670a7

data/.codeclimate.yml

@@ -7,6 +7,7 @@ engines:
       Rubocop/Style/StabbyLambdaParentheses:
         enabled: false
       Rubocop/Metrics/CyclomaticComplexity:
+        enabled: true
         Max: 10
 ratings:
   paths:

data/.travis.yml

@@ -1,13 +1,14 @@
 language: ruby
 sudo: false
 cache: bundler
-bundler_args: --without console
+bundler_args: --without console benchmarks
 script:
   - bundle exec rake spec
 rvm:
   - 2.0
   - 2.1
   - 2.2
+  - 2.3.0
   - rbx-2
   - jruby-9000
   - ruby-head
@@ -17,9 +18,9 @@ env:
     - JRUBY_OPTS='--dev -J-Xmx1024M'
 matrix:
   allow_failures:
+    - rvm: rbx-2
     - rvm: ruby-head
     - rvm: jruby-head
-    - rvm: jruby-9000
 notifications:
   email: false
   webhooks:

data/CHANGELOG.md

@@ -1,3 +1,45 @@
+# v0.7.0 2016-03-16
+
+### Added
+
+* Support for macros:
+  * `required` - when value must be filled
+  * `maybe` - when value can be nil (or empty, in case of `Form`)
+  * `when` - for composing high-level rule based on predicates applied to a
+    validated value
+  * `confirmation` - for confirmation validation
+* Support for `value(:foo).eql?(value(:bar))` syntax in high-level rules (solnic)
+* New DSL for defining schema objects `Dry::Validation.Schema do .. end` (solnic)
+* Ability to define a schema for an array via top-level `each` rule (solnic)
+* Ability to define nested schemas via `key(:location).schema do .. end` (solnic)
+* Ability to re-use schemas inside other schemas via `key(:location).schema(LocationSchema)` (solnic)
+* Ability to inherit rules from another schema via `Dry::Validation.Schema(Other) do .. end` (solnic)
+* Ability to inject arbitrary dependencies to schemas via `Schema.option` + `Schema#with` (solnic)
+* Ability to provide translations for rule names under `%{locale}.rules.%{name}` pattern (solnic)
+* Ability to configure input processor, either `:form` or `:sanitizer` (solnic)
+* Ability to pass a constrained dry type when defining keys or attrs, ie `key(:age, Types::Age)` (solnic)
+* `Result#messages` supports `:full` option to get messages with rule names, disabled by default (solnic)
+* `Validation::Result` responds to `#[]` and `#each` (delegating to its output)
+  and it's an enumerable (solnic)
+
+### Changed
+
+* `schema` was **removed** from the DSL, just use `key(:name).schema` instead (solnic)
+* `confirmation` is now a macro that you can call on a key rule (solnic)
+* rule names for nested structures are now fully qualified, which means you can
+  provide customized messages for them. ie `user: :email` (solnic)
+* `Schema::Result#params` was renamed to `#output` (solnic)
+* `Schema::Result` is now `Validation::Result` and it no longer has success and
+  failure results, only error results are provided (solnic)
+
+### Fixed
+
+* Qualified rule names properly use last node by default for error messages (solnic)
+* Validation hints only include relevant messages (solnic)
+* `:yaml` messages respect `:locale` option in `Result#messages` (solnic)
+
+[Compare v0.6.0...v0.7.0](https://github.com/dryrb/dry-validation/compare/v0.6.0...v0.7.0)
+
 # v0.6.0 2016-01-20
 
 ### Added

data/Gemfile

@@ -8,9 +8,16 @@ group :test do
 end
 
 group :tools do
-  gem 'rubocop'
   gem 'guard'
   gem 'guard-rspec'
   gem 'guard-rubocop'
   gem 'byebug', platform: :mri
 end
+
+group :benchmarks do
+  gem 'hotch'
+  gem 'activemodel', '5.0.0.beta3'
+  gem 'actionpack', '5.0.0.beta3'
+  gem 'benchmark-ips'
+  gem 'virtus'
+end

data/README.md

@@ -1,98 +1,22 @@
 [gem]: https://rubygems.org/gems/dry-validation
-[travis]: https://travis-ci.org/dryrb/dry-validation
-[gemnasium]: https://gemnasium.com/dryrb/dry-validation
-[codeclimate]: https://codeclimate.com/github/dryrb/dry-validation
-[coveralls]: https://coveralls.io/r/dryrb/dry-validation
-[inchpages]: http://inch-ci.org/github/dryrb/dry-validation
+[travis]: https://travis-ci.org/dry-rb/dry-validation
+[gemnasium]: https://gemnasium.com/dry-rb/dry-validation
+[codeclimate]: https://codeclimate.com/github/dry-rb/dry-validation
+[coveralls]: https://coveralls.io/r/dry-rb/dry-validation
+[inchpages]: http://inch-ci.org/github/dry-rb/dry-validation
 
-# dry-validation [![Join the chat at https://gitter.im/dryrb/chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dryrb/chat)
+# 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)
 
 [![Gem Version](https://badge.fury.io/rb/dry-validation.svg)][gem]
-[![Build Status](https://travis-ci.org/dryrb/dry-validation.svg?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/dryrb/dry-validation.svg)][gemnasium]
-[![Code Climate](https://codeclimate.com/github/dryrb/dry-validation/badges/gpa.svg)][codeclimate]
-[![Test Coverage](https://codeclimate.com/github/dryrb/dry-validation/badges/coverage.svg)][codeclimate]
-[![Inline docs](http://inch-ci.org/github/dryrb/dry-validation.svg?branch=master)][inchpages]
+[![Build Status](https://travis-ci.org/dry-rb/dry-validation.svg?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/dry-rb/dry-validation.svg)][gemnasium]
+[![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]
 
-Data validation library based on predicate logic and rule composition.
+## Links
 
-## Overview
-
-Unlike other, well known, validation solutions in Ruby, `dry-validation` takes
-a different approach and focuses a lot on explicitness, clarity and preciseness
-of validation logic. It is designed to work with any data input, whether it's a
-simple hash, an array or a complex object with deeply nested data.
-
-It is based on an idea that each validation is encapsulated by a simple,
-stateless predicate, that receives some input and returns either `true` or `false`.
-
-Those predicates are encapsulated by `rules` which can be composed together using
-`predicate logic`. This means you can use the common logic operators to build up
-a validation `schema`.
-
-Validations can be described with great precision, `dry-validation` eliminates
-ambigious concepts like `presence` validation where we can't really say whether
-some attribute or key is *missing* or it's just that the value is `nil`.
-
-In `dry-validation` type-safety is a first-class feature, something that's completely
-missing in other validation libraries, and it's an important and useful feature. It
-means you can compose a validation that does rely on the type of a given value. In
-example it makes no sense to validate each element of an array when it turns out to
-be an empty string.
-
-## The DSL
-
-The core of `dry-validation` is rule composition and predicate logic provided by
-[dry-logic](https://github.com/dryrb/dry-logic). The DSL is a simple front-end
-for it. It only allows you to define the rules by using predicate identifiers.
-There are no magical options, conditionals and custom validation blocks known from
-other libraries. The focus is on pure validation logic expressed in a concise way.
-
-The DSL is very abstract, it builds [a rule AST](https://github.com/dryrb/dry-validation/wiki/Rule-AST)
-which is compiled into an array of rule objects. This means alternative interfaces could
-be easily build.
-
-## When To Use?
-
-Always and everywhere. This is a general-purpose validation library that can be used for many things and **it's multiple times faster** than `ActiveRecord`/`ActiveModel::Validations` *and* `strong-parameters`.
-
-Possible use-cases include validation of:
-
-* Form params
-* "GET" params
-* JSON documents
-* YAML documents
-* Application configuration (ie stored in ENV)
-* Replacement for `ActiveRecord`/`ActiveModel::Validations`
-* Replacement for `strong-parameters`
-* etc.
-
-## Synopsis
-
-Please refer to [the wiki](https://github.com/dryrb/dry-validation/wiki) for full usage documentation.
-
-``` ruby
-class UserSchema < Dry::Validation::Schema
-  key(:name) { |name| name.filled? }
-
-  key(:email) { |email| email.filled? & email.format?(EMAIL_REGEX) }
-
-  key(:age) { |age| age.none? | age.int? }
-
-  key(:address) do |address|
-   address.key(:street, &:filled?)
-   address.key(:city, &:filled?)
-   address.key(:zipcode, &:filled?)
-  end
-end
-```
-
-## Status and Roadmap
-
-This library is in an early stage of development but you are encouraged to
-try it out and provide feedback.
-
-For planned features check out [the issues](https://github.com/dryrb/dry-validation/labels/feature).
+* [Documentation](http://dry-rb.org/gems/dry-validation)
 
 ## License
 

data/config/errors.yml

@@ -1,62 +1,68 @@
 en:
   errors:
-    array?: "%{name} must be an array"
+    array?: "must be an array"
 
-    empty?: "%{name} cannot be empty"
+    empty?: "cannot be empty"
 
-    exclusion?: "%{name} must not be one of: %{list}"
+    exclusion?: "must not be one of: %{list}"
 
-    eql?: "%{name} must be equal to %{eql_value}"
+    eql?: "must be equal to %{eql_value}"
 
-    filled?: "%{name} must be filled"
+    filled?: "must be filled"
 
-    format?: "%{name} is in invalid format"
+    format?: "is in invalid format"
 
-    gt?: "%{name} must be greater than %{num}"
+    gt?: "must be greater than %{num}"
 
-    gteq?: "%{name} must be greater than or equal to %{num}"
+    gteq?: "must be greater than or equal to %{num}"
 
-    hash?: "%{name} must be a hash"
+    hash?: "must be a hash"
 
-    inclusion?: "%{name} must be one of: %{list}"
+    inclusion?: "must be one of: %{list}"
 
-    bool?: "%{name} must be boolean"
+    bool?: "must be boolean"
 
-    int?: "%{name} must be an integer"
+    true?: "must be true"
 
-    float?: "%{name} must be a float"
+    false?: "must be false"
 
-    decimal?: "%{name} must be a decimal"
+    int?: "must be an integer"
 
-    date?: "%{name} must be a date"
+    float?: "must be a float"
 
-    date_time?: "%{name} must be a date time"
+    decimal?: "must be a decimal"
 
-    time?: "%{name} must be a time"
+    date?: "must be a date"
 
-    key?: "%{name} is missing"
+    date_time?: "must be a date time"
 
-    attr?: "%{name} is missing"
+    time?: "must be a time"
 
-    lt?: "%{name} must be less than %{num} (%{value} was given)"
+    key?: "is missing"
 
-    lteq?: "%{name} must be less than or equal to %{num}"
+    attr?: "is missing"
 
-    max_size?: "%{name} size cannot be greater than %{num}"
+    lt?: "must be less than %{num} (%{value} was given)"
 
-    min_size?: "%{name} size cannot be less than %{num}"
+    lteq?: "must be less than or equal to %{num}"
 
-    none?: "%{name} cannot be defined"
+    max_size?: "size cannot be greater than %{num}"
 
-    str?: "%{name} must be a string"
+    min_size?: "size cannot be less than %{num}"
+
+    none?: "cannot be defined"
+
+    str?: "must be a string"
+
+    type?: "must be %{type}"
 
     size?:
       arg:
-        default: "%{name} size must be %{num}"
-        range: "%{name} size must be within %{left} - %{right}"
+        default: "size must be %{num}"
+        range: "size must be within %{left} - %{right}"
 
       value:
         string:
           arg:
-            default: "%{name} length must be %{num}"
-            range: "%{name} length must be within %{left} - %{right}"
+            default: "length must be %{num}"
+            range: "length must be within %{left} - %{right}"

data/dry-validation.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'dry-configurable', '~> 0.1', '>= 0.1.3'
   spec.add_runtime_dependency 'dry-container', '~> 0.2', '>= 0.2.8'
   spec.add_runtime_dependency 'dry-equalizer', '~> 0.2'
-  spec.add_runtime_dependency 'dry-logic', '~> 0.1', '>= 0.1.2'
-  spec.add_runtime_dependency 'dry-data', '~> 0.5', '>= 0.5.0'
+  spec.add_runtime_dependency 'dry-logic', '~> 0.2', '>= 0.2.0'
+  spec.add_runtime_dependency 'dry-types', '~> 0.6', '>= 0.6.0'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

data/examples/basic.rb

@@ -1,15 +1,11 @@
 require 'dry-validation'
 
-class Schema < Dry::Validation::Schema
-  key(:email) { |email| email.filled? }
+schema = Dry::Validation.Schema do
+  key(:email).required
 
-  key(:age) do |age|
-    age.int? & age.gt?(18)
-  end
+  key(:age).required(:int?, gt?: 18)
 end
 
-schema = Schema.new
-
 errors = schema.call(email: 'jane@doe.org', age: 19).messages
 
 puts errors.inspect

data/examples/each.rb

@@ -1,15 +1,10 @@
+require 'byebug'
 require 'dry-validation'
 
-class Schema < Dry::Validation::Schema
-  key(:phone_numbers) do |phone_numbers|
-    phone_numbers.array? do
-      phone_numbers.each(&:str?)
-    end
-  end
+schema = Dry::Validation.Schema do
+  key(:phone_numbers).each(:str?)
 end
 
-schema = Schema.new
-
 errors = schema.call(phone_numbers: '').messages
 
 puts errors.inspect

data/examples/form.rb

@@ -1,14 +1,11 @@
 require 'dry-validation'
-require 'dry/validation/schema/form'
 
-class UserFormSchema < Dry::Validation::Schema::Form
-  key(:email) { |value| value.str? & value.filled? }
+schema = Dry::Validation.Form do
+  key(:email).required
 
-  key(:age) { |value| value.int? & value.gt?(18) }
+  key(:age).required(:int?, gt?: 18)
 end
 
-schema = UserFormSchema.new
-
 errors = schema.call('email' => '', 'age' => '18').messages
 
 puts errors.inspect

data/examples/nested.rb

@@ -1,26 +1,18 @@
 require 'dry-validation'
 
-class Schema < Dry::Validation::Schema
-  key(:address) do |address|
-    address.hash? do
-      address.key(:city) do |city|
-        city.min_size?(3)
-      end
+schema = Dry::Validation.Schema do
+  key(:address).schema do
+    key(:city).required(min_size?: 3)
 
-      address.key(:street) do |street|
-        street.filled?
-      end
+    key(:street).required
 
-      address.key(:country) do |country|
-        country.key(:name, &:filled?)
-        country.key(:code, &:filled?)
-      end
+    key(:country).schema do
+      key(:name).required
+      key(:code).required
     end
   end
 end
 
-schema = Schema.new
-
 errors = schema.call({}).messages
 
 puts errors.inspect

data/lib/dry/validation.rb

@@ -2,15 +2,43 @@ require 'dry-equalizer'
 require 'dry-configurable'
 require 'dry-container'
 
-# A collection of micro-libraries, each intended to encapsulate
-# a common task in Ruby
+require 'dry/validation/schema'
+require 'dry/validation/schema/form'
+
 module Dry
   module Validation
+    MissingMessageError = Class.new(StandardError)
+
     def self.messages_paths
       Messages::Abstract.config.paths
     end
+
+    def self.Schema(base = Schema, **options, &block)
+      dsl_opts = {
+        schema_class: Class.new(base.is_a?(Schema) ? base.class : base),
+        parent: options[:parent]
+      }
+
+      dsl = Schema::Value.new(dsl_opts)
+      dsl.instance_exec(&block)
+
+      klass = dsl.schema_class
+
+      klass.configure do |config|
+        config.rules = config.rules + (options.fetch(:rules, []) + dsl.rules)
+        config.checks = config.checks + dsl.checks
+        config.path = dsl.path
+      end
+
+      if options[:build] == false
+        klass
+      else
+        klass.new
+      end
+    end
+
+    def self.Form(options = {}, &block)
+      Validation.Schema(Schema::Form, options, &block)
+    end
   end
 end
-
-require 'dry/validation/schema'
-require 'dry/validation/schema/form'