File Coverage

blib/lib/Form/Factory/Feature/Control/MatchRegex.pm

Criterion	Covered	Total	%
statement	13	16	81.2
branch	3	6	50.0
condition			n/a
subroutine	4	4	100.0
pod	2	2	100.0
total	22	28	78.5

package Form::Factory::Feature::Control::MatchRegex;
$Form::Factory::Feature::Control::MatchRegex::VERSION = '0.022';
use Moose;

with qw(
    Form::Factory::Feature
    Form::Factory::Feature::Role::Check
    Form::Factory::Feature::Role::Control
    Form::Factory::Feature::Role::CustomControlMessage
);

use Carp ();

# ABSTRACT: Match a control value against a regex


has regex => (
    is        => 'ro',
    isa       => 'RegexpRef',
    required  => 1,
);


sub check_control {
    my ($self, $control) = @_;

    return if $control->does('Form::Factory::Control::Role::ScalarValue');

    Carp::croak("the match_regex feature only works with scalar value controls, not $control");
}


sub check {
    my $self  = shift;
    my $value = $self->control->current_value;

    my $regex = $self->regex;
    unless ($value =~ /$regex/) {
        $self->control_error("the %s does not match $regex");
        $self->result->is_valid(0);
    }

    $self->result->is_valid(1) unless $self->result->is_validated;
}

__PACKAGE__->meta->make_immutable;

__END__

=pod

=encoding UTF-8

=head1 NAME

Form::Factory::Feature::Control::MatchRegex - Match a control value against a regex

=head1 VERSION

version 0.022

=head1 SYNOPSIS

  has_control five_char_palindrome => (
      control => 'text',
      features => {
          match_regex => {
              regex => qr/(.)(.).\2\1/,
              message => 'the %s is not a palindrome',
          },
      },
  );

=head1 DESCRIPTION

Checks that the control value matches a regular expression. Returns an error if it does not.

=head1 ATTRIBUTES

=head2 regex

The regular expression to use.

=head1 METHODS

=head2 check_control

Checks that the control does L<Form::Factory::Control::Role::ScalarValue>.

=head2 check

Runs the regular expression against the current value of the control and reports an error if it does not match.

=head1 AUTHOR

Andrew Sterling Hanenkamp <[e-mail]>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2015 by Qubling Software LLC.

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

=cut