logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

Path::IsDev::Role::Heuristic - Base role for Heuristic things.

Author

       Kent Fredric <kentnl@cpan.org>

Methods

"name"
       Returns the name to use in debugging.

       By default, this is derived from the classes name with the "PIDH" prefix removed:

           Path::IsDev::Heuristic::Tool::Dzil->name()
           → "+ ::Tool::Dzil"

   "heuristic_type"
       Returns a description of the general heuristic type

           positive heuristic

Name

       Path::IsDev::Role::Heuristic - Base role for Heuristic things.

Role Requires

"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 should set "$result_object->result( 1 )" prior to returning true.

       Composing roles should also invoke "$result_object->add_reason( $self, $result_value,
       $descriptive_reason_for_result, \%contextinfo )".

       See "Path::IsDev::Result" for details

Version

       version 1.001003

See Also