lib/WWW/Mechanize/Script/Plugin.pm

   1 package WWW::Mechanize::Script::Plugin;
   2
   3 use strict;
   4 use warnings;
   5
   6 # ABSTRACT: plugin base class for check plugins
   7
   8 our $VERSION = '0.001_003';
   9
  10 use 5.014;
  11
  12 =method new()
  13
  14 Instantiates new WWW::Mechanize::Script::Plugin. This is an abstract class.
  15
  16 =cut
  17
  18 sub new
  19 {
  20     my ($class) = @_;
  21
  22     my $self = bless( {}, $class );
  23
  24     return $self;
  25 }
  26
  27 =method get_check_value(\%check,$value_name)
  28
  29 Retrieves the value for I<$value_name> from the hash I<%check>.
  30
  31 =cut
  32
  33 sub get_check_value
  34 {
  35     my ( $self, $check, $value_name ) = @_;
  36
  37     $value_name or return;
  38
  39     return $check->{check}->{$value_name};
  40 }
  41
  42 =method get_check_value_as_bool(\%check,$value_name)
  43
  44 Retrieves the value for I<$value_name> from the hash I<%check> and returns
  45 true when it can be interpreted as a boolean value with true content
  46 (any object is always returned as it is, (?:(?i)true|on|yes) evaluates to
  47 I<true>, anything else to I<false>).
  48
  49 =cut
  50
  51 sub get_check_value_as_bool
  52 {
  53     my ( $self, $check, $value_name ) = @_;
  54
  55     $value_name or return;
  56
  57     my $val = $check->{check}->{$value_name};
  58
  59     defined($val) or return;
  60     ref($val) and return $val;
  61     if ( _STRING($val) )
  62     {
  63         $val =~ m/(?:true|on|yes)/i and return 1;
  64     }
  65
  66     return 0;
  67 }
  68
  69 =method can_check(\%check)
  70
  71 Proves whether this instance can check anything on the current run test.
  72 Looks if any of the required L</check_value_names> are specified in the
  73 check parameters of the current test.
  74
  75 =cut
  76
  77 sub can_check
  78 {
  79     my ( $self, $check ) = @_;
  80     my $ok = 0;
  81
  82     my @value_names = $self->check_value_names();
  83     foreach my $value_name (@value_names)
  84     {
  85         my $cv = $self->get_check_value( $check, $value_name );
  86         $cv and $ok = 1 and last;
  87     }
  88
  89     return $ok;
  90
  91 }
  92
  93 =method check_value_names()
  94
  95 Returns list of check values which are used to check the response.
  96
  97 Each I<value> has a I<value>C<_code> counterpart which is used to modify
  98 the return value of L</check_response> when the check upon that value
  99 fails.
 100
 101 =cut
 102
 103 sub check_value_names { ... }
 104
 105 =method check_response(\%check,$mech)
 106
 107 Checks the response based on test specifications. See individual plugins
 108 for specific test information.
 109
 110 Returns the accumulated code for each failing check along with optional
 111 messages containing details about each failure.
 112
 113   # no error
 114   return (0);
 115   # some error
 116   return ($code,@messages);
 117   # some error but no details
 118   return ($code);
 119
 120 =cut
 121
 122 sub check_response { ... }
 123
 124 1;