File Coverage

blib/lib/Acme/CPANModules/OneLinerTools.pm

Criterion	Covered	Total	%
statement	3	3	100.0
branch			n/a
condition			n/a
subroutine	1	1	100.0
pod			n/a
total	4	4	100.0

package Acme::CPANModules::OneLinerTools;

use strict;

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2024-06-21'; # DATE
our $DIST = 'Acme-CPANModules-OneLinerTools'; # DIST
our $VERSION = '0.005'; # VERSION

our $LIST = {
    summary => 'List of modules to make your life easier when writing perl one-liners',
    description => <<'MARKDOWN',

This list also tries to catalog modules that are meant to be primarily used in
one-liners.

MARKDOWN
    entries => [

        {
            module => 'L',
            description => <<'MARKDOWN',

One of the "module autoloader" modules, which happens to have a short name for
one-liner usage. So instead of having to type this:

    % perl -MOrg::Parser::Tiny -E'$doc = Org::Parser::Tiny->new->parse_file("/home/budi/todo.org"); ...'

you can now write:

    % perl -ML -E'$doc = Org::Parser::Tiny->new->parse_file("/home/budi/todo.org"); ...'

"Module autoloader" modules work using Perl's autoloading mechanism (read
`perlsub` for more details). By declaring a subroutine named `AUTOLOAD` in the
`UNIVERSAL` package, you setup a fallback mechanism when you call an undefined
subroutine. 's AUTOLOADER loads the module using  then
try to invoke the undefined subroutine once again.

MARKDOWN
            tags => ['module-loading'],
        },

        {
            module => 'lib::xi',
            description => <<'MARKDOWN',

This module can automatically install missing module during run-time using
`cpanm`. Convenient when running a Perl script (that comes without a proper
distribution or `cpanfile`) that uses several modules which you might not have.
The alternative to lib::xi is the "trial and error" method: repeatedly run the
Perl script to see which module it tries and fails to load.

lib::xi works by installing a hook in `@INC`.

MARKDOWN
            tags => ['module-loading'],
            alternate_modules => [
                'Require::Hook::More', # the autoinstalling feature has not been implemented though
            ],
        },

        {
            module => 'Log::ger::App',
            description => <<'MARKDOWN',

A convenient way to display (consume) logs if your application uses
 to produce logs.

MARKDOWN
            tags => ['logging'],
        },

        {
            module => 'DD::Dummy',
            description => <<'MARKDOWN',

My preference when dumping data structure when debugging Perl application is,
well, Perl format (unlike some others which prefer custom format like
). The DD-Dummy distribution provides  module, which in
turn exports `dd` to dump your data structures for debugging using
. Another good alternative is  which by default uses YAML
output but can be changed with this environment variable setting:

    PERL_XXX_DUMPER=Data::Dump

MARKDOWN
            alternate_modules => ['XXX', 'Data::Printer'],
            tags => ['debugging'],
        },

        {
            module => 'Devel::Confess',
            description => <<'MARKDOWN',

Forces stack trace when your application warns or dies. Used with the perl's
`-d` flag:

    % perl -d:Confess ...
    % perl -d:Confess=dump ...

MARKDOWN
            tags => ['debugging'],
        },

        {
            module => 'Carp::Patch::Config',
            description => <<'MARKDOWN',

 is used as a stack trace printer (also indirectly if you use
). Sometimes you want to customize some Carp parameters like
$Carp::MaxArgNums and $Carp::MaxArgLen from the command-line, and this is where
this module helps.

MARKDOWN
            tags => ['debugging'],
        },

        {
            module => 'DBIx::Conn::MySQL',
            description => <<'MARKDOWN',

Shortcut when connecting to MySQL database in your one-liner. Instead of:

    % perl -MDBI -E'my $dbh = DBI->connect("dbi:mysql:database=mydb", "someuser", "somepass"); $dbh->selectrow_array("query"); ...'

you can type:

    % perl -MDBIx::Conn::MySQL=mydb -E'$dbh->selectrow_array("query"); ...'

MARKDOWN
            tags => ['database', 'dbi'],
        },

        {
            module => 'DBIx::Conn::SQLite',
            description => <<'MARKDOWN',

Shortcut when connecting to MySQL database in your one-liner. Instead of:

    % perl -MDBI -E'my $dbh = DBI->connect("dbi:SQLite:dbname=mydb", "", ""); $dbh->selectrow_array("query"); ...'

you can type:

    % perl -MDBIx::Conn::SQLite=mydb -E'$dbh->selectrow_array("query"); ...'

MARKDOWN
            tags => ['database', 'dbi'],
        },

        {module=>'ojo'},
        {module=>'DDP', summary=>'From the Data::Printer distribution', tags=>['debugging']},
        {module=>'XXX', tags=>['debugging']},
        {module=>'eval', tags=>['debugging']},
        {module=>'this_mod', tags=>['module-loading']},
        {module=>'lib::filter', tags=>['debugging', 'module-loading']},
    ],
};

1;
# ABSTRACT: List of modules to make your life easier when writing perl one-liners

__END__