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 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
|
package CPAN::Changes::Parser;
use strict;
use warnings;
our $VERSION = '0.500005';
$VERSION =~ tr/_//d;
use Module::Runtime qw(use_module);
use Carp qw(croak);
use Encode qw(decode FB_CROAK LEAVE_SRC);
use Moo;
has _changelog_class => (
is => 'ro',
default => 'CPAN::Changes',
coerce => sub { use_module($_[0]) },
);
has _release_class => (
is => 'ro',
default => 'CPAN::Changes::Release',
coerce => sub { use_module($_[0]) },
);
has _entry_class => (
is => 'ro',
default => 'CPAN::Changes::Entry',
coerce => sub { use_module($_[0]) },
);
has version_like => (
is => 'ro',
);
has version_prefix => (
is => 'ro',
);
sub parse_string {
my ($self, $string) = @_;
$self->_transform($self->_parse($string));
}
sub parse_file {
my ($self, $file, $layers) = @_;
my $mode = defined $layers ? "<$layers" : '<:raw';
open my $fh, $mode, $file or croak "Can't open $file: $!";
my $content = do { local $/; <$fh> };
if (!defined $layers) {
# if it's valid UTF-8, decode that. otherwise, assume latin 1 and leave it.
eval { $content = decode('UTF-8', $content, FB_CROAK | LEAVE_SRC) };
}
$self->parse_string($content);
}
sub _transform {
my ($self, $data) = @_;
my $release_class = $self->_release_class;
my $entry_class = $self->_entry_class;
$self->_changelog_class->new(
(defined $data->{preamble} ? (preamble => $data->{preamble}) : ()),
releases => [
map {
my $r = $_;
$release_class->new(
(map { defined $r->{$_} ? ($_ => $r->{$_}) : () }
qw(version line date raw_date note)),
($_->{entries} ? (
entries => [
map { _trans_entry($entry_class, $_) } @{$_->{entries}},
],
) : () ),
)
} reverse @{$data->{releases}},
],
);
}
sub _trans_entry {
my ($entry_class, $entry) = @_;
$entry_class->new(
line => $entry->{line},
text => $entry->{text},
$entry->{entries} ? (
entries => [
map { _trans_entry($entry_class, $_) } @{$entry->{entries}},
],
) : (),
);
}
our $VERSION_REGEX = qr{
(?:
v [0-9]+ (?: (?:\.[0-9]+ )+ (?:_[0-9]+)? )?
|
(?:[0-9]+)? (?:\.[0-9]+){2,} (?:_[0-9]+)?
|
[0-9]* \.[0-9]+ (?: _[0-9]+ )?
|
[0-9]+ (?: _[0-9]+ )?
)
(?: -TRIAL )?
}x;
sub _parse {
my ($self, $string) = @_;
my $version_prefix = qr/version|revision/i;
if (defined(my $vp = $self->version_prefix)) {
$version_prefix = qr/$version_prefix|$vp/
}
my $version_token = qr/$VERSION_REGEX(?:-TRIAL)?/;
if (defined(my $vt = $self->version_like)) {
$version_token = qr/$version_token|$vt/
}
my $raw_preamble = '';
my @releases;
my @indents;
my $line_number = -1;
while ($string =~ /((.*?)(?:\r\n?|\n|\z))/g) {
my ($full_line, $line) = ($1, $2);
last
if !length $full_line;
$line_number++;
if ( $line =~ /^(?:$version_prefix\s+)?($version_token)(?:[:;.-]?\s+(.*))?$/i ) {
my $version = $1;
my $note = $2;
my $date;
my $raw_date;
if (defined $note) {
($date, $raw_date, $note) = _split_date($note);
}
my $release = {
version => $version,
(defined $date ? (date => $date) : ()),
(defined $raw_date ? (raw_date => $raw_date) : ()),
(defined $note ? (note => $note) : ()),
raw => $full_line,
entries => [],
line => $line_number+1,
};
push @releases, $release;
@indents = ($release);
next;
}
elsif (!@indents) {
$raw_preamble .= $full_line,
next;
}
if ( $line =~ /^[-_*+~#=\s]*$/ ) {
$indents[-1]{done}++
if @indents > 1;
if (@indents) {
$indents[-1]{raw} .= $full_line;
}
else {
$releases[-1]{raw} .= $full_line;
}
next;
}
$line =~ s/\s+$//;
$line =~ s/^(\s*)//;
my $indent = 1 + length _expand_tab($1);
my $change;
my $done;
my $nest;
my $style = '';
if ( $line =~ /^\[\s*([^\[\]]*)\]$/ ) {
$done = 1;
$nest = 1;
$change = $1;
$style = '[]';
$change =~ s/\s+$//;
}
elsif ( $line =~ /^([-*+=#]+)\s+(.*)/ ) {
$style = $1;
$change = $2;
}
else {
$change = $line;
if (
defined $indents[-1]{text}
&& !$indents[-1]{done}
&& (
$indent > $#indents
|| (
$indent == $#indents
&& (
length $indents[-1]{style}
|| $indent == 1
)
)
)
) {
$indents[-1]{raw} .= $full_line;
$indents[-1]{text} .= " $change";
next;
}
}
my $group;
my $nested;
if ( !$nest && $indents[$indent]{nested} ) {
$nested = $group = $indents[$indent]{nested};
}
elsif ( !$nest && $indents[$indent]{nest} ) {
$nested = $group = $indents[$indent];
}
else {
($group) = grep {defined} reverse @indents[ 0 .. $indent - 1 ];
}
my $entry = {
text => $change,
line => $line_number+1,
done => $done,
nest => $nest,
nested => $nested,
style => $style,
raw => $full_line,
};
push @{ $group->{entries} ||= [] }, $entry;
if ( $indent <= $#indents ) {
$#indents = $indent;
}
$indents[$indent] = $entry;
}
my $preamble;
if (length $raw_preamble) {
$preamble = $raw_preamble;
$preamble =~ s/\A\s*\n//;
$preamble =~ s/\s+\z//;
$preamble =~ s/\r\n?/\n/g;
}
my @entries = @releases;
while ( my $entry = shift @entries ) {
push @entries, @{ $entry->{entries} } if $entry->{entries};
delete @{$entry}{qw(done nest nested)};
}
return {
( defined $preamble ? (preamble => $preamble) : () ),
raw_preamble => $raw_preamble,
releases => \@releases,
};
}
my @months = qw(
Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec
);
my %months = map {; lc $months[$_] => $_ } 0 .. $#months;
our ($_SHORT_MONTH) = map qr{$_}i, join '|', map quotemeta, @months;
our ($_SHORT_DAY) = map qr{$_}i, join '|', map quotemeta, qw(
Sun Mon Tue Wed Thu Fri Sat
);
our ($_UNKNOWN_DATE) = map qr{$_}i, join '|', map quotemeta, (
'Unknown Release Date',
'Unknown',
'Not Released',
'Development Release',
'Development',
'Developer Release',
);
our $_LOCALTIME_DATE = qr{
(?:
(?:$_SHORT_DAY\s+)?
($_SHORT_MONTH)\s+
|
($_SHORT_MONTH)\s+
(?:$_SHORT_DAY\s+)
)
(\d{1,2})\s+ # date
(?: ([\d:]+)\s+ )? # time
(?: ([A-Z]+)\s+ )? # timezone
(\d{4}) # year
}x;
our $_RFC_2822_DATE = qr{
$_SHORT_DAY,\s+
(\d{1,2})\s+
($_SHORT_MONTH)\s+
(\d{4})\s+
(\d\d:\d\d:\d\d)\s+
([+-])(\d{2})(\d{2})
}x;
our $_DZIL_DATE = qr{
(\d{4}-\d\d-\d\d)\s+
(\d\d:\d\d(?::\d\d)?)(\s+[A-Za-z]+/[A-Za-z_-]+)
}x;
our $_ISO_8601_DATE = qr{
\d\d\d\d # Year
(?:
[-/]\d\d # -Month
(?:
[-/]\d\d # -Day
(?:
[T\s]
\d\d:\d\d # Hour:Minute
(?:
:\d\d # :Second
(?: \.\d+ )? # .Fractional_Second
)?
(?:
Z # UTC
|
[+-]\d\d:\d\d # Hour:Minute TZ offset
(?: :\d\d )? # :Second TZ offset
)?
)?
)?
)?
}x;
sub _split_date {
my $note = shift;
my $date;
my $parsed_date;
# munge date formats, save the remainder as note
if (defined $note && length $note) {
$note =~ s/^[^\w\s]*\s+//;
$note =~ s/\s+$//;
# explicitly unknown dates
if ( $note =~ s{^($_UNKNOWN_DATE)}{} ) {
$parsed_date = $date = $1;
}
# handle localtime-like timestamps
elsif ( $note =~ s{^($_LOCALTIME_DATE)}{} ) {
$date = $1;
$parsed_date = sprintf( '%d-%02d-%02d', $7, 1+$months{lc($2 || $3)}, $4 );
if ($5) {
# unfortunately ignores TZ data ($6)
$parsed_date .= sprintf( 'T%sZ', $5 );
}
}
# RFC 2822
elsif ( $note =~ s{^($_RFC_2822_DATE)}{} ) {
$date = $1;
$parsed_date = sprintf( '%d-%02d-%02dT%s%s%02d:%02d',
$4, 1+$months{lc $3}, $2, $5, $6, $7, $8 );
}
# handle dist-zilla style, again ingoring TZ data
elsif ( $note =~ s{^($_DZIL_DATE)}{} ) {
$date = $1;
$parsed_date = sprintf( '%sT%sZ', $2, $3 );
$note = $4 . $note;
}
# start with W3CDTF, ignore rest
elsif ( $note =~ s{^($_ISO_8601_DATE)}{} ) {
$parsed_date = $date = $1;
$parsed_date =~ s{ }{T};
$parsed_date =~ s{/}{-}g;
# Add UTC TZ if date ends at H:M, H:M:S or H:M:S.FS
$parsed_date .= 'Z'
if length($parsed_date) == 16
|| length($parsed_date) == 19
|| $parsed_date =~ m{\.\d+$};
}
$note =~ s/^\s+//;
}
defined $_ && !length $_ && undef $_ for ($parsed_date, $date, $note);
return ($parsed_date, $date, $note);
}
sub _expand_tab {
my $string = "$_[0]";
$string =~ s/([^\t]*)\t/$1 . (" " x (8 - (length $1) % 8))/eg;
return $string;
}
1;
__END__
=head1 NAME
CPAN::Changes::Parser - Parse a CPAN Changelog file
=head1 SYNOPSIS
my $parser = CPAN::Changes::Parser->new(
version_like => qr/\{\{\$NEXT\}\}/,
version_prefix => qr/=head\d\s+/,
);
my $changelog = $parser->parse_file('Changes', ':utf8');
my $changelog = $parser->parse_string($content);
=head1 DESCRIPTION
Parses a file or string into a L<CPAN::Changes> object. Many forms of change
log are accepted.
=head1 ATTRIBUTES
=head2 version_like
A regular expression for a token that will be accepted in place of a version
number. For example, this could be set to C<qr/\{\{\$NEXT\}\}/> if the
L<Dist::Zilla> plugin L<[NextRelease]|Dist::Zilla::Plugin::NextRelease> is
managing the file.
=head2 version_prefix
A regular expression for a prefix that will be matched before a version number.
C<qr/=head\d\s+/> could be used if the change log is using Pod headings for the
release headings.
=head1 METHODS
=head2 parse_file
Parses a file into a L<CPAN::Changes> object. Optionally accepts a string of
layers to be used when reading the file.
=head2 parse_string
Parses a string into a L<CPAN::Changes> object.
=head1 AUTHORS
See L<CPAN::Changes> for authors.
=head1 COPYRIGHT AND LICENSE
See L<CPAN::Changes> for the copyright and license.
=cut
|