#!perl

# Note: This script is a CLI  for Riap function /App/progpatcher/progpatcher
# and generated automatically using Perinci::CmdLine::Gen version 0.46

our $DATE = '2017-07-03'; # DATE
our $DIST = 'App-progpatcher'; # DIST
our $VERSION = '0.002'; # VERSION

use 5.010001;
use strict;
use warnings;
use Log::ger;

use Perinci::CmdLine::Any;

Perinci::CmdLine::Any->new(
    url => "/App/progpatcher/progpatcher",
    program_name => "progpatcher",
    log => 1,
)->run;

# ABSTRACT: Apply a set of patches to your programs
# PODNAME: progpatcher

__END__

=pod

=encoding UTF-8

=head1 NAME

progpatcher - Apply a set of patches to your programs

=head1 VERSION

This document describes version 0.002 of progpatcher (from Perl distribution App-progpatcher), released on 2017-07-03.

=head1 SYNOPSIS

Usage:

 % progpatcher [options]

=head1 DESCRIPTION

This is like L<pmpatcher> except for programs. You might have a set of
patches that you want to apply on programs in the C<PATH>. For example, currently
as of this writing I have this on my C<patches> directory:

 prog-cpanm.20161127-only_use_uri_from_mirror_where_we_found_module.patch

These patches might be pending for merge upstream, or are of private nature so
might never be merged, or of any other nature. Applying patches is a lightweight
alternative to creating a fork for each of these programs.

This utility helps you making the process of applying these patches more
convenient. Basically this utility just locates all the target modules and
feeds all of these patches to the C<patch> program.

To use this utility, first of all you need to gather all your program patches in
a single directory (see C<patches_dir> option). Also, you need to make sure that
all patches you want to use match this name pattern:

 prog-<PROGRAM-NAME>.<TOPIC>.patch

This directory can be the same as the one you use for C<pmpatcher>, since
C<pmpatcher> uses another prefix.

Then, to apply all the patches, you just call:

 % progpatcher --patches-dir ~/patches

(Or, you might also want to put C<patches_dir=/path/to/patches> into
C<~/progpatcher.conf> to save you from having to type the option repeatedly.)

Example result:

 % progpatcher
 +--------------------------------------------------------------------------+--------+---------+
 | item_id                                                                  | status | message |
 +--------------------------------------------------------------------------+--------+---------+
 | prog-cpanm.20161127-only_use_uri_from_mirror_where_we_found_module.patch | 200    | Applied |
 +--------------------------------------------------------------------------+--------+---------+

If you try to run it again, you might get:

 % progpatcher
 +--------------------------------------------------------------------------+--------+-----------------+
 | item_id                                                                  | status | message         |
 +--------------------------------------------------------------------------+--------+-----------------+
 | prog-cpanm.20161127-only_use_uri_from_mirror_where_we_found_module.patch | 304    | Already applied |
 +--------------------------------------------------------------------------+--------+-----------------+

There's also a C<--dry-run> and a C<-R> (C<--reverse>) option, just like C<patch>.

=head1 OPTIONS

C<*> marks required options.

=head2 Main options

=over

=item B<--patches-dir>=I<s>*

=item B<--reverse>, B<-R>

=back

=head2 Configuration options

=over

=item B<--config-path>=I<filename>

Set path to configuration file.

Can be specified multiple times.

=item B<--config-profile>=I<s>

Set configuration profile to use.

=item B<--no-config>

Do not use any configuration file.

=back

=head2 Environment options

=over

=item B<--no-env>

Do not read environment for default options.

=back

=head2 Logging options

=over

=item B<--debug>

Shortcut for --log-level=debug.

=item B<--log-level>=I<s>

Set log level.

=item B<--quiet>

Shortcut for --log-level=error.

=item B<--trace>

Shortcut for --log-level=trace.

=item B<--verbose>

Shortcut for --log-level=info.

=back

=head2 Output options

=over

=item B<--format>=I<s>

Choose output format, e.g. json, text.

Default value:

 undef

=item B<--json>

Set output format to json.

=item B<--naked-res>

