File Coverage

blib/lib/Repl/Spec/Type/PatternType.pm

Criterion	Covered	Total	%
statement	15	25	60.0
branch	0	2	0.0
condition	1	3	33.3
subroutine	4	6	66.6
pod	3	3	100.0
total	23	39	58.9

=head1 NAME

Repl::Spec::Type::PatternType - A parameter guard for strings matching a regular expression.

=head1 SYNOPSIS

This type guard ensures that a string parameter was passed by the user
matching a specified regular expression.

=head1 DESCRIPTION

=head1 Methods

=over 4

=item C

A regular expression to which the values must conform.

=item C

Parameters: A single expression.
Returns: The string value.

=item C

=head1 SEE ALSO

L
L
L
L
L
L
L
L

=cut

package Repl::Spec::Type::PatternType;

use strict;
use warnings;
use Carp;

# Parameter:
# - A string representing a regexp (don't include the '/').
sub new
{
    my $invocant = shift;
    my $class = ref($invocant) || $invocant;
    my $description = shift;
    my $pattern = shift;

    my $self= {DESCRIPTION=>$description, PATTERN=>$pattern};
    return bless $self, $class;
}

sub guard
{
    my $self = shift;
    my $arg = shift;
    my $pattern = $self->{PATTERN};
    my $description = $self->{DESCRIPTION};

    return $arg if $arg =~ /$pattern/;
    croak sprintf("Expected '%s' but received '%s'.",$self->name(), $arg);
}

sub name
{
    my $self = shift;
    my $pattern = $self->{PATTERN};
    my $description = $self->{DESCRIPTION};

    return sprintf("%s matching /%s/",$description, $pattern);
}

1;