Skip to content

Commit 3fdad9c

Browse files
jfcherngjfcherng
committed
Fix Context/Unified output for EOL at EOF
#23 Signed-off-by: Jack Cherng <jfcherng@gmail.com>
1 parent 8ab502f commit 3fdad9c

File tree

4 files changed

+183
-47
lines changed

4 files changed

+183
-47
lines changed

‎src/Differ.php‎

Lines changed: 99 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ final class Differ
2323
*/
2424
private const CACHED_PROPERTIES = [
2525
'groupedOpcodes' => [],
26+
'groupedOpcodesGnu' => [],
27+
'oldNoEolAtEofIdx' => -1,
28+
'newNoEolAtEofIdx' => -1,
2629
'oldNewComparison' => 0,
2730
];
2831

@@ -51,17 +54,34 @@ final class Differ
5154
*/
5255
private $sequenceMatcher;
5356

57+
/**
58+
* @var int the end index for the old if the old has no EOL at EOF
59+
* -1 means the old has an EOL at EOF
60+
*/
61+
private $oldNoEolAtEofIdx = -1;
62+
63+
/**
64+
* @var int the end index for the new if the new has no EOL at EOF
65+
* -1 means the new has an EOL at EOF
66+
*/
67+
private $newNoEolAtEofIdx = -1;
68+
5469
/**
5570
* @var int the result of comparing the old and the new with the spaceship operator
5671
* -1 means old < new, 0 means old == new, 1 means old > new
5772
*/
5873
private $oldNewComparison = 0;
5974

6075
/**
61-
* @var array array containing the generated opcodes for the differences between the two items
76+
* @var int[][][] array containing the generated opcodes for the differences between the two items
6277
*/
6378
private $groupedOpcodes = [];
6479

80+
/**
81+
* @var int[][][] array containing the generated opcodes for the differences between the two items (GNU version)
82+
*/
83+
private $groupedOpcodesGnu = [];
84+
6585
/**
6686
* @var array associative array of the default options available for the Differ class and their default value
6787
*/
@@ -187,6 +207,26 @@ public function getOptions(): array
187207
return $this->options;
188208
}
189209

210+
/**
211+
* Get the old no EOL at EOF index.
212+
*
213+
* @return int the old no EOL at EOF index
214+
*/
215+
public function getOldNoEolAtEofIdx(): int
216+
{
217+
return $this->finalize()->oldNoEolAtEofIdx;
218+
}
219+
220+
/**
221+
* Get the new no EOL at EOF index.
222+
*
223+
* @return int the new no EOL at EOF index
224+
*/
225+
public function getNewNoEolAtEofIdx(): int
226+
{
227+
return $this->finalize()->newNoEolAtEofIdx;
228+
}
229+
190230
/**
191231
* Compare the old and the new with the spaceship operator.
192232
*/
@@ -222,6 +262,61 @@ public function getGroupedOpcodes(): array
222262
}
223263

224264
return $this->groupedOpcodes = $this->sequenceMatcher
265+
->setSequences($this->old, $this->new)
266+
->getGroupedOpcodes($this->options['context']);
267+
}
268+
269+
/**
270+
* A EOL-at-EOF-sensitve version of getGroupedOpcodes().
271+
*
272+
* @return int[][][] array of the grouped opcodes for the generated diff (GNU version)
273+
*/
274+
public function getGroupedOpcodesGnu(): array
275+
{
276+
$this->finalize();
277+
278+
if (!empty($this->groupedOpcodesGnu)) {
279+
return $this->groupedOpcodesGnu;
280+
}
281+
282+
$old = \array_map(
283+
function (string $line): string {
284+
return "{$line}\n";
285+
},
286+
$this->old
287+
);
288+
289+
$new = \array_map(
290+
function (string $line): string {
291+
return "{$line}\n";
292+
},
293+
$this->new
294+
);
295+
296+
// note that the old and the new are never empty at this point
297+
// they have at least one element "\n" in the array because explode("\n", "") === [""]
298+
$oldLastIdx = \count($old) - 1;
299+
$newLastIdx = \count($new) - 1;
300+
$oldLast = &$old[$oldLastIdx];
301+
$newLast = &$new[$newLastIdx];
302+
303+
if ($oldLast === "\n") {
304+
// remove the last plain "\n" line since we don't need it anymore
305+
unset($old[$oldLastIdx]);
306+
} else {
307+
// this means the original source has no EOL at EOF
308+
// we have to remove the trailing \n from the last line
309+
$oldLast = \substr($oldLast, 0, -1);
310+
}
311+
312+
if ($newLast === "\n") {
313+
unset($new[$newLastIdx]);
314+
} else {
315+
$newLast = \substr($newLast, 0, -1);
316+
}
317+
318+
return $this->groupedOpcodesGnu = $this->sequenceMatcher
319+
->setSequences($old, $new)
225320
->getGroupedOpcodes($this->options['context']);
226321
}
227322

