Skip to content

Commit 2f85968

Browse files
jfcherngjfcherng
committed
Tidy codes (Inline/SideBySide/Combined)
Signed-off-by: Jack Cherng <jfcherng@gmail.com>
1 parent e39d674 commit 2f85968

File tree

5 files changed

+167
-135
lines changed

5 files changed

+167
-135
lines changed

‎src/Renderer/AbstractRenderer.php‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
namespace Jfcherng\Diff\Renderer;
66

77
use Jfcherng\Diff\Differ;
8+
use Jfcherng\Diff\SequenceMatcher;
89
use Jfcherng\Diff\Utility\Language;
910

1011
/**
@@ -25,6 +26,16 @@ abstract class AbstractRenderer implements RendererInterface
2526
*/
2627
const IS_TEXT_RENDERER = true;
2728

29+
/**
30+
* @var string[] array of the opcodes and their corresponding symbols
31+
*/
32+
const SYMBOL_MAP = [
33+
SequenceMatcher::OP_DEL => '-',
34+
SequenceMatcher::OP_EQ => ' ',
35+
SequenceMatcher::OP_INS => '+',
36+
SequenceMatcher::OP_REP => '!',
37+
];
38+
2839
/**
2940
* @var Language the language translation object
3041
*/

‎src/Renderer/Html/Combined.php‎

Lines changed: 32 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -79,19 +79,19 @@ protected function renderTableSeparateBlock(): string
7979
*/
8080
protected function renderTableHunks(array $hunks): string
8181
{
82-
$html = '';
82+
$ret = '';
8383

8484
foreach ($hunks as $i => $hunk) {
8585
if ($i > 0 && $this->options['separateBlock']) {
86-
$html .= $this->renderTableSeparateBlock();
86+
$ret .= $this->renderTableSeparateBlock();
8787
}
8888

8989
foreach ($hunk as $block) {
90-
$html .= $this->renderTableBlock($block);
90+
$ret .= $this->renderTableBlock($block);
9191
}
9292
}
9393

94-
return $html;
94+
return $ret;
9595
}
9696

9797
/**
@@ -121,21 +121,18 @@ protected function renderTableBlock(array $block): string
121121
*/
122122
protected function renderTableBlockEqual(array $block): string
123123
{
124-
$html = '';
124+
$ret = '';
125125

126126
// note that although we are in a OP_EQ situation,
127127
// the old and the new may not be exactly the same
128128
// because of ignoreCase, ignoreWhitespace, etc
129129
foreach ($block['new']['lines'] as $newLine) {
130130
// we could only pick either the old or the new to show
131131
// here we pick the new one to let the user know what it is now
132-
$html .=
133-
'<tr data-type="=">' .
134-
'<td class="new">' . $newLine . '</td>' .
135-
'</tr>';
132+
$ret .= $this->renderTableRow('new', SequenceMatcher::OP_EQ, $newLine);
136133
}
137134

138-
return $html;
135+
return $ret;
139136
}
140137

141138
/**
@@ -145,16 +142,13 @@ protected function renderTableBlockEqual(array $block): string
145142
*/
146143
protected function renderTableBlockInsert(array $block): string
147144
{
148-
$html = '';
145+
$ret = '';
149146

150147
foreach ($block['new']['lines'] as $newLine) {
151-
$html .=
152-
'<tr data-type="+">' .
153-
'<td class="new">' . $newLine . '</td>' .
154-
'</tr>';
148+
$ret .= $this->renderTableRow('new', SequenceMatcher::OP_INS, $newLine);
155149
}
156150

157-
return $html;
151+
return $ret;
158152
}
159153

