jonasbn > Module-Info-File > Module::Info::File

Download:
Module-Info-File-0.11.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.11   Source  

NAME ^

Module::Info::File - retrieves module information from a file or script

SYNOPSIS ^

        use Module::Info::File;
        
        my $module = Module::Info::File->new_from_file('path/to/Some/Module.pm');
        
        $mod->name();
        
        $mod->version();
        
        $mod->file();
        
        $mod->inc_dir();

VERSION ^

This POD describes version 0.11 of Module::Info::File

DESCRIPTION ^

Module::Info (SEE REFERENCES), are lacking functionality of being able to extract certain data when parsing a module directly from a file. I have therefor created Module::Info::File, which inherits from Module::Info and replaces the new_from_file method so the lacking data can be accessed (dir and name attributes). Apart from that you can use all the neat accessors from Module::Info.

In the bin folder in this distribution is a small script called version.pl, which was the beginning of everything.

SUBROUTINES/METHODS ^

new_from_file

Given a file, it will interpret this as the module you want information about. You can also hand it a perl script.

After construction has been completed three attributes have been set in the object:

So by using the inherited methods from Module::Info you can access the attributes.

There is an example in the bin/ folder called version.pl, this script was the starting point for this module.

new_from_data

A helper method to streamline the result set

In general please refer to the documentation on Module::Info for more details.

In list context the module returns and array of Module::Info::File objects, with which you can use the above accessors. The information in the objects might not be complete though (SEE: CAVEATS).

In the t/ directory of this distribution there is a test (Info.t), it includes some tests. These tests will test your installation of Module::Info (required by Module::Info::File), if the tests fail, Module::Info::File will be obsolete and can be discontinued.

SEE ALSO ^

BUGS AND LIMITATIONS ^

The module can somewhat handle several package definitions in one file, but the information is not complete yet, such as version information etc.

The method currently only support the following version number lines:

        $VERSION = '0.01';
        
        $VERSION = 0.01;

INCOMPATIBILITIES ^

Eric D. Paterson scanned his complete CPAN installation and got and came across a few problems:

DBD::Oracle, the package was defined in a closure, this is handled from Module::Info::File 0.09.
Archive::Zip::Tree, which is installed, however deprecated and does NOT contain a package defition.
CGI::Apache, where the installed version was located in CGI/apache.pm so the casing was not uniform with the package definition, I have asked Eric for further information on this issue, regarding his version and installation.

DIAGNOSTICS ^

CONFIGURATION AND ENVIRONMENT ^

There is a such no configuration necessary and Module::Info::File is expected to work on the same environments as perl itself.

DEPENDENCIES ^

This module is a sub-class of Module::Info, so the following direct dependencies have to be met:

Module::Info 0.20
File::Spec, to work on non-unix operating systems
Perl 5.6.0 and above

Compability for older perls is no longer required, if somebody would require this I would be willing to invest the time and effort.

TODO ^

ACKNOWLEDGEMENTS ^

In no particular order

AUTHOR ^

jonasbn <jonasbn@cpan.org>

LICENSE AND COPYRIGHT ^

Module::Info::File and related modules are free software and is released under the Artistic License. See <http://www.perl.com/language/misc/Artistic.html> for details.

Module::Info::File is (C) 2003-2007 Jonas B. Nielsen (jonasbn) <jonasbn@cpan.org>

syntax highlighting: