Skip to content

Commit b136ee3

Browse files
jfcherngjfcherng
committed
Release of new version 6.10.16
1 parent 297d6a9 commit b136ee3

36 files changed

+181
-233
lines changed

‎CHANGELOG/CHANGELOG_v6.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
## VERSION 6 UNIFIED
33

44
* Version **6.10** - feat: add methods to get diff statistics
5+
* 2024-03-08 02:00 **6.10.16** fix Differ::getStatistics()
6+
* 297d6a9 fix: Differ::getStatistics() not working when no difference
57
* 2024-03-05 17:05 **6.10.15** new differ option: fullContextIfIdentical
68
* 42dd214 chore: fix php-cs-fixer deprecated options
79
* 239c68f feat: add new differ option: fullContextIfIdentical (#79)

‎example/demo_base.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
// the two sample files for comparison
99
$oldFile = __DIR__ . '/old_file.txt';
1010
$newFile = __DIR__ . '/new_file.txt';
11-
$oldString = \file_get_contents($oldFile);
12-
$newString = \file_get_contents($newFile);
11+
$oldString = file_get_contents($oldFile);
12+
$newString = file_get_contents($newFile);
1313

1414
// options for Diff class
1515
$diffOptions = [

‎src/DiffHelper.php

+20-19
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public static function getProjectDirectory(): string
2323
{
2424
static $path;
2525

26-
return $path = $path ?? \realpath(__DIR__ . '/..');
26+
return $path = $path ?? realpath(__DIR__ . '/..');
2727
}
2828

2929
/**
@@ -37,31 +37,31 @@ public static function getRenderersInfo(): array
3737
return $info;
3838
}
3939

40-
$glob = \implode(\DIRECTORY_SEPARATOR, [
41-
static::getProjectDirectory(),
40+
$glob = implode(\DIRECTORY_SEPARATOR, [
41+
self::getProjectDirectory(),
4242
'src',
4343
'Renderer',
44-
'{' . \implode(',', RendererConstant::RENDERER_TYPES) . '}',
44+
'{' . implode(',', RendererConstant::RENDERER_TYPES) . '}',
4545
'*.php',
4646
]);
4747

48-
$fileNames = \array_map(
48+
$fileNames = array_map(
4949
// get basename without file extension
50-
function (string $file): string {
51-
return \pathinfo($file, \PATHINFO_FILENAME);
50+
static function (string $file): string {
51+
return pathinfo($file, \PATHINFO_FILENAME);
5252
},
5353
// paths of all Renderer files
54-
\glob($glob, \GLOB_BRACE)
54+
glob($glob, \GLOB_BRACE)
5555
);
5656

57-
$renderers = \array_filter(
57+
$renderers = array_filter(
5858
$fileNames,
5959
// only normal class files are wanted
60-
function (string $fileName): bool {
60+
static function (string $fileName): bool {
6161
return
62-
\substr($fileName, 0, 8) !== 'Abstract'
63-
&& \substr($fileName, -9) !== 'Interface'
64-
&& \substr($fileName, -5) !== 'Trait';
62+
substr($fileName, 0, 8) !== 'Abstract'
63+
&& substr($fileName, -9) !== 'Interface'
64+
&& substr($fileName, -5) !== 'Trait';
6565
}
6666
);
6767

@@ -80,7 +80,7 @@ function (string $fileName): bool {
8080
*/
8181
public static function getAvailableRenderers(): array
8282
{
83-
return \array_keys(self::getRenderersInfo());
83+
return array_keys(self::getRenderersInfo());
8484
}
8585

8686
/**
@@ -97,7 +97,7 @@ public static function getStyleSheet(): string
9797
return $fileContent;
9898
}
9999

100-
$filePath = static::getProjectDirectory() . '/example/diff-table.css';
100+
$filePath = self::getProjectDirectory() . '/example/diff-table.css';
101101

102102
$file = new \SplFileObject($filePath, 'r');
103103

@@ -133,16 +133,17 @@ public static function calculate(
133133
array $rendererOptions = []
134134
): string {
135135
// always convert into array form
136-
\is_string($old) && ($old = \explode("\n", $old));
137-
\is_string($new) && ($new = \explode("\n", $new));
136+
\is_string($old) && ($old = explode("\n", $old));
137+
\is_string($new) && ($new = explode("\n", $new));
138138

139139
return RendererFactory::getInstance($renderer)
140140
->setOptions($rendererOptions)
141141
->render(
142142
Differ::getInstance()
143143
->setOldNew($old, $new)
144144
->setOptions($differOptions)
145-
);
145+
)
146+
;
146147
}
147148

148149
/**
@@ -172,7 +173,7 @@ public static function calculateFiles(
172173
$oldFile = new \SplFileObject($old, 'r');
173174
$newFile = new \SplFileObject($new, 'r');
174175

175-
return static::calculate(
176+
return self::calculate(
176177
// fread() requires the length > 0 hence we plus 1 for empty files
177178
$oldFile->fread($oldFile->getSize() + 1),
178179
$newFile->fread($newFile->getSize() + 1),

‎src/Differ.php

+9-7
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ public function setNew(array $new): self
185185
*/
186186
public function setOptions(array $options): self
187187
{
188-
$mergedOptions = $options + static::$defaultOptions;
188+
$mergedOptions = $options + self::$defaultOptions;
189189

190190
if ($this->options !== $mergedOptions) {
191191
$this->options = $mergedOptions;
@@ -268,7 +268,7 @@ public static function getInstance(): self
268268
{
269269
static $singleton;
270270

271-
return $singleton = $singleton ?? new static([], []);
271+
return $singleton = $singleton ?? new self([], []);
272272
}
273273

274274
/**
@@ -334,7 +334,8 @@ public function getGroupedOpcodes(): array
334334
} else {
335335
$opcodes = $this->sequenceMatcher
336336
->setSequences($old, $new)
337-
->getGroupedOpcodes($this->options['context']);
337+
->getGroupedOpcodes($this->options['context'])
338+
;
338339
}
339340

340341
$this->getGroupedOpcodesPost($opcodes);
@@ -369,7 +370,8 @@ public function getGroupedOpcodesGnu(): array
369370
} else {
370371
$opcodes = $this->sequenceMatcher
371372
->setSequences($old, $new)
372-
->getGroupedOpcodes($this->options['context']);
373+
->getGroupedOpcodes($this->options['context'])
374+
;
373375
}
374376

375377
$this->getGroupedOpcodesGnuPost($opcodes);
@@ -394,10 +396,10 @@ private function getGroupedOpcodesPre(array &$old, array &$new): void
394396
];
395397

396398
$this->oldSrcLength = \count($old);
397-
\array_push($old, ...$eolAtEofHelperLines);
399+
array_push($old, ...$eolAtEofHelperLines);
398400

399401
$this->newSrcLength = \count($new);
400-
\array_push($new, ...$eolAtEofHelperLines);
402+
array_push($new, ...$eolAtEofHelperLines);
401403
}
402404

403405
/**
@@ -517,7 +519,7 @@ private function finalize(): self
517519
*/
518520
private function resetCachedResults(): self
519521
{
520-
foreach (static::CACHED_PROPERTIES as $property => $value) {
522+
foreach (self::CACHED_PROPERTIES as $property => $value) {
521523
$this->{$property} = $value;
522524
}
523525

‎src/Exception/FileNotFoundException.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
final class FileNotFoundException extends \Exception
88
{
9-
public function __construct(string $filepath = '', int $code = 0, \Throwable $previous = null)
9+
public function __construct(string $filepath = '', int $code = 0, ?\Throwable $previous = null)
1010
{
1111
parent::__construct("File not found: {$filepath}", $code, $previous);
1212
}

‎src/Exception/UnsupportedFunctionException.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
final class UnsupportedFunctionException extends \Exception
88
{
9-
public function __construct(string $funcName = '', int $code = 0, \Throwable $previous = null)
9+
public function __construct(string $funcName = '', int $code = 0, ?\Throwable $previous = null)
1010
{
1111
parent::__construct("Unsupported function: {$funcName}", $code, $previous);
1212
}

‎src/Factory/LineRendererFactory.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,9 @@ public static function getInstance(string $type, ...$ctorArgs): AbstractLineRend
4848
*/
4949
public static function make(string $type, ...$ctorArgs): AbstractLineRenderer
5050
{
51-
$className = RendererConstant::RENDERER_NAMESPACE . '\\Html\\LineRenderer\\' . \ucfirst($type);
51+
$className = RendererConstant::RENDERER_NAMESPACE . '\\Html\\LineRenderer\\' . ucfirst($type);
5252

53-
if (!\class_exists($className)) {
53+
if (!class_exists($className)) {
5454
throw new \InvalidArgumentException("LineRenderer not found: {$type}");
5555
}
5656

‎src/Factory/RendererFactory.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ public static function resolveRenderer(string $renderer): ?string
7373
foreach (RendererConstant::RENDERER_TYPES as $type) {
7474
$className = RendererConstant::RENDERER_NAMESPACE . "\\{$type}\\{$renderer}";
7575

76-
if (\class_exists($className)) {
76+
if (class_exists($className)) {
7777
return $cache[$renderer] = $className;
7878
}
7979
}

‎src/Renderer/AbstractRenderer.php

+2-9
Original file line numberDiff line numberDiff line change
@@ -152,8 +152,6 @@ public function getOptions(): array
152152
}
153153

154154
/**
155-
* {@inheritdoc}
156-
*
157155
* @final
158156
*
159157
* @todo mark this method with "final" in the next major release
@@ -176,21 +174,16 @@ public function getResultForIdenticals(): string
176174
*/
177175
abstract public function getResultForIdenticalsDefault(): string;
178176

179-
/**
180-
* {@inheritdoc}
181-
*/
182177
final public function render(Differ $differ): string
183178
{
184179
$this->changesAreRaw = true;
180+
185181
// the "no difference" situation may happen frequently
186182
return $differ->getOldNewComparison() === 0 && !$differ->options['fullContextIfIdentical']
187183
? $this->getResultForIdenticals()
188184
: $this->renderWorker($differ);
189185
}
190186

191-
/**
192-
* {@inheritdoc}
193-
*/
194187
final public function renderArray(array $differArray): string
195188
{
196189
$this->changesAreRaw = false;
@@ -241,6 +234,6 @@ protected function _(string $text, bool $escapeHtml = true): string
241234
{
242235
$text = $this->t->translate($text);
243236

244-
return $escapeHtml ? \htmlspecialchars($text) : $text;
237+
return $escapeHtml ? htmlspecialchars($text) : $text;
245238
}
246239
}

‎src/Renderer/Html/AbstractHtml.php

+12-21
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,6 @@ abstract class AbstractHtml extends AbstractRenderer
4444
*/
4545
public const AUTO_FORMAT_CHANGES = true;
4646

47-
/**
48-
* {@inheritdoc}
49-
*/
5047
public function getResultForIdenticalsDefault(): string
5148
{
5249
return '';
@@ -105,19 +102,13 @@ public function getChanges(Differ $differ): array
105102
return $changes;
106103
}
107104

108-
/**
109-
* {@inheritdoc}
110-
*/
111105
protected function renderWorker(Differ $differ): string
112106
{
113107
$rendered = $this->redererChanges($this->getChanges($differ));
114108

115109
return $this->cleanUpDummyHtmlClosures($rendered);
116110
}
117111

118-
/**
119-
* {@inheritdoc}
120-
*/
121112
protected function renderArrayWorker(array $differArray): string
122113
{
123114
$this->ensureChangesUseIntTag($differArray);
@@ -199,7 +190,7 @@ final protected function formatChanges(array &$changes): void
199190

200191
/** @phan-suppress-next-line PhanTypeInvalidLeftOperandOfBitwiseOp */
201192
if ($block['tag'] & (SequenceMatcher::OP_REP | SequenceMatcher::OP_DEL)) {
202-
$block['old']['lines'] = \str_replace(
193+
$block['old']['lines'] = str_replace(
203194
RendererConstant::HTML_CLOSURES,
204195
RendererConstant::HTML_CLOSURES_DEL,
205196
$block['old']['lines']
@@ -208,7 +199,7 @@ final protected function formatChanges(array &$changes): void
208199

209200
/** @phan-suppress-next-line PhanTypeInvalidLeftOperandOfBitwiseOp */
210201
if ($block['tag'] & (SequenceMatcher::OP_REP | SequenceMatcher::OP_INS)) {
211-
$block['new']['lines'] = \str_replace(
202+
$block['new']['lines'] = str_replace(
212203
RendererConstant::HTML_CLOSURES,
213204
RendererConstant::HTML_CLOSURES_INS,
214205
$block['new']['lines']
@@ -232,10 +223,10 @@ protected function formatLines(array $lines): array
232223
* we can glue lines into a string and call functions for one time.
233224
* After that, we split the string back into lines.
234225
*/
235-
return \explode(
226+
return explode(
236227
RendererConstant::IMPLODE_DELIMITER,
237228
$this->formatStringFromLines(
238-
\implode(
229+
implode(
239230
RendererConstant::IMPLODE_DELIMITER,
240231
$lines
241232
)
@@ -288,16 +279,16 @@ protected function expandTabs(string $string, int $tabSize = 4, bool $onlyLeadin
288279
}
289280

290281
if ($onlyLeadingTabs) {
291-
return \preg_replace_callback(
282+
return preg_replace_callback(
292283
"/^[ \t]{1,}/mS", // tabs and spaces may be mixed
293-
function (array $matches) use ($tabSize): string {
294-
return \str_replace("\t", \str_repeat(' ', $tabSize), $matches[0]);
284+
static function (array $matches) use ($tabSize): string {
285+
return str_replace("\t", str_repeat(' ', $tabSize), $matches[0]);
295286
},
296287
$string
297288
);
298289
}
299290

300-
return \str_replace("\t", \str_repeat(' ', $tabSize), $string);
291+
return str_replace("\t", str_repeat(' ', $tabSize), $string);
301292
}
302293

303294
/**
@@ -309,7 +300,7 @@ function (array $matches) use ($tabSize): string {
309300
*/
310301
protected function htmlSafe(string $string): string
311302
{
312-
return \htmlspecialchars($string, \ENT_NOQUOTES, 'UTF-8');
303+
return htmlspecialchars($string, \ENT_NOQUOTES, 'UTF-8');
313304
}
314305

315306
/**
@@ -321,7 +312,7 @@ protected function htmlSafe(string $string): string
321312
*/
322313
protected function htmlFixSpaces(string $string): string
323314
{
324-
return \str_replace(' ', ' ', $string);
315+
return str_replace(' ', ' ', $string);
325316
}
326317

327318
/**
@@ -333,7 +324,7 @@ protected function htmlFixSpaces(string $string): string
333324
*/
334325
protected function htmlReplaceSpacesToHtmlTag(string $string): string
335326
{
336-
return \strtr($string, [
327+
return strtr($string, [
337328
' ' => '<span class="ch sp"> </span>',
338329
"\t" => "<span class=\"ch tab\">\t</span>",
339330
]);
@@ -367,7 +358,7 @@ protected function ensureChangesUseIntTag(array &$changes): void
367358
*/
368359
protected function cleanUpDummyHtmlClosures(string $string): string
369360
{
370-
return \str_replace(
361+
return str_replace(
371362
[
372363
RendererConstant::HTML_CLOSURES_DEL[0] . RendererConstant::HTML_CLOSURES_DEL[1],
373364
RendererConstant::HTML_CLOSURES_INS[0] . RendererConstant::HTML_CLOSURES_INS[1],

0 commit comments

Comments
 (0)