Perl x Open Food Facts Hackathon: Paris, France - May 24-25 Learn more

KENTNL / Path-IsDev-0.6.0 / lib / Path / IsDev / Role / Heuristic / RegexpFile.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
—
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

              
use strict;
use warnings;
package Path::IsDev::Role::Heuristic::RegexpFile;
BEGIN {
  $Path::IsDev::Role::Heuristic::RegexpFile::AUTHORITY = 'cpan:KENTNL';
}
{
  $Path::IsDev::Role::Heuristic::RegexpFile::VERSION = '0.6.0';
}
# ABSTRACT: Positive Heuristic when a path has a child file matching an expression
sub _debug { require Path::IsDev; goto &Path::IsDev::debug }
use Role::Tiny;
sub _matches_basename_regexp {
  my ( $self, $result_object ) = @_;
  my $regexp = $self->basename_regexp;
  for my $child ( $result_object->path->children ) {
    next unless -f $child;
    if ( $child->basename =~ $regexp ) {
      _debug("$child matches expression for $self");
      $result_object->add_reason( $self, 1, { 'child_basename_matches_expression?' => $child } );
      $result_object->result(1);
      return 1;
    }
    $result_object->add_reason( $self, 0, { 'child_basename_matches_expression?' => $child } );
  }
  $result_object->result(undef);
  return;
}
sub matches {
  my ( $self, $result_object ) = @_;
  return $self->_matches_basename_regexp($result_object);
}
with 'Path::IsDev::Role::Heuristic';
requires 'basename_regexp';
1;
__END__
=pod
=encoding utf-8
=head1 NAME
Path::IsDev::Role::Heuristic::RegexpFile - Positive Heuristic when a path has a child file matching an expression
=head1 VERSION
version 0.6.0
=head1 SYNOPSIS
    package Some::Heuristic;
    use Role::Tiny::With;
    with 'Path::IsDev::Role::Heuristic::RegexpFile';
    # Match if $PATH contains a child like $PATH/.bashrc or $PATH/.bash_profile
    sub basename_regexp {
        return qr/ \A [.] bash/xism;
    }
    1;
=head1 ROLE REQUIRES
=head2 C<basename_regexp>
Consuming classes must provide this method.
    returns : a regexp ref that will be matched on all of $PATH->children's $_->basename
=head1 METHODS
=head2 C<matches>
Implements L<< C<matches> for C<Path::IsDev::Role::Heuristic>|Path::IsDev::Role::Heuristic/matches >>
    if ( $class->matches($result_object) ) {
      # one of the items in $result_object->path->children matched $class->basename_regexp
      # $result_object has been modified to reflect that
      # _debug has been done where relevant
    }
    else {
      # no matches
      # $result_object has been modified with diagnostic data
      # _debug has been done where relevant
    }
=begin MetaPOD::JSON v1.1.0
{
    "namespace":"Path::IsDev::Role::Heuristic::RegexpFile",
    "interface":"role",
    "does":"Path::IsDev::Role::Heuristic"
}
=end MetaPOD::JSON
=head1 AUTHOR
Kent Fredric <kentfredric@gmail.com>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2013 by Kent Fredric <kentfredric@gmail.com>.
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