dry-validation 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee26d9a3fbca2ae3faf18827ad28f02bd323239b
-  data.tar.gz: a007eccefbc3456f8a481549512896074dcf3f86
+  metadata.gz: a4c5757cf4c0d97231cb5077aa617a731ae8b77c
+  data.tar.gz: bb77ddf24b5108592e5ab92961bff80caefb20e6
 SHA512:
-  metadata.gz: fe7c8c42376862ea8fbe14d3563ad65f7e3bc3f8d9b8bbbb9bff2fc239b7e16bfb9a11fd6cba5f2d0957650cd365470beaacb158a5a078998a589a15d92ca571
-  data.tar.gz: 8d337dd7bbf3fef8ca79f41ea962bc692ac6dd25b6fd93fca7c55559f0f3723f37e1bdd5fea804d3fcccbda1358f0360c8576268ecf766eed589208ac4771a31
+  metadata.gz: 78c62e2a2585215397e12cb0621497e1b4332750b61501534b0e1f643f7d5ea7f82e05f3c64b9977a313acf87466c8031ec160e3706794b34ce90c1fe8a7300a
+  data.tar.gz: 1a9685102ac167001c910e617dee87cea45f6413d105f5231e93790bc3dad0c7199e67a0d838b294185520e26a5475ab56f9b13df08be92e5880a630b129ca20

data/CHANGELOG.md

@@ -1,10 +1,34 @@
-# v0.2.0 to-be-released
+# v0.3.0 to-be-released
+
+### Added
+
+* I18n messages support (solnic)
+* Ability to configure `messages` via `configure { config.messages = :i18n }` (solnic)
+* `rule` interface in DSL for defining rules that depend on other rules (solnic)
+* `confirmation` interface as a shortcut for defining "confirmation of" rule (solnic)
+* Error messages can be now matched by input value type too (solnic)
+
+### Fixed
+
+* `optional` rule with coercions work correctly with `|` + multiple `&`s (solnic)
+* `Schema#[]` checks registered predicates first before defaulting to its own predicates (solnic)
+
+### Changed
+
+* `Schema#messages(input)` => `Schema#call(input).messages` (solnic)
+* `Schema#call` returns `Schema::Result` which has access to all rule results,
+  errors and messages
+* `Schema::Result#messages` returns a hash with rule names, messages and input values (solnic)
+
+[Compare v0.2.0...HEAD](https://github.com/dryrb/dry-validation/compare/v0.2.0...HEAD)
+
+# v0.2.0 2015-11-30
 
 ### Added
 
 * `Schema::Form` with a built-in coercer inferred from type-check predicates  (solnic)
 * Ability to pass a block to predicate check in the DSL ie `value.hash? { ... }` (solnic)
-* Optional keys using `option(:key_name) { ... }` interface in the DSL (solnic)
+* Optional keys using `optional(:key_name) { ... }` interface in the DSL (solnic)
 * New predicates:
   - `bool?`
   - `date?`

data/Gemfile

@@ -2,6 +2,10 @@ source 'https://rubygems.org'
 
 gemspec
 
+group :test do
+  gem 'i18n'
+end
+
 group :tools do
   gem 'rubocop'
   gem 'guard'

data/README.md

@@ -75,15 +75,15 @@ end
 
 schema = Schema.new
 
-errors = schema.messages(email: 'jane@doe.org', age: 19)
+errors = schema.call(email: 'jane@doe.org', age: 19).messages
 
 puts errors.inspect
 # []
 
-errors = schema.messages(email: nil, age: 19)
+errors = schema.call(email: nil, age: 19).messages
 
 puts errors.inspect
-# [[:email, ["email must be filled"]]]
+# { :email => [["email must be filled", nil]] }
 ```
 
 A couple of remarks:
@@ -112,15 +112,15 @@ end
 
 schema = Schema.new
 
-errors = schema.messages(email: 'jane@doe.org')
+errors = schema.call(email: 'jane@doe.org').messages
 
 puts errors.inspect
 # []
 
-errors = schema.messages(email: 'jane@doe.org', age: 17)
+errors = schema.call(email: 'jane@doe.org', age: 17).messages
 
 puts errors.inspect
-# [[:age, ["age must be greater than 18 (17 was given)"]]]
+# { :age => [["age must be greater than 18"], 17] }
 ```
 
 ### Optional Values
@@ -140,20 +140,20 @@ end
 
 schema = Schema.new
 
-errors = schema.messages(email: 'jane@doe.org', age: nil)
+errors = schema.call(email: 'jane@doe.org', age: nil).messages
 
 puts errors.inspect
 # []
 
-errors = schema.messages(email: 'jane@doe.org', age: 19)
+errors = schema.call(email: 'jane@doe.org', age: 19).messages
 
 puts errors.inspect
 # []
 
-errors = schema.messages(email: 'jane@doe.org', age: 17)
+errors = schema.call(email: 'jane@doe.org', age: 17).messages
 
 puts errors.inspect
-# [[:age, ["age must be greater than 18 (17 was given)"]]]
+# { :age => [["age must be greater than 18"], 17] }
 ```
 
 ### Optional Key vs Value
@@ -201,15 +201,20 @@ end
 
 schema = Schema.new
 
-errors = schema.messages({})
+errors = schema.call({}).messages
 
 puts errors.inspect
-# [[:address, ["address is missing"]]]
+# { :address => ["address is missing"] }
 
-errors = schema.messages(address: { city: 'NYC' })
+errors = schema.call(address: { city: 'NYC' }).messages
 
-puts errors.inspect
-# [[:address, [[:street, ["street is missing"]], [:country, ["country is missing"]]]]]
+puts errors.to_h.inspect
+# {
+#   :address => [
+#     { :street => ["street is missing"] },
+#     { :country => ["country is missing"] }
+#   ]
+# }
 ```
 
 ### Array Elements
@@ -227,17 +232,50 @@ end
 
 schema = Schema.new
 
-errors = schema.messages(phone_numbers: '')
+errors = schema.call(phone_numbers: '').messages
 
 puts errors.inspect
-# [[:phone_numbers, ["phone_numbers must be an array"]]]
+# { :phone_numbers => [["phone_numbers must be an array", ""]] }
 
-errors = schema.messages(phone_numbers: ['123456789', 123456789])
+errors = schema.call(phone_numbers: ['123456789', 123456789]).messages
 
 puts errors.inspect
-# [[:phone_numbers, [[:phone_numbers, ["phone_numbers must be a string"]]]]]
+# {
+#   :phone_numbers => [
+#     {
+#       :phone_numbers => [
+#         ["phone_numbers must be a string", 123456789]
+#       ]
+#     }
+#   ]
+# }
+```
+
+### Rules Depending On Other Rules
+
+When a rule needs input from other rules and depends on their results you can
+define it using `rule` DSL. A common example of this is "confirmation validation":
+
+``` ruby
+class Schema < Dry::Validation::Schema
+  key(:password, &:filled?)
+  key(:password_confirmation, &:filled?)
+
+  rule(:password_confirmation, eql?: [:password, :password_confirmation])
+end
 ```
 
+A short version of the same thing:
+
+``` ruby
+class Schema < Dry::Validation::Schema
+  confirmation(:password)
+end
+```
+
+Notice that you must add `:password_confirmation` error message configuration if
+you want to have the error converted to a message.
+
 ### Form Validation With Coercions
 
 Probably the most common use case is to validate form params. This is a special
@@ -262,11 +300,13 @@ end
 
 schema = UserFormSchema.new
 
-errors = schema.messages('email' => '', 'age' => '18')
+errors = schema.call('email' => '', 'age' => '18').messages
 
 puts errors.inspect
-
-# [[:email, ["email must be filled"]], [:age, ["age must be greater than 18 (18 was given)"]]]
+# {
+#   :email => [["email must be filled", nil]],
+#   :age => [["age must be greater than 18 (18 was given)", 18]]
+# }
 ```
 
 There are few major differences between how it works here and in `ActiveModel`:
@@ -350,7 +390,8 @@ You can learn how to do that in the [Error Messages](https://github.com/dryrb/dr
 * `lteq?`
 * `max_size?`
 * `min_size?`
-* `size?`
+* `size?(int)`
+* `size?(range)`
 * `format?`
 * `inclusion?`
 * `exclusion?`
@@ -359,7 +400,7 @@ You can learn how to do that in the [Error Messages](https://github.com/dryrb/dr
 
 By default `dry-validation` comes with a set of pre-defined error messages for
 every built-in predicate. They are defined in [a yaml file](https://github.com/dryrb/dry-validation/blob/master/config/errors.yml)
-which is shipped with the gem.
+which is shipped with the gem. This file is compatible with `I18n` format.
 
 You can provide your own messages and configure your schemas to use it like that:
 
@@ -380,18 +421,31 @@ end
 Lookup rules:
 
 ``` yaml
-filled?: "%{name} must be filled"
-
-attributes:
-  email:
-    filled?: "the email is missing"
-
-user:
-  filled?: "%{name} name cannot be blank"
-
-  attributes:
-    address:
-      filled?: "You gotta tell us where you live"
+en:
+  errors:
+    size?:
+      arg:
+        default: "%{name} size must be %{num}"
+        range: "%{name} size must be within %{left} - %{right}"
+
+      value:
+        string:
+          arg:
+            default: "%{name} length must be %{num}"
+            range: "%{name} length must be within %{left} - %{right}"
+
+    filled?: "%{name} must be filled"
+
+    rules:
+      email:
+        filled?: "the email is missing"
+
+      user:
+        filled?: "%{name} name cannot be blank"
+
+        rules:
+          address:
+            filled?: "You gotta tell us where you live"
 ```
 
 Given the yaml file above, messages lookup works as follows:
@@ -399,15 +453,25 @@ Given the yaml file above, messages lookup works as follows:
 ``` ruby
 messages = Dry::Validation::Messages.load('/path/to/our/errors.yml')
 
-messages.lookup(:filled?, :age) # => "age must be filled"
-messages.lookup(:filled?, :address) # => "address must be filled"
-messages.lookup(:filled?, :email) # => "the email is missing"
+# matching arg type for size? predicate
+messages[:size?, rule: :name, arg_type: Fixnum] # => "%{name} size must be %{num}"
+messages[:size?, rule: :name, arg_type: Range] # => "%{name} size must within %{left} - %{right}"
+
+# matching val type for size? predicate
+messages[:size?, rule: :name, val_type: String] # => "%{name} length must be %{num}"
+
+# matching predicate
+messages[:filled?, rule: :age] # => "%{name} must be filled"
+messages[:filled?, rule: :address] # => "%{name} must be filled"
+
+# matching predicate for a specific rule
+messages[:filled?, rule: :email] # => "the email is missing"
 
 # with namespaced messages
 user_messages = messages.namespaced(:user)
 
-user_messages.lookup(:filled?, :age) # "age cannot be blank"
-user_messages.lookup(:filled?, :address) # "You gotta tell us where you live"
+user_messages[:filled?, rule: :age] # "%{name} cannot be blank"
+user_messages[:filled?, rule: :address] # "You gotta tell us where you live"
 ```
 
 By configuring `messages_file` and/or `namespace` in a schema, default messages
@@ -415,7 +479,32 @@ are going to be automatically merged with your overrides and/or namespaced.
 
 ## I18n Integration
 
-Coming (very) soon...
+If you are using `i18n` gem and load it before `dry-validation` then you'll be
+able to configure a schema to use `i18n` messages:
+
+``` ruby
+require 'i18n'
+require 'dry-validation'
+
+class Schema < Dry::Validation::Schema
+  configure { config.messages = :i18n }
+
+  key(:email, &:filled?)
+end
+
+schema = Schema.new
+
+# return default translations
+puts schema.call(email: '').messages
+{ :email => ["email must be filled"] }
+
+# return other translations (assuming you have it :))
+puts schema.call(email: '').messages(locale: :pl)
+{ :email => ["email musi być wypełniony"] }
+```
+
+Important: I18n must be initialized before using schema, `dry-validation` does
+not try to do it for you, it only sets its default error translations automatically.
 
 ## Rule AST
 

data/config/errors.yml

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

data/examples/basic.rb

@@ -10,12 +10,10 @@ end
 
 schema = Schema.new
 
-errors = schema.messages(email: 'jane@doe.org', age: 19)
+errors = schema.call(email: 'jane@doe.org', age: 19).messages
 
 puts errors.inspect
-# []
 
-errors = schema.messages(email: nil, age: 19)
+errors = schema.call(email: nil, age: 19).messages
 
 puts errors.inspect
-# [[:email, ["email must be filled"]]]

data/examples/each.rb

@@ -10,10 +10,10 @@ end
 
 schema = Schema.new
 
-errors = schema.messages(phone_numbers: '')
+errors = schema.call(phone_numbers: '').messages
 
 puts errors.inspect
 
-errors = schema.messages(phone_numbers: ['123456789', 123456789])
+errors = schema.call(phone_numbers: ['123456789', 123456789]).messages
 
 puts errors.inspect