160154
/**
@@ -164,16 +158,13 @@ protected function renderTableBlockInsert(array $block): string
164158
*/
165159
protected function renderTableBlockDelete(array $block): string
166160
{
167-
$html = '';
161+
$ret = '';
168162

169163
foreach ($block['old']['lines'] as $oldLine) {
170-
$html .=
171-
'<tr data-type="-">' .
172-
'<td class="old">' . $oldLine . '</td>' .
173-
'</tr>';
164+
$ret .= $this->renderTableRow('old', SequenceMatcher::OP_DEL, $oldLine);
174165
}
175166

176-
return $html;
167+
return $ret;
177168
}
178169

179170
/**
@@ -187,7 +178,7 @@ protected function renderTableBlockReplace(array $block): string
187178
return $this->renderTableBlockDelete($block) . $this->renderTableBlockInsert($block);
188179
}
189180

190-
$html = '';
181+
$ret = '';
191182

192183
$oldLines = $block['old']['lines'];
193184
$newLines = $block['new']['lines'];
@@ -207,18 +198,30 @@ protected function renderTableBlockReplace(array $block): string
207198
$mergedLine = $this->mergeReplaceLines($oldLines[$no], $newLines[$no]);
208199

209200
if (!isset($mergedLine)) {
210-
$html .= $this->renderTableBlockDelete($block) . $this->renderTableBlockInsert($block);
201+
$ret .= $this->renderTableBlockDelete($block) . $this->renderTableBlockInsert($block);
211202

212203
continue;
213204
}
214205

215-
$html .=
216-
'<tr data-type="!">' .
217-
'<td class="rep">' . $mergedLine . '</td>' .
218-
'</tr>';
206+
$ret .= $this->renderTableRow('rep', SequenceMatcher::OP_REP, $mergedLine);
219207
}
220208

221-
return $html;
209+
return $ret;
210+
}
211+
212+
/**
213+
* Renderer a content row of the output table.
214+
*
215+
* @param string $tdClass the <td> class
216+
* @param int $op the operation
217+
* @param string $line the line
218+
*/
219+
protected function renderTableRow(string $tdClass, int $op, string $line): string
220+
{
221+
return
222+
'<tr data-type="' . self::SYMBOL_MAP[$op] . '">' .
223+
'<td class="' . $tdClass . '">' . $line . '</td>' .
224+
'</tr>';
222225
}
223226

224227
/**

‎src/Renderer/Html/Inline.php‎

Lines changed: 59 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -86,19 +86,19 @@ protected function renderTableSeparateBlock(): string
8686
*/
8787
protected function renderTableHunks(array $hunks): string
8888
{
89-
$html = '';
89+
$ret = '';
9090

9191
foreach ($hunks as $i => $hunk) {
9292
if ($i > 0 && $this->options['separateBlock']) {
93-
$html .= $this->renderTableSeparateBlock();
93+
$ret .= $this->renderTableSeparateBlock();
9494
}
9595

9696
foreach ($hunk as $block) {
97-
$html .= $this->renderTableBlock($block);
97+
$ret .= $this->renderTableBlock($block);
9898
}
9999
}
100100

101-
return $html;
101+
return $ret;
102102
}
103103

104104
/**
@@ -128,26 +128,24 @@ protected function renderTableBlock(array $block): string
128128
*/
129129
protected function renderTableBlockEqual(array $block): string
130130
{
131-
$html = '';
131+
$ret = '';
132132

133133
// note that although we are in a OP_EQ situation,
134134
// the old and the new may not be exactly the same
135135
// because of ignoreCase, ignoreWhitespace, etc
136136
foreach ($block['new']['lines'] as $no => $newLine) {
137137
// we could only pick either the old or the new to show
138138
// here we pick the new one to let the user know what it is now
139-
$oldLineNum = $block['old']['offset'] + $no + 1;
140-
$newLineNum = $block['new']['offset'] + $no + 1;
141-
142-
$html .=
143-
'<tr data-type="=">' .
144-
$this->renderLineNumberColumns($oldLineNum, $newLineNum) .
145-
'<th class="sign"></th>' .
146-
'<td class="new">' . $newLine . '</td>' .
147-
'</tr>';
139+
$ret .= $this->renderTableRow(
140+
'new',
141+
SequenceMatcher::OP_EQ,
142+
$newLine,
143+
$block['old']['offset'] + $no + 1,
144+
$block['new']['offset'] + $no + 1
145+
);
148146
}
149147

150-
return $html;
148+
return $ret;
151149
}
152150

