#!perl

our $DATE = '2016-03-02'; # DATE
our $VERSION = '0.03'; # VERSION

BEGIN { $ENV{VERBOSE} //= 1 }

use 5.010;
use strict;
use warnings;
require Log::Any unless $ENV{COMP_LINE};

use App::PDRUtils;
use Perinci::CmdLine::Any;

my $prefix = '/App/PDRUtils/';
Perinci::CmdLine::Any->new(
    %App::PDRUtils::Common_CLI_Attrs,
    url => $prefix,
    subcommands => {
        'inc-prereq-version-to' => {url => "${prefix}inc_prereq_version_to"},
        'dec-prereq-version-to' => {url => "${prefix}dec_prereq_version_to"},
        'inc-prereq-version-by' => {url => "${prefix}inc_prereq_version_by"},
        'dec-prereq-version-by' => {url => "${prefix}dec_prereq_version_by"},
        'set-prereq-version-to' => {url => "${prefix}set_prereq_version_to"},
        'remove-prereq'         => {url => "${prefix}remove_prereq"},
        'add-prereq'            => {url => "${prefix}add_prereq"},
    },
    log => 1,
)->run;

1;
# ABSTRACT: Collection of utilities for perl dist repos
# PODNAME: pdrutils

__END__

=pod

=encoding UTF-8

=head1 NAME

pdrutils - Collection of utilities for perl dist repos

=head1 VERSION

This document describes version 0.03 of pdrutils (from Perl distribution App-PDRUtils), released on 2016-03-02.

=head1 SYNOPSIS

Usage:

 % pdrutils add-prereq [options] <module> [module_version]
 % pdrutils dec-prereq-version-by [options] <module> <by>
 % pdrutils dec-prereq-version-to [options] <module> <module_version>
 % pdrutils inc-prereq-version-by [options] <module> <by>
 % pdrutils inc-prereq-version-to [options] <module> <module_version>
 % pdrutils remove-prereq [options] <module>
 % pdrutils set-prereq-version-to [options] <module> <module_version>

=head1 DESCRIPTION

B<EARLY RELEASE. SOME SUBCOMMANDS NOT YET IMPLEMENTED.>

If you have one or more CPAN (or DarkPAN) perl distribution repos on your
filesystem, then this suite of CLI utilities might be useful for you. Currently
only the combination of L<Dist::Zilla>-based Perl distributions managed by git
version control is supported.

To use this suite of utilities, first create a configuration C<~/pdrutils.conf>
containing at the very least something like:

 repos = !paths ~/repos/perl-*

You can change the C<~/repos/perl-*> part to a wildcard of where you put your
perl dist repos. Another example where you specify multiple wildcard patterns:

 repos = !paths ~/repos/perl-* ~/repos-[12]*/perl-* ~/repos-private/perl-*

Or, if you prefer to specify the repos individually:

 repos = /home/budi/Foo-Bar
 repos = /home/budi/Foo-Baz
 repos = /home/budi/Qux
 repos = !path ~/perl-Module-Zap

(Note that if you want C<~> to be expanded into your home directory, like in a
Unix shell, you need to put C<!path> encoding as the prefix for the value. See
L<IOD> for more details on the configuration format.)

A few things that you can do with the utilities:

=over

=item * List distributions based on various criteria

B<NOT YET IMPLEMENTED.> List the names of all distributions:

 % pdrutils ls

List the names as well as other details of all distributions:

 % pdrutils ls -l

List distributions that have unclean git status (needs to be committed, etc):

 % pdrutils ls --no-git-clean

List distributions that specify prereq to a certain module:

 % pdrutils ls --depends Foo::Bar
 % pdrutils ls --depends 'Foo::Bar >= 0.12'
 % pdrutils ls --depends 'Foo::Bar = 0.12'
 % pdrutils ls --depends 'Foo::Bar < 0.12'

List distributions that depend on certain prereq in a certain phase/relationship
only:

 % pdrutils ls --depends 'Test::More < 0.98' --phase test

List distributions that does I<not> depend on a certain module:

 % pdrutils ls --depends-not Baz

=item * Add prereq

Add a prereq to C<Foo::Bar> (by default version is C<0> and if there is already
an existing prereq to C<Foo::Bar>, will do nothing).

 % pdrutils add-prereq Foo::Bar

Set version, and replace existing prereq line:

 % pdrutils add-prereq --replace Foo::Bar 1.23

=item * Remove prereq

 % pdrutils remove-prereq Foo::Bar

=item * Modify prereq: set/increase/decrease version

For example, you want to increase the minimum prereq version for all your
distributions, e.g. L<Bencher> to 0.30:

 % pdrutils inc-prereq-version-to Bencher 0.30

All distributions which do not list L<Bencher> as a prereq in their F<dist.ini>,
or distributions which already list L<Bencher> version 0.30 or later, won't be
modified.

Some other examples:

 % pdrutils dec-prereq-version-to Some::Module 1.2
 % pdrutils inc-prereq-version-by Some::Module 0.01
 % pdrutils dec-prereq-version-by Some::Module 0.01
 % pdrutils set-prereq-version Some::Module 1.2

=back

=head1 SUBCOMMANDS

=head2 B<add-prereq>

Add a prereq.

=head2 B<dec-prereq-version-by>

Decrease prereq version by a certain decrement.

=head2 B<dec-prereq-version-to>

Decrease prereq version to a specified version.

=head2 B<inc-prereq-version-by>

Increase prereq version by a certain increment.

=head2 B<inc-prereq-version-to>

Increase prereq version to a specified version.

=head2 B<remove-prereq>

Remove a prereq.

=head2 B<set-prereq-version-to>

Set prereq version to a specified version.

=head1 OPTIONS

C<*> marks required options.

=head2 Common 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<--debug>

Set log level to debug (note: you also need to set LOG=1 to enable logging, or use DEBUG=1).

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

Only include repos that has prereq to a specified module.

=item B<--exclude-dist-pattern>=I<s@>

Exclude repos which match specified pattern(s).

Can be specified multiple times.

=item B<--exclude-dist-patterns-json>=I<s>

Exclude repos which match specified pattern(s) (JSON-encoded).

See C<--exclude-dist-pattern>.

=item B<--exclude-dist>=I<s@>

Exclude repos which have specified name(s).

Can be specified multiple times.

=item B<--exclude-dists-json>=I<s>

Exclude repos which have specified name(s) (JSON-encoded).

See C<--exclude-dist>.

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

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

Default value:

 undef

=item B<--has-tag>=I<s@>

Only include repos which have specified tag(s).

A repo can be tagged by tag `X` if it has a top-level file named `.tag-X`.


Can be specified multiple times.

=item B<--has-tags-json>=I<s>

Only include repos which have specified tag(s) (JSON-encoded).

See C<--has-tag>.

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

Display help message and exit.

=item B<--include-dist-pattern>=I<s@>

Only include repos which match specified pattern(s).

Can be specified multiple times.

=item B<--include-dist-patterns-json>=I<s>

Only include repos which match specified pattern(s) (JSON-encoded).

See C<--include-dist-pattern>.

=item B<--include-dist>=I<s@>

Only include repos which have specified name(s).

Can be specified multiple times.

=item B<--include-dists-json>=I<s>

Only include repos which have specified name(s) (JSON-encoded).

See C<--include-dist>.

=item B<--json>

Set output format to json.

=item B<--lacks-tag>=I<s@>

Exclude repos which have specified tag(s).

A repo can be tagged by tag `X` if it has a top-level file named `.tag-X`.


Can be specified multiple times.

=item B<--lacks-tags-json>=I<s>

Exclude repos which have specified tag(s) (JSON-encoded).

See C<--lacks-tag>.

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

Set log level (note: you also need to set LOG=1 to enable logging).

=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]


