view release on metacpan or  search on metacpan

README.md  view on Meta::CPAN

    Thus, I have designed `Data::Validator` in more Perl-ish way
    with full of `Smart::Args` functionality.

- Basics on type constraint system

    Moose's type constraint system is awesome, and so is Mouse's. In fact,
    Mouse's type constraints are much faster than Moose's so that you need not
    hesitate to check types.

    Thus, I have made `Data::Validator` on Mouse's type constraint system.

- Pure Perl

    Although I do not hesitate to depend on XS modules, some people think that
    XS modules are hard to install.

    Thus, I have written `Data::Validator` in pure Perl and selected dependent
    modules which work in pure Perl.

- Performance

    Validators should be as fast as possible because they matter only for illegal
    inputs. Otherwise, one would want something like _no validation_ option.

    This is much faster than `Params::Validate`, which has an XS backend, though.

# INTERFACE

## `Data::Validator->new( $arg_name => $rule [, ...]) :Validator`

Creates a validation rule. You should cache the rules for performance.

Attributes for _$rule_ are as follows:

- `isa => $type : Str|Object`

    The type of the rule, which can be a Mouse type constraint name, a class name,
    or a type constraint object of either Mouse or Moose (i.e. it's duck-typed).

- `does => $role : Str|Object`

    The type of the rule, which can be a Mouse type constraint name, a role name,
    or a type constraint object of either Mouse or Moose (i.e. it's duck-typed).

    Note that you cannot use it with the `isa` attribute.

- `coerce => $should_coercion : Bool`

    If false, the rule does not try to coerce when the validation fails.
    Default to true.

- `default=> $value : Any | CodeRef`

    The default value for the argument.
    If it is a CODE reference, it is called in scalar context as
    `$default->($validator, $rule, $args)` and its return value
    is used as a default value.

    Because arguments are validated in the order of definitions, `default`
    callbacks can rely on the previously-filled values:

        my $v = Data::Validator->new(
            foo => { default => 99 },
            bar => { default => sub {
                my($validator, $this_rule, $args) = @_;
                return $args->{foo} + 1;
            } },
        );
        $v->validate();          # bar is 100
        $v->validate(foo => 42); # bar is 43

    Unlike Moose/Mouse's `default`, any references are allowed, but note that
    they are statically allocated.

- `optional => $value : Bool`

    If true, users can omit the argument. Default to false.

- `xor => $exclusives : ArrayRef`

    Exclusive arguments, which users cannot pass together.

- `documentation => $doc : Str`

    Descriptions of the argument.

    This is not yet used anywhere.

## `$validator->find_rule($name :Str)`

Finds the rule named _$name_. Provided for error handling.

## `$validator->with(@extensions) :Validator`

Applies _@extensions_ to _$validator_ and returns itself.

See ["EXTENSIONS"](#extensions) for details.

## `$validator->validate(@args) :HashRef`

Validates _@args_ and returns a restricted HASH reference.

Restricted hashes are hashes which do not allow to access non-existing keys,
so you must check a key `exists` in the hash before fetching its values.

# EXTENSIONS

There are extensions which changes behaviours of `validate()`.

## Method

Takes the first argument as an invocant (i.e. class or object instance),
and returns it as the first value:

    my($invocant, $args) = $rule->validate(@_);

## SmartSequenced

Deals with arguments in mixing sequenced style and named style.
The sequenced style should be passed by the order of argument rules,