@@ -239,11 +334,11 @@ private function finalize(): self
239334
if ($this->isCacheDirty) {
240335
$this->resetCachedResults();
241336

337+
$this->oldNoEolAtEofIdx = $this->getOld(-1) === [''] ? -1 : \count($this->old);
338+
$this->newNoEolAtEofIdx = $this->getNew(-1) === [''] ? -1 : \count($this->new);
242339
$this->oldNewComparison = $this->old <=> $this->new;
243340

244-
$this->sequenceMatcher
245-
->setOptions($this->options)
246-
->setSequences($this->old, $this->new);
341+
$this->sequenceMatcher->setOptions($this->options);
247342
}
248343

249344
return $this;

‎src/Renderer/Text/AbstractText.php‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,21 @@ abstract class AbstractText extends AbstractRenderer
1717
*/
1818
const IS_TEXT_RENDERER = true;
1919

20+
/**
21+
* @var int indicating using the old as the source text
22+
*/
23+
const OLD_AS_SOURCE = 1;
24+
25+
/**
26+
* @var int indicating using the new as the source text
27+
*/
28+
const NEW_AS_SOURCE = 2;
29+
30+
/**
31+
* @var string the diff output representing there is no EOL at EOF in the GNU diff tool
32+
*/
33+
const GNU_OUTPUT_NO_EOL_AT_EOF = '\ No newline at end of file';
34+
2035
/**
2136
* {@inheritdoc}
2237
*/

‎src/Renderer/Text/Context.php‎

Lines changed: 35 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -32,22 +32,14 @@ final class Context extends AbstractText
3232
SequenceMatcher::OP_REP => '!',
3333
];
3434