=item B<--no-config>

Do not use any configuration file.

=item B<--no-env>

Do not read environment for default options.

=item B<--quiet>

Set log level to quiet (note: you also need to set LOG=1 to enable logging, or use QUIET=1).

=item B<--repo>=I<s@>

Can be specified multiple times.

=item B<--repos-json>=I<s>

See C<--repo>.

=item B<--subcommands>

List available subcommands.

=item B<--trace>

Set log level to trace (note: you also need to set LOG=1 to enable logging, or use TRACE=1).

=item B<--verbose>

Set log level to info (note: you also need to set LOG=1 to enable logging, or use VERBOSE=1).

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

Display program's version and exit.

=back

=head2 Options for subcommand add-prereq

=over

=item B<--module-version>=I<s>

Default value:

 0

=item B<--module>=I<s>*

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

Select prereq phase.

Default value:

 "runtime"

Valid values:

 ["build","configure","develop","runtime","test"]

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

Select prereq relationship.

Default value:

 "requires"

Valid values:

 ["requires","suggests","recommends"]

=back

=head2 Options for subcommand dec-prereq-version-by

=over

=item B<--by>=I<s>*

=item B<--module>=I<s>*

=back

=head2 Options for subcommand dec-prereq-version-to

=over

=item B<--module-version>=I<s>*

