Skip to content

PPI::Token::HereDoc->heredoc() includes the terminator for quoted terminators #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

PPI::Token::HereDoc->heredoc() includes the terminator for quoted terminators #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
31954b2
Add tests for PPI::Token::HereDoc->heredoc().
guillaumeaubert Mar 19, 2014
0295784
Fix detection of the terminator in HereDoc blocks.
guillaumeaubert Mar 19, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions lib/PPI/Token/HereDoc.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,29 +171,34 @@ sub __TOKENIZER__on_char {
if ( $content =~ /^\<\<(\w+)$/ ) {
# Bareword
$token->{_mode} = 'interpolate';
$token->{_raw_terminator} = $1;
$token->{_terminator} = $1;

} elsif ( $content =~ /^\<\<\s*\'(.*)\'$/ ) {
# ''-quoted literal
$token->{_mode} = 'literal';
$token->{_raw_terminator} = "'$1'";
$token->{_terminator} = $1;
$token->{_terminator} =~ s/\\'/'/g;

} elsif ( $content =~ /^\<\<\s*\"(.*)\"$/ ) {
# ""-quoted literal
$token->{_mode} = 'interpolate';
$token->{_raw_terminator} = "\"$1\"";
$token->{_terminator} = $1;
$token->{_terminator} =~ s/\\"/"/g;

} elsif ( $content =~ /^\<\<\s*\`(.*)\`$/ ) {
# ``-quoted command
$token->{_mode} = 'command';
$token->{_raw_terminator} = "`$1`";
$token->{_terminator} = $1;
$token->{_terminator} =~ s/\\`/`/g;

} elsif ( $content =~ /^\<\<\\(\w+)$/ ) {
# Legacy forward-slashed bareword
$token->{_mode} = 'literal';
$token->{_raw_terminator} = "\\$1";
$token->{_terminator} = $1;

} else {
Expand All @@ -207,9 +212,9 @@ sub __TOKENIZER__on_char {

# Suck in the HEREDOC
$token->{_heredoc} = [];
my $terminator = $token->{_terminator} . "\n";
my $raw_terminator = $token->{_raw_terminator} . "\n";
while ( defined($line = $t->_get_line) ) {
if ( $line eq $terminator ) {
if ( $line eq $raw_terminator ) {
# Keep the actual termination line for consistency
# when we are re-assembling the file
$token->{_terminator_line} = $line;
Expand Down
67 changes: 67 additions & 0 deletions t/ppi_token_heredoc.t
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
#!/usr/bin/perl

# Unit testing for PPI::Token::HereDoc

use strict;
BEGIN {
$| = 1;
$^W = 1;
no warnings 'once';
$PPI::XS_DISABLE = 1;
$PPI::Lexer::X_TOKENIZER ||= $ENV{X_TOKENIZER};
}
use Test::More tests => 6;
use Test::NoWarnings;
use PPI;


HEREDOC: {
my $tests = [
{
name => 'Bareword terminator.',
content => "my \$heredoc = <<HERE;\nLine 1\nLine 2\nHERE\n",
},
{
name => 'Single-quoted bareword terminator.',
content => "my \$heredoc = <<'HERE';\nLine 1\nLine 2\n'HERE'\n",
},
{
name => 'Double-quoted bareword terminator.',
content => "my \$heredoc = <<\"HERE\";\nLine 1\nLine 2\n\"HERE\"\n",
},
{
name => 'Command-quoted terminator.',
content => "my \$heredoc = <<`HERE`;\nLine 1\nLine 2\n`HERE`\n",
},
{
name => 'Legacy escaped bareword terminator.',
content => "my \$heredoc = <<\\HERE;\nLine 1\nLine 2\n\\HERE\n",
},
];

foreach my $test ( @$tests ) {
subtest(
$test->{'name'},
sub {
plan( tests => 6 );

my $document = PPI::Document->new( \$test->{'content'} );
isa_ok( $document, 'PPI::Document' );

my $heredocs = $document->find('Token::HereDoc');
is( ref($heredocs), 'ARRAY', 'Found heredocs.' );
is( scalar(@$heredocs), 1, 'Found 1 heredoc block.' );
my $heredoc = $heredocs->[0];
isa_ok( $heredoc, 'PPI::Token::HereDoc');
can_ok( $heredoc, 'heredoc' );

my @content = $heredoc->heredoc();
unlike(
$content[-1],
qr/HERE/,
'The returned content does not include the heredoc terminator.',
) || diag( "heredoc() returned ", explain( \@content ) );
}
);
}
}