/usr/share/doc/ruby-valid/README.md is in ruby-valid 1.0.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 | # Validator
[](http://travis-ci.org/zombor/Validator)
Validator is a simple ruby validation class. You don't use it directly inside your classes like just about every other ruby validation class out there. I chose to implement it in this way so I didn't automatically pollute the namespace of the objects I wanted to validate.
This also solves the problem of validating forms very nicely. Frequently you will have a form that represents many different data objects in your system, and you can pre-validate everything before doing any saving.
## Usage
Validator is useful for validating the state of any existing ruby object.
```ruby
object = OpenStruct.new(:email => 'foo@bar.com', :password => 'foobar')
validator = Validation::Validator.new(object)
validator.rule(:email, [:email, :not_empty]) # multiple rules in one line
validator.rule(:password, :not_empty) # a single rule on a line
validator.rule(:password, :length => {:minimum => 3}) # a rule that takes parameters
if validator.valid?
# save the data somewhere
else
@errors = validator.errors
end
```
The first paramater can be any message that the object responds to.
### Writing your own rules
If you have a custom rule you need to write, just put it inside the `Validation::Rule` namespace:
```ruby
module Validation
module Rule
class MyCustomRule
def error_key
:my_custom_rule
end
def valid_value?(value)
# Logic for determining the validity of the value
end
def params
{}
end
end
end
end
```
A rule class should have the following methods on it:
- `error_key` a symbol to represent the error. This shows up in the errors hash. Must be an underscored_version of the class name
- `valid_value?(value)` the beef of the rule. This is where you determine if the value is valid or not
- `params` the params hash that was passed into the constructor
### Writing self-contained validators
You can also create self-contained validation classes if you don't like the dynamic creation approach:
```ruby
require 'validation'
require 'validation/rule/not_empty'
class MyFormValidator < Validation::Validator
include Validation
rule :email, :not_empty
end
```
Now you can use this anywhere in your code:
```ruby
form_validator = MyFormValidator.new(OpenStruct.new(params))
form_validator.valid?
```
# Contributing
Have an improvement? Have an awesome rule you want included? Simple!
1. Fork the repository
2. Create a branch off of the `develop` branch
3. Write specs for the change
4. Add your change
5. Submit a pull request to merge against the `develop` branch
Don't change any version files or gemspec files in your change.
|