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
|
package Dist::Zilla::Plugin::OurPkgVersion;
use 5.008;
use strict;
use warnings;
our $VERSION = '0.005001'; # VERSION
use Moose;
with (
'Dist::Zilla::Role::FileMunger',
'Dist::Zilla::Role::FileFinderUser' => {
default_finders => [ ':InstallModules', ':ExecFiles' ],
},
);
use PPI;
use MooseX::Types::Perl qw( LaxVersionStr );
use namespace::autoclean;
sub munge_files {
my $self = shift;
$self->munge_file($_) for @{ $self->found_files };
return;
}
sub munge_file {
my ( $self, $file ) = @_;
if ( $file->name =~ m/\.pod$/ixms ) {
$self->log_debug( 'Skipping: "' . $file->name . '" is pod only');
return;
}
my $version = $self->zilla->version;
confess 'invalid characters in version'
unless LaxVersionStr->check( $version );
my $content = $file->content;
my $doc = PPI::Document->new(\$content)
or $self->log( 'Skipping: "'
. $file->name
. '" error with PPI: '
. PPI::Document->errstr
)
;
return unless defined $doc;
my $comments = $doc->find('PPI::Token::Comment');
my $version_regex
= q{
^
(\s*) # capture all whitespace before comment
(
\#\s*VERSION # capture # VERSION
\b # and ensure it ends on a word boundary
[ # conditionally
[:print:] # all printable characters after VERSION
\s # any whitespace including newlines see GH #5
]* # as many of the above as there are
)
$ # until the EOL}
;
my $munged_version = 0;
if ( ref($comments) eq 'ARRAY' ) {
foreach ( @{ $comments } ) {
if ( /$version_regex/xms ) {
my ( $ws, $comment ) = ( $1, $2 );
$comment =~ s/(?=\bVERSION\b)/TRIAL /x if $self->zilla->is_trial;
my $code
= "$ws"
. q{our $VERSION = '}
. $version
. qq{'; $comment}
;
$_->set_content("$code");
$file->content( $doc->serialize );
$munged_version++;
}
}
}
if ( $munged_version ) {
$self->log_debug([ 'adding $VERSION assignment to %s', $file->name ]);
}
else {
$self->log( 'Skipping: "'
. $file->name
. '" has no "# VERSION" comment'
);
}
return;
}
__PACKAGE__->meta->make_immutable;
1;
# ABSTRACT: no line insertion and does Package version with our
__END__
=pod
=head1 NAME
Dist::Zilla::Plugin::OurPkgVersion - no line insertion and does Package version with our
=head1 VERSION
version 0.005001
=head1 SYNOPSIS
in dist.ini
[OurPkgVersion]
in your modules
# VERSION
=head1 DESCRIPTION
This module was created as an alternative to
L<Dist::Zilla::Plugin::PkgVersion> and uses some code from that module. This
module is designed to use a the more readable format C<our $VERSION =
$version;> as well as not change then number of lines of code in your files,
which will keep your repository more in sync with your CPAN release. It also
allows you slightly more freedom in how you specify your version.
=head2 EXAMPLES
in dist.ini
...
version = 0.01;
[OurPkgVersion]
in lib/My/Module.pm
package My::Module;
# VERSION
...
output lib/My/Module.pm
package My::Module;
our $VERSION = '0.01'; # VERSION
...
please note that whitespace before the comment is significant so
package My::Module;
BEGIN {
# VERSION
}
...
becomes
package My::Module;
BEGIN {
our $VERSION = '0.01'; # VERSION
}
...
while
package My::Module;
BEGIN {
# VERSION
}
...
becomes
package My::Module;
BEGIN {
our $VERSION = '0.01'; # VERSION
}
...
you can also add additional comments to your comment
...
# VERSION: generated by DZP::OurPkgVersion
...
becomes
...
our $VERSION = '0.1.0'; # VERSION: generated by DZP::OurPkgVersion
...
Also note, the package line is not in any way significant, it will insert the
C<our $VERSION> line anywhere in the file before C<# VERSION> as many times as
you've written C<# VERSION> regardless of whether or not inserting it there is
a good idea. OurPkgVersion will not insert a version unless you have C<#
VERSION> so it is a bit more work.
If you make a trial release, the comment will be altered to say so:
# VERSION
becomes
our $VERSION = '0.01'; # TRIAL VERSION
=head1 METHODS
=over
=item munge_files
Override the default provided by L<Dist::Zilla::Role::FileMunger> to limit
the number of files to search to only be modules and executables.
=item munge_file
tells which files to munge, see L<Dist::Zilla::Role::FileMunger>
=back
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website
https://github.com/xenoterracide/dist-zilla-plugin-ourpkgversion/issues
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
=head1 CONTRIBUTORS
=over 4
=item *
Alexandr Ciornii <alexchorny@gmail.com>
=item *
Alexei Znamensky <russoz@cpan.org>
=item *
Christian Walde <walde.christian@googlemail.com>
=item *
Christopher J. Madsen <perl@cjmweb.net>
=item *
David Golden <dagolden@cpan.org>
=back
=head1 AUTHOR
Caleb Cushing <xenoterracide@gmail.com>
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2013 by Caleb Cushing.
This is free software, licensed under:
The Artistic License 2.0 (GPL Compatible)
=cut
|