File Coverage

blib/lib/Search/Tools/RegEx.pm

Criterion	Covered	Total	%
statement	13	14	92.8
branch			n/a
condition			n/a
subroutine	5	6	83.3
pod			n/a
total	18	20	90.0

package Search::Tools::RegEx;
use Moo;
extends 'Search::Tools::Object';
use Carp;
use overload
    '""'     => sub { $_[0]->term; },
    'bool'   => sub {1},
    fallback => 1;

#use Data::Dump qw( dump );

use namespace::autoclean;

our $VERSION = '1.006';

my @ro_attrs = qw(
    plain
    html
    term
    term_re
    is_phrase
    phrase_terms
);

for my $attr (@ro_attrs) {
    has $attr => ( is => 'ro' );
}

=head1 NAME

Search::Tools::RegEx - regular expressions for terms

=head1 SYNOPSIS

 my $regex = $query->regex_for('foo');
 like( 'foo', $regex->plain, "matches plain (no markup)");
 like( 'foo', $regex->html,  "matches html (with markup)");
 ok( ! $regex->is_phrase, "foo is not a phrase");
 is( 'foo', $regex->term, "foo is the term");

=head1 DESCRIPTION


=head1 METHODS

=head2 plain

=head2 html

=head2 term

=head2 term_re

=head2 is_phrase

=head2 phrase_terms

If B is true, B will contain an ARRAY ref
of Search::Tools::RegEx objects, each one representing a term
in the phrase.

=cut

1;

__END__