From b2477b30be5624e11ddae1ee9faa523d814d1f0b Mon Sep 17 00:00:00 2001 From: catch <catch@35733.no-reply.drupal.org> Date: Fri, 1 Mar 2024 10:39:46 +0000 Subject: [PATCH] Issue #3424436 by mondrake, longwave: [11.x] Remove deprecated code from the Diff component --- core/lib/Drupal/Component/Diff/Diff.php | 157 ------ .../Component/Diff/Engine/DiffEngine.php | 466 ------------------ .../Drupal/Component/Diff/Engine/DiffOp.php | 34 -- .../Component/Diff/Engine/DiffOpAdd.php | 11 - .../Component/Diff/Engine/DiffOpChange.php | 11 - .../Component/Diff/Engine/DiffOpCopy.php | 11 - .../Component/Diff/Engine/DiffOpDelete.php | 11 - core/lib/Drupal/Component/Diff/composer.json | 2 +- core/phpstan-baseline.neon | 73 --- .../Component/Diff/Engine/DiffEngineTest.php | 132 ----- .../Component/Diff/Engine/DiffOpTest.php | 41 -- 11 files changed, 1 insertion(+), 948 deletions(-) delete mode 100644 core/lib/Drupal/Component/Diff/Engine/DiffEngine.php delete mode 100644 core/tests/Drupal/Tests/Component/Diff/Engine/DiffEngineTest.php delete mode 100644 core/tests/Drupal/Tests/Component/Diff/Engine/DiffOpTest.php diff --git a/core/lib/Drupal/Component/Diff/Diff.php b/core/lib/Drupal/Component/Diff/Diff.php index 1b5c40a70514..631e3b32883a 100644 --- a/core/lib/Drupal/Component/Diff/Diff.php +++ b/core/lib/Drupal/Component/Diff/Diff.php @@ -37,163 +37,6 @@ public function __construct($from_lines, $to_lines) { $this->edits = $diffOpBuilder->toOpsArray($differ->diffToArray($from_lines, $to_lines)); } - /** - * Compute reversed Diff. - * - * SYNOPSIS: - * - * $diff = new Diff($lines1, $lines2); - * $rev = $diff->reverse(); - * @return object - * A Diff object representing the inverse of the original diff. - * - * @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no - * replacement. - * - * @see https://www.drupal.org/node/3337942 - */ - public function reverse() { - @trigger_error(__METHOD__ . '() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no replacement. See https://www.drupal.org/node/3337942', E_USER_DEPRECATED); - $rev = $this; - $rev->edits = []; - foreach ($this->edits as $edit) { - $rev->edits[] = $edit->reverse(); - } - return $rev; - } - - /** - * Check for empty diff. - * - * @return bool True iff two sequences were identical. - * - * @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no - * replacement. - * - * @see https://www.drupal.org/node/3337942 - */ - public function isEmpty() { - @trigger_error(__METHOD__ . '() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no replacement. See https://www.drupal.org/node/3337942', E_USER_DEPRECATED); - foreach ($this->edits as $edit) { - if ($edit->type != 'copy') { - return FALSE; - } - } - return TRUE; - } - - /** - * Compute the length of the Longest Common Subsequence (LCS). - * - * This is mostly for diagnostic purposed. - * - * @return int The length of the LCS. - * - * @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no - * replacement. - * - * @see https://www.drupal.org/node/3337942 - */ - public function lcs() { - @trigger_error(__METHOD__ . '() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no replacement. See https://www.drupal.org/node/3337942', E_USER_DEPRECATED); - $lcs = 0; - foreach ($this->edits as $edit) { - if ($edit->type == 'copy') { - $lcs += sizeof($edit->orig); - } - } - return $lcs; - } - - /** - * Gets the original set of lines. - * - * This reconstructs the $from_lines parameter passed to the - * constructor. - * - * @return array The original sequence of strings. - * - * @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no - * replacement. - * - * @see https://www.drupal.org/node/3337942 - */ - public function orig() { - @trigger_error(__METHOD__ . '() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no replacement. See https://www.drupal.org/node/3337942', E_USER_DEPRECATED); - $lines = []; - - foreach ($this->edits as $edit) { - if ($edit->orig) { - array_splice($lines, sizeof($lines), 0, $edit->orig); - } - } - return $lines; - } - - /** - * Gets the closing set of lines. - * - * This reconstructs the $to_lines parameter passed to the - * constructor. - * - * @return array The sequence of strings. - * - * @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no - * replacement. - * - * @see https://www.drupal.org/node/3337942 - */ - public function closing() { - @trigger_error(__METHOD__ . '() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no replacement. See https://www.drupal.org/node/3337942', E_USER_DEPRECATED); - $lines = []; - - foreach ($this->edits as $edit) { - if ($edit->closing) { - array_splice($lines, sizeof($lines), 0, $edit->closing); - } - } - return $lines; - } - - /** - * Check a Diff for validity. - * - * This is here only for debugging purposes. - * - * @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no - * replacement. - * - * @see https://www.drupal.org/node/3337942 - */ - public function check($from_lines, $to_lines) { - @trigger_error(__METHOD__ . '() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no replacement. See https://www.drupal.org/node/3337942', E_USER_DEPRECATED); - if (serialize($from_lines) != serialize($this->orig())) { - trigger_error("Reconstructed original doesn't match", E_USER_ERROR); - } - if (serialize($to_lines) != serialize($this->closing())) { - trigger_error("Reconstructed closing doesn't match", E_USER_ERROR); - } - - $rev = $this->reverse(); - if (serialize($to_lines) != serialize($rev->orig())) { - trigger_error("Reversed original doesn't match", E_USER_ERROR); - } - if (serialize($from_lines) != serialize($rev->closing())) { - trigger_error("Reversed closing doesn't match", E_USER_ERROR); - } - - $prevtype = 'none'; - foreach ($this->edits as $edit) { - if ( $prevtype == $edit->type ) { - trigger_error("Edit sequence is non-optimal", E_USER_ERROR); - } - $prevtype = $edit->type; - } - - $lcs = $this->lcs(); - trigger_error('Diff okay: LCS = ' . $lcs, E_USER_NOTICE); - } - /** * Gets the list of differences as an array of diff operations. * diff --git a/core/lib/Drupal/Component/Diff/Engine/DiffEngine.php b/core/lib/Drupal/Component/Diff/Engine/DiffEngine.php deleted file mode 100644 index 1289f96ebaf1..000000000000 --- a/core/lib/Drupal/Component/Diff/Engine/DiffEngine.php +++ /dev/null @@ -1,466 +0,0 @@ -<?php - -namespace Drupal\Component\Diff\Engine; - -/** - * Class used internally by Diff to actually compute the diffs. - * - * The algorithm used here is mostly lifted from the perl module - * Algorithm::Diff (version 1.06) by Ned Konz, which is available at: - * http://www.perl.com/CPAN/authors/id/N/NE/NEDKONZ/Algorithm-Diff-1.06.zip - * - * More ideas are taken from: - * http://www.ics.uci.edu/~eppstein/161/960229.html - * - * Some ideas (and a bit of code) are from analyze.c, from GNU - * diffutils-2.7, which can be found at: - * ftp://gnudist.gnu.org/pub/gnu/diffutils/diffutils-2.7.tar.gz - * - * closingly, some ideas (subdivision by NCHUNKS > 2, and some optimizations) - * are my own. - * - * Line length limits for robustness added by Tim Starling, 2005-08-31 - * - * @author Geoffrey T. Dairiki, Tim Starling - * @private - * @subpackage DifferenceEngine - * - * @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use - * sebastianbergmann/diff instead. - * - * @see https://www.drupal.org/node/3337942 - */ -#[\AllowDynamicProperties] -class DiffEngine { - - const USE_ASSERTS = FALSE; - - const MAX_XREF_LENGTH = 10000; - - public function __construct() { - @trigger_error('Drupal\Component\Diff\Engine\DiffEngine is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use sebastianbergmann/diff instead. See https://www.drupal.org/node/3337942', E_USER_DEPRECATED); - } - - public function diff($from_lines, $to_lines) { - - $n_from = sizeof($from_lines); - $n_to = sizeof($to_lines); - - $this->xchanged = $this->ychanged = []; - $this->xv = $this->yv = []; - $this->xind = $this->yind = []; - unset($this->seq); - unset($this->in_seq); - unset($this->lcs); - - // Skip leading common lines. - for ($skip = 0; $skip < $n_from && $skip < $n_to; $skip++) { - if ($from_lines[$skip] !== $to_lines[$skip]) { - break; - } - $this->xchanged[$skip] = $this->ychanged[$skip] = FALSE; - } - // Skip trailing common lines. - $xi = $n_from; - $yi = $n_to; - for ($endskip = 0; --$xi > $skip && --$yi > $skip; $endskip++) { - if ($from_lines[$xi] !== $to_lines[$yi]) { - break; - } - $this->xchanged[$xi] = $this->ychanged[$yi] = FALSE; - } - - // Ignore lines which do not exist in both files. - for ($xi = $skip; $xi < $n_from - $endskip; $xi++) { - $xhash[$this->_line_hash($from_lines[$xi])] = 1; - } - - for ($yi = $skip; $yi < $n_to - $endskip; $yi++) { - $line = $to_lines[$yi]; - if ($this->ychanged[$yi] = empty($xhash[$this->_line_hash($line)])) { - continue; - } - $yhash[$this->_line_hash($line)] = 1; - $this->yv[] = $line; - $this->yind[] = $yi; - } - for ($xi = $skip; $xi < $n_from - $endskip; $xi++) { - $line = $from_lines[$xi]; - if ($this->xchanged[$xi] = empty($yhash[$this->_line_hash($line)])) { - continue; - } - $this->xv[] = $line; - $this->xind[] = $xi; - } - - // Find the LCS. - $this->_compareseq(0, sizeof($this->xv), 0, sizeof($this->yv)); - - // Merge edits when possible - $this->_shift_boundaries($from_lines, $this->xchanged, $this->ychanged); - $this->_shift_boundaries($to_lines, $this->ychanged, $this->xchanged); - - // Compute the edit operations. - $edits = []; - $xi = $yi = 0; - while ($xi < $n_from || $yi < $n_to) { - $this::USE_ASSERTS && assert($yi < $n_to || $this->xchanged[$xi]); - $this::USE_ASSERTS && assert($xi < $n_from || $this->ychanged[$yi]); - - // Skip matching "snake". - $copy = []; - while ( $xi < $n_from && $yi < $n_to && !$this->xchanged[$xi] && !$this->ychanged[$yi]) { - $copy[] = $from_lines[$xi++]; - ++$yi; - } - if ($copy) { - $edits[] = new DiffOpCopy($copy); - } - // Find deletes & adds. - $delete = []; - while ($xi < $n_from && $this->xchanged[$xi]) { - $delete[] = $from_lines[$xi++]; - } - $add = []; - while ($yi < $n_to && $this->ychanged[$yi]) { - $add[] = $to_lines[$yi++]; - } - if ($delete && $add) { - $edits[] = new DiffOpChange($delete, $add); - } - elseif ($delete) { - $edits[] = new DiffOpDelete($delete); - } - elseif ($add) { - $edits[] = new DiffOpAdd($add); - } - } - return $edits; - } - - /** - * Returns the whole line if it's small enough, or a hash otherwise. - */ - protected function _line_hash($line) { - if (mb_strlen($line) > $this::MAX_XREF_LENGTH) { - return hash('crc32b', $line); - } - else { - return $line; - } - } - - - /** - * Divide the Largest Common Subsequence (LCS) of the sequences - * [XOFF, XLIM) and [YOFF, YLIM) into NCHUNKS approximately equally - * sized segments. - * - * Returns (LCS, PTS). LCS is the length of the LCS. PTS is an - * array of NCHUNKS+1 (X, Y) indexes giving the diving points between - * sub sequences. The first sub-sequence is contained in [X0, X1), - * [Y0, Y1), the second in [X1, X2), [Y1, Y2) and so on. Note - * that (X0, Y0) == (XOFF, YOFF) and - * (X[NCHUNKS], Y[NCHUNKS]) == (XLIM, YLIM). - * - * This function assumes that the first lines of the specified portions - * of the two files do not match, and likewise that the last lines do not - * match. The caller must trim matching lines from the beginning and end - * of the portions it is going to specify. - */ - protected function _diag($xoff, $xlim, $yoff, $ylim, $nchunks) { - $flip = FALSE; - - if ($xlim - $xoff > $ylim - $yoff) { - // Things seems faster (I'm not sure I understand why) - // when the shortest sequence in X. - $flip = TRUE; - [$xoff, $xlim, $yoff, $ylim] = [$yoff, $ylim, $xoff, $xlim]; - } - - if ($flip) { - for ($i = $ylim - 1; $i >= $yoff; $i--) { - $ymatches[$this->xv[$i]][] = $i; - } - } - else { - for ($i = $ylim - 1; $i >= $yoff; $i--) { - $ymatches[$this->yv[$i]][] = $i; - } - } - $this->lcs = 0; - $this->seq[0] = $yoff - 1; - $this->in_seq = []; - $ymids[0] = []; - - $numer = $xlim - $xoff + $nchunks - 1; - $x = $xoff; - for ($chunk = 0; $chunk < $nchunks; $chunk++) { - if ($chunk > 0) { - for ($i = 0; $i <= $this->lcs; $i++) { - $ymids[$i][$chunk - 1] = $this->seq[$i]; - } - } - - $x1 = $xoff + (int)(($numer + ($xlim - $xoff) * $chunk) / $nchunks); - for (; $x < $x1; $x++) { - $line = $flip ? $this->yv[$x] : $this->xv[$x]; - if (empty($ymatches[$line])) { - continue; - } - $matches = $ymatches[$line]; - $found_empty = FALSE; - foreach ($matches as $y) { - if (!$found_empty) { - if (empty($this->in_seq[$y])) { - $k = $this->_lcs_pos($y); - $this::USE_ASSERTS && assert($k > 0); - $ymids[$k] = $ymids[$k - 1]; - $found_empty = TRUE; - } - } - else { - if ($y > $this->seq[$k - 1]) { - $this::USE_ASSERTS && assert($y < $this->seq[$k]); - // Optimization: this is a common case: - // next match is just replacing previous match. - $this->in_seq[$this->seq[$k]] = FALSE; - $this->seq[$k] = $y; - $this->in_seq[$y] = 1; - } - elseif (empty($this->in_seq[$y])) { - $k = $this->_lcs_pos($y); - $this::USE_ASSERTS && assert($k > 0); - $ymids[$k] = $ymids[$k - 1]; - } - } - } - } - } - - $seps[] = $flip ? [$yoff, $xoff] : [$xoff, $yoff]; - $ymid = $ymids[$this->lcs]; - for ($n = 0; $n < $nchunks - 1; $n++) { - $x1 = $xoff + (int)(($numer + ($xlim - $xoff) * $n) / $nchunks); - $y1 = $ymid[$n] + 1; - $seps[] = $flip ? [$y1, $x1] : [$x1, $y1]; - } - $seps[] = $flip ? [$ylim, $xlim] : [$xlim, $ylim]; - - return [$this->lcs, $seps]; - } - - protected function _lcs_pos($ypos) { - - $end = $this->lcs; - if ($end == 0 || $ypos > $this->seq[$end]) { - $this->seq[++$this->lcs] = $ypos; - $this->in_seq[$ypos] = 1; - return $this->lcs; - } - - $beg = 1; - while ($beg < $end) { - $mid = (int)(($beg + $end) / 2); - if ($ypos > $this->seq[$mid]) { - $beg = $mid + 1; - } - else { - $end = $mid; - } - } - - $this::USE_ASSERTS && assert($ypos != $this->seq[$end]); - - $this->in_seq[$this->seq[$end]] = FALSE; - $this->seq[$end] = $ypos; - $this->in_seq[$ypos] = 1; - return $end; - } - - /** - * Find LCS of two sequences. - * - * The results are recorded in the vectors $this->{x,y}changed[], by - * storing a 1 in the element for each line that is an insertion - * or deletion (ie. is not in the LCS). - * - * The subsequence of file 0 is [XOFF, XLIM) and likewise for file 1. - * - * Note that XLIM, YLIM are exclusive bounds. - * All line numbers are origin-0 and discarded lines are not counted. - */ - protected function _compareseq($xoff, $xlim, $yoff, $ylim) { - - // Slide down the bottom initial diagonal. - while ($xoff < $xlim && $yoff < $ylim && $this->xv[$xoff] == $this->yv[$yoff]) { - ++$xoff; - ++$yoff; - } - - // Slide up the top initial diagonal. - while ($xlim > $xoff && $ylim > $yoff && $this->xv[$xlim - 1] == $this->yv[$ylim - 1]) { - --$xlim; - --$ylim; - } - - if ($xoff == $xlim || $yoff == $ylim) { - $lcs = 0; - } - else { - // This is ad hoc but seems to work well. - //$nchunks = sqrt(min($xlim - $xoff, $ylim - $yoff) / 2.5); - //$nchunks = max(2, min(8, (int)$nchunks)); - $nchunks = min(7, $xlim - $xoff, $ylim - $yoff) + 1; - [$lcs, $seps] = $this->_diag($xoff, $xlim, $yoff, $ylim, $nchunks); - } - - if ($lcs == 0) { - // X and Y sequences have no common subsequence: - // mark all changed. - while ($yoff < $ylim) { - $this->ychanged[$this->yind[$yoff++]] = 1; - } - while ($xoff < $xlim) { - $this->xchanged[$this->xind[$xoff++]] = 1; - } - } - else { - // Use the partitions to split this problem into subproblems. - reset($seps); - $pt1 = $seps[0]; - while ($pt2 = next($seps)) { - $this->_compareseq ($pt1[0], $pt2[0], $pt1[1], $pt2[1]); - $pt1 = $pt2; - } - } - } - - /** - * Adjust inserts/deletes of identical lines to join changes - * as much as possible. - * - * We do something when a run of changed lines include a - * line at one end and has an excluded, identical line at the other. - * We are free to choose which identical line is included. - * `compareseq' usually chooses the one at the beginning, - * but usually it is cleaner to consider the following identical line - * to be the "change". - * - * This is extracted verbatim from analyze.c (GNU diffutils-2.7). - */ - protected function _shift_boundaries($lines, &$changed, $other_changed) { - $i = 0; - $j = 0; - - $this::USE_ASSERTS && assert(sizeof($lines) == sizeof($changed)); - $len = sizeof($lines); - $other_len = sizeof($other_changed); - - while (1) { - /* - * Scan forwards to find beginning of another run of changes. - * Also keep track of the corresponding point in the other file. - * - * Throughout this code, $i and $j are adjusted together so that - * the first $i elements of $changed and the first $j elements - * of $other_changed both contain the same number of zeros - * (unchanged lines). - * Furthermore, $j is always kept so that $j == $other_len or - * $other_changed[$j] == FALSE. - */ - while ($j < $other_len && $other_changed[$j]) { - $j++; - } - while ($i < $len && !$changed[$i]) { - $this::USE_ASSERTS && assert($j < $other_len && ! $other_changed[$j]); - $i++; - $j++; - while ($j < $other_len && $other_changed[$j]) { - $j++; - } - } - - if ($i == $len) { - break; - } - $start = $i; - - // Find the end of this run of changes. - while (++$i < $len && $changed[$i]) { - continue; - } - - do { - /* - * Record the length of this run of changes, so that - * we can later determine whether the run has grown. - */ - $runlength = $i - $start; - - /* - * Move the changed region back, so long as the - * previous unchanged line matches the last changed one. - * This merges with previous changed regions. - */ - while ($start > 0 && $lines[$start - 1] == $lines[$i - 1]) { - $changed[--$start] = 1; - $changed[--$i] = FALSE; - while ($start > 0 && $changed[$start - 1]) { - $start--; - } - $this::USE_ASSERTS && assert($j > 0); - while ($other_changed[--$j]) { - continue; - } - $this::USE_ASSERTS && assert($j >= 0 && !$other_changed[$j]); - } - - /* - * Set CORRESPONDING to the end of the changed run, at the last - * point where it corresponds to a changed run in the other file. - * CORRESPONDING == LEN means no such point has been found. - */ - $corresponding = $j < $other_len ? $i : $len; - - /* - * Move the changed region forward, so long as the - * first changed line matches the following unchanged one. - * This merges with following changed regions. - * Do this second, so that if there are no merges, - * the changed region is moved forward as far as possible. - */ - while ($i < $len && $lines[$start] == $lines[$i]) { - $changed[$start++] = FALSE; - $changed[$i++] = 1; - while ($i < $len && $changed[$i]) { - $i++; - } - $this::USE_ASSERTS && assert($j < $other_len && ! $other_changed[$j]); - $j++; - if ($j < $other_len && $other_changed[$j]) { - $corresponding = $i; - while ($j < $other_len && $other_changed[$j]) { - $j++; - } - } - } - } while ($runlength != $i - $start); - - /* - * If possible, move the fully-merged run of changes - * back to a corresponding run in the other file. - */ - while ($corresponding < $i) { - $changed[--$start] = 1; - $changed[--$i] = 0; - $this::USE_ASSERTS && assert($j > 0); - while ($other_changed[--$j]) { - continue; - } - $this::USE_ASSERTS && assert($j >= 0 && !$other_changed[$j]); - } - } - } - -} diff --git a/core/lib/Drupal/Component/Diff/Engine/DiffOp.php b/core/lib/Drupal/Component/Diff/Engine/DiffOp.php index 735669dc147c..44e0a71b054b 100644 --- a/core/lib/Drupal/Component/Diff/Engine/DiffOp.php +++ b/core/lib/Drupal/Component/Diff/Engine/DiffOp.php @@ -11,38 +11,4 @@ class DiffOp { public $type; public $orig; public $closing; - - /** - * @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no - * replacement. - * - * @see https://www.drupal.org/node/3337942 - */ - public function reverse() { - @trigger_error(__METHOD__ . '() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no replacement. See https://www.drupal.org/node/3337942', E_USER_DEPRECATED); - trigger_error('pure virtual', E_USER_ERROR); - } - - /** - * @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no - * replacement. - * - * @see https://www.drupal.org/node/3337942 - */ - public function norig() { - @trigger_error(__METHOD__ . '() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no replacement. See https://www.drupal.org/node/3337942', E_USER_DEPRECATED); - return $this->orig ? sizeof($this->orig) : 0; - } - - /** - * @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no - * replacement. - * - * @see https://www.drupal.org/node/3337942 - */ - public function nclosing() { - @trigger_error(__METHOD__ . '() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no replacement. See https://www.drupal.org/node/3337942', E_USER_DEPRECATED); - return $this->closing ? sizeof($this->closing) : 0; - } - } diff --git a/core/lib/Drupal/Component/Diff/Engine/DiffOpAdd.php b/core/lib/Drupal/Component/Diff/Engine/DiffOpAdd.php index df954302f6cc..9aef8d332c7c 100644 --- a/core/lib/Drupal/Component/Diff/Engine/DiffOpAdd.php +++ b/core/lib/Drupal/Component/Diff/Engine/DiffOpAdd.php @@ -15,15 +15,4 @@ public function __construct($lines) { $this->orig = FALSE; } - /** - * @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no - * replacement. - * - * @see https://www.drupal.org/node/3337942 - */ - public function reverse() { - @trigger_error(__METHOD__ . '() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no replacement. See https://www.drupal.org/node/3337942', E_USER_DEPRECATED); - return new DiffOpDelete($this->closing); - } - } diff --git a/core/lib/Drupal/Component/Diff/Engine/DiffOpChange.php b/core/lib/Drupal/Component/Diff/Engine/DiffOpChange.php index 93d15db885b9..3e66b256e6c6 100644 --- a/core/lib/Drupal/Component/Diff/Engine/DiffOpChange.php +++ b/core/lib/Drupal/Component/Diff/Engine/DiffOpChange.php @@ -15,15 +15,4 @@ public function __construct($orig, $closing) { $this->closing = $closing; } - /** - * @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no - * replacement. - * - * @see https://www.drupal.org/node/3337942 - */ - public function reverse() { - @trigger_error(__METHOD__ . '() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no replacement. See https://www.drupal.org/node/3337942', E_USER_DEPRECATED); - return new DiffOpChange($this->closing, $this->orig); - } - } diff --git a/core/lib/Drupal/Component/Diff/Engine/DiffOpCopy.php b/core/lib/Drupal/Component/Diff/Engine/DiffOpCopy.php index c82e2a61b996..d51f3c934417 100644 --- a/core/lib/Drupal/Component/Diff/Engine/DiffOpCopy.php +++ b/core/lib/Drupal/Component/Diff/Engine/DiffOpCopy.php @@ -18,15 +18,4 @@ public function __construct($orig, $closing = FALSE) { $this->closing = $closing; } - /** - * @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no - * replacement. - * - * @see https://www.drupal.org/node/3337942 - */ - public function reverse() { - @trigger_error(__METHOD__ . '() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no replacement. See https://www.drupal.org/node/3337942', E_USER_DEPRECATED); - return new DiffOpCopy($this->closing, $this->orig); - } - } diff --git a/core/lib/Drupal/Component/Diff/Engine/DiffOpDelete.php b/core/lib/Drupal/Component/Diff/Engine/DiffOpDelete.php index 4aa84be1300e..60e6974cbcb2 100644 --- a/core/lib/Drupal/Component/Diff/Engine/DiffOpDelete.php +++ b/core/lib/Drupal/Component/Diff/Engine/DiffOpDelete.php @@ -15,15 +15,4 @@ public function __construct($lines) { $this->closing = FALSE; } - /** - * @deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no - * replacement. - * - * @see https://www.drupal.org/node/3337942 - */ - public function reverse() { - @trigger_error(__METHOD__ . '() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no replacement. See https://www.drupal.org/node/3337942', E_USER_DEPRECATED); - return new DiffOpAdd($this->orig); - } - } diff --git a/core/lib/Drupal/Component/Diff/composer.json b/core/lib/Drupal/Component/Diff/composer.json index 57a07592ff85..7410e7afbdef 100644 --- a/core/lib/Drupal/Component/Diff/composer.json +++ b/core/lib/Drupal/Component/Diff/composer.json @@ -8,7 +8,7 @@ "license": "GPL-2.0-or-later", "require": { "php": ">=8.1.0", - "sebastian/diff": "^4" + "sebastian/diff": "^4 | ^5" }, "autoload": { "psr-4": { diff --git a/core/phpstan-baseline.neon b/core/phpstan-baseline.neon index 5091ae91c221..87c7b033a71d 100644 --- a/core/phpstan-baseline.neon +++ b/core/phpstan-baseline.neon @@ -88,61 +88,6 @@ parameters: count: 1 path: lib/Drupal/Component/Diff/DiffFormatter.php - - - message: "#^Access to an undefined property Drupal\\\\Component\\\\Diff\\\\Engine\\\\DiffEngine\\:\\:\\$in_seq\\.$#" - count: 3 - path: lib/Drupal/Component/Diff/Engine/DiffEngine.php - - - - message: "#^Access to an undefined property Drupal\\\\Component\\\\Diff\\\\Engine\\\\DiffEngine\\:\\:\\$lcs\\.$#" - count: 4 - path: lib/Drupal/Component/Diff/Engine/DiffEngine.php - - - - message: "#^Access to an undefined property Drupal\\\\Component\\\\Diff\\\\Engine\\\\DiffEngine\\:\\:\\$seq\\.$#" - count: 7 - path: lib/Drupal/Component/Diff/Engine/DiffEngine.php - - - - message: "#^Access to an undefined property Drupal\\\\Component\\\\Diff\\\\Engine\\\\DiffEngine\\:\\:\\$xchanged\\.$#" - count: 6 - path: lib/Drupal/Component/Diff/Engine/DiffEngine.php - - - - message: "#^Access to an undefined property Drupal\\\\Component\\\\Diff\\\\Engine\\\\DiffEngine\\:\\:\\$xind\\.$#" - count: 2 - path: lib/Drupal/Component/Diff/Engine/DiffEngine.php - - - - message: "#^Access to an undefined property Drupal\\\\Component\\\\Diff\\\\Engine\\\\DiffEngine\\:\\:\\$xv\\.$#" - count: 5 - path: lib/Drupal/Component/Diff/Engine/DiffEngine.php - - - - message: "#^Access to an undefined property Drupal\\\\Component\\\\Diff\\\\Engine\\\\DiffEngine\\:\\:\\$ychanged\\.$#" - count: 5 - path: lib/Drupal/Component/Diff/Engine/DiffEngine.php - - - - message: "#^Access to an undefined property Drupal\\\\Component\\\\Diff\\\\Engine\\\\DiffEngine\\:\\:\\$yind\\.$#" - count: 2 - path: lib/Drupal/Component/Diff/Engine/DiffEngine.php - - - - message: "#^Access to an undefined property Drupal\\\\Component\\\\Diff\\\\Engine\\\\DiffEngine\\:\\:\\$yv\\.$#" - count: 5 - path: lib/Drupal/Component/Diff/Engine/DiffEngine.php - - - - message: "#^Variable \\$k might not be defined\\.$#" - count: 4 - path: lib/Drupal/Component/Diff/Engine/DiffEngine.php - - - - message: "#^Variable \\$seps might not be defined\\.$#" - count: 3 - path: lib/Drupal/Component/Diff/Engine/DiffEngine.php - - message: "#^Constructor of class Drupal\\\\Component\\\\FileCache\\\\NullFileCache has an unused parameter \\$cache_backend_class\\.$#" count: 1 @@ -390,24 +335,6 @@ parameters: count: 1 path: lib/Drupal/Core/DependencyInjection/ContainerBuilder.php - - - message: """ - #^Call to deprecated method closing\\(\\) of class Drupal\\\\Component\\\\Diff\\\\WordLevelDiff\\: - in drupal\\:10\\.1\\.0 and is removed from drupal\\:11\\.0\\.0\\. There is no - replacement\\.$# - """ - count: 1 - path: lib/Drupal/Core/Diff/DiffFormatter.php - - - - message: """ - #^Call to deprecated method orig\\(\\) of class Drupal\\\\Component\\\\Diff\\\\WordLevelDiff\\: - in drupal\\:10\\.1\\.0 and is removed from drupal\\:11\\.0\\.0\\. There is no - replacement\\.$# - """ - count: 1 - path: lib/Drupal/Core/Diff/DiffFormatter.php - - message: "#^Method Drupal\\\\Core\\\\DrupalKernel\\:\\:discoverServiceProviders\\(\\) should return array but return statement is missing\\.$#" count: 1 diff --git a/core/tests/Drupal/Tests/Component/Diff/Engine/DiffEngineTest.php b/core/tests/Drupal/Tests/Component/Diff/Engine/DiffEngineTest.php deleted file mode 100644 index 231b3c999192..000000000000 --- a/core/tests/Drupal/Tests/Component/Diff/Engine/DiffEngineTest.php +++ /dev/null @@ -1,132 +0,0 @@ -<?php - -declare(strict_types=1); - -namespace Drupal\Tests\Component\Diff\Engine; - -use Drupal\Component\Diff\Engine\DiffEngine; -use Drupal\Component\Diff\Engine\DiffOpAdd; -use Drupal\Component\Diff\Engine\DiffOpCopy; -use Drupal\Component\Diff\Engine\DiffOpChange; -use Drupal\Component\Diff\Engine\DiffOpDelete; -use PHPUnit\Framework\TestCase; -use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait; - -/** - * Test DiffEngine class. - * - * @coversDefaultClass \Drupal\Component\Diff\Engine\DiffEngine - * - * @group Diff - * @group legacy - */ -class DiffEngineTest extends TestCase { - - use ExpectDeprecationTrait; - - /** - * @return array - * - Expected output in terms of return class. A list of class names - * expected to be returned by DiffEngine::diff(). - * - An array of strings to change from. - * - An array of strings to change to. - */ - public static function provideTestDiff() { - return [ - 'empty' => [[], [], []], - 'add' => [[DiffOpAdd::class], [], ['a']], - 'copy' => [[DiffOpCopy::class], ['a'], ['a']], - 'change' => [[DiffOpChange::class], ['a'], ['b']], - 'copy-and-change' => [ - [ - DiffOpCopy::class, - DiffOpChange::class, - ], - ['a', 'b'], - ['a', 'c'], - ], - 'copy-change-copy' => [ - [ - DiffOpCopy::class, - DiffOpChange::class, - DiffOpCopy::class, - ], - ['a', 'b', 'd'], - ['a', 'c', 'd'], - ], - 'copy-change-copy-add' => [ - [ - DiffOpCopy::class, - DiffOpChange::class, - DiffOpCopy::class, - DiffOpAdd::class, - ], - ['a', 'b', 'd'], - ['a', 'c', 'd', 'e'], - ], - 'copy-delete' => [ - [ - DiffOpCopy::class, - DiffOpDelete::class, - ], - ['a', 'b', 'd'], - ['a'], - ], - 'change-copy' => [ - [ - DiffOpChange::class, - DiffOpCopy::class, - ], - ['aa', 'bb', 'cc', 'd'], - ['a', 'c', 'd'], - ], - 'copy-change-copy-change' => [ - [ - DiffOpCopy::class, - DiffOpChange::class, - DiffOpCopy::class, - DiffOpChange::class, - ], - ['a', 'bb', 'd', 'ee'], - ['a', 'b', 'c', 'd', 'e'], - ], - ]; - } - - /** - * Tests whether op classes returned by DiffEngine::diff() match expectations. - * - * @covers ::diff - * @dataProvider provideTestDiff - */ - public function testDiff($expected, $from, $to) { - $this->expectDeprecation('Drupal\Component\Diff\Engine\DiffEngine is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use sebastianbergmann/diff instead. See https://www.drupal.org/node/3337942'); - $diff_engine = new DiffEngine(); - $diff = $diff_engine->diff($from, $to); - // Make sure we have the same number of results as expected. - $this->assertSameSize($expected, $diff); - // Make sure the diff objects match our expectations. - foreach ($expected as $index => $op_class) { - $this->assertEquals($op_class, get_class($diff[$index])); - } - } - - /** - * Tests that two files can be successfully diffed. - * - * @covers ::diff - */ - public function testDiffInfiniteLoop() { - $this->expectDeprecation('Drupal\Component\Diff\Engine\DiffEngine is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use sebastianbergmann/diff instead. See https://www.drupal.org/node/3337942'); - $from = explode("\n", file_get_contents(__DIR__ . '/fixtures/file1.txt')); - $to = explode("\n", file_get_contents(__DIR__ . '/fixtures/file2.txt')); - $diff_engine = new DiffEngine(); - $diff = $diff_engine->diff($from, $to); - $this->assertCount(4, $diff); - $this->assertEquals($diff[0], new DiffOpDelete([' - image.style.max_650x650'])); - $this->assertEquals($diff[1], new DiffOpCopy([' - image.style.max_325x325'])); - $this->assertEquals($diff[2], new DiffOpAdd([' - image.style.max_650x650', '_core:', ' default_config_hash: random_hash_string_here'])); - $this->assertEquals($diff[3], new DiffOpCopy(['fallback_image_style: max_325x325', ''])); - } - -} diff --git a/core/tests/Drupal/Tests/Component/Diff/Engine/DiffOpTest.php b/core/tests/Drupal/Tests/Component/Diff/Engine/DiffOpTest.php deleted file mode 100644 index d45aef5858df..000000000000 --- a/core/tests/Drupal/Tests/Component/Diff/Engine/DiffOpTest.php +++ /dev/null @@ -1,41 +0,0 @@ -<?php - -declare(strict_types=1); - -namespace Drupal\Tests\Component\Diff\Engine; - -use Drupal\Component\Diff\Engine\DiffOp; -use Drupal\Tests\Traits\PhpUnitWarnings; -use PHPUnit\Framework\TestCase; -use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait; - -/** - * Test DiffOp base class. - * - * The only significant behavior here is that ::reverse() should throw an error - * if not overridden. In versions of this code in other projects, reverse() is - * marked as abstract, which enforces some of this behavior. - * - * @coversDefaultClass \Drupal\Component\Diff\Engine\DiffOp - * - * @group Diff - * @group legacy - */ -class DiffOpTest extends TestCase { - - use ExpectDeprecationTrait; - use PhpUnitWarnings; - - /** - * DiffOp::reverse() always throws an error. - * - * @covers ::reverse - */ - public function testReverse() { - $this->expectDeprecation('Drupal\Component\Diff\Engine\DiffOp::reverse() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. There is no replacement. See https://www.drupal.org/node/3337942'); - $this->expectError(); - $op = new DiffOp(); - $result = $op->reverse(); - } - -} -- GitLab