153151
/**
@@ -157,20 +155,19 @@ protected function renderTableBlockEqual(array $block): string
157155
*/
158156
protected function renderTableBlockInsert(array $block): string
159157
{
160-
$html = '';
158+
$ret = '';
161159

162160
foreach ($block['new']['lines'] as $no => $newLine) {
163-
$newLineNum = $block['new']['offset'] + $no + 1;
164-
165-
$html .=
166-
'<tr data-type="+">' .
167-
$this->renderLineNumberColumns(null, $newLineNum) .
168-
'<th class="sign ins">+</th>' .
169-
'<td class="new">' . $newLine . '</td>' .
170-
'</tr>';
161+
$ret .= $this->renderTableRow(
162+
'new',
163+
SequenceMatcher::OP_INS,
164+
$newLine,
165+
null,
166+
$block['new']['offset'] + $no + 1
167+
);
171168
}
172169

173-
return $html;
170+
return $ret;
174171
}
175172

176173
/**
@@ -180,20 +177,19 @@ protected function renderTableBlockInsert(array $block): string
180177
*/
181178
protected function renderTableBlockDelete(array $block): string
182179
{
183-
$html = '';
180+
$ret = '';
184181

185182
foreach ($block['old']['lines'] as $no => $oldLine) {
186-
$oldLineNum = $block['old']['offset'] + $no + 1;
187-
188-
$html .=
189-
'<tr data-type="-">' .
190-
$this->renderLineNumberColumns($oldLineNum, null) .
191-
'<th class="sign del">-</th>' .
192-
'<td class="old">' . $oldLine . '</td>' .
193-
'</tr>';
183+
$ret .= $this->renderTableRow(
184+
'old',
185+
SequenceMatcher::OP_DEL,
186+
$oldLine,
187+
$block['old']['offset'] + $no + 1,
188+
null
189+
);
194190
}
195191

196-
return $html;
192+
return $ret;
197193
}
198194

199195
/**
@@ -206,6 +202,34 @@ protected function renderTableBlockReplace(array $block): string
206202
return $this->renderTableBlockDelete($block) . $this->renderTableBlockInsert($block);
207203
}
208204

205+
/**
206+
* Renderer a content row of the output table.
207+
*
208+
* @param string $tdClass the <td> class
209+
* @param int $op the operation
210+
* @param string $line the line
211+
* @param null|int $oldLineNum the old line number
212+
* @param null|int $newLineNum the new line number
213+
*/
214+
protected function renderTableRow(
215+
string $tdClass,
216+
int $op,
217+
string $line,
218+
?int $oldLineNum,
219+
?int $newLineNum
220+
): string {
221+
return
222+
'<tr data-type="' . self::SYMBOL_MAP[$op] . '">' .
223+
(
224+
$this->options['lineNumbers']
225+
? $this->renderLineNumberColumns($oldLineNum, $newLineNum)
226+
: ''
227+
) .
228+
'<th class="sign ' . self::TAG_CLASS_MAP[$op] . '">' . self::SYMBOL_MAP[$op] . '</th>' .
229+
'<td class="' . $tdClass . '">' . $line . '</td>' .
230+
'</tr>';
231+
}
232+
209233
/**
210234
* Renderer the line number columns.
211235
*
@@ -214,10 +238,6 @@ protected function renderTableBlockReplace(array $block): string
214238
*/
215239
protected function renderLineNumberColumns(?int $oldLineNum, ?int $newLineNum): string
216240
{
217-
if (!$this->options['lineNumbers']) {
218-
return '';
219-
}
220-
221241
return
222242
(
223243
isset($oldLineNum)

0 commit comments

Comments
 (0)