When outputing as JSON, strip result envelope.

Default value:

 0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

    [200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd
element) as well as result metadata/extra result (4th element) instead of just
the result (3rd element). However, sometimes you want just the result, e.g. when
you want to pipe the result for more post-processing. In this case you can use
`--naked-res` so you just get:

    [1,2,3]


=back

=head2 Other options

=over

=item B<--dry-run>

Run in simulation mode (also via DRY_RUN=1).

=item B<--help>, B<-h>, B<-?>

Display help message and exit.

=item B<--version>, B<-v>

Display program's version and exit.

=back

=head1 COMPLETION

This script has shell tab completion capability with support for several
shells.

=head2 bash

To activate bash completion for this script, put:

 complete -C progpatcher progpatcher

in your bash startup (e.g. F<~/.bashrc>). Your next shell session will then
recognize tab completion for the command. Or, you can also directly execute the
line above in your shell to activate immediately.

It is recommended, however, that you install L<shcompgen> which allows you to
activate completion scripts for several kinds of scripts on multiple shells.
Some CPAN distributions (those that are built with
L<Dist::Zilla::Plugin::GenShellCompletion>) will even automatically enable shell
completion for their included scripts (using L<shcompgen>) at installation time,
so you can immediately have tab completion.

=head2 tcsh

To activate tcsh completion for this script, put:

 complete progpatcher 'p/*/`progpatcher`/'

in your tcsh startup (e.g. F<~/.tcshrc>). Your next shell session will then
recognize tab completion for the command. Or, you can also directly execute the
line above in your shell to activate immediately.

It is also recommended to install L<shcompgen> (see above).

=head2 other shells

For fish and zsh, install L<shcompgen> as described above.

=head1 CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of L<IOD>, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using C<--config-path>): F<~/.config/progpatcher.conf>, F<~/progpatcher.conf>, or F</etc/progpatcher.conf>.

All found files will be read and merged.

To disable searching for configuration files, pass C<--no-config>.

You can put multiple profiles in a single file by using section names like C<[profile=SOMENAME]> or C<[SOMESECTION profile=SOMENAME]>. Those sections will only be read if you specify the matching C<--config-profile SOMENAME>.

You can also put configuration for multiple programs inside a single file, and use filter C<program=NAME> in section names, e.g. C<[program=NAME ...]> or C<[SOMESECTION program=NAME]>. The section will then only be used when the reading program matches.

Finally, you can filter a section by environment variable using the filter C<env=CONDITION> in section names. For example if you only want a section to be read if a certain environment variable is true: C<[env=SOMEVAR ...]> or C<[SOMESECTION env=SOMEVAR ...]>. If you only want a section to be read when the value of an environment variable has value equals something: C<[env=HOSTNAME=blink ...]> or C<[SOMESECTION env=HOSTNAME=blink ...]>. If you only want a section to be read when the value of an environment variable does not equal something: C<[env=HOSTNAME!=blink ...]> or C<[SOMESECTION env=HOSTNAME!=blink ...]>. If you only want a section to be read when an environment variable contains something: C<[env=HOSTNAME*=server ...]> or C<[SOMESECTION env=HOSTNAME*=server ...]>. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

List of available configuration parameters:

 format (see --format)
 log_level (see --log-level)
 naked_res (see --naked-res)
 patches_dir (see --patches-dir)
 reverse (see --reverse)

=head1 ENVIRONMENT

=head2 PROGPATCHER_OPT => str

Specify additional command-line options.

=head1 FILES

F<~/.config/progpatcher.conf>

F<~/progpatcher.conf>

F</etc/progpatcher.conf>

=head1 HOMEPAGE

Please visit the project's homepage at L<https://metacpan.org/release/App-progpatcher>.

=head1 SOURCE

Source repository is at L<https://github.com/perlancar/perl-App-progpatcher>.

=head1 BUGS

Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=App-progpatcher>

When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.

=head1 SEE ALSO

L<pmpatcher>.

=head1 AUTHOR

perlancar <perlancar@cpan.org>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by perlancar@cpan.org.

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