briandfoy / module-extract-namespaces

Extract the namespaces a Perl module uses

The Module::Extract::Namespaces module

This is the README for the Module::Extract::Namespaces Perl module. You're probably looking at this because you don't know where else to find what you're looking for. Read this once and you might never have to read one again for any Perl module.

Documentation

To read about Module::Extract::Namespaces, look at the embedded documentation in the module itself. Inside the distribution, you can format it with perldoc:

% perldoc lib/Module/Extract/Namespaces.pm

If you have already installed the module, you can specify the module name instead of the file location:

% perldoc Module::Extract::Namespaces

You can read the documentation and inspect the meta data at MetaCPAN.

The standard module documentation has example uses in the SYNOPSIS section, but you can also look in the examples/ directory (if it's there), or look at the test files in t/.

Installation

You can install this module with a CPAN client, which will resolve and install the dependencies:

% cpan Module::Extract::Namespaces
% cpanm Module::Extract::Namespaces

You can also install directly from the distribution directory, which will also install the dependencies:

% cpan .
% cpanm .

You could install just this module manually:

% perl Makefile.PL
% make
% make test
% make install

You probably don't want to do that unless you're fiddling with the module and only want to run the tests without installing anything.

Source location

The meta data, such as the source repository and bug tracker, is in Makefile.PL or the META.* files it creates. You can find that on those CPAN web interfaces, but you can also look at files directly in the source repository:

• https://github.com/briandfoy/module-extract-namespaces

If you find a problem, file a ticket in the issue tracker:

• https://github.com/briandfoy/module-extract-namespaces/issues

Getting help

Although I'm happy to hear from module users in private email, that's the best way for me to forget to do something.

Besides the issue trackers, you can find help at Perlmonks or Stackoverflow, both of which have many competent Perlers who can answer your question, almost in real time. They might not know the particulars of this module, but they can help you diagnose your problem.

You might like to read brian's Guide to Solving Any Perl Problem.

Copyright and License

You should have received a LICENSE file, but the license is also noted in the module files. About the only thing you can't do is pretend that you wrote code that you didn't.

Good luck!

Enjoy,

brian d foy, [email protected]

module-extract-namespaces's Issues

Tests fail (with older PPI?)

t/corpus.t fails on a few of my smoker systems:

#   Failed test 'Extracts right namespaces for NewPackageSyntax.pm'
#   at t/corpus.t line 32.
#     Structures begin differing at:
#          $got->[1] = Does not exist
#     $expected->[1] = 'Buster'

#   Failed test 'Extracts right namespaces for NewPackageSyntax.pm'
#   at t/corpus.t line 54.
#     Structures begin differing at:
#          $got->[1] = Does not exist
#     $expected->[1] = ARRAY(0x41d1e990)
# Looks like you failed 2 tests of 28.
t/corpus.t ........ 
Dubious, test returned 2 (wstat 512, 0x200)
Failed 2/28 subtests 

This seems to happen with older PPI. Statistical analysis:

****************************************************************
Regression 'mod:PPI'
****************************************************************
Name           	       Theta	      StdErr	 T-stat
[0='const']    	      0.0000	      0.0000	   0.56
[1='eq_1.220'] 	      0.0000	      0.0000	   1.06
[2='eq_1.224'] 	      1.0000	      0.0000	3567633010345957.00
[3='eq_1.230'] 	      1.0000	      0.0000	4671128091923860.00
[4='eq_1.232'] 	      1.0000	      0.0000	4719534857260060.00
[5='eq_1.234'] 	      1.0000	      0.0000	4923801337625259.00
[6='eq_1.236'] 	      1.0000	      0.0000	5029503941490325.00

R^2= 1.000, N= 202, K= 7
****************************************************************

So 1.224 and newer seems to be OK, 1.220 is causing the failures.

t/from_module.t needs a new test for wantarray

I was using the module itself but I removed some code that reduced the number of packages to one. There are plenty in corpus though and I just have to load the right file.

License ambiguity again

This old chestnut again.

The 'LICENSE' file says that the module is licensed "under the same terms as perl itself, under the Artistic License 2.0", which is self-contradicting because perl is licensed under either GPL or Artistic 1 licenses, not Artistic 2. The text in the module file itself says "Artistic 2.0", so it would probably be better to get rid of the "same as perl" text everywhere and just say "Artistic 2.0" instead.