dry-validation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6acd14c8b93a29eed518ef8934921cf35d0faf17
+  data.tar.gz: 83c9f549fb92f5ff4cf3f5c95ec8029e81c045d2
+SHA512:
+  metadata.gz: b7411edfe3d00dbc645d9c48a7df9dd952bf36c01e59f1a55e39114e0a757afd6b4e66b57a07380b658a146b2757651f4a1b47d61f29565d464d2b7896cdb04f
+  data.tar.gz: 50201382e0ed26bcebcf19f1d9dafe2c7c3ee260c9654afdb3b6002ce7cbf4bc83ad549e6ffff9f6636ca1fb9aa6eaadea1371044a08e33425443768eef2e512

data/.gitignore

@@ -0,0 +1,8 @@
+.DS_Store
+coverage
+/.bundle
+vendor/bundle
+bin/
+tmp/
+.idea/
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--order random

data/.rubocop.yml

@@ -0,0 +1,16 @@
+# Generated by `rubocop --auto-gen-config`
+inherit_from: .rubocop_todo.yml
+
+Metrics/LineLength:
+  Max: 100
+
+Style/Documentation:
+  Enabled: false
+
+Lint/HandleExceptions:
+  Exclude:
+    - rakelib/*.rake
+
+Style/FileName:
+  Exclude:
+    - lib/dry-validation.rb

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-10-30 01:32:46 +0000 using RuboCop version 0.34.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/.travis.yml

@@ -0,0 +1,29 @@
+language: ruby
+sudo: false
+cache: bundler
+bundler_args: --without console
+script:
+  - bundle exec rake spec
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - rbx-2
+  - jruby-9000
+  - ruby-head
+  - jruby-head
+env:
+  global:
+    - JRUBY_OPTS='--dev -J-Xmx1024M'
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+notifications:
+  email: false
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/19098b4253a72c9796db
+    on_success: change  # options: [always|never|change] default: always
+    on_failure: always  # options: [always|never|change] default: always
+    on_start: false     # default: false

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# v0.1.0 2015-11-25
+
+First public release

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :tools do
+  gem 'rubocop'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+  gem 'byebug', platform: :mri
+end

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Ruby Object Mapper
+
+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
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,297 @@
+# dry-validation <a href="https://gitter.im/dryrb/chat" target="_blank">![Join the chat at https://gitter.im/dryrb/chat](https://badges.gitter.im/Join%20Chat.svg)</a>
+
+<a href="https://rubygems.org/gems/dry-validation" target="_blank">![Gem Version](https://badge.fury.io/rb/dry-validation.svg)</a>
+<a href="https://travis-ci.org/dryrb/dry-validation" target="_blank">![Build Status](https://travis-ci.org/dryrb/dry-validation.svg?branch=master)</a>
+<a href="https://gemnasium.com/dryrb/dry-validation" target="_blank">![Dependency Status](https://gemnasium.com/dryrb/dry-validation.svg)</a>
+<a href="https://codeclimate.com/github/dryrb/dry-validation" target="_blank">![Code Climate](https://codeclimate.com/github/dryrb/dry-validation/badges/gpa.svg)</a>
+<a href="http://inch-ci.org/github/dryrb/dry-validation" target="_blank">![Documentation Status](http://inch-ci.org/github/dryrb/dry-validation.svg?branch=master&style=flat)</a>
+
+Data validation library based on predicate logic and rule composition.
+
+## 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 a simple 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`.
+
+It's very explicit, powerful and extendible.
+
+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`.
+
+There's also the concept of type-safety, completely missing in other validation
+libraries, which is quite important and useful. 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 rules composition and predicate logic. The DSL
+is a simple front-end for that. 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.
+
+## Examples
+
+### Basic
+
+Here's a basic example where we validate following things:
+
+* The input *must have a key* called `:email`
+  * Provided the email key is present, its value *must be filled*
+* The input *must have a key* called `:age`
+  * Provided the age key is present, its value *must be an integer* and it *must be greater than 18*
+
+This can be easily expressed through the DSL:
+
+``` ruby
+require 'dry-validation'
+
+class Schema < Dry::Validation::Schema
+  key(:email) { |email| email.filled? }
+
+  key(:age) do |age|
+    age.int? & age.gt?(18)
+  end
+end
+
+schema = Schema.new
+
+errors = schema.messages(email: 'jane@doe.org', age: 19)
+
+puts errors.inspect
+# []
+
+errors = schema.messages(email: nil, age: 19)
+
+puts errors.inspect
+# [[:email, ["email must be filled"]]]
+```
+
+A couple of remarks:
+
+* `key` assumes that we want to use the `:key?` predicate to check the existance of that key
+* `age.gt?(18)` translates to calling a predicate like this: `schema[:gt?].(18, age)`
+* `age.int? & age.gt?(18)` is a conjunction, so we don't bother about `gt?` unless `int?` returns `true`
+* You can also use `|` for disjunction
+* Schema object does not carry the input as its state, nor does it know how to access the input values, we
+  pass the input to `call` and get error set as the response
+
+### Nested Hash
+
+We are free to define validations for anything, including deeply nested structures:
+
+``` ruby
+require 'dry-validation'
+
+class Schema < Dry::Validation::Schema
+  key(:address) do |address|
+    address.key(:city) do |city|
+      city.min_size?(3)
+    end
+
+    address.key(:street) do |street|
+      street.filled?
+    end
+
+    address.key(:country) do |country|
+      country.key(:name, &:filled?)
+      country.key(:code, &:filled?)
+    end
+  end
+end
+
+schema = Schema.new
+
+errors = schema.messages({})
+
+puts errors.inspect
+# [[:address, ["address is missing"]]]
+
+errors = schema.messages(address: { city: 'NYC' })
+
+puts errors.inspect
+# [[:address, [[:street, ["street is missing"]], [:country, ["country is missing"]]]]]
+```
+
+### Defining Custom Predicates
+
+You can simply define predicate methods on your schema object:
+
+``` ruby
+class Schema < Dry::Validation::Schema
+  key(:email) { |value| value.str? & value.email? }
+
+  def email?(value)
+    ! /magical-regex-that-matches-emails/.match(value).nil?
+  end
+end
+```
+
+You can also re-use a predicate container across multiple schemas:
+
+``` ruby
+module MyPredicates
+  include Dry::Validation::Predicates
+
+  predicate(:email?) do |input|
+    ! /magical-regex-that-matches-emails/.match(value).nil?
+  end
+end
+
+class Schema < Dry::Validation::Schema
+  configure do |config|
+    config.predicates = MyPredicates
+  end
+
+  key(:email) { |value| value.str? & value.email? }
+end
+```
+
+## List of Built-In Predicates
+
+* `empty?`
+* `eql?`
+* `exclusion?`
+* `filled?`
+* `format?`
+* `gt?`
+* `gteq?`
+* `inclusion?`
+* `int?`
+* `key?`
+* `lt?`
+* `lteq?`
+* `max_size?`
+* `min_size?`
+* `nil?`
+* `size?`
+* `str?`
+
+## Error Messages
+
+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.
+
+You can provide your own messages and configure your schemas to use it like that:
+
+``` ruby
+class Schema < Dry::Validation::Schema
+  configure { |config| config.messages_file = '/path/to/my/errors.yml' }
+end
+```
+
+You can also provide a namespace per-schema that will be used by default:
+
+``` ruby
+class Schema < Dry::Validation::Schema
+  configure { |config| config.namespace = :user }
+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"
+```
+
+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"
+
+# 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"
+```
+
+By configuring `messages_file` and/or `namespace` in a schema, default messages
+are going to be automatically merged with your overrides and/or namespaced.
+
+## I18n Integration
+
+Coming (very) soon...
+
+## Rule AST
+
+Internally, `dry-validation` uses a simple AST representation of rules and errors
+to produce rule objects and error messages. If you would like to programatically
+generate rules, it is a very simple process:
+
+``` ruby
+ast = [
+  [
+    :and,
+    [
+      [:key, [:age, [:predicate, [:key?, []]]]],
+      [
+        :and,
+        [
+          [:val, [:age, [:predicate, [:filled?, []]]]],
+          [:val, [:age, [:predicate, [:gt?, [18]]]]]
+        ]
+      ]
+    ]
+  ]
+]
+
+compiler = Dry::Validation::RuleCompiler.new(Dry::Validation::Predicates)
+
+# compile an array of rule objects
+rules = compiler.call(ast)
+
+puts rules.inspect
+# [
+#   #<Dry::Validation::Rule::Conjunction
+#     left=#<Dry::Validation::Rule::Key name=:age predicate=#<Dry::Validation::Predicate id=:key?>>
+#     right=#<Dry::Validation::Rule::Conjunction
+#       left=#<Dry::Validation::Rule::Value name=:age predicate=#<Dry::Validation::Predicate id=:filled?>>
+#       right=#<Dry::Validation::Rule::Value name=:age predicate=#<Dry::Validation::Predicate id=:gt?>>>>
+# ]
+
+# dump it back to ast
+puts rules.map(&:to_ary).inspect
+# [[:and, [:key, [:age, [:predicate, [:key?, [:age]]]]], [[:and, [:val, [:age, [:predicate, [:filled?, []]]]], [[:val, [:age, [:predicate, [:gt?, [18]]]]]]]]]]
+```
+
+Complete docs for the AST format are coming soon, for now please refer to
+[this spec](https://github.com/dryrb/dry-validation/blob/master/spec/unit/rule_compiler_spec.rb).
+
+## Status and Roadmap
+
+This library is in a very early stage of development but you are encauraged to
+try it out and provide feedback.
+
+For planned features check out [the issues](https://github.com/dryrb/dry-validation/labels/feature).
+
+## License
+
+See `LICENSE` file.

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+task default: :spec
+
+desc 'Run all specs in spec directory'
+RSpec::Core::RakeTask.new(:spec)

data/config/errors.yml

@@ -0,0 +1,35 @@
+empty?: "%{name} cannot be empty"
+
+exclusion?: "%{name} must not be one of: %{list}"
+
+eql?: "%{name} must be equal to %{eql_value}"
+
+filled?: "%{name} must be filled"
+
+format?: "%{name} is in invalid format"
+
+gt?: "%{name} must be greater than %{num} (%{value} was given)"
+
+gteq?: "%{name} must be greater than or equal to %{num}"
+
+inclusion?: "%{name} must be one of: %{list}"
+
+int?: "%{name} must be an integer"
+
+key?: "%{name} is missing"
+
+lt?: "%{name} must be less than %{num} (%{value} was given)"
+
+lteq?: "%{name} must be less than or equal to %{num}"
+
+max_size?: "%{name} size cannot be greater than %{num}"
+
+min_size?: "%{name} size cannot be less than %{num}"
+
+nil?: "%{name} cannot be nil"
+
+size?:
+  range: "%{name} size must be within %{left} - %{right}"
+  default: "%{name} size must be %{num}"
+
+str?: "%{name} must be a string"