/ 
String-Tests-0.01
River stage zero No dependents
/ String::Tests

NAME

String::Tests - run a series of tests on a string

VERSION

Version 0.01

SYNOPSIS

use String::Tests;
my $boolean = String::Tests->pass( $some_string, $some_tests );

DESCRIPTION

It is very common (for example when doing user input validation) to have to run a series of tests on a single string of data. This module attempts to ease the burden of doing so, by amalgamating all tests into a single boolean method call.

EXAMPLES

# 1. run a series of code/regexp tests on a string

    my $boolean = String::Tests->pass( 'wimpy_password', [
        qr/^[\w[:punct:]]{8,16}\z/, # character white list
        qr/[A-Z]/, # force 1 upper case
        qr/[a-z]/, # force 1 lower case
        qr/\d/, # force 1 digit
        qr/[[:punct:]]/, # force 1 punctuation symbol
        sub {$self->SUPER::password_tests(@_)}}, # whatever else...
    ]);

# 2. run a single code ref or regexp

    my $boolean = String::Tests->pass( 'email@address.com', sub {
        use Email::Valid; return Email::Valid->rfc822(shift);
    });
    my $boolean = String::Tests->pass( 'some_string', qr/some_regexp/ );

# 3. capture return values from a code/regexp test into an array

    my @blocks_abcd = String::Tests->pass( '10.0.0.1', {
        regexp => qr/^ (\d{1,3}) \. (\d{1,3}) \. (\d{1,3}) \. (\d{1,3}) \z/x
    });

    my @domain_parts = String::Tests->pass( 'x.y.z.sub.domain.tld.stld', {
        code => sub {return split_domain_name(shift)}
    });

# If performance is a major issue, and you are using a persistant environment
# (such as mod_perl) you can pre-compile the tests as in the example below

  package MyPackage;

  use String::Tests;

  use constant PARAM_TESTS => {
      username => [
          q| must be 2-32 alpha-numeric, "." or "_" characters |,
          [
              qr/^[\w\.\-]{2,32}\z/,
              qr/[a-z0-9]/i,
          ],
      ],
      password => [
          q| must have 8-16 dual case letters, numbers, and punctations |,
          [
              qr/^[\w[:punct:]]{8,16}\z/,
              qr/[A-Z]/,
              qr/[a-z]/,
              qr/\d/,
              qr/[[:punct:]]/,
          ],
      ],
      email => [
          q| must be a valid email address |,
          sub { use Email::Valid; return Email::Valid->rfc822(shift) },
      ],
  };

  sub test_params { # ->test_params(qw( username password email ))
      my ( $self, @param_fields ) = @_;
      for my $field (@param_fields) {
          my ( $error_message, $tests ) = @{ __PACKAGE__->PARAM_TESTS->{$field} };
          # set error messages (if any) so you can alert the user
          $self->errors->{$field} = $error_message
              if not String::Tests->pass( $http_request->param($field), $tests );
      }
  }

EXPORT

None by default

METHODS

pass

AUTHOR

Shaun Fryer, <pause.cpan.org at sourcery.ca>

BUGS

Please report any bugs or feature requests to bug-string-tests at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=String-Tests. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc String::Tests

You can also look for information at:

COPYRIGHT & LICENSE

Copyright 2008 Shaun Fryer, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.