improving doc part3 including some fixes found during code review while documenting
authorJens Rehsack <sno@NetBSD.org>
Fri, 10 Aug 2012 12:27:44 +0000 (10 14:27 +0200)
committerJens Rehsack <sno@NetBSD.org>
Fri, 10 Aug 2012 12:27:44 +0000 (10 14:27 +0200)
lib/Config/Any/WTScript.pm
lib/WWW/Mechanize/Script/Plugin/ContentSizeTest.pm
lib/WWW/Mechanize/Script/Plugin/RegexMatchTest.pm
lib/WWW/Mechanize/Script/Plugin/ResponseTimeTest.pm
lib/WWW/Mechanize/Script/Plugin/StatusTest.pm
lib/WWW/Mechanize/Script/Plugin/TextMatchTest.pm

index c7bfc47..5c2ed4f 100644 (file)
@@ -139,7 +139,7 @@ MSG
     return \@configs;
 }
 
-sub eval_in_playground
+sub _eval_in_playground
 {
     my $code = shift;
 
@@ -153,11 +153,11 @@ $code
 CODE
 }
 
-sub make_sub_in_playground
+sub _make_sub_in_playground
 {
     my $code = shift;
 
-    return eval_in_playground("sub { local \$^W; $code }");
+    return _eval_in_playground("sub { local \$^W; $code }");
 }
 
 sub _parse
