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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
use 5.008; # utf8
use strict;
use warnings;
use utf8;
package Path::IsDev::Role::Heuristic;
our $VERSION = '1.001003';
# ABSTRACT: Base role for Heuristic things.
our $AUTHORITY = 'cpan:KENTNL'; # AUTHORITY
sub _blessed { require Scalar::Util; goto &Scalar::Util::blessed }
use Role::Tiny qw( requires );
sub name {
my $name = shift;
$name = _blessed($name) if _blessed($name);
$name =~ s/\APath::IsDev::Heuristic:/+ :/msx;
return $name;
}
sub heuristic_type {
return 'positive heuristic';
}
requires 'matches';
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Path::IsDev::Role::Heuristic - Base role for Heuristic things.
=head1 VERSION
version 1.001003
=head1 ROLE REQUIRES
=head2 C<matches>
Implementing classes must provide this method.
return : 1 / undef
1 -> this path is a development directory as far as this heuristic is concerned
undef -> this path is not a development directory as far as this heuristic is concerned
args : ( $class , $result_object )
$class -> method will be invoked on packages, not objects
$result_object -> will be a Path::IsDev::Result
Additionally, consuming classes B<should> set C<< $result_object->result( 1 ) >> prior to returning true.
Composing roles B<should> also invoke C<< $result_object->add_reason( $self, $result_value, $descriptive_reason_for_result, \%contextinfo ) >>.
See L<< C<Path::IsDev::Result> for details|Path::IsDev::Result >>
=head1 METHODS
=head2 C<name>
Returns the name to use in debugging.
By default, this is derived from the classes name
with the C<PIDH> prefix removed:
Path::IsDev::Heuristic::Tool::Dzil->name()
→ "+ ::Tool::Dzil"
=head2 C<heuristic_type>
Returns a description of the general heuristic type
positive heuristic
=begin MetaPOD::JSON v1.1.0
{
"namespace":"Path::IsDev::Role::Heuristic",
"interface":"role"
}
=end MetaPOD::JSON
=head1 AUTHOR
Kent Fredric <kentnl@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2017 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
|
