File Coverage

blib/lib/Acme/CPANModules/MagicVariableTechnique.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::MagicVariableTechnique;

use strict;

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2023-10-29'; # DATE
our $DIST = 'Acme-CPANModules-MagicVariableTechnique'; # DIST
our $VERSION = '0.002'; # VERSION

our $LIST = {
    summary => 'List of modules which employ magic variable technique to do stuffs',
    description => <<'_',

This is a list of modules which provide some "magic" variable which you can
get/set to perform stuffs. I personally find this technique is mostly useful to
"temporarily set" stuffs, by combining it with Perl's `local()`.

_
    entries => [
        {
            module => 'File::chdir',
            description => <<'_',

Provides `$CWD` which you can use to change directory. By doing:

    local $CWD = ...;

in a subroutine or block, you can safely change directory temporarily without
messing current directory and breaking code in other parts. Very handy and
convenient.

This is the first module I found/use where I realized the technique. Since then
I've been looking for other modules using similar technique, and have even
created a few myself.

_
        },
        {
            module => 'File::umask',
            description => <<'_',

Provides `$UMASK` to get/set umask.

_
        },
        {
            module => 'Umask::Local',
            description => <<'_',

Like , but instead of using a tied variable, uses an object with
its `DESTROY` method restoring original umask. I find the interface a bit more
awkward.

_
            alternate_modules => ['File::umask'],
        },
        {
            module => 'Locale::Tie',
            description => <<'_',

Provides `$LANG`, `$LC_ALL`, `$LC_TIME`, and few others to let you (temporarily)
set locale settings.

_
        },
        {
            module => 'Locale::Scope',
            description => <<'_',

Like , but instead of using a tied variable, uses an object with
its `DESTROY` method restoring original settings.

_
        },
    ],
};

1;
# ABSTRACT: List of modules which employ magic variable technique to do stuffs

__END__