mirror of https://github.com/craftcms/cms.git
Brandon Kelly
5 years ago
9 changed files with 7537 additions and 88 deletions
-
2CHANGELOG-v3.6.md
-
2CHANGELOG.md
-
1composer.json
-
134composer.lock
-
178src/helpers/Diff.php
-
24src/helpers/ProjectConfig.php
-
3595tests/_data/diff/a.php
-
3595tests/_data/diff/b.php
-
94tests/unit/helpers/DiffHelperTest.php
@ -0,0 +1,178 @@ |
|||
<?php |
|||
/** |
|||
* @link https://craftcms.com/ |
|||
* @copyright Copyright (c) Pixel & Tonic, Inc. |
|||
* @license https://craftcms.github.io/license/ |
|||
*/ |
|||
|
|||
namespace craft\helpers; |
|||
|
|||
use Symfony\Component\Yaml\Yaml; |
|||
|
|||
/** |
|||
* Diff helper |
|||
* |
|||
* @author Pixel & Tonic, Inc. <support@pixelandtonic.com> |
|||
* @since 3.6.0 |
|||
*/ |
|||
class Diff |
|||
{ |
|||
/** |
|||
* Generates a diff for two values, represented as YAML. |
|||
* |
|||
* @param $from |
|||
* @param $to |
|||
* @param int $indent The indent size that nested values should have |
|||
* @param int $contextLines The number of lines to show before and after changes |
|||
* @return string |
|||
*/ |
|||
public static function diff($from, $to, int $indent = 2, int $contextLines = 3): string |
|||
{ |
|||
$diff = ''; |
|||
$lines = static::_diff($from, $to, $indent, 0); |
|||
$lastChange = null; |
|||
|
|||
foreach ($lines as $i => $line) { |
|||
if ($line[0] === null) { |
|||
continue; |
|||
} |
|||
|
|||
// Is this the first change we've seen?
|
|||
if ($contextLines > 0) { |
|||
if ($lastChange === null) { |
|||
for ($j = max($i - $contextLines, 0); $j < $i; $j++) { |
|||
$diff .= ' ' . $lines[$j][1] . "\n"; |
|||
} |
|||
} else if ($lastChange < $i - $contextLines * 2 + 2) { |
|||
// More than 2X the context size
|
|||
for ($j = $lastChange + 1; $j < $lastChange + $contextLines + 1; $j++) { |
|||
$diff .= ' ' . $lines[$j][1] . "\n"; |
|||
} |
|||
$diff .= "...\n"; |
|||
for ($j = $i - $contextLines; $j < $i; $j++) { |
|||
$diff .= ' ' . $lines[$j][1] . "\n"; |
|||
} |
|||
} else { |
|||
// Within two contexts so just show the whole chunk
|
|||
for ($j = $lastChange + 1; $j < $i; $j++) { |
|||
$diff .= ' ' . $lines[$j][1] . "\n"; |
|||
} |
|||
} |
|||
} |
|||
|
|||
$diff .= $lines[$i][0] . ' ' . $lines[$i][1] . "\n"; |
|||
$lastChange = $i; |
|||
} |
|||
|
|||
// Remaining context
|
|||
if ($lastChange !== null && $contextLines > 0) { |
|||
$max = min($lastChange + $contextLines, count($lines) - 1); |
|||
for ($i = $lastChange + 1; $i < $max; $i++) { |
|||
$diff .= ' ' . $lines[$i][1] . "\n"; |
|||
} |
|||
} |
|||
|
|||
return rtrim($diff); |
|||
} |
|||
|
|||
/** |
|||
* @param $from |
|||
* @param $to |
|||
* @param int $indent |
|||
* @param int $level |
|||
* @return array[] |
|||
*/ |
|||
private static function _diff($from, $to, int $indent, int $level): array |
|||
{ |
|||
// Are we done doing recursion?
|
|||
if ( |
|||
(!is_array($from) || !ArrayHelper::isAssociative($from)) || |
|||
(!is_array($to) || !ArrayHelper::isAssociative($to)) |
|||
) { |
|||
if (static::compare($from, $to)) { |
|||
return static::_buildLinesForValue($from, $indent, $level); |
|||
} else { |
|||
$lines = []; |
|||
ArrayHelper::append($lines, ...static::_buildLinesForValue($from, $indent, $level, '-')); |
|||
ArrayHelper::append($lines, ...static::_buildLinesForValue($to, $indent, $level, '+')); |
|||
return $lines; |
|||
} |
|||
} |
|||
|
|||
$lines = []; |
|||
$toKeys = array_keys($to); |
|||
$toCursor = 0; |
|||
|
|||
foreach ($from as $key => $value) { |
|||
// Do both arrays have this key?
|
|||
if (array_key_exists($key, $to)) { |
|||
$toPos = array_search($key, $toKeys); |
|||
|
|||
// Output any keys in $to that come before this one
|
|||
if ($toPos > $toCursor) { |
|||
$newKeys = array_slice($toKeys, $toCursor, $toPos - $toCursor); |
|||
static::_buildLinesForValue(ArrayHelper::filter($to, $newKeys), $indent, $level, '+'); |
|||
} |
|||
|
|||
$lines[] = static::_buildLine("$key:", $indent, $level); |
|||
ArrayHelper::append($lines, ...static::_diff($value, $to[$key], $indent, $level + 1)); |
|||
$toCursor = $toPos + 1; |
|||
} else { |
|||
ArrayHelper::append($lines, ...static::_buildLinesForValue([$key => $value], $indent, $level, '-')); |
|||
} |
|||
} |
|||
|
|||
// Output any remaining $to keys
|
|||
$newKeys = array_slice($toKeys, $toCursor); |
|||
if (!empty($newKeys)) { |
|||
ArrayHelper::append($lines, ...static::_buildLinesForValue(ArrayHelper::filter($to, $newKeys), $indent, $level, '+')); |
|||
} |
|||
|
|||
return $lines; |
|||
} |
|||
|
|||
private static function _buildLinesForValue($value, int $indent, int $level, ?string $char = null): array |
|||
{ |
|||
$lines = []; |
|||
$yamlLines = explode("\n", rtrim(Yaml::dump($value, 20 - $level, $indent))); |
|||
foreach ($yamlLines as $line) { |
|||
$lines[] = static::_buildLine($line, $indent, $level, $char); |
|||
} |
|||
return $lines; |
|||
} |
|||
|
|||
private static function _buildLine(string $line, int $indent, int $level, ?string $char = null): array |
|||
{ |
|||
return [$char, str_repeat(' ', $indent * $level) . $line]; |
|||
} |
|||
|
|||
/** |
|||
* Compares two arrays and returns whether they are identical. |
|||
* |
|||
* If the values are both arrays, they will be compared recursively. |
|||
* |
|||
* @param mixed $a |
|||
* @param mixed $b |
|||
* @param bool $strict Whether strict comparisons should be used |
|||
* @return bool |
|||
* @since 3.6.0 |
|||
*/ |
|||
public static function compare($a, $b, bool $strict = true): bool |
|||
{ |
|||
if (!is_array($a) || !is_array($b)) { |
|||
return $strict ? $a === $b : $a == $b; |
|||
} |
|||
|
|||
if (array_keys($a) !== array_keys($b)) { |
|||
return false; |
|||
} |
|||
|
|||
foreach ($a as $key => $value) { |
|||
if (!static::compare($value, $b[$key], $strict)) { |
|||
return false; |
|||
} |
|||
} |
|||
|
|||
return true; |
|||
} |
|||
} |
|||
3595
tests/_data/diff/a.php
File diff suppressed because it is too large
View File
File diff suppressed because it is too large
View File
3595
tests/_data/diff/b.php
File diff suppressed because it is too large
View File
File diff suppressed because it is too large
View File
@ -0,0 +1,94 @@ |
|||
<?php |
|||
/** |
|||
* @link https://craftcms.com/ |
|||
* @copyright Copyright (c) Pixel & Tonic, Inc. |
|||
* @license https://craftcms.github.io/license/ |
|||
*/ |
|||
|
|||
namespace crafttests\unit\helpers; |
|||
|
|||
use Codeception\Test\Unit; |
|||
use craft\helpers\Diff; |
|||
|
|||
/** |
|||
* Unit tests for the Diff Helper class. |
|||
* |
|||
* @author Pixel & Tonic, Inc. <support@pixelandtonic.com> |
|||
* @since 3.6.0 |
|||
*/ |
|||
class DiffHelperTest extends Unit |
|||
{ |
|||
/** |
|||
* @dataProvider compareDataProvider |
|||
* |
|||
* @param bool $expected |
|||
* @param mixed $a |
|||
* @param mixed $b |
|||
* @param bool $strict |
|||
*/ |
|||
public function testCompare(bool $expected, $a, $b, bool $strict) |
|||
{ |
|||
self::assertSame($expected, Diff::compare($a, $b, $strict)); |
|||
} |
|||
|
|||
/** |
|||
* @dataProvider diffDataProvider |
|||
* |
|||
* @param string $expected |
|||
* @param mixed $from |
|||
* @param mixed $to |
|||
* @param int $indent |
|||
* @param int $contextLines |
|||
*/ |
|||
public function testDiff(string $expected, $from, $to, int $indent = 2, int $contextLines = 3) |
|||
{ |
|||
self::assertSame($expected, Diff::diff($from, $to, $indent, $contextLines)); |
|||
} |
|||
|
|||
/** |
|||
* @return array |
|||
*/ |
|||
public function compareDataProvider(): array |
|||
{ |
|||
return [ |
|||
[true, 1, '1', false], |
|||
[false, 1, '1', true], |
|||
[true, ['foo' => ['bar' => 'baz']], ['foo' => ['bar' => 'baz']], true], |
|||
[false, ['foo' => ['bar' => 'baz']], ['foo' => ['bar' => 'qux']], true], |
|||
[false, ['foo' => true], ['foo' => true, 'bar' => true], true], |
|||
]; |
|||
} |
|||
|
|||
/** |
|||
* @return array |
|||
*/ |
|||
public function diffDataProvider(): array |
|||
{ |
|||
return [ |
|||
['', 'foo', 'foo'], |
|||
["- foo\n+ bar", 'foo', 'bar'], |
|||
[ |
|||
"- - foo\n- - bar\n- - baz\n+ - foo\n+ - bar\n+ - qux", |
|||
['foo', 'bar', 'baz'], |
|||
['foo', 'bar', 'qux'] |
|||
], |
|||
[ |
|||
" foo:\n- - bar\n- - baz\n+ - bar\n+ - qux", |
|||
['foo' => ['bar', 'baz']], |
|||
['foo' => ['bar', 'qux']] |
|||
], |
|||
[ |
|||
"- - bar\n- - baz\n+ - bar\n+ - qux", |
|||
['foo' => ['bar', 'baz']], |
|||
['foo' => ['bar', 'qux']], |
|||
4, |
|||
0 |
|||
], |
|||
[ |
|||
" dateModified:\n- 1607544575\n+ 1607544576\n email:\n fromEmail:", |
|||
include dirname(__DIR__, 2) . '/_data/diff/a.php', |
|||
include dirname(__DIR__, 2) . '/_data/diff/b.php' |
|||
] |
|||
]; |
|||
} |
|||
} |
|||
Write
Preview
Loading…
Cancel
Save
Reference in new issue