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 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
|
# ABSTRACT: Simple Streaming Data Validation
package Validation::Class::Simple::Streamer;
use 5.10.0;
use strict;
use warnings;
use base 'Validation::Class::Simple';
use Carp;
use Validation::Class::Util;
use overload bool => \&validate, '""' => \&messages, fallback => 1;
our $VERSION = '7.900057'; # VERSION
sub new {
my $class = shift;
$class = ref $class || $class;
my $self = $class->SUPER::new(@_);
$self->{action} = '';
$self->{target} = '';
return $self;
}
sub check {
my ($self, $target) = @_;
if ($target) {
return $self if $target eq $self->{target};
$self->prototype->fields->add($target => {name => $target})
unless $self->prototype->fields->has($target);
$self->prototype->queue($self->{target} = $target);
$self->prototype->normalize($self);
}
return $self;
}
sub clear {
my ($self) = @_;
$self->prototype->queued->clear;
$self->prototype->reset_fields;
return $self;
}
sub declare {
my ($self, @config) = @_;
my $arguments = pop(@config);
my $action = shift(@config) || $self->{action};
my $target = $self->{target};
return $self unless $target;
$self->prototype->queue($target); # if clear() was called or check() wasn't
unless ($arguments) {
$arguments = 1 if $action eq 'city';
$arguments = 1 if $action eq 'creditcard';
$arguments = 1 if $action eq 'date';
$arguments = 1 if $action eq 'decimal';
$arguments = 1 if $action eq 'email';
$arguments = 1 if $action eq 'hostname';
$arguments = 1 if $action eq 'multiples';
$arguments = 1 if $action eq 'required';
$arguments = 1 if $action eq 'ssn';
$arguments = 1 if $action eq 'state';
$arguments = 1 if $action eq 'telephone';
$arguments = 1 if $action eq 'time';
$arguments = 1 if $action eq 'uuid';
$arguments = 1 if $action eq 'zipcode';
}
if ($self->prototype->fields->has($target)) {
my $field = $self->prototype->fields->get($target);
if ($field->can($action)) {
$field->$action($arguments) if defined $arguments;
return $self;
}
}
exit carp sprintf q(Can't locate object method "%s" via package "%s"),
$action, ((ref $_[0] || $_[0]) || 'main')
;
}
sub messages {
my ($self, @arguments) = @_;
return $self->prototype->errors_to_string(@arguments);
}
sub validate {
my ($self) = @_;
my $true = $self->prototype->validate($self);
return $true;
}
sub AUTOLOAD {
(my $routine = $Validation::Class::Simple::Streamer::AUTOLOAD) =~ s/.*:://;
my ($self) = @_;
if ($routine) {
$self->{action} = $routine;
goto &declare;
}
croak sprintf q(Can't locate object method "%s" via package "%s"),
$routine, ((ref $_[0] || $_[0]) || 'main')
;
}
sub DESTROY {}
1;
__END__
=pod
=head1 NAME
Validation::Class::Simple::Streamer - Simple Streaming Data Validation
=head1 VERSION
version 7.900057
=head1 SYNOPSIS
use Validation::Class::Simple::Streamer;
my $params = {
credit_card => '0000000000000000',
email_address => 'root@localhost',
};
my $rules = Validation::Class::Simple::Streamer->new(params => $params);
# the point here is expressiveness
# directive methods auto-validate in boolean context !!!
if (not $rules->check('credit_card')->creditcard(['visa', 'mastercard'])) {
# credit card is invalid visa/mastercard
warn $rules->errors_to_string;
}
if (not $rules->check('email_address')->min_length(3)->email) {
# email address is invalid
warn $rules->errors_to_string;
}
# prepare password for validation
$rules->check('password');
die "Password is not valid"
unless $rules->min_symbols(1) && $rules->matches('password2');
# are you of legal age?
if ($rules->check('member_years_of_age')->between('18-75')) {
# access to explicit content approved
}
# get all fields with errors
my $fields = $rules->error_fields;
# warn with errors if any
warn $rules->errors_to_string unless $rules->validate;
=head1 DESCRIPTION
Validation::Class::Simple::Streamer is a simple streaming validation module
that makes data validation fun. Target parameters and attach matching fields
and directives to them by chaining together methods which represent
Validation::Class L<directives|Validation::Class::Directives/DIRECTIVES>. This
module is built around the powerful L<Validation::Class> data validation
framework via L<Validation::Class::Simple>. This module is a sub-class of and
derived from the L<Validation::Class::Simple> class.
=head1 RATIONALE
If you are new to Validation::Class, or would like more information on
the underpinnings of this library and how it views and approaches
data validation, please review L<Validation::Class::Whitepaper>. Please review
the L<Validation::Class::Cookbook/GUIDED-TOUR> for a detailed step-by-step look
into how Validation::Class works.
=head1 METHODS
=head2 check
The check method specifies the parameter to be affected by directive methods
if/when called.
$self = $self->check('email_address'); # focus on email_address
$self->required; # apply the Required directive to email_address
$self->min_symbols(1); # apply the MinSymbols directive to email_address
$self->min_length(5); # apply the MinLength directive to email_address
=head2 clear
The clear method resets the validation queue and declared fields but leaves the
declared parameters in-tact, almost like the object state post-instantiation.
$self->clear;
=head2 messages
The messages method returns any registered errors as a concatenated string using
the L<Validation::Class::Prototype/errors_to_string> method and accepts the same
parameters.
print $self->messages;
=head2 validate
The validate method uses the validator to perform data validation based on the
series and sequence of commands issued previously. This method is called
implicitly whenever the object is used in boolean context, e.g. in a
conditional.
$true = $self->validate;
=head1 PROXY METHODS
Each instance of Validation::Class::Simple::Streamer is injected with a few
proxy methods which are basically aliases to the corresponding prototype
class methods, however it is possible to access the prototype directly using
the proto/prototype methods.
=head2 class
$self->class;
See L<Validation::Class::Prototype/class> for full documentation.
=head2 clear_queue
$self->clear_queue;
See L<Validation::Class::Prototype/clear_queue> for full documentation.
=head2 error_count
$self->error_count;
See L<Validation::Class::Prototype/error_count> for full documentation.
=head2 error_fields
$self->error_fields;
See L<Validation::Class::Prototype/error_fields> for full documentation.
=head2 errors
$self->errors;
See L<Validation::Class::Prototype/errors> for full documentation.
=head2 errors_to_string
$self->errors_to_string;
See L<Validation::Class::Prototype/errors_to_string> for full documentation.
=head2 get_errors
$self->get_errors;
See L<Validation::Class::Prototype/get_errors> for full documentation.
=head2 get_fields
$self->get_fields;
See L<Validation::Class::Prototype/get_fields> for full documentation.
=head2 get_hash
$self->get_hash;
See L<Validation::Class::Prototype/get_hash> for full documentation.
=head2 get_params
$self->get_params;
See L<Validation::Class::Prototype/get_params> for full documentation.
=head2 get_values
$self->get_values;
See L<Validation::Class::Prototype/get_values> for full documentation.
=head2 fields
$self->fields;
See L<Validation::Class::Prototype/fields> for full documentation.
=head2 filtering
$self->filtering;
See L<Validation::Class::Prototype/filtering> for full documentation.
=head2 ignore_failure
$self->ignore_failure;
See L<Validation::Class::Prototype/ignore_failure> for full documentation.
=head2 ignore_unknown
$self->ignore_unknown;
See L<Validation::Class::Prototype/ignore_unknown> for full documentation.
=head2 is_valid
$self->is_valid;
See L<Validation::Class::Prototype/is_valid> for full documentation.
=head2 param
$self->param;
See L<Validation::Class::Prototype/param> for full documentation.
=head2 params
$self->params;
See L<Validation::Class::Prototype/params> for full documentation.
=head2 plugin
$self->plugin;
See L<Validation::Class::Prototype/plugin> for full documentation.
=head2 queue
$self->queue;
See L<Validation::Class::Prototype/queue> for full documentation.
=head2 report_failure
$self->report_failure;
See L<Validation::Class::Prototype/report_failure> for full
documentation.
=head2 report_unknown
$self->report_unknown;
See L<Validation::Class::Prototype/report_unknown> for full documentation.
=head2 reset_errors
$self->reset_errors;
See L<Validation::Class::Prototype/reset_errors> for full documentation.
=head2 reset_fields
$self->reset_fields;
See L<Validation::Class::Prototype/reset_fields> for full documentation.
=head2 reset_params
$self->reset_params;
See L<Validation::Class::Prototype/reset_params> for full documentation.
=head2 set_errors
$self->set_errors;
See L<Validation::Class::Prototype/set_errors> for full documentation.
=head2 set_fields
$self->set_fields;
See L<Validation::Class::Prototype/set_fields> for full documentation.
=head2 set_params
$self->set_params;
See L<Validation::Class::Prototype/set_params> for full documentation.
=head2 set_method
$self->set_method;
See L<Validation::Class::Prototype/set_method> for full documentation.
=head2 stash
$self->stash;
See L<Validation::Class::Prototype/stash> for full documentation.
=head2 validate
$self->validate;
See L<Validation::Class::Prototype/validate> for full documentation.
=head2 validate_method
$self->validate_method;
See L<Validation::Class::Prototype/validate_method> for full documentation.
=head2 validate_profile
$self->validate_profile;
See L<Validation::Class::Prototype/validate_profile> for full documentation.
=head1 AUTHOR
Al Newkirk <anewkirk@ana.io>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2011 by Al Newkirk.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|