view release on metacpan or  search on metacpan

lib/Acme/CPANModules/CheckingModuleInstalledLoadable.pm  view on Meta::CPAN

    summary => 'List of modules to check if a module is installed or loadable',
    description => <<'_',

If you simply want to check that a module's `.pm` file is locatable in `@INC`,
you can just do something like:

    my $mod = "Foo/Bar.pm";
    for my $dir (@INC) {
        next if ref $dir;
        if (-f "$dir/$mod") {
            print "Module $mod is installed";
            last;
        }
    }

Or you can use something like <pm:Module::Path> or <pm:Module::Path::More> which
does similar to the above.

A module can also be loaded from a require hook in ~@INC~ (like in the case of
fatpacked or datapacked script) and the above methods does not handle it.
Instead, you'll need to use <pm:Module::Load::Conditional>'s `check_install` or
<pm:Module::Installed::Tiny>'s `module_installed`:

    use Module::Load::Conditional qw(check_install);
    if (check_install(module => "Foo::Bar")) {
        # Foo::Bar is installed
    }

The above does not guarantee that the module will be loaded successfully. To
check that, there's no other way but to actually try to load it:

    if (eval { require Foo::Bar; 1 }) {
        # Foo::Bar can be loaded (and was loaded!)
    }

_
    tags => ['task'],
    entries => [
        {
            module=>'Module::Path',
        },
        {
            module=>'Module::Path::More',
        },
        {
            module=>'Module::Load::Conditional',
        },
        {
            module=>'Module::Installed::Tiny',
        },
    ],
};

1;
# ABSTRACT: List of modules to check if a module is installed or loadable

__END__

=pod

=encoding UTF-8

=head1 NAME

Acme::CPANModules::CheckingModuleInstalledLoadable - List of modules to check if a module is installed or loadable

=head1 VERSION

This document describes version 0.002 of Acme::CPANModules::CheckingModuleInstalledLoadable (from Perl distribution Acme-CPANModules-CheckingModuleInstalledLoadable), released on 2023-08-06.

=head1 DESCRIPTION

If you simply want to check that a module's C<.pm> file is locatable in C<@INC>,
you can just do something like:

 my $mod = "Foo/Bar.pm";
 for my $dir (@INC) {
     next if ref $dir;
     if (-f "$dir/$mod") {
         print "Module $mod is installed";
         last;
     }
 }

Or you can use something like L<Module::Path> or L<Module::Path::More> which
does similar to the above.

A module can also be loaded from a require hook in ~@INC~ (like in the case of
fatpacked or datapacked script) and the above methods does not handle it.
Instead, you'll need to use L<Module::Load::Conditional>'s C<check_install> or
L<Module::Installed::Tiny>'s C<module_installed>:

 use Module::Load::Conditional qw(check_install);
 if (check_install(module => "Foo::Bar")) {
     # Foo::Bar is installed
 }

The above does not guarantee that the module will be loaded successfully. To
check that, there's no other way but to actually try to load it:

 if (eval { require Foo::Bar; 1 }) {
     # Foo::Bar can be loaded (and was loaded!)
 }

=head1 ACME::CPANMODULES ENTRIES

=over

=item L<Module::Path>

Author: L<NEILB|https://metacpan.org/author/NEILB>

=item L<Module::Path::More>

Author: L<PERLANCAR|https://metacpan.org/author/PERLANCAR>

=item L<Module::Load::Conditional>

Author: L<BINGOS|https://metacpan.org/author/BINGOS>

=item L<Module::Installed::Tiny>