35-
/**
36-
* @var int the union of OPs that indicate there is a change
37-
*/
38-
const OP_BLOCK_CHANGED =
39-
SequenceMatcher::OP_INS |
40-
SequenceMatcher::OP_DEL |
41-
SequenceMatcher::OP_REP;
42-
4335
/**
4436
* {@inheritdoc}
4537
*/
4638
protected function renderWorker(Differ $differ): string
4739
{
4840
$ret = '';
4941

50-
foreach ($differ->getGroupedOpcodes() as $hunk) {
42+
foreach ($differ->getGroupedOpcodesGnu() as $hunk) {
5143
$lastBlockIdx = \count($hunk) - 1;
5244

5345
// note that these line number variables are 0-based
@@ -70,16 +62,16 @@ protected function renderWorker(Differ $differ): string
7062
/**
7163
* Render the hunk header.
7264
*
73-
* @param string $delimiter the delimiter
74-
* @param int $a1 the a1
75-
* @param int $a2 the a2
65+
* @param string $symbol the symbol
66+
* @param int $a1 the begin index
67+
* @param int $a2 the end index
7668
*/
77-
protected function renderHunkHeader(string $delimiter, int $a1, int $a2): string
69+
protected function renderHunkHeader(string $symbol, int $a1, int $a2): string
7870
{
7971
return
80-
"{$delimiter}{$delimiter}{$delimiter} " .
72+
"{$symbol}{$symbol}{$symbol} " .
8173
($a2 - $a1 >= 2 ? ($a1 + 1) . ',' . $a2 : $a2) .
82-
" {$delimiter}{$delimiter}{$delimiter}{$delimiter}\n";
74+
" {$symbol}{$symbol}{$symbol}{$symbol}\n";
8375
}
8476

8577
/**
@@ -98,11 +90,11 @@ protected function renderHunkOld(Differ $differ, array $hunk): string
9890
continue;
9991
}
10092

101-
if ($op & self::OP_BLOCK_CHANGED) {
93+
if ($op !== SequenceMatcher::OP_EQ) {
10294
$hasChangeInHunk = true;
10395
}
10496

105-
$ret .= $this->renderContext(self::TAG_MAP[$op], $differ->getOld($i1, $i2));
97+
$ret .= $this->renderContext(self::TAG_MAP[$op], $differ, self::OLD_AS_SOURCE, $i1, $i2);
10698
}
10799

108100
return $hasChangeInHunk ? $ret : '';
@@ -124,11 +116,11 @@ protected function renderHunkNew(Differ $differ, array $hunk): string
124116
continue;
125117
}
126118

127-
if ($op & self::OP_BLOCK_CHANGED) {
119+
if ($op !== SequenceMatcher::OP_EQ) {
128120
$hasChangeInHunk = true;
129121
}
130122

131-
$ret .= $this->renderContext(self::TAG_MAP[$op], $differ->getNew($j1, $j2));
123+
$ret .= $this->renderContext(self::TAG_MAP[$op], $differ, self::NEW_AS_SOURCE, $j1, $j2);
132124
}
133125

134126
return $hasChangeInHunk ? $ret : '';
@@ -137,13 +129,31 @@ protected function renderHunkNew(Differ $differ, array $hunk): string
137129
/**
138130
* Render the context array with the symbol.
139131
*
140-
* @param string $symbol the leading symbol
141-
* @param string[] $context the context
132+
* @param string $symbol the symbol
133+
* @param Differ $differ the differ
134+
* @param int $source the source type
135+
* @param int $a1 the begin index
136+
* @param int $a2 the end index
142137
*/
143-
protected function renderContext(string $symbol, array $context): string
138+
protected function renderContext(string $symbol, Differ $differ, int $source, int $a1, int $a2): string
144139
{
145-
return empty($context)
146-
? ''
147-
: "{$symbol} " . \implode("\n{$symbol} ", $context) . "\n";
140+
$context = $source === self::OLD_AS_SOURCE
141+
? $differ->getOld($a1, $a2)
142+
: $differ->getNew($a1, $a2);
143+
144+
if (empty($context)) {
145+
return '';
146+
}
147+
148+
$ret = "{$symbol} " . \implode("\n{$symbol} ", $context) . "\n";
149+
150+
if (
151+
($source === self::OLD_AS_SOURCE && $a2 === $differ->getOldNoEolAtEofIdx()) ||
152+
($source === self::NEW_AS_SOURCE && $a2 === $differ->getNewNoEolAtEofIdx())
153+
) {
154+
$ret .= self::GNU_OUTPUT_NO_EOL_AT_EOF . "\n";
155+
}
156+
157+
return $ret;
148158
}
149159
}

‎src/Renderer/Text/Unified.php‎

Lines changed: 34 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ protected function renderWorker(Differ $differ): string
2929
{
3030
$ret = '';
3131

32-
foreach ($differ->getGroupedOpcodes() as $hunk) {
32+
foreach ($differ->getGroupedOpcodesGnu() as $hunk) {
3333
$ret .= $this->renderHunkHeader($differ, $hunk);
3434
$ret .= $this->renderHunkBlocks($differ, $hunk);
3535
}
@@ -57,20 +57,18 @@ protected function renderHunkHeader(Differ $differ, array $hunk): string
5757
$newLinesCount = $j2 - $j1;
5858

5959
return
60-
'@@ ' .
61-
'-' .
60+
'@@' .
61+
' -' .
6262
// the line number in GNU diff is 1-based, so we add 1
6363
// a special case is when a hunk has only changed blocks,
6464
// i.e., context is set to 0, we do not need the adding
6565
($i1 === $i2 ? $i1 : $i1 + 1) .
6666
// if the line counts is 1, it can (and mostly) be omitted
6767
($oldLinesCount === 1 ? '' : ",{$oldLinesCount}") .
68-
' ' .
69-
'+' .
68+
' +' .
7069
($j1 === $j2 ? $j1 : $j1 + 1) .
7170
($newLinesCount === 1 ? '' : ",{$newLinesCount}") .
72-
' ' .
73-
"@@\n";
71+
" @@\n";
7472
}
7573

7674
/**
@@ -81,41 +79,59 @@ protected function renderHunkHeader(Differ $differ, array $hunk): string
8179
*/
8280
protected function renderHunkBlocks(Differ $differ, array $hunk): string
8381
{
84-
$html = '';
82+
$ret = '';
8583

8684
foreach ($hunk as [$op, $i1, $i2, $j1, $j2]) {
8785
// note that although we are in a OP_EQ situation,
8886
// the old and the new may not be exactly the same
8987
// because of ignoreCase, ignoreWhitespace, etc
9088
if ($op === SequenceMatcher::OP_EQ) {
9189
// we could only pick either the old or the new to show
92-
$html .= $this->renderContext(' ', $differ->getNew($j1, $j2));
90+
$ret .= $this->renderContext(' ', $differ, self::NEW_AS_SOURCE, $j1, $j2);
9391

9492
continue;
9593
}
9694

9795
if ($op & (SequenceMatcher::OP_REP | SequenceMatcher::OP_DEL)) {
98-
$html .= $this->renderContext('-', $differ->getOld($i1, $i2));
96+
$ret .= $this->renderContext('-', $differ, self::OLD_AS_SOURCE, $i1, $i2);
9997
}
10098

10199
if ($op & (SequenceMatcher::OP_REP | SequenceMatcher::OP_INS)) {
102-
$html .= $this->renderContext('+', $differ->getNew($j1, $j2));
100+
$ret .= $this->renderContext('+', $differ, self::NEW_AS_SOURCE, $j1, $j2);
103101
}
104102
}
105103

106-
return $html;
104+
return $ret;
107105
}
108106

109107
/**
110108
* Render the context array with the symbol.
111109
*
112-
* @param string $symbol the symbol
113-
* @param string[] $context the context
110+
* @param string $symbol the symbol
111+
* @param Differ $differ the differ
112+
* @param int $source the source type
113+
* @param int $a1 the begin index
114+
* @param int $a2 the end index
114115
*/
115-
protected function renderContext(string $symbol, array $context): string
116+
protected function renderContext(string $symbol, Differ $differ, int $source, int $a1, int $a2): string
116117
{
117-
return empty($context)
118-
? ''
119-
: $symbol . \implode("\n{$symbol}", $context) . "\n";
118+
$context = $source === self::OLD_AS_SOURCE
119+
? $differ->getOld($a1, $a2)
120+
: $differ->getNew($a1, $a2);
121+
122+
if (empty($context)) {
123+
return '';
124+
}
125+
126+
$ret = $symbol . \implode("\n{$symbol}", $context) . "\n";
127+
128+
if (
129+
($source === self::OLD_AS_SOURCE && $a2 === $differ->getOldNoEolAtEofIdx()) ||
130+
($source === self::NEW_AS_SOURCE && $a2 === $differ->getNewNoEolAtEofIdx())
131+
) {
132+
$ret .= self::GNU_OUTPUT_NO_EOL_AT_EOF . "\n";
133+
}
134+
135+
return $ret;
120136
}
121137
}

0 commit comments

Comments
 (0)