=item B<--module>=I<s>*

=back

=head2 Options for subcommand inc-prereq-version-by

=over

=item B<--by>=I<s>*

=item B<--module>=I<s>*

=back

=head2 Options for subcommand inc-prereq-version-to

=over

=item B<--module-version>=I<s>*

=item B<--module>=I<s>*

=back

=head2 Options for subcommand remove-prereq

=over

=item B<--module>=I<s>*

=back

=head2 Options for subcommand set-prereq-version-to

=over

=item B<--module-version>=I<s>*

=item B<--module>=I<s>*

=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 pdrutils pdrutils

in your bash startup (e.g. C<~/.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 C<shcompgen>) at installation time,
so you can immadiately have tab completion.

=head2 tcsh

To activate tcsh completion for this script, put:

 complete pdrutils 'p/*/`pdrutils`/'

in your tcsh startup (e.g. C<~/.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 C<shcompgen> (see above).

=head2 other shells

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

=head1 CONFIGURATION FILE

This script can read configuration file, which by default is searched at ~/.config/pdrutils.conf, ~/pdrutils.conf or /etc/pdrutils.conf (can be changed by specifying C<--config-path>). All found files will be read and merged.

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

Configuration file is in the format of L<IOD>, which is basically INI with some extra features.

To put configuration for a certain subcommand only, use a section name like C<[subcommand=NAME]>.

You can put multiple profiles in a single file by using section names like C<[profile=SOMENAME]> (filter by profile) or C<[SUBCOMMAND_NAME 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=foo ...]>. 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 ...]>. If you only want a section to be read when the value of an environment variable has value equals something: C<[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 ...]>. If you only want a section to be read when an environment variable contains something: C<[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:

=head2 Common for all subcommands

 depends (see --depends)
 exclude_dist_patterns (see --exclude-dist-pattern)
 exclude_dists (see --exclude-dist)
 format (see --format)
 has_tags (see --has-tag)
 include_dist_patterns (see --include-dist-pattern)
 include_dists (see --include-dist)
 lacks_tags (see --lacks-tag)
 log_level (see --log-level)
 naked_res (see --naked-res)
 repos (see --repo)

=head2 Configuration for subcommand 'add-prereq'

 module (see --module)
 module_version (see --module-version)
 phase (see --phase)
 rel (see --rel)

=head2 Configuration for subcommand 'dec-prereq-version-by'

 by (see --by)
 module (see --module)

=head2 Configuration for subcommand 'dec-prereq-version-to'

 module (see --module)
 module_version (see --module-version)

=head2 Configuration for subcommand 'inc-prereq-version-by'

 by (see --by)
 module (see --module)

=head2 Configuration for subcommand 'inc-prereq-version-to'

 module (see --module)
 module_version (see --module-version)

=head2 Configuration for subcommand 'remove-prereq'

 module (see --module)

=head2 Configuration for subcommand 'set-prereq-version-to'

 module (see --module)
 module_version (see --module-version)

=head1 ENVIRONMENT

=head2 PDRUTILS_OPT => str

Specify additional command-line options

=head1 FILES

~/.config/pdrutils.conf

~/pdrutils.conf

/etc/pdrutils.conf

=head1 HOMEPAGE

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

=head1 SOURCE

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

=head1 BUGS

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

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 AUTHOR

perlancar <perlancar@cpan.org>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2016 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
