2 # -*- mode: cperl; tab-width: 8; indent-tabs-mode: nil; basic-offset: 2 -*-
3 # vim:ts=8:sw=2:et:sta:sts=2
9 # parse various module $VERSION lines
10 # these will be reversed later to create %modules
12 '1.23' => <<'---', # declared & defined on same line with 'our'
14 our $VERSION = '1.23';
16 '1.23' => <<'---', # declared & defined on separate lines with 'our'
21 '1.23' => <<'---', # use vars
23 use vars qw( $VERSION );
26 '1.23' => <<'---', # choose the right default package based on package/file name
27 package Simple::_private;
30 $VERSION = '1.23'; # this should be chosen for version
32 '1.23' => <<'---', # just read the first $VERSION line
34 $VERSION = '1.23'; # we should see this line
35 $VERSION = eval $VERSION; # and ignore this one
37 '1.23' => <<'---', # just read the first $VERSION line in reopened package (1)
40 package Error::Simple;
44 '1.23' => <<'---', # just read the first $VERSION line in reopened package (2)
46 package Error::Simple;
51 '1.23' => <<'---', # mentions another module's $VERSION
54 if ( $Other::VERSION ) {
58 '1.23' => <<'---', # mentions another module's $VERSION in a different package
62 if ( $Simple::VERSION ) {
66 '1.23' => <<'---', # $VERSION checked only in assignments, not regexp ops
69 if ( $VERSION =~ /1\.23/ ) {
73 '1.23' => <<'---', # $VERSION checked only in assignments, not relational ops
76 if ( $VERSION == 3.45 ) {
80 '1.23' => <<'---', # $VERSION checked only in assignments, not relational ops
84 if ( $Simple::VERSION == 3.45 ) {
88 '1.23' => <<'---', # Fully qualified $VERSION declared in package
90 $Simple::VERSION = 1.23;
92 '1.23' => <<'---', # Differentiate fully qualified $VERSION in a package
94 $Simple2::VERSION = '999';
95 $Simple::VERSION = 1.23;
97 '1.23' => <<'---', # Differentiate fully qualified $VERSION and unqualified
99 $Simple2::VERSION = '999';
102 '1.23' => <<'---', # $VERSION declared as package variable from within 'main' package
103 $Simple::VERSION = '1.23';
106 $x = $y, $cats = $dogs;
109 '1.23' => <<'---', # $VERSION wrapped in parens - space inside
111 ( $VERSION ) = '1.23';
113 '1.23' => <<'---', # $VERSION wrapped in parens - no space inside
117 '1.23' => <<'---', # $VERSION follows a spurious 'package' in a quoted construct
119 __PACKAGE__->mk_accessors(qw(
121 package filename line codeline subroutine finished));
123 our $VERSION = "1.23";
125 '1.23' => <<'---', # $VERSION using version.pm
127 use version; our $VERSION = version->new('1.23');
129 '1.23' => <<'---', # $VERSION using version.pm and qv()
131 use version; our $VERSION = qv('1.230');
133 '1.23' => <<'---', # Two version assignments, should ignore second one
134 $Simple::VERSION = '1.230';
135 $Simple::VERSION = eval $Simple::VERSION;
137 '1.23' => <<'---', # declared & defined on same line with 'our'
139 our $VERSION = '1.23_00_00';
141 '1.23' => <<'---', # package NAME VERSION
144 '1.23_01' => <<'---', # package NAME VERSION
145 package Simple 1.23_01;
147 'v1.2.3' => <<'---', # package NAME VERSION
148 package Simple v1.2.3;
150 'v1.2_3' => <<'---', # package NAME VERSION
151 package Simple v1.2_3;
154 my %modules = reverse @modules;
156 plan tests => 37 + 2 * keys( %modules );
158 require_ok('Module::Metadata');
160 my $tmp = MBTest->tmpdir;
163 my $dist = DistGen->new( dir => $tmp );
168 #########################
170 # class method C<find_module_by_name>
171 my $module = Module::Metadata->find_module_by_name(
172 'Module::Metadata' );
173 ok( -e $module, 'find_module_by_name() succeeds' );
176 # fail on invalid module name
177 my $pm_info = Module::Metadata->new_from_module(
178 'Foo::Bar', inc => [] );
179 ok( !defined( $pm_info ), 'fail if can\'t find module by module name' );
182 # fail on invalid filename
183 my $file = File::Spec->catfile( 'Foo', 'Bar.pm' );
184 $pm_info = Module::Metadata->new_from_file( $file, inc => [] );
185 ok( !defined( $pm_info ), 'fail if can\'t find module by file name' );
188 # construct from module filename
189 $file = File::Spec->catfile( 'lib', split( /::/, $dist->name ) ) . '.pm';
190 $pm_info = Module::Metadata->new_from_file( $file );
191 ok( defined( $pm_info ), 'new_from_file() succeeds' );
193 # construct from module name, using custom include path
194 $pm_info = Module::Metadata->new_from_module(
195 $dist->name, inc => [ 'lib', @INC ] );
196 ok( defined( $pm_info ), 'new_from_module() succeeds' );
199 foreach my $module ( sort keys %modules ) {
200 my $expected = $modules{$module};
202 skip( "No our() support until perl 5.6", 2 )
203 if $] < 5.006 && $module =~ /\bour\b/;
204 skip( "No package NAME VERSION support until perl 5.11.1", 2 )
205 if $] < 5.011001 && $module =~ /package\s+[\w\:\']+\s+v?[0-9._]+/;
207 $dist->change_file( 'lib/Simple.pm', $module );
211 local $SIG{__WARN__} = sub { $warnings .= $_ for @_ };
212 my $pm_info = Module::Metadata->new_from_file( $file );
214 # Test::Builder will prematurely numify objects, so use this form
216 ok( $pm_info->version eq $expected,
217 "correct module version (expected '$expected')" )
219 is( $warnings, '', 'no warnings from parsing' ) or $errs++;
220 diag "Got: '@{[$pm_info->version]}'\nModule contents:\n$module" if $errs;
224 # revert to pristine state
225 $dist->regen( clean => 1 );
227 # Find each package only once
228 $dist->change_file( 'lib/Simple.pm', <<'---' );
231 package Error::Simple;
238 $pm_info = Module::Metadata->new_from_file( $file );
240 my @packages = $pm_info->packages_inside;
241 is( @packages, 2, 'record only one occurence of each package' );
244 # Module 'Simple.pm' does not contain package 'Simple';
245 # constructor should not complain, no default module name or version
246 $dist->change_file( 'lib/Simple.pm', <<'---' );
252 $pm_info = Module::Metadata->new_from_file( $file );
254 is( $pm_info->name, undef, 'no default package' );
255 is( $pm_info->version, undef, 'no version w/o default package' );
257 # Module 'Simple.pm' contains an alpha version
258 # constructor should report first $VERSION found
259 $dist->change_file( 'lib/Simple.pm', <<'---' );
261 $VERSION = '1.23_01';
262 $VERSION = eval $VERSION;
266 $pm_info = Module::Metadata->new_from_file( $file );
268 is( $pm_info->version, '1.23_01', 'alpha version reported');
270 # NOTE the following test has be done this way because Test::Builder is
271 # too smart for our own good and tries to see if the version object is a
272 # dual-var, which breaks with alpha versions:
273 # Argument "1.23_0100" isn't numeric in addition (+) at
274 # /usr/lib/perl5/5.8.7/Test/Builder.pm line 505.
276 ok( $pm_info->version > 1.23, 'alpha version greater than non');
278 # revert to pristine state
279 $dist->regen( clean => 1 );
281 # parse $VERSION lines scripts for package main
283 <<'---', # package main declared
288 <<'---', # on first non-comment line, non declared package main
292 <<'---', # after non-comment line
297 <<'---', # 1st declared package
304 <<'---', # 2nd declared package
311 <<'---', # split package
319 <<'---', # define 'main' version from other package
324 <<'---', # define 'main' version from other package
331 my ( $i, $n ) = ( 1, scalar( @scripts ) );
332 foreach my $script ( @scripts ) {
333 $dist->change_file( 'bin/simple.plx', $script );
335 $pm_info = Module::Metadata->new_from_file(
336 File::Spec->catfile( 'bin', 'simple.plx' ) );
338 is( $pm_info->version, '0.01', "correct script version ($i of $n)" );
343 # examine properties of a module: name, pod, etc
344 $dist->change_file( 'lib/Simple.pm', <<'---' );
361 $pm_info = Module::Metadata->new_from_module(
362 $dist->name, inc => [ 'lib', @INC ] );
364 is( $pm_info->name, 'Simple', 'found default package' );
365 is( $pm_info->version, '0.01', 'version for default package' );
367 # got correct version for secondary package
368 is( $pm_info->version( 'Simple::Ex' ), '0.02',
369 'version for secondary package' );
371 my $filename = $pm_info->filename;
372 ok( defined( $filename ) && -e $filename,
373 'filename() returns valid path to module file' );
375 @packages = $pm_info->packages_inside;
376 is( @packages, 2, 'found correct number of packages' );
377 is( $packages[0], 'Simple', 'packages stored in order found' );
379 # we can detect presence of pod regardless of whether we are collecting it
380 ok( $pm_info->contains_pod, 'contains_pod() succeeds' );
382 my @pod = $pm_info->pod_inside;
383 is_deeply( \@pod, [qw(NAME AUTHOR)], 'found all pod sections' );
385 is( $pm_info->pod('NONE') , undef,
386 'return undef() if pod section not present' );
388 is( $pm_info->pod('NAME'), undef,
389 'return undef() if pod section not collected' );
393 $pm_info = Module::Metadata->new_from_module(
394 $dist->name, inc => [ 'lib', @INC ], collect_pod => 1 );
396 my $name = $pm_info->pod('NAME');
401 is( $name, q|Simple - It's easy.|, 'collected pod section' );
405 # Make sure processing stops after __DATA__
406 $dist->change_file( 'lib/Simple.pm', <<'---' );
410 *UNIVERSAL::VERSION = sub {
416 $pm_info = Module::Metadata->new_from_file('lib/Simple.pm');
417 is( $pm_info->name, 'Simple', 'found default package' );
418 is( $pm_info->version, '0.01', 'version for default package' );
419 my @packages = $pm_info->packages_inside;
420 is_deeply(\@packages, ['Simple'], 'packages inside');
424 # Make sure we handle version.pm $VERSIONs well
425 $dist->change_file( 'lib/Simple.pm', <<'---' );
427 $VERSION = version->new('0.60.' . (qw$Revision: 128 $)[1]);
428 package Simple::Simon;
429 $VERSION = version->new('0.61.' . (qw$Revision: 129 $)[1]);
433 $pm_info = Module::Metadata->new_from_file('lib/Simple.pm');
434 is( $pm_info->name, 'Simple', 'found default package' );
435 is( $pm_info->version, '0.60.128', 'version for default package' );
436 my @packages = $pm_info->packages_inside;
437 is_deeply([sort @packages], ['Simple', 'Simple::Simon'], 'packages inside');
438 is( $pm_info->version('Simple::Simon'), '0.61.129', 'version for embedded package' );