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' );
291 # fail on invalid filename
292 my $file = File::Spec->catfile( 'Foo', 'Bar.pm' );
293 $pm_info = Module::Metadata->new_from_file( $file, inc => [] );
294 ok( !defined( $pm_info ), 'fail if can\'t find module by file name' );
297 # construct from module filename
298 $file = File::Spec->catfile( 'lib', split( /::/, $dist->name ) ) . '.pm';
299 $pm_info = Module::Metadata->new_from_file( $file );
300 ok( defined( $pm_info ), 'new_from_file() succeeds' );
302 # construct from filehandle
303 my $handle = IO::File->new($file);
304 $pm_info = Module::Metadata->new_from_handle( $handle, $file );
305 ok( defined( $pm_info ), 'new_from_handle() succeeds' );
306 $pm_info = Module::Metadata->new_from_handle( $handle );
307 is( $pm_info, undef, "new_from_handle() without filename returns undef" );
310 # construct from module name, using custom include path
311 $pm_info = Module::Metadata->new_from_module(
312 $dist->name, inc => [ 'lib', @INC ] );
313 ok( defined( $pm_info ), 'new_from_module() succeeds' );
316 # iterate through @modules pairwise
318 while (++$test_case and my ($expected_version, $code) = splice @modules, 0, 2 ) {
320 skip( "No our() support until perl 5.6", 2 )
321 if $] < 5.006 && $code =~ /\bour\b/;
322 skip( "No package NAME VERSION support until perl 5.11.1", 2 )
323 if $] < 5.011001 && $code =~ /package\s+[\w\:\']+\s+v?[0-9._]+/;
325 $dist->change_file( 'lib/Simple.pm', $code );
329 local $SIG{__WARN__} = sub { $warnings .= $_ for @_ };
330 my $pm_info = Module::Metadata->new_from_file( $file );
332 # Test::Builder will prematurely numify objects, so use this form
334 my $got = $pm_info->version;
339 "case $test_case: correct module version ("
340 . (defined $expected_version? "'$expected_version'" : 'undef')
345 is( $warnings, '', "case $test_case: no warnings from parsing" ) or $errs++;
346 diag "Got: '$got'\nModule contents:\n$code" if $errs;
350 # revert to pristine state
351 $dist->regen( clean => 1 );
354 while (++$test_case and my ($expected_name, $code) = splice @pkg_names, 0, 2) {
355 $dist->change_file( 'lib/Simple.pm', $code);
359 local $SIG{__WARN__} = sub { $warnings .= $_ for @_ };
360 my $pm_info = Module::Metadata->new_from_file( $file );
362 # Test::Builder will prematurely numify objects, so use this form
364 my @got = $pm_info->packages_inside();
365 is_deeply( \@got, $expected_name,
366 "case $test_case: correct package names (expected '" . join(', ', @$expected_name) . "')" )
368 is( $warnings, '', "case $test_case: no warnings from parsing" ) or $errs++;
369 diag "Got: '" . join(', ', @got) . "'\nModule contents:\n$code" if $errs;
372 # revert to pristine state
373 $dist->regen( clean => 1 );
375 # Find each package only once
376 $dist->change_file( 'lib/Simple.pm', <<'---' );
379 package Error::Simple;
386 $pm_info = Module::Metadata->new_from_file( $file );
388 my @packages = $pm_info->packages_inside;
389 is( @packages, 2, 'record only one occurence of each package' );
392 # Module 'Simple.pm' does not contain package 'Simple';
393 # constructor should not complain, no default module name or version
394 $dist->change_file( 'lib/Simple.pm', <<'---' );
400 $pm_info = Module::Metadata->new_from_file( $file );
402 is( $pm_info->name, undef, 'no default package' );
403 is( $pm_info->version, undef, 'no version w/o default package' );
405 # Module 'Simple.pm' contains an alpha version
406 # constructor should report first $VERSION found
407 $dist->change_file( 'lib/Simple.pm', <<'---' );
409 $VERSION = '1.23_01';
410 $VERSION = eval $VERSION;
414 $pm_info = Module::Metadata->new_from_file( $file );
416 is( $pm_info->version, '1.23_01', 'alpha version reported');
418 # NOTE the following test has be done this way because Test::Builder is
419 # too smart for our own good and tries to see if the version object is a
420 # dual-var, which breaks with alpha versions:
421 # Argument "1.23_0100" isn't numeric in addition (+) at
422 # /usr/lib/perl5/5.8.7/Test/Builder.pm line 505.
424 ok( $pm_info->version > 1.23, 'alpha version greater than non');
426 # revert to pristine state
427 $dist->regen( clean => 1 );
429 # parse $VERSION lines scripts for package main
431 <<'---', # package main declared
436 <<'---', # on first non-comment line, non declared package main
440 <<'---', # after non-comment line
445 <<'---', # 1st declared package
452 <<'---', # 2nd declared package
459 <<'---', # split package
467 <<'---', # define 'main' version from other package
472 <<'---', # define 'main' version from other package
479 my ( $i, $n ) = ( 1, scalar( @scripts ) );
480 foreach my $script ( @scripts ) {
481 $dist->change_file( 'bin/simple.plx', $script );
483 $pm_info = Module::Metadata->new_from_file(
484 File::Spec->catfile( 'bin', 'simple.plx' ) );
486 is( $pm_info->version, '0.01', "correct script version ($i of $n)" );
491 # examine properties of a module: name, pod, etc
492 $dist->change_file( 'lib/Simple.pm', <<'---' );
506 You can find me on the IRC channel
507 #simon on irc.perl.org.
513 $pm_info = Module::Metadata->new_from_module(
514 $dist->name, inc => [ 'lib', @INC ] );
516 is( $pm_info->name, 'Simple', 'found default package' );
517 is( $pm_info->version, '0.01', 'version for default package' );
519 # got correct version for secondary package
520 is( $pm_info->version( 'Simple::Ex' ), '0.02',
521 'version for secondary package' );
523 my $filename = $pm_info->filename;
524 ok( defined( $filename ) && -e $filename,
525 'filename() returns valid path to module file' );
527 @packages = $pm_info->packages_inside;
528 is( @packages, 2, 'found correct number of packages' );
529 is( $packages[0], 'Simple', 'packages stored in order found' );
531 # we can detect presence of pod regardless of whether we are collecting it
532 ok( $pm_info->contains_pod, 'contains_pod() succeeds' );
534 my @pod = $pm_info->pod_inside;
535 is_deeply( \@pod, [qw(NAME AUTHOR)], 'found all pod sections' );
537 is( $pm_info->pod('NONE') , undef,
538 'return undef() if pod section not present' );
540 is( $pm_info->pod('NAME'), undef,
541 'return undef() if pod section not collected' );
545 $pm_info = Module::Metadata->new_from_module(
546 $dist->name, inc => [ 'lib', @INC ], collect_pod => 1 );
550 for my $section (qw(NAME AUTHOR)) {
551 my $content = $pm_info->pod( $section );
553 $content =~ s/^\s+//;
554 $content =~ s/\s+$//;
556 $pod{$section} = $content;
559 NAME => q|Simple - It's easy.|,
560 AUTHOR => <<'EXPECTED'
563 You can find me on the IRC channel
564 #simon on irc.perl.org.
567 for my $text (values %expected) {
571 is( $pod{NAME}, $expected{NAME}, 'collected NAME pod section' );
572 is( $pod{AUTHOR}, $expected{AUTHOR}, 'collected AUTHOR pod section' );
576 # test things that look like POD, but aren't
577 $dist->change_file( 'lib/Simple.pm', <<'---' );
582 our $VERSION = '999';
586 our $VERSION = '666';
591 =*no_this_does_not_start_pod;
593 our $VERSION = '1.23';
597 $pm_info = Module::Metadata->new_from_file('lib/Simple.pm');
598 is( $pm_info->name, 'Simple', 'found default package' );
599 is( $pm_info->version, '1.23', 'version for default package' );
603 # Make sure processing stops after __DATA__
604 $dist->change_file( 'lib/Simple.pm', <<'---' );
608 *UNIVERSAL::VERSION = sub {
614 $pm_info = Module::Metadata->new_from_file('lib/Simple.pm');
615 is( $pm_info->name, 'Simple', 'found default package' );
616 is( $pm_info->version, '0.01', 'version for default package' );
617 my @packages = $pm_info->packages_inside;
618 is_deeply(\@packages, ['Simple'], 'packages inside');
622 # Make sure we handle version.pm $VERSIONs well
623 $dist->change_file( 'lib/Simple.pm', <<'---' );
625 $VERSION = version->new('0.60.' . (qw$Revision: 128 $)[1]);
626 package Simple::Simon;
627 $VERSION = version->new('0.61.' . (qw$Revision: 129 $)[1]);
631 $pm_info = Module::Metadata->new_from_file('lib/Simple.pm');
632 is( $pm_info->name, 'Simple', 'found default package' );
633 is( $pm_info->version, '0.60.128', 'version for default package' );
634 my @packages = $pm_info->packages_inside;
635 is_deeply([sort @packages], ['Simple', 'Simple::Simon'], 'packages inside');
636 is( $pm_info->version('Simple::Simon'), '0.61.129', 'version for embedded package' );
639 # check that package_versions_from_directory works
641 $dist->change_file( 'lib/Simple.pm', <<'---' );
647 package main; # should ignore this
650 package DB; # should ignore this
653 package Simple::_private; # should ignore this
670 'file' => 'Simple.pm',
674 'file' => 'Simple.pm',
679 my $got_pvfd = Module::Metadata->package_versions_from_directory('lib');
681 is_deeply( $got_pvfd, $exp_pvfd, "package_version_from_directory()" )
682 or diag explain $got_pvfd;
685 my $got_provides = Module::Metadata->provides(dir => 'lib', version => 2);
688 'file' => 'lib/Simple.pm',
692 'file' => 'lib/Simple.pm',
697 is_deeply( $got_provides, $exp_provides, "provides()" )
698 or diag explain $got_provides;
702 my $got_provides = Module::Metadata->provides(dir => 'lib', prefix => 'other', version => 1.4);
705 'file' => 'other/Simple.pm',
709 'file' => 'other/Simple.pm',
714 is_deeply( $got_provides, $exp_provides, "provides()" )
715 or diag explain $got_provides;
718 # Check package_versions_from_directory with regard to case-sensitivity
720 $dist->change_file( 'lib/Simple.pm', <<'---' );
726 $pm_info = Module::Metadata->new_from_file('lib/Simple.pm');
727 is( $pm_info->name, undef, 'no default package' );
728 is( $pm_info->version, undef, 'version for default package' );
729 is( $pm_info->version('simple'), '0.01', 'version for lower-case package' );
730 is( $pm_info->version('Simple'), undef, 'version for capitalized package' );
731 ok( $pm_info->is_indexable(), 'an indexable package is found' );
732 ok( $pm_info->is_indexable('simple'), 'the simple package is indexable' );
733 ok( !$pm_info->is_indexable('Simple'), 'the Simple package would not be indexed' );
735 $dist->change_file( 'lib/Simple.pm', <<'---' );
745 $pm_info = Module::Metadata->new_from_file('lib/Simple.pm');
746 is( $pm_info->name, 'Simple', 'found default package' );
747 is( $pm_info->version, '0.02', 'version for default package' );
748 is( $pm_info->version('simple'), '0.01', 'version for lower-case package' );
749 is( $pm_info->version('Simple'), '0.02', 'version for capitalized package' );
750 is( $pm_info->version('SiMpLe'), '0.03', 'version for mixed-case package' );
751 ok( $pm_info->is_indexable('simple'), 'the simple package is indexable' );
752 ok( $pm_info->is_indexable('Simple'), 'the Simple package is indexable' );
754 $dist->change_file( 'lib/Simple.pm', <<'---' );
755 package ## hide from PAUSE
762 $pm_info = Module::Metadata->new_from_file('lib/Simple.pm');
763 is( $pm_info->name, undef, 'no package names found' );
764 ok( !$pm_info->is_indexable('simple'), 'the simple package would not be indexed' );
765 ok( !$pm_info->is_indexable('Simple'), 'the Simple package would not be indexed' );
766 ok( !$pm_info->is_indexable(), 'no indexable package is found' );