@@ -360,7 +360,7 @@ sub _parse_scalar
         {
             # variable interpolation impossible - just evalute string
             # to get rid of escape chars
-            my $ret = eval_in_playground($extracted);
+            my $ret = _eval_in_playground($extracted);
 
             chomp $@;
             die "Eval error\n$@\n" if $@;
@@ -371,7 +371,7 @@ sub _parse_scalar
         {
             # variable interpolation possible - evaluate as subroutine
             # which will be used as callback
-            my $ret = make_sub_in_playground($extracted);
+            my $ret = _make_sub_in_playground($extracted);
 
             chomp $@;
             die "Eval error\n$@\n" if $@;
@@ -386,7 +386,7 @@ sub _parse_scalar
         die "Missing right curly bracket\n"
           if $extracted eq '';
 
-        my $ret = make_sub_in_playground($extracted);
+        my $ret = _make_sub_in_playground($extracted);
 
         chomp $@;
         die "Eval error\n$@\n" if $@;
index 5e72a98..8d84585 100644 (file)
@@ -11,11 +11,29 @@ our $VERSION = '0.001_003';
 
 use 5.014;
 
+=method check_value_names()
+
+Returns qw(min_bytes max_bytes)
+
+=cut
+
 sub check_value_names
 {
     return qw(min_bytes max_bytes);
 }
 
+=method check_response(\%check,$mech)
+
+Proves whether I<min_bytes> is greater than length of received content
+(and accumulate I<min_bytes_code> into I<$code> when true) or
+I<max_bytes> is lower than length of received content (and accumulate
+I<max_bytes_code> into I<$code> when true).
+
+Return the accumulated I<$code> and appropriate constructed message, if
+any coparisation failed.
+
+=cut
+
 sub check_response
 {
     my ( $self, $check, $mech ) = @_;
@@ -23,8 +41,8 @@ sub check_response
     my $code = 0;
     my $msg;
 
-    my $min_bytes = $self->get_check_value( $check, "min_bytes" );
-    my $max_bytes = $self->get_check_value( $check, "max_bytes" );
+    my $min_bytes = 0 + $self->get_check_value( $check, "min_bytes" );
+    my $max_bytes = 0 + $self->get_check_value( $check, "max_bytes" );
     my $content_len = length $mech->response()->content();
 
     if ( defined($min_bytes) and $min_bytes > $content_len )
index 54dcd3a..029eb88 100644 (file)
@@ -13,11 +13,32 @@ our $VERSION = '0.001_003';
 
 use 5.014;
 
+=method check_value_names()
+
+Returns qw(regex_forbid regex_require).
+
+=cut
+
 sub check_value_names
 {
     return qw(regex_forbid regex_require);
 }
 
+=method check_response(\%check,$mech)
+
+This method checks whether any line of I<regex_forbid> matches against
+received content (and accumulates I<regex_forbid_code> into I<$code> when
+match) or any line of I<regex_require> doesn't match against content
+(and accumulates I<regex_forbid_code> into I<$code> unless match).
+
+In case of an HTML response, the received content is rendered into plain
+text before searching for matches.
+
+Return the accumulated I<$code> and appropriate constructed message, if
+any match approval failed.
+
+=cut
+
 sub check_response
 {
     my ( $self, $check, $mech ) = @_;
index 2714a6b..67b94c4 100644 (file)
@@ -11,11 +11,29 @@ our $VERSION = '0.001_003';
 
 use 5.014;
 
+=method check_value_names()
+
+Returns qw(min_elapsed_time max_elapsed_time)
+
+=cut
+
 sub check_value_names
 {
     return qw(min_elapsed_time max_elapsed_time);
 }
 
+=method check_response(\%check,$mech)
+
+Proves whether I<min_elapsed_time> is greater than C<client_elapsed_time>
+(and accumulate I<min_elapsed_time_code> into I<$code> when true) or
+I<max_elapsed_time> is lower than C<client_elapsed_time> (and accumulate
+I<max_elapsed_time_code> into I<$code> when true).
+
+Return the accumulated I<$code> and appropriate constructed message, if
+any coparisation failed.
+
+=cut
+
 sub check_response
 {
     my ( $self, $check, $mech ) = @_;
@@ -23,9 +41,9 @@ sub check_response
     my $code = 0;
     my $msg;
 
-    my $min_time = $self->get_check_value( $check, "min_elapsed_time" );
-    my $max_time = $self->get_check_value( $check, "max_elapsed_time" );
-    my $total_time = $mech->client_elapsed_time();
+    my $min_time = 0 + $self->get_check_value( $check, "min_elapsed_time" );
+    my $max_time = 0 + $self->get_check_value( $check, "max_elapsed_time" );
+    my $total_time = 0 + $mech->client_elapsed_time();
 
     if ( defined($min_time) and $min_time > $total_time )
     {
index 9536edf..294bc19 100644 (file)
@@ -11,16 +11,33 @@ our $VERSION = '0.001_003';
 
 use 5.014;
 
+=method check_value_names()
+
+Returns qw(response).
+
+=cut
+
 sub check_value_names
 {
     return qw(response);
 }
 
+=method check_response(\%check,$mech)
+
+This methods proves whether the HTTP status code of the response matches the
+value configured in I<response> and accumulates I<response_code> into I<$code>
+when not.
+
+Return the accumulated I<$code> and appropriate constructed message, if
+coparisation failed.
+
+=cut
+
 sub check_response
 {
     my ( $self, $check, $mech ) = @_;
 
-    my $response_code = $self->get_check_value( $check, "response" );
+    my $response_code = 0 + $self->get_check_value( $check, "response" );
 
     if ( $response_code != $mech->status() )
     {
index 6025abe..5b05ad4 100644 (file)
@@ -13,11 +13,32 @@ our $VERSION = '0.001_003';
 
 use 5.014;
 
+=method check_value_names()
+
+Returns qw(text_forbid text_require).
+
+=cut
+
 sub check_value_names
 {
     return qw(text_forbid text_require);
 }
 
+=method check_response(\%check,$mech)
+
+This method checks whether any line of I<text_forbid> is found in received
+content (and accumulates I<text_forbid_code> into I<$code> when found) or
+any line of I<text_require> missing in content (and accumulates
+I<text_forbid_code> into I<$code> when missing).
+
+In case of an HTML response, the received content is rendered into plain
+text before searching for matches.
+
+Return the accumulated I<$code> and appropriate constructed message, if
+any match approval failed.
+
+=cut
+
 sub check_response
 {
     my ( $self, $check, $mech ) = @_;