/ 
exact-1.22
River stage two • 25 direct dependents • 26 total dependents
/ exact

NAME

exact - Perl pseudo pragma to enable strict, warnings, features, mro, filehandle methods

VERSION

version 1.22

SYNOPSIS

Instead of this:

use strict;
use warnings;
use feature ':all';
no warnings "experimental";
use utf8;
use open ':std', ':utf8';
use mro 'c3';
use IO::File;
use IO::Handle;
use Carp qw( croak carp confess cluck );
use Syntax::Keyword::Try;
use PerlX::Maybe ':all';
use namespace::autoclean;

Type this:

use exact;

Or for finer control, add some trailing modifiers like a line of the following:

use exact -nofeatures, -signatures, -try, -say, -state;
use exact 5.16, -nostrict, -nowarnings, -noc3, -noutf8, -noautoclean;
use exact '5.20';

DESCRIPTION

exact is a Perl pseudo pragma to enable strict, warnings, features, mro, and filehandle methods along with a lot of other things, plus allow for easy extension via exact::* classes. The goal is to reduce header boilerplate, assuming defaults that seem to make sense but allowing overrides easily.

By default, exact will:

  • enable strictures (version 2)

  • enable all available features and switch off experimental warnings

  • use utf8 in the source code context and set STDIN, STROUT, and STRERR to handle UTF8

  • set C3 style of mro

  • enable methods on filehandles

  • import Carp's 4 methods

  • implement a try...catch...finally block solution based on Perl version

  • import PerlX::Maybe's 4 methods

  • autoclean the namespace via namespace::autoclean

IMPORT FLAGS

exact supports the following import flags:

nostrict

This skips turning on the strict pragma.

nowarnings

This skips turning on the warnings pragma.

nofeatures

Normally, exact will enable all available features. Applying nofeatures causes this behavior to be skipped. You can still explicitly set features and/or bundles.

noskipexperimentalwarnings

Normally, exact will disable experimental warnings. This skips that disabling step.

noutf8

This skips turning on UTF8 in the source code context. Also skips setting STDIN, STDOUT, and STDERR to expect UTF8.

noc3

This skips setting C3 mro.

nocarp

This skips importing the 4 Carp methods: croak, carp, confess, and cluck.

notry

This skips setting up try...catch...finally support. This support is provided either by the native Perl try feature if available or else by importing the functionality of Syntax::Keyword::Try otherwise.

trytiny

If you want to use Try::Tiny instead of either native Perl's try feature or Syntax::Keyword::Try, this is how.

nomaybe

This skips loading the 4 namespace::autoclean methods: maybe, provided, provided_deref, and provided_deref_with_maybe.

noautoclean

This skips using namespace::autoclean.

BUNDLES

By default, the "all" bundle is enabled. You can skip this by including an explicit bundle name or nofeatures. You can enable and disable features.

use exact -nofeatures, -signatures, -try, -say, -state;
use exact 5.16, -nosay, -nostate;
use exact '5.20';

Bundles provided can be exactly like those described in feature or in a variety of obvious forms:

  • :5.26

  • 5.26

  • v5.26

  • 26

Note that bundles are exactly the same as what's in feature, so for any feature not part of a version bundle in feature, you won't pick up that feature with a bundle unless you explicitly declare the feature.

class versus cor

To avoid a conflict between the exact::class extension (see below) and the class feature available as of Perl 5.37, the class feature gets handled slightly differently from other features. If using Perl 5.37 or newer and nothing is specified, the default behavior is to enable the class feature.

To explicitly enable the feature, though, you must use the cor flag.

use exact -nofeatures, -cor;

To explicitly disable the feature, use the nocor flag.

EXTENSIONS

It's possible to write extensions or plugins for exact to provide context-specific behavior, provided you are using Perl version 5.14 or newer. To activate these extensions, you need to provide their named suffix as a parameter to the use of exact.

# will load "exact" and "exact::class";
use exact -class;

# will load "exact" and "exact::role" and turn off UTF8 features;
use exact -role, -noutf8;

It's possible to provide parameters to the import method of the extension.

# will load "exact" and "exact::answer" and pass "42" to the import method
use exact 'answer(42)';

Writing Extensions

An extension may but is not required to have an import method. If such a method does exist, it will be passed: the package name, the name of the caller of exact, and any parameters passed.

package exact::example;
use exact;

sub import {
    my ( $self, $caller, $params ) = @_;
    exact->monkey_patch( $caller, 'example' => \&example );
}

sub example {
    say 42;
}

1;

PARENTS

You can use exact to setup inheritance as follows:

use exact 'SomeModule', 'SomeOtherModule';

This is roughly equivalent to:

use exact;
use parent 'SomeModule', 'SomeOtherModule';

See also the no_parent method.

METHODS

monkey_patch

Monkey patch functions into a given package.

exact->monkey_patch( 'PackageName', add => sub { return $_[0] + $_[1] } );
exact->monkey_patch(
    'PackageName',
    one   => sub { return 1 },
    two   => sub { return 2 },
    three => sub { return 3 },
);

add_isa

This method will add a given parent to the @ISA of a given child.

exact->add_isa( 'SuperClassParent', 'SubClassChild' );

no_parent

Normally, if you specify a parent, it'll be added as a parent by inclusion in @INC. If you don't want to skip @INC inclusion, you can call no_parent in the import of the module being specified as a parent.

sub import {
    exact->no_parent;
}

late_parent

There may be a situation where you need an included parent to be listed last in @INC (at least relative to other parents). Normally, you'd do this by putting the name last in the list of modules. However, if for some reason you can't do that, you can call late_parent from the import of the parent that should be delayed in @INC inclusion.

sub import {
    exact->late_parent;
}

export

This method performs work similar to using Exporter's @EXPORT, but only for methods. For a given method within your package, it will be exported to the namespace that uses your package.

exact->export( 'method', 'other_method' );

exportable

This method performs work similar to using Exporter's @EXPORT_OK, but only for methods. For a given method within your package, it will be exported to the namespace that uses your package.

exact->exportable( 'method', 'other_method' );

It's possible to provide hashrefs as input to this method, and doing so provides the means to setup groups of methods a consuming namespace can import.

exact->exportable(
    'method',
    'other_method',
    {
        ':stuff' => [ qw( method other_method ) ],
        ':all'   => [ qw( method other_method some_additional_method ) ],
    }
);

In the consuming namespace, you can then write:

use YourPackage ':stuff'; # imports both "method" and "other_method"

SEE ALSO

You can look for additional information at:

AUTHOR

Gryphon Shafer <gryphon@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2017-2050 by Gryphon Shafer.

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)