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
|
#!/usr/bin/perl
# Unit testing for PPI::Token::HereDoc
use lib 't/lib';
use PPI::Test::pragmas;
use Test::More tests => 11 + ($ENV{AUTHOR_TESTING} ? 1 : 0);
use PPI;
use Test::Deep;
sub h;
# List of tests to perform. Each test requires the following information:
# - 'name': the name of the test in the output.
# - 'content': the Perl string to parse using PPI.
# - 'expected': a hashref with the keys being property names on the
# PPI::Token::HereDoc object, and the values being the expected value of
# that property after the heredoc block has been parsed.
# Tests with a carriage return after the termination marker.
h {
name => 'Bareword terminator.',
content => "my \$heredoc = <<HERE;\nLine 1\nLine 2\nHERE\n",
expected => {
_terminator_line => "HERE\n",
_damaged => undef,
_terminator => 'HERE',
_mode => 'interpolate',
},
};
h {
name => 'Single-quoted bareword terminator.',
content => "my \$heredoc = <<'HERE';\nLine 1\nLine 2\nHERE\n",
expected => {
_terminator_line => "HERE\n",
_damaged => undef,
_terminator => 'HERE',
_mode => 'literal',
},
};
h {
name => 'Double-quoted bareword terminator.',
content => "my \$heredoc = <<\"HERE\";\nLine 1\nLine 2\nHERE\n",
expected => {
_terminator_line => "HERE\n",
_damaged => undef,
_terminator => 'HERE',
_mode => 'interpolate',
},
};
h {
name => 'Command-quoted terminator.',
content => "my \$heredoc = <<`HERE`;\nLine 1\nLine 2\nHERE\n",
expected => {
_terminator_line => "HERE\n",
_damaged => undef,
_terminator => 'HERE',
_mode => 'command',
},
};
h {
name => 'Legacy escaped bareword terminator.',
content => "my \$heredoc = <<\\HERE;\nLine 1\nLine 2\nHERE\n",
expected => {
_terminator_line => "HERE\n",
_damaged => undef,
_terminator => 'HERE',
_mode => 'literal',
},
};
# Tests without a carriage return after the termination marker.
h {
name => 'Bareword terminator (no return).',
content => "my \$heredoc = <<HERE;\nLine 1\nLine 2\nHERE",
expected => {
_terminator_line => 'HERE',
_damaged => 1,
_terminator => 'HERE',
_mode => 'interpolate',
},
};
h {
name => 'Single-quoted bareword terminator (no return).',
content => "my \$heredoc = <<'HERE';\nLine 1\nLine 2\nHERE",
expected => {
_terminator_line => "HERE",
_damaged => 1,
_terminator => 'HERE',
_mode => 'literal',
},
};
h {
name => 'Double-quoted bareword terminator (no return).',
content => "my \$heredoc = <<\"HERE\";\nLine 1\nLine 2\nHERE",
expected => {
_terminator_line => 'HERE',
_damaged => 1,
_terminator => 'HERE',
_mode => 'interpolate',
},
};
h {
name => 'Command-quoted terminator (no return).',
content => "my \$heredoc = <<`HERE`;\nLine 1\nLine 2\nHERE",
expected => {
_terminator_line => 'HERE',
_damaged => 1,
_terminator => 'HERE',
_mode => 'command',
},
};
h {
name => 'Legacy escaped bareword terminator (no return).',
content => "my \$heredoc = <<\\HERE;\nLine 1\nLine 2\nHERE",
expected => {
_terminator_line => 'HERE',
_damaged => 1,
_terminator => 'HERE',
_mode => 'literal',
},
};
# Tests without a terminator.
h {
name => 'Unterminated heredoc block.',
content => "my \$heredoc = <<HERE;\nLine 1\nLine 2\n",
expected => {
_terminator_line => undef,
_damaged => 1,
_terminator => 'HERE',
_mode => 'interpolate',
},
};
sub h {
my ( $test ) = @_;
subtest(
$test->{name},
sub {
plan tests => 6 + keys %{ $test->{expected} };
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;
is_deeply(
\@content,
[ "Line 1\n", "Line 2\n", ],
'The returned content does not include the heredoc terminator.',
) or diag "heredoc() returned ", explain \@content;
is( $heredoc->{$_}, $test->{expected}{$_}, "property '$_'" ) for keys %{ $test->{expected} };
}
);
}
|
