added validation support to form helpers

mojolicious · Sep 25, 2013 · c325cb4 · c325cb4
1 parent e2c3a2b
commit c325cb4
Show file tree

Hide file tree

Showing 6 changed files with 60 additions and 38 deletions.
diff --git a/lib/Mojolicious/Controller.pm b/lib/Mojolicious/Controller.pm
@@ -415,6 +415,12 @@ sub url_for {
   return $url;
 }
 
+sub validation {
+  my $self = shift;
+  return $self->stash->{'mojo.validation'}
+    ||= $self->app->validator->validation->input($self->req->params->to_hash);
+}
+
 sub write {
   my ($self, $chunk, $cb) = @_;
   ($cb, $chunk) = ($chunk, undef) if ref $chunk eq 'CODE';
@@ -895,6 +901,13 @@ to inherit query parameters from the current request.
   # "/list?q=mojo&page=2" if current request was for "/list?q=mojo&page=1"
   $c->url_with->query([page => 2]);
 
+=head2 validation
+
+  my $validation = $c->validation;
+
+Get L<Mojolicious::Validator::Validation> object for current request. Note
+that this method is EXPERIMENTAL and might change without warning!
+
 =head2 write
 
   $c = $c->write;

diff --git a/lib/Mojolicious/Plugin/DefaultHelpers.pm b/lib/Mojolicious/Plugin/DefaultHelpers.pm
@@ -8,7 +8,7 @@ sub register {
   my ($self, $app) = @_;
 
   # Controller alias helpers
-  for my $name (qw(app flash param stash session url_for)) {
+  for my $name (qw(app flash param stash session url_for validation)) {
     $app->helper($name => sub { shift->$name(@_) });
   }
 
@@ -33,7 +33,6 @@ sub register {
   $app->helper(include       => \&_include);
   $app->helper(ua            => sub { shift->app->ua });
   $app->helper(url_with      => \&_url_with);
-  $app->helper(validation    => \&_validation);
 }
 
 sub _content {
@@ -89,12 +88,6 @@ sub _url_with {
   return $self->url_for(@_)->query($self->req->url->query->clone);
 }
 
-sub _validation {
-  my $self = shift;
-  return $self->stash->{'mojo.validation'}
-    ||= $self->app->validator->validation->input($self->req->params->to_hash);
-}
-
 1;
 
 =encoding utf8
@@ -262,8 +255,8 @@ request.
 
   %= validation
 
-Get L<Mojolicious::Validator::Validation> object for current request. Note
-that this helper is EXPERIMENTAL and might change without warning!
+Alias for L<Mojolicious::Controller/"validation">. Note that this helper is
+EXPERIMENTAL and might change without warning!
 
 =head1 METHODS
 

diff --git a/lib/Mojolicious/Plugin/TagHelpers.pm b/lib/Mojolicious/Plugin/TagHelpers.pm
@@ -82,12 +82,9 @@ sub _input {
 
     # Others
     else { $attrs{value} = $values[0] }
-
-    return _tag('input', name => $name, %attrs);
   }
 
-  # Empty tag
-  return _tag('input', name => $name, %attrs);
+  return _wrap($self, $name, _tag('input', name => $name, %attrs));
 }
 
 sub _javascript {
@@ -162,7 +159,7 @@ sub _select_field {
     return $parts;
   };
 
-  return _tag('select', name => $name, %attrs, $optgroup);
+  return _wrap($self, $name, _tag('select', name => $name, %attrs, $optgroup));
 }
 
 sub _stylesheet {
@@ -227,7 +224,13 @@ sub _text_area {
     $cb = sub { xml_escape $content }
   }
 
-  return _tag('textarea', name => $name, @_, $cb);
+  return _wrap($self, $name, _tag('textarea', name => $name, @_, $cb));
+}
+
+sub _wrap {
+  my ($self, $name, $html) = @_;
+  return $html unless $self->validation->has_errors($name);
+  return _tag('div', class => 'fields_with_errors', sub {$html});
 }
 
 1;

diff --git a/lib/Mojolicious/Validator.pm b/lib/Mojolicious/Validator.pm
@@ -3,10 +3,10 @@ use Mojo::Base -base;
 
 use Mojolicious::Validator::Validation;
 
-has checks => sub { {range => \&_range} };
+has checks => sub { {size => \&_size} };
 has errors => sub {
   {
-    range    => sub {qq{Value needs to be $_[3]-$_[4] characters long.}},
+    size     => sub {qq{Value needs to be $_[3]-$_[4] characters long.}},
     required => sub {qq{Value is required.}}
   };
 };
@@ -24,7 +24,7 @@ sub _add {
   return $self;
 }
 
-sub _range {
+sub _size {
   my ($validation, $name, $value, $min, $max) = @_;
   my $len = length $value;
   return $len >= $min && $len <= $max;
@@ -56,16 +56,16 @@ L<Mojolicious::Validator> implements the following attributes.
 =head2 checks
 
   my $checks = $validator->checks;
-  $validator = $validator->checks({range => sub {...}});
+  $validator = $validator->checks({size => sub {...}});
 
-Registered checks, by default only C<range> is already defined.
+Registered checks, by default only C<size> is already defined.
 
 =head2 errors
 
   my $errors = $validator->errors;
-  $validator = $validator->errors({range => sub {...}});
+  $validator = $validator->errors({size => sub {...}});
 
-Registered error generators, by default only C<range> and C<required> are
+Registered error generators, by default only C<required> and C<size> are
 already defined.
 
 =head1 METHODS
@@ -75,13 +75,13 @@ implements the following new ones.
 
 =head2 add_check
 
-  $validator = $validator->add_check(range => sub {...});
+  $validator = $validator->add_check(size => sub {...});
 
 Register a new check.
 
 =head2 add_error
 
-  $validator = $validator->add_error(range => sub {...});
+  $validator = $validator->add_error(size => sub {...});
 
 Register a new error generator.
 

diff --git a/lib/Mojolicious/Validator/Validation.pm b/lib/Mojolicious/Validator/Validation.pm
@@ -158,7 +158,7 @@ and implements the following new ones.
 
 =head2 check
 
-  $validation = $validation->check('range', 2, 7);
+  $validation = $validation->check('size', 2, 7);
 
 Perform validation check.
 

diff --git a/t/mojolicious/validation_lite_app.t b/t/mojolicious/validation_lite_app.t
@@ -10,8 +10,11 @@ use Mojolicious::Lite;
 use Test::Mojo;
 
 get '/' => sub {
-  my $self = shift;
-  $self->validation->required('name')->range(2, 5);
+  my $self       = shift;
+  my $validation = $self->validation;
+  $validation->required('foo')->size(2, 5);
+  $validation->optional('bar')->size(2, 5);
+  $validation->optional('baz')->size(2, 5);
 } => 'index';
 
 my $t = Test::Mojo->new;
@@ -39,18 +42,18 @@ ok $validation->has_errors, 'has errors';
 is_deeply [$validation->errors('does_not_exist')->each],
   ['Value is required.'], 'right error';
 
-# Range
+# Size
 $validation = $t->app->validation;
 $validation->input({foo => 'bar', baz => 'yada', yada => 'yada'});
-ok $validation->required('foo')->range(1, 3)->is_valid, 'valid';
+ok $validation->required('foo')->size(1, 3)->is_valid, 'valid';
 is_deeply $validation->output, {foo => 'bar'}, 'right result';
 ok !$validation->has_errors, 'no errors';
-ok !$validation->required('baz')->range(1, 3)->is_valid, 'not valid';
+ok !$validation->required('baz')->size(1, 3)->is_valid, 'not valid';
 is_deeply $validation->output, {foo => 'bar'}, 'right result';
 ok $validation->has_errors, 'has errors';
 is_deeply [$validation->errors('baz')->each],
   ['Value needs to be 1-3 characters long.'], 'right error';
-ok !$validation->required('yada')->range(5, 10)->is_valid, 'not valid';
+ok !$validation->required('yada')->size(5, 10)->is_valid, 'not valid';
 is_deeply $validation->output, {foo => 'bar'}, 'right result';
 ok $validation->has_errors, 'has errors';
 is_deeply [$validation->errors('yada')->each],
@@ -70,13 +73,13 @@ ok !$validation->required('baz')->is_valid, 'not valid';
 ok $validation->has_errors, 'has errors';
 is_deeply [$validation->errors('baz')->each], ['Value is required.'],
   'right error';
-ok !$validation->required('foo')->error('Foo is too small.')->range(25, 100)
+ok !$validation->required('foo')->error('Foo is too small.')->size(25, 100)
   ->is_valid, 'not valid';
 ok $validation->has_errors, 'has errors';
 is_deeply [$validation->errors('foo')->each], ['Foo is too small.'],
   'right error';
 is $validation->topic, 'foo', 'right topic';
-ok !$validation->error('Failed!')->required('yada')->range(25, 100)->is_valid,
+ok !$validation->error('Failed!')->required('yada')->size(25, 100)->is_valid,
   'not valid';
 ok $validation->has_errors, 'has errors';
 is_deeply [$validation->errors('yada')->each],
@@ -85,15 +88,25 @@ is $validation->topic, 'yada', 'right topic';
 ok $validation->has_errors('bar'), 'has errors';
 
 # Successful validation
-$t->get_ok('/?name=sri')->status_is(200)->content_is("\n");
+$t->get_ok('/?foo=ok')->status_is(200)->element_exists('form > input')
+  ->element_exists('form > textarea')->element_exists('form > select');
 
 # Failed validation
-$t->get_ok('/?name=sebastian')->status_is(200)
-  ->content_is("Value needs to be 2-5 characters long.\n");
+$t->get_ok('/?foo=too_long&bar=too_long_too&baz=way_too_long')->status_is(200)
+  ->element_exists_not('form > input')
+  ->element_exists('form > div.fields_with_errors > input')
+  ->element_exists_not('form > textarea')
+  ->element_exists('form > div.fields_with_errors > textarea')
+  ->element_exists_not('form > select')
+  ->element_exists('form > div.fields_with_errors > select');
 
 done_testing();
 
 __DATA__
 
 @@ index.html.ep
-%= $_ for validation->errors('name')->each
+%= form_for index => begin
+  %= text_field 'foo'
+  %= text_area 'bar'
+  %= select_field baz => [qw(yada yada)]
+% end