DiffFormatterTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\Component\Diff;

use Drupal\Component\Diff\Diff;
use Drupal\Component\Diff\DiffFormatter;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Group;
use PHPUnit\Framework\TestCase;

/**
 * Test DiffFormatter classes.
 */
class DiffFormatterTest extends TestCase {
  
  /**
   * @return array
   *   - Expected formatted diff output.
   *   - First array of text to diff.
   *   - Second array of text to diff.
   */
  public static function provideTestDiff() : array {
    return [
      'empty' => [
        '',
        [],
        [],
      ],
      'add' => [
        "3a3\n> line2a\n",
        [
          'line1',
          'line2',
          'line3',
        ],
        [
          'line1',
          'line2',
          'line2a',
          'line3',
        ],
      ],
      'delete' => [
        "3d3\n< line2a\n",
        [
          'line1',
          'line2',
          'line2a',
          'line3',
        ],
        [
          'line1',
          'line2',
          'line3',
        ],
      ],
      'change' => [
        "3c3\n< line2a\n---\n> line2b\n",
        [
          'line1',
          'line2',
          'line2a',
          'line3',
        ],
        [
          'line1',
          'line2',
          'line2b',
          'line3',
        ],
      ],
      // Lines are compared including their end of line markings, so lines
      // differing only by those are a change. Differ's mismatched line ending
      // warning is not part of the output.
'change, line endings differ' => [
        "1c1\n< foo\r\n\n---\n> foo\n\n",
        [
          "foo\r\n",
        ],
        [
          "foo\n",
        ],
      ],
      'change, line endings differ on multiple lines' => [
        "1,2c1,2\n< line1\r\n\n< line2\r\n\n---\n> line1\n\n> line2\n\n",
        [
          "line1\r\n",
          "line2\r\n",
        ],
        [
          "line1\n",
          "line2\n",
        ],
      ],
      'copy, line endings match' => [
        '',
        [
          "foo\r\n",
        ],
        [
          "foo\r\n",
        ],
      ],
    ];
  }
  
  /**
   * Tests whether op classes returned by DiffEngine::diff() match expectations.
   *
   * @legacy-covers ::format
   */
  public function testDiff(string $expected, array $from, array $to) : void {
    $diff = new Diff($from, $to);
    $formatter = new DiffFormatter();
    $output = $formatter->format($diff);
    $this->assertEquals($expected, $output);
  }

}