/usr/share/perl5/Dist/Zilla/Plugin/PkgVersion.pm is in libdist-zilla-perl 5.043-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 | package Dist::Zilla::Plugin::PkgVersion;
# ABSTRACT: add a $VERSION to your packages
$Dist::Zilla::Plugin::PkgVersion::VERSION = '5.043';
use Moose;
with(
'Dist::Zilla::Role::FileMunger',
'Dist::Zilla::Role::FileFinderUser' => {
default_finders => [ ':InstallModules', ':ExecFiles' ],
},
'Dist::Zilla::Role::PPI',
);
use namespace::autoclean;
#pod =head1 SYNOPSIS
#pod
#pod in dist.ini
#pod
#pod [PkgVersion]
#pod
#pod =head1 DESCRIPTION
#pod
#pod This plugin will add lines like the following to each package in each Perl
#pod module or program (more or less) within the distribution:
#pod
#pod $MyModule::VERSION = '0.001';
#pod
#pod or
#pod
#pod { our $VERSION = '0.001'; }
#pod
#pod ...where 0.001 is the version of the dist, and MyModule is the name of the
#pod package being given a version. (In other words, it always uses fully-qualified
#pod names to assign versions.)
#pod
#pod It will skip any package declaration that includes a newline between the
#pod C<package> keyword and the package name, like:
#pod
#pod package
#pod Foo::Bar;
#pod
#pod This sort of declaration is also ignored by the CPAN toolchain, and is
#pod typically used when doing monkey patching or other tricky things.
#pod
#pod =attr die_on_existing_version
#pod
#pod If true, then when PkgVersion sees an existing C<$VERSION> assignment, it will
#pod throw an exception rather than skip the file. This attribute defaults to
#pod false.
#pod
#pod =attr die_on_line_insertion
#pod
#pod By default, PkgVersion looks for a blank line after each C<package> statement.
#pod If it finds one, it inserts the C<$VERSION> assignment on that line. If it
#pod doesn't, it will insert a new line, which means the shipped copy of the module
#pod will have different line numbers (off by one) than the source. If
#pod C<die_on_line_insertion> is true, PkgVersion will raise an exception rather
#pod than insert a new line.
#pod
#pod =attr use_our
#pod
#pod The idea here was to insert C<< { our $VERSION = '0.001'; } >> instead of C<<
#pod $Module::Name::VERSION = '0.001'; >>. It turns out that this causes problems
#pod with some analyzers. Use of this feature is deprecated.
#pod
#pod Something else will replace it in the future.
#pod
#pod =attr use_begin
#pod
#pod If true, the version assignment is wrapped in a BEGIN block. This may help in
#pod rare cases, such as when DynaLoader has to be called at BEGIN time, and
#pod requires VERSION. This option should be needed rarely.
#pod
#pod Also note that assigning to C<$VERSION> before the module has finished
#pod compiling can lead to confused behavior with attempts to determine whether a
#pod module was successfully loaded on perl v5.8.
#pod
#pod =attr finder
#pod
#pod =for stopwords FileFinder
#pod
#pod This is the name of a L<FileFinder|Dist::Zilla::Role::FileFinder> for finding
#pod modules to edit. The default value is C<:InstallModules> and C<:ExecFiles>;
#pod this option can be used more than once.
#pod
#pod Other predefined finders are listed in
#pod L<Dist::Zilla::Role::FileFinderUser/default_finders>.
#pod You can define your own with the
#pod L<[FileFinder::ByName]|Dist::Zilla::Plugin::FileFinder::ByName> and
#pod L<[FileFinder::Filter]|Dist::Zilla::Plugin::FileFinder::Filter> plugins.
#pod
#pod =cut
sub BUILD {
my ($self) = @_;
$self->log("use_our option to PkgVersion is deprecated and will be removed")
if $self->use_our;
}
sub munge_files {
my ($self) = @_;
$self->munge_file($_) for @{ $self->found_files };
}
sub munge_file {
my ($self, $file) = @_;
if ($file->is_bytes) {
$self->log_debug($file->name . " has 'bytes' encoding, skipping...");
return;
}
if ($file->name =~ /\.pod$/) {
$self->log_debug($file->name . " is a pod file, skipping...");
return;
}
return $self->munge_perl($file);
}
has die_on_existing_version => (
is => 'ro',
isa => 'Bool',
default => 0,
);
has die_on_line_insertion => (
is => 'ro',
isa => 'Bool',
default => 0,
);
has use_our => (
is => 'ro',
isa => 'Bool',
default => 0,
);
has use_begin => (
is => 'ro',
isa => 'Bool',
default => 0,
);
sub munge_perl {
my ($self, $file) = @_;
my $version = $self->zilla->version;
require version;
Carp::croak("invalid characters in version")
unless version::is_lax($version);
my $document = $self->ppi_document_for_file($file);
my $package_stmts = $document->find('PPI::Statement::Package');
unless ($package_stmts) {
$self->log_debug([ 'skipping %s: no package statement found', $file->name ]);
return;
}
if ($self->document_assigns_to_variable($document, '$VERSION')) {
if ($self->die_on_existing_version) {
$self->log_fatal([ 'existing assignment to $VERSION in %s', $file->name ]);
}
$self->log([ 'skipping %s: assigns to $VERSION', $file->name ]);
return;
}
my %seen_pkg;
my $munged = 0;
for my $stmt (@$package_stmts) {
my $package = $stmt->namespace;
if ($seen_pkg{ $package }++) {
$self->log([ 'skipping package re-declaration for %s', $package ]);
next;
}
if ($stmt->content =~ /package\s*(?:#.*)?\n\s*\Q$package/) {
$self->log([ 'skipping private package %s in %s', $package, $file->name ]);
next;
}
$self->log("non-ASCII package name is likely to cause problems")
if $package =~ /\P{ASCII}/;
$self->log("non-ASCII version is likely to cause problems")
if $version =~ /\P{ASCII}/;
# the \x20 hack is here so that when we scan *this* document we don't find
# an assignment to version; it shouldn't be needed, but it's been annoying
# enough in the past that I'm keeping it here until tests are better
my $trial = $self->zilla->is_trial ? ' # TRIAL' : '';
my $perl = $self->use_our
? "{ our \$VERSION\x20=\x20'$version'; }$trial"
: "\$$package\::VERSION\x20=\x20'$version';$trial";
$self->use_begin
and $perl = "BEGIN { $perl }";
$self->log_debug([
'adding $VERSION assignment to %s in %s',
$package,
$file->name,
]);
my $blank;
{
my $curr = $stmt;
while (1) {
# avoid bogus locations due to insert_after
$document->flush_locations if $munged;
my $curr_line_number = $curr->line_number + 1;
my $find = $document->find(sub {
my $line = $_[1]->line_number;
return $line > $curr_line_number ? undef : $line == $curr_line_number;
});
last unless $find and @$find == 1;
if ($find->[0]->isa('PPI::Token::Comment')) {
$curr = $find->[0];
next;
}
if ("$find->[0]" =~ /\A\s*\z/) {
$blank = $find->[0];
}
last;
}
}
$perl = $blank ? "$perl\n" : "\n$perl";
(my $clean_version = $version) =~ tr/_//d;
$perl .= (
$self->use_our
? "\n\$VERSION\x20=\x20'$clean_version';"
: "\n\$$package\::VERSION\x20=\x20'$clean_version';"
) if $version ne $clean_version;
# Why can't I use PPI::Token::Unknown? -- rjbs, 2014-01-11
my $bogus_token = PPI::Token::Comment->new($perl);
if ($blank) {
Carp::carp("error inserting version in " . $file->name)
unless $blank->insert_after($bogus_token);
$blank->delete;
} else {
my $method = $self->die_on_line_insertion ? 'log_fatal' : 'log';
$self->$method([
'no blank line for $VERSION after package %s statement in %s line %s',
$stmt->namespace,
$file->name,
$stmt->line_number,
]);
Carp::carp("error inserting version in " . $file->name)
unless $stmt->insert_after($bogus_token);
}
$munged = 1;
}
# the document is no longer correct; it must be reparsed before it can be used again
$file->encoded_content($document->serialize) if $munged;
}
__PACKAGE__->meta->make_immutable;
1;
#pod =head1 SEE ALSO
#pod
#pod Core Dist::Zilla plugins:
#pod L<PodVersion|Dist::Zilla::Plugin::PodVersion>,
#pod L<AutoVersion|Dist::Zilla::Plugin::AutoVersion>,
#pod L<NextRelease|Dist::Zilla::Plugin::NextRelease>.
#pod
#pod Other Dist::Zilla plugins:
#pod L<OurPkgVersion|Dist::Zilla::Plugin::OurPkgVersion> inserts version
#pod numbers using C<our $VERSION = '...';> and without changing line numbers
#pod
#pod =cut
__END__
=pod
=encoding UTF-8
=head1 NAME
Dist::Zilla::Plugin::PkgVersion - add a $VERSION to your packages
=head1 VERSION
version 5.043
=head1 SYNOPSIS
in dist.ini
[PkgVersion]
=head1 DESCRIPTION
This plugin will add lines like the following to each package in each Perl
module or program (more or less) within the distribution:
$MyModule::VERSION = '0.001';
or
{ our $VERSION = '0.001'; }
...where 0.001 is the version of the dist, and MyModule is the name of the
package being given a version. (In other words, it always uses fully-qualified
names to assign versions.)
It will skip any package declaration that includes a newline between the
C<package> keyword and the package name, like:
package
Foo::Bar;
This sort of declaration is also ignored by the CPAN toolchain, and is
typically used when doing monkey patching or other tricky things.
=head1 ATTRIBUTES
=head2 die_on_existing_version
If true, then when PkgVersion sees an existing C<$VERSION> assignment, it will
throw an exception rather than skip the file. This attribute defaults to
false.
=head2 die_on_line_insertion
By default, PkgVersion looks for a blank line after each C<package> statement.
If it finds one, it inserts the C<$VERSION> assignment on that line. If it
doesn't, it will insert a new line, which means the shipped copy of the module
will have different line numbers (off by one) than the source. If
C<die_on_line_insertion> is true, PkgVersion will raise an exception rather
than insert a new line.
=head2 use_our
The idea here was to insert C<< { our $VERSION = '0.001'; } >> instead of C<<
$Module::Name::VERSION = '0.001'; >>. It turns out that this causes problems
with some analyzers. Use of this feature is deprecated.
Something else will replace it in the future.
=head2 use_begin
If true, the version assignment is wrapped in a BEGIN block. This may help in
rare cases, such as when DynaLoader has to be called at BEGIN time, and
requires VERSION. This option should be needed rarely.
Also note that assigning to C<$VERSION> before the module has finished
compiling can lead to confused behavior with attempts to determine whether a
module was successfully loaded on perl v5.8.
=head2 finder
=for stopwords FileFinder
This is the name of a L<FileFinder|Dist::Zilla::Role::FileFinder> for finding
modules to edit. The default value is C<:InstallModules> and C<:ExecFiles>;
this option can be used more than once.
Other predefined finders are listed in
L<Dist::Zilla::Role::FileFinderUser/default_finders>.
You can define your own with the
L<[FileFinder::ByName]|Dist::Zilla::Plugin::FileFinder::ByName> and
L<[FileFinder::Filter]|Dist::Zilla::Plugin::FileFinder::Filter> plugins.
=head1 SEE ALSO
Core Dist::Zilla plugins:
L<PodVersion|Dist::Zilla::Plugin::PodVersion>,
L<AutoVersion|Dist::Zilla::Plugin::AutoVersion>,
L<NextRelease|Dist::Zilla::Plugin::NextRelease>.
Other Dist::Zilla plugins:
L<OurPkgVersion|Dist::Zilla::Plugin::OurPkgVersion> inserts version
numbers using C<our $VERSION = '...';> and without changing line numbers
=head1 AUTHOR
Ricardo SIGNES <rjbs@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2016 by Ricardo SIGNES.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|