Devel-Examine-Subs

 view release on metacpan or  search on metacpan

Changes  view on Meta::CPAN

1.23    20150811
    - removed all traces of cache
    - dependency fixes
    - cleaned up POD
    - fixed typos and PPI var names
    - added POD for Engine and Prefilter
    - ./Build dist

1.20_01 20150723
    - engine framework in place
    - uses pre_proc, pre_filter and engine callbacks
    - callbacks can be sent in by user code
    - search uses optional regex
    - directory or file can be sent in
    - refined objects, they now have 'lines'
    - began making things more generic
    - can search/replace and inject code
    - can cache results in directory searching
    - countless bug fixes

1.17    20150715
    - implemented PPI sub checking, much safer

README  view on Meta::CPAN

    Optional parameters:

    copy

      Set it to a new file name which will be a copy of the specified file,
      and only change the copy. Useful for verifying the changes took
      properly.

 pre_procs, post_procs, engines

    For development. Returns the list of the respective built-in callbacks.

PARAMETERS

    There are various parameters that can be used to change the behaviour
    of the application. Some are persistent across calls, and others
    aren't. You can change or null any/all parameters in any call, but some
    should be set in the new() method (set it and forget it).

    The following list are persistent parameters, which need to be manually
    changed or nulled. Consider setting these in new().

README  view on Meta::CPAN

      Prints to STDOUT with Data::Dumper the current state of all loaded
      configuration parameters.

    pre_proc, post_proc, engine

      State: Transient

      Default: undef

      These are mainly used to set up the public methods with the proper
      callbacks used by the run() command.

      engine and pre_proc take either a single string that contains a valid
      built-in callback, or a single code reference of a custom callback.

      post_proc works a lot differently. These modules can be
      daisy-chained. Like engine and pre_proc, you can send in a string or
      cref, or to chain, send in an aref where each element is either a
      string or cref. The filters will be executed based on their order in
      the array reference.

lib/Devel/Examine/Subs.pm  view on Meta::CPAN

=item C<copy>

Set it to a new file name which will be a copy of the specified file, and only
change the copy. Useful for verifying the changes took properly.

=back


=head2 C<pre_procs>, C<post_procs>, C<engines>

For development. Returns the list of the respective built-in callbacks.




=head1 PARAMETERS

There are various parameters that can be used to change the behaviour of the
application. Some are persistent across calls, and others aren't. You can
change or null any/all parameters in any call, but some should be set in the
C<new()> method (set it and forget it).

lib/Devel/Examine/Subs.pm  view on Meta::CPAN

configuration parameters.



=item C<pre_proc, post_proc, engine>

State: Transient

Default: undef

These are mainly used to set up the public methods with the proper callbacks
used by the C<run()> command.

C<engine> and C<pre_proc> take either a single string that contains a valid
built-in callback, or a single code reference of a custom callback.

C<post_proc> works a lot differently. These modules can be daisy-chained.
Like C<engine> and C<pre_proc>, you can send in a string or cref, or to chain,
send in an aref where each element is either a string or cref. The filters
will be executed based on their order in the array reference.

lib/Devel/Examine/Subs/Engine.pm  view on Meta::CPAN

        return \@processed;
    };                        
}
sub _vim_placeholder {1;}
1;

__END__

=head1 NAME

Devel::Examine::Subs::Engine - Provides core engine callbacks for

=for html
<a href="https://github.com/stevieb9/devel-examine-subs/actions"><img src="https://github.com/stevieb9/devel-examine-subs/workflows/CI/badge.svg"/></a>
<a href='https://coveralls.io/github/stevieb9/devel-examine-subs?branch=master'><img src='https://coveralls.io/repos/stevieb9/devel-examine-subs/badge.svg?branch=master&service=github' alt='Coverage Status' /></a>

Devel::Examine::Subs

=head1 SYNOPSIS

    use Devel::Examine::Subs::Engine;

lib/Devel/Examine/Subs/Postprocessor.pm  view on Meta::CPAN

        return \@return;
    };
}
sub _vim_placeholder {1;}
1;
__END__

=head1 NAME

Devel::Examine::Subs::Postprocessor - Provides core Pre-Filter callbacks for

=for html
<a href="https://github.com/stevieb9/devel-examine-subs/actions"><img src="https://github.com/stevieb9/devel-examine-subs/workflows/CI/badge.svg"/></a>
<a href='https://coveralls.io/github/stevieb9/devel-examine-subs?branch=master'><img src='https://coveralls.io/repos/stevieb9/devel-examine-subs/badge.svg?branch=master&service=github' alt='Coverage Status' /></a>

Devel::Examine::Subs

=head1 DESCRIPTION

This module generates and supplies the core post-processor module callbacks.
Postprocessors run after the core Processor, and before any Engine is run.

=head1 SYNOPSIS

Post-processors can be daisy chained as text strings that represent a built-in
post-processor, or as callbacks, or both.

See C<Devel::Examine::Subs::_post_proc()> for implementation details.

=head1 METHODS

All methods other than C<exists()> takes an href of configuration data as its
first parameter.

=head2 C<exists('post-processor')>

lib/Devel/Examine/Subs/Preprocessor.pm  view on Meta::CPAN

        }
        $p->{write_file_contents} = \@file;
    }
}
sub _vim_placeholder {1;}
1;
__END__

=head1 NAME

Devel::Examine::Subs::Preprocessor - Provides core pre_proc callbacks for

=for html
<a href="https://github.com/stevieb9/devel-examine-subs/actions"><img src="https://github.com/stevieb9/devel-examine-subs/workflows/CI/badge.svg"/></a>
<a href='https://coveralls.io/github/stevieb9/devel-examine-subs?branch=master'><img src='https://coveralls.io/repos/stevieb9/devel-examine-subs/badge.svg?branch=master&service=github' alt='Coverage Status' /></a>

Devel::Examine::Subs

=head1 SYNOPSIS

    use Devel::Examine::Subs::Preprocessor;