https://github.com/kentnl/module-data

Introspect context information about modules in @INC
https://github.com/kentnl/module-data

Last synced: 4 days ago
JSON representation

Introspect context information about modules in @INC

• Host: GitHub
• URL: https://github.com/kentnl/module-data
• Owner: kentnl
• License: other
• Created: 2012-03-22T00:22:39.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2017-03-06T11:56:01.000Z (over 7 years ago)
• Last Synced: 2024-06-19T00:24:04.195Z (5 months ago)
• Language: Perl
• Homepage:
• Size: 248 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.mkdn
  • Changelog: Changes
  • License: LICENSE

Awesome Lists containing this project

README

        
# NAME

Module::Data - Introspect context information about modules in @INC

# VERSION

version 0.014

# SYNOPSIS

        use Module::Data;

        my $d = Module::Data->new( 'Package::Stash' );

        $d->path; # returns the path to where Package::Stash was found in @INC

        $d->root; # returns the root directory in @INC that 'Package::Stash' was found inside.

        # Convenient trick to discern if you're in a development environment

        my $d = Module::Data->new( 'Module::Im::Developing' );

        if ( -e $d->root->parent->subdir('share') ) {

                # Yep, this dir exists, so we're in a dev context.

                # because we know in the development context all modules are in lib/*/*

                # so if the modules are anywhere else, its not a dev context.

                # see File::ShareDir::ProjectDistDir for more.

        }

        # Helpful sugar.

        my $v = $d->version;

# METHODS

## package

Returns the package the `Module::Data` instance was created for. In essence,

this will just return the value you passed during `new`, nothing more, nothing

less.

        my $package = $md->package

## loaded

Check to see if the module is already recorded as being loaded in `%INC`

        if ( $md->loaded ) {

                say "$md was loaded";

        }

## require

Require the module be loaded into memory and the global stash.

    my $mod = Module::Data->new( 'Foo' ); # nothing much happens.

    $mod->require; # like 'require Foo';

Returns the ["package"](#package) name itself for convenience so you can do

    my $mod = Module::Data->new('Foo');

    $mod->require->new( %args );

## path

A Path::Tiny object with the absolute path to the found module.

        my $md = Module::Data->new( 'Foo' );

        my $path = $md->path;

`$path` is computed optimistically. If the ["package"](#package) is listed as being

["loaded"](#loaded), then it asks `%INC` for where it was found, otherwise, the path is

resolved by simulating `perl`'s path look up in `@INC` via

[`Path::ScanINC`](https://metacpan.org/pod/Path::ScanINC).

## root

Returns the base directory of the tree the module was found at.

( Probably from @INC );

        local @INC = (

                "somewhere/asinine/",

                "somewhere/in/space/",   # Where Lib::Foo::Bar is

                "somethingelse/",

        );

        my $md = Module::Data->new( "Lib::Foo::Bar");

        $md->path ; # somewhere/in/space/Lib/Foo/Bar.pm

        my $root = $md->root # somewhere/in/space

## version

If the module appears to be already loaded in memory:

        my $v = $md->version;

is merely shorthand for $package->VERSION;

However, if the module is not loaded into memory, all efforts to extract the

value without loading the code permanently are performed.

Here, this means we compute the path to the file manually ( see ["path"](#path) ) and

parse the file with [`Module::Metadata`](https://metacpan.org/pod/Module::Metadata) to statically extract `$VERSION`.

This means you can unleash this code on your entire installed module tree, while

incurring no permanent memory gain as you would normally incur if you were to

`require` them all.

# AUTHOR

Kent Fredric 

# COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Kent Fredric .

This is free software; you can redistribute it and/or modify it under

the same terms as the Perl 5 programming language system itself.