2 # -*- mode: cperl; tab-width: 8; indent-tabs-mode: nil; basic-offset: 2 -*-
3 # vim:ts=8:sw=2:et:sta:sts=2
14 # parse various module $VERSION lines
15 # format: expected version => code snippet
17 $undef => <<'---', # no $VERSION line
20 $undef => <<'---', # undefined $VERSION
24 '1.23' => <<'---', # declared & defined on same line with 'our'
26 our $VERSION = '1.23';
28 '1.23' => <<'---', # declared & defined on separate lines with 'our'
33 '1.23' => <<'---', # commented & defined on same line
35 our $VERSION = '1.23'; # our $VERSION = '4.56';
37 '1.23' => <<'---', # commented & defined on separate lines
39 # our $VERSION = '4.56';
40 our $VERSION = '1.23';
42 '1.23' => <<'---', # use vars
44 use vars qw( $VERSION );
47 '1.23' => <<'---', # choose the right default package based on package/file name
48 package Simple::_private;
51 $VERSION = '1.23'; # this should be chosen for version
53 '1.23' => <<'---', # just read the first $VERSION line
55 $VERSION = '1.23'; # we should see this line
56 $VERSION = eval $VERSION; # and ignore this one
58 '1.23' => <<'---', # just read the first $VERSION line in reopened package (1)
61 package Error::Simple;
65 '1.23' => <<'---', # just read the first $VERSION line in reopened package (2)
67 package Error::Simple;
72 '1.23' => <<'---', # mentions another module's $VERSION
75 if ( $Other::VERSION ) {
79 '1.23' => <<'---', # mentions another module's $VERSION in a different package
83 if ( $Simple::VERSION ) {
87 '1.23' => <<'---', # $VERSION checked only in assignments, not regexp ops
90 if ( $VERSION =~ /1\.23/ ) {
94 '1.23' => <<'---', # $VERSION checked only in assignments, not relational ops
97 if ( $VERSION == 3.45 ) {
101 '1.23' => <<'---', # $VERSION checked only in assignments, not relational ops
105 if ( $Simple::VERSION == 3.45 ) {
109 '1.23' => <<'---', # Fully qualified $VERSION declared in package
111 $Simple::VERSION = 1.23;
113 '1.23' => <<'---', # Differentiate fully qualified $VERSION in a package
115 $Simple2::VERSION = '999';
116 $Simple::VERSION = 1.23;
118 '1.23' => <<'---', # Differentiate fully qualified $VERSION and unqualified
120 $Simple2::VERSION = '999';
123 '1.23' => <<'---', # $VERSION declared as package variable from within 'main' package
124 $Simple::VERSION = '1.23';
127 $x = $y, $cats = $dogs;
130 '1.23' => <<'---', # $VERSION wrapped in parens - space inside
132 ( $VERSION ) = '1.23';
134 '1.23' => <<'---', # $VERSION wrapped in parens - no space inside
138 '1.23' => <<'---', # $VERSION follows a spurious 'package' in a quoted construct
140 __PACKAGE__->mk_accessors(qw(
142 package filename line codeline subroutine finished));
144 our $VERSION = "1.23";
146 '1.23' => <<'---', # $VERSION using version.pm
148 use version; our $VERSION = version->new('1.23');
150 '1.23' => <<'---', # $VERSION using version.pm and qv()
152 use version; our $VERSION = qv('1.230');
154 '1.23' => <<'---', # Two version assignments, should ignore second one
155 $Simple::VERSION = '1.230';
156 $Simple::VERSION = eval $Simple::VERSION;
158 '1.23' => <<'---', # declared & defined on same line with 'our'
160 our $VERSION = '1.23_00_00';
162 '1.23' => <<'---', # package NAME VERSION
165 '1.23_01' => <<'---', # package NAME VERSION
166 package Simple 1.23_01;
168 'v1.2.3' => <<'---', # package NAME VERSION
169 package Simple v1.2.3;
171 'v1.2_3' => <<'---', # package NAME VERSION
172 package Simple v1.2_3;
174 '1.23' => <<'---', # trailing crud
177 $VERSION = '1.23-alpha';
179 '1.23' => <<'---', # trailing crud
184 '1.234' => <<'---', # multi_underscore
187 $VERSION = '1.2_3_4';
189 '0' => <<'---', # non-numeric
192 $VERSION = 'onetwothree';
194 $undef => <<'---', # package NAME BLOCK, undef $VERSION
199 '1.23' => <<'---', # package NAME BLOCK, with $VERSION
201 our $VERSION = '1.23';
204 '1.23' => <<'---', # package NAME VERSION BLOCK
205 package Simple 1.23 {
209 'v1.2.3_4' => <<'---', # package NAME VERSION BLOCK
210 package Simple v1.2.3_4 {
214 '0' => <<'---', # set from separately-initialised variable
216 our $CVSVERSION = '$Revision: 1.7 $';
217 our ($VERSION) = ($CVSVERSION =~ /(\d+\.\d+)/);
222 # format: expected package name => code snippet
224 [ 'Simple' ] => <<'---', # package NAME
227 [ 'Simple::Edward' ] => <<'---', # package NAME::SUBNAME
228 package Simple::Edward;
230 [ 'Simple::Edward::' ] => <<'---', # package NAME::SUBNAME::
231 package Simple::Edward::;
233 [ "Simple'Edward" ] => <<'---', # package NAME'SUBNAME
234 package Simple'Edward;
236 [ "Simple'Edward::" ] => <<'---', # package NAME'SUBNAME::
237 package Simple'Edward::;
239 [ 'Simple::::Edward' ] => <<'---', # package NAME::::SUBNAME
240 package Simple::::Edward;
242 [ '::Simple::Edward' ] => <<'---', # package ::NAME::SUBNAME
243 package ::Simple::Edward;
245 [ 'main' ] => <<'---', # package NAME:SUBNAME (fail)
246 package Simple:Edward;
248 [ 'main' ] => <<'---', # package NAME' (fail)
251 [ 'main' ] => <<'---', # package NAME::SUBNAME' (fail)
252 package Simple::Edward';
254 [ 'main' ] => <<'---', # package NAME''SUBNAME (fail)
255 package Simple''Edward;
257 [ 'main' ] => <<'---', # package NAME-SUBNAME (fail)
258 package Simple-Edward;
262 # 2 tests per each pair of @modules, @pkg_names entry
263 plan tests => 63 + ( @modules ) + ( @pkg_names );
265 require_ok('Module::Metadata');
268 # class method C<find_module_by_name>
269 my $module = Module::Metadata->find_module_by_name(
270 'Module::Metadata' );
271 ok( -e $module, 'find_module_by_name() succeeds' );
274 #########################
276 my $tmp = MBTest->tmpdir;
279 my $dist = DistGen->new( dir => $tmp );
285 # fail on invalid module name
286 my $pm_info = Module::Metadata->new_from_module(
287 'Foo::Bar', inc => [] );
288 ok( !defined( $pm_info ), 'fail if can\'t find module by module name' );
292 # fail on invalid filename
293 my $file = File::Spec->catfile( 'Foo', 'Bar.pm' );
294 my $pm_info = Module::Metadata->new_from_file( $file, inc => [] );
295 ok( !defined( $pm_info ), 'fail if can\'t find module by file name' );
299 # construct from module filename
300 my $file = File::Spec->catfile( 'lib', split( /::/, $dist->name ) ) . '.pm';
301 my $pm_info = Module::Metadata->new_from_file( $file );
302 ok( defined( $pm_info ), 'new_from_file() succeeds' );
304 # construct from filehandle
305 my $handle = IO::File->new($file);
306 $pm_info = Module::Metadata->new_from_handle( $handle, $file );
307 ok( defined( $pm_info ), 'new_from_handle() succeeds' );
308 $pm_info = Module::Metadata->new_from_handle( $handle );
309 is( $pm_info, undef, "new_from_handle() without filename returns undef" );
314 # construct from module name, using custom include path
315 my $pm_info = Module::Metadata->new_from_module(
316 $dist->name, inc => [ 'lib', @INC ] );
317 ok( defined( $pm_info ), 'new_from_module() succeeds' );
321 # iterate through @modules pairwise
323 while (++$test_case and my ($expected_version, $code) = splice @modules, 0, 2 ) {
325 skip( "No our() support until perl 5.6", 2 )
326 if $] < 5.006 && $code =~ /\bour\b/;
327 skip( "No package NAME VERSION support until perl 5.11.1", 2 )
328 if $] < 5.011001 && $code =~ /package\s+[\w\:\']+\s+v?[0-9._]+/;
330 $dist->change_file( 'lib/Simple.pm', $code );
334 local $SIG{__WARN__} = sub { $warnings .= $_ for @_ };
335 my $file = File::Spec->catfile( 'lib', split( /::/, $dist->name ) ) . '.pm';
336 my $pm_info = Module::Metadata->new_from_file( $file );
338 # Test::Builder will prematurely numify objects, so use this form
340 my $got = $pm_info->version;
345 "case $test_case: correct module version ("
346 . (defined $expected_version? "'$expected_version'" : 'undef')
351 is( $warnings, '', "case $test_case: no warnings from parsing" ) or $errs++;
352 diag "Got: '$got'\nModule contents:\n$code" if $errs;
356 # revert to pristine state
357 $dist->regen( clean => 1 );
360 while (++$test_case and my ($expected_name, $code) = splice @pkg_names, 0, 2) {
361 $dist->change_file( 'lib/Simple.pm', $code);
365 local $SIG{__WARN__} = sub { $warnings .= $_ for @_ };
366 my $file = File::Spec->catfile( 'lib', split( /::/, $dist->name ) ) . '.pm';
367 my $pm_info = Module::Metadata->new_from_file( $file );
369 # Test::Builder will prematurely numify objects, so use this form
371 my @got = $pm_info->packages_inside();
372 is_deeply( \@got, $expected_name,
373 "case $test_case: correct package names (expected '" . join(', ', @$expected_name) . "')" )
375 is( $warnings, '', "case $test_case: no warnings from parsing" ) or $errs++;
376 diag "Got: '" . join(', ', @got) . "'\nModule contents:\n$code" if $errs;
379 # revert to pristine state
380 $dist->regen( clean => 1 );
383 # Find each package only once
384 $dist->change_file( 'lib/Simple.pm', <<'---' );
387 package Error::Simple;
394 my $file = File::Spec->catfile( 'lib', split( /::/, $dist->name ) ) . '.pm';
395 my $pm_info = Module::Metadata->new_from_file( $file );
397 my @packages = $pm_info->packages_inside;
398 is( @packages, 2, 'record only one occurence of each package' );
402 # Module 'Simple.pm' does not contain package 'Simple';
403 # constructor should not complain, no default module name or version
404 $dist->change_file( 'lib/Simple.pm', <<'---' );
410 my $file = File::Spec->catfile( 'lib', split( /::/, $dist->name ) ) . '.pm';
411 my $pm_info = Module::Metadata->new_from_file( $file );
413 is( $pm_info->name, undef, 'no default package' );
414 is( $pm_info->version, undef, 'no version w/o default package' );
418 # Module 'Simple.pm' contains an alpha version
419 # constructor should report first $VERSION found
420 $dist->change_file( 'lib/Simple.pm', <<'---' );
422 $VERSION = '1.23_01';
423 $VERSION = eval $VERSION;
427 my $file = File::Spec->catfile( 'lib', split( /::/, $dist->name ) ) . '.pm';
428 my $pm_info = Module::Metadata->new_from_file( $file );
430 is( $pm_info->version, '1.23_01', 'alpha version reported');
432 # NOTE the following test has be done this way because Test::Builder is
433 # too smart for our own good and tries to see if the version object is a
434 # dual-var, which breaks with alpha versions:
435 # Argument "1.23_0100" isn't numeric in addition (+) at
436 # /usr/lib/perl5/5.8.7/Test/Builder.pm line 505.
438 ok( $pm_info->version > 1.23, 'alpha version greater than non');
441 # revert to pristine state
442 $dist->regen( clean => 1 );
444 # parse $VERSION lines scripts for package main
446 <<'---', # package main declared
451 <<'---', # on first non-comment line, non declared package main
455 <<'---', # after non-comment line
460 <<'---', # 1st declared package
467 <<'---', # 2nd declared package
474 <<'---', # split package
482 <<'---', # define 'main' version from other package
487 <<'---', # define 'main' version from other package
494 my ( $i, $n ) = ( 1, scalar( @scripts ) );
495 foreach my $script ( @scripts ) {
496 $dist->change_file( 'bin/simple.plx', $script );
498 my $pm_info = Module::Metadata->new_from_file(
499 File::Spec->catfile( 'bin', 'simple.plx' ) );
501 is( $pm_info->version, '0.01', "correct script version ($i of $n)" );
506 # examine properties of a module: name, pod, etc
507 $dist->change_file( 'lib/Simple.pm', <<'---' );
521 You can find me on the IRC channel
522 #simon on irc.perl.org.
528 my $pm_info = Module::Metadata->new_from_module(
529 $dist->name, inc => [ 'lib', @INC ] );
531 is( $pm_info->name, 'Simple', 'found default package' );
532 is( $pm_info->version, '0.01', 'version for default package' );
534 # got correct version for secondary package
535 is( $pm_info->version( 'Simple::Ex' ), '0.02',
536 'version for secondary package' );
538 my $filename = $pm_info->filename;
539 ok( defined( $filename ) && -e $filename,
540 'filename() returns valid path to module file' );
542 my @packages = $pm_info->packages_inside;
543 is( @packages, 2, 'found correct number of packages' );
544 is( $packages[0], 'Simple', 'packages stored in order found' );
546 # we can detect presence of pod regardless of whether we are collecting it
547 ok( $pm_info->contains_pod, 'contains_pod() succeeds' );
549 my @pod = $pm_info->pod_inside;
550 is_deeply( \@pod, [qw(NAME AUTHOR)], 'found all pod sections' );
552 is( $pm_info->pod('NONE') , undef,
553 'return undef() if pod section not present' );
555 is( $pm_info->pod('NAME'), undef,
556 'return undef() if pod section not collected' );
560 $pm_info = Module::Metadata->new_from_module(
561 $dist->name, inc => [ 'lib', @INC ], collect_pod => 1 );
564 for my $section (qw(NAME AUTHOR)) {
565 my $content = $pm_info->pod( $section );
567 $content =~ s/^\s+//;
568 $content =~ s/\s+$//;
570 $pod{$section} = $content;
573 NAME => q|Simple - It's easy.|,
574 AUTHOR => <<'EXPECTED'
577 You can find me on the IRC channel
578 #simon on irc.perl.org.
581 for my $text (values %expected) {
585 is( $pod{NAME}, $expected{NAME}, 'collected NAME pod section' );
586 is( $pod{AUTHOR}, $expected{AUTHOR}, 'collected AUTHOR pod section' );
590 # test things that look like POD, but aren't
591 $dist->change_file( 'lib/Simple.pm', <<'---' );
596 our $VERSION = '999';
600 our $VERSION = '666';
605 =*no_this_does_not_start_pod;
607 our $VERSION = '1.23';
611 my $pm_info = Module::Metadata->new_from_file('lib/Simple.pm');
612 is( $pm_info->name, 'Simple', 'found default package' );
613 is( $pm_info->version, '1.23', 'version for default package' );
617 # Make sure processing stops after __DATA__
618 $dist->change_file( 'lib/Simple.pm', <<'---' );
622 *UNIVERSAL::VERSION = sub {
628 my $pm_info = Module::Metadata->new_from_file('lib/Simple.pm');
629 is( $pm_info->name, 'Simple', 'found default package' );
630 is( $pm_info->version, '0.01', 'version for default package' );
631 my @packages = $pm_info->packages_inside;
632 is_deeply(\@packages, ['Simple'], 'packages inside');
636 # Make sure we handle version.pm $VERSIONs well
637 $dist->change_file( 'lib/Simple.pm', <<'---' );
639 $VERSION = version->new('0.60.' . (qw$Revision: 128 $)[1]);
640 package Simple::Simon;
641 $VERSION = version->new('0.61.' . (qw$Revision: 129 $)[1]);
645 my $pm_info = Module::Metadata->new_from_file('lib/Simple.pm');
646 is( $pm_info->name, 'Simple', 'found default package' );
647 is( $pm_info->version, '0.60.128', 'version for default package' );
648 my @packages = $pm_info->packages_inside;
649 is_deeply([sort @packages], ['Simple', 'Simple::Simon'], 'packages inside');
650 is( $pm_info->version('Simple::Simon'), '0.61.129', 'version for embedded package' );
653 # check that package_versions_from_directory works
656 $dist->change_file( 'lib/Simple.pm', <<'---' );
662 package main; # should ignore this
665 package DB; # should ignore this
668 package Simple::_private; # should ignore this
685 'file' => 'Simple.pm',
689 'file' => 'Simple.pm',
694 my $got_pvfd = Module::Metadata->package_versions_from_directory('lib');
696 is_deeply( $got_pvfd, $exp_pvfd, "package_version_from_directory()" )
697 or diag explain $got_pvfd;
700 my $got_provides = Module::Metadata->provides(dir => 'lib', version => 2);
703 'file' => 'lib/Simple.pm',
707 'file' => 'lib/Simple.pm',
712 is_deeply( $got_provides, $exp_provides, "provides()" )
713 or diag explain $got_provides;
717 my $got_provides = Module::Metadata->provides(dir => 'lib', prefix => 'other', version => 1.4);
720 'file' => 'other/Simple.pm',
724 'file' => 'other/Simple.pm',
729 is_deeply( $got_provides, $exp_provides, "provides()" )
730 or diag explain $got_provides;
734 # Check package_versions_from_directory with regard to case-sensitivity
736 $dist->change_file( 'lib/Simple.pm', <<'---' );
742 my $pm_info = Module::Metadata->new_from_file('lib/Simple.pm');
743 is( $pm_info->name, undef, 'no default package' );
744 is( $pm_info->version, undef, 'version for default package' );
745 is( $pm_info->version('simple'), '0.01', 'version for lower-case package' );
746 is( $pm_info->version('Simple'), undef, 'version for capitalized package' );
747 ok( $pm_info->is_indexable(), 'an indexable package is found' );
748 ok( $pm_info->is_indexable('simple'), 'the simple package is indexable' );
749 ok( !$pm_info->is_indexable('Simple'), 'the Simple package would not be indexed' );
753 $dist->change_file( 'lib/Simple.pm', <<'---' );
763 my $pm_info = Module::Metadata->new_from_file('lib/Simple.pm');
764 is( $pm_info->name, 'Simple', 'found default package' );
765 is( $pm_info->version, '0.02', 'version for default package' );
766 is( $pm_info->version('simple'), '0.01', 'version for lower-case package' );
767 is( $pm_info->version('Simple'), '0.02', 'version for capitalized package' );
768 is( $pm_info->version('SiMpLe'), '0.03', 'version for mixed-case package' );
769 ok( $pm_info->is_indexable('simple'), 'the simple package is indexable' );
770 ok( $pm_info->is_indexable('Simple'), 'the Simple package is indexable' );
774 $dist->change_file( 'lib/Simple.pm', <<'---' );
775 package ## hide from PAUSE
782 my $pm_info = Module::Metadata->new_from_file('lib/Simple.pm');
783 is( $pm_info->name, undef, 'no package names found' );
784 ok( !$pm_info->is_indexable('simple'), 'the simple package would not be indexed' );
785 ok( !$pm_info->is_indexable('Simple'), 'the Simple package would not be indexed' );
786 ok( !$pm_info->is_indexable(), 'no indexable package is found' );