aboutsummaryrefslogtreecommitdiffstats
path: root/tests/phpunit/includes/diff/TextDiffer/Wikidiff2TextDifferTest.php
diff options
context:
space:
mode:
authorTim Starling <tstarling@wikimedia.org>2023-07-03 18:27:47 +1000
committerTim Starling <tstarling@wikimedia.org>2023-07-19 12:38:18 +1000
commit2aa87cdf2c21570f170ea5f4961b10e2da35b013 (patch)
treeb32557b1fba5504f5e28379585189487f1484207 /tests/phpunit/includes/diff/TextDiffer/Wikidiff2TextDifferTest.php
parentb42062e7d068a8b01af3fb72a7885d23379bc0e6 (diff)
downloadmediawikicore-2aa87cdf2c21570f170ea5f4961b10e2da35b013.tar.gz
mediawikicore-2aa87cdf2c21570f170ea5f4961b10e2da35b013.zip
Factor out TextDiffer hierarchy from TextSlotDiffRenderer
* Follow the TODO comment in TextSlotDiffRenderer ::getTextDiffInternal() by moving the code out to three parallel implementations, namely ExternalTextDiffer, PhpTextDiffer and Wikidiff2TextDiffer. * Add a container/factory class ManifoldTextDiffer to glue them together and collate available formats. * Move the inline legend to Wikidiff2TextDiffer. Not the toggle since the ability to toggle depends on the available format, not the current format. * Update the diff cache keys so that ManifoldTextDiffer can store the engine=>format map it used to generate the diff. * Drop support for the second parameter to TextSlotDiffRenderer ::setEngine(), since nothing used it anymore. * Provide a format batch API, since some engines are able to efficiently generate multiple formats. This might be used by DifferenceEngine in future. Needs risky change notification for the cache key change. Bug: T339184 Depends-On: I8a35b9b8ec1622c9a36d2496bdd24f51bc52c85f Change-Id: I5c506e39162855aff53dd420dd8145156739059c
Diffstat (limited to 'tests/phpunit/includes/diff/TextDiffer/Wikidiff2TextDifferTest.php')
-rw-r--r--tests/phpunit/includes/diff/TextDiffer/Wikidiff2TextDifferTest.php148
1 files changed, 148 insertions, 0 deletions
diff --git a/tests/phpunit/includes/diff/TextDiffer/Wikidiff2TextDifferTest.php b/tests/phpunit/includes/diff/TextDiffer/Wikidiff2TextDifferTest.php
new file mode 100644
index 000000000000..af389c4ec535
--- /dev/null
+++ b/tests/phpunit/includes/diff/TextDiffer/Wikidiff2TextDifferTest.php
@@ -0,0 +1,148 @@
+<?php
+
+use MediaWiki\Diff\TextDiffer\TextDiffer;
+use MediaWiki\Diff\TextDiffer\Wikidiff2TextDiffer;
+use MediaWiki\Tests\Diff\TextDiffer\TextDifferData;
+use Wikimedia\TestingAccessWrapper;
+
+/**
+ * @covers \MediaWiki\Diff\TextDiffer\Wikidiff2TextDiffer
+ */
+class Wikidiff2TextDifferTest extends MediaWikiIntegrationTestCase {
+ private function createDiffer() {
+ $differ = new Wikidiff2TextDiffer();
+ $localizer = RequestContext::getMain();
+ $localizer->setLanguage( 'qqx' );
+ $differ->setLocalizer( $localizer );
+ TestingAccessWrapper::newFromObject( $differ )->haveMoveSupport = true;
+ return $differ;
+ }
+
+ /**
+ * @requires extension wikidiff2
+ */
+ public function testRenderBatch() {
+ $oldText = 'foo';
+ $newText = 'bar';
+ $differ = new Wikidiff2TextDiffer();
+ // Should not need a MessageLocalizer
+ $result = $differ->renderBatch( $oldText, $newText, [ 'table', 'inline' ] );
+ $this->assertSame(
+ [
+ 'table' => TextDifferData::WIKIDIFF2_TABLE,
+ 'inline' => TextDifferData::WIKIDIFF2_INLINE
+ ],
+ $result
+ );
+ }
+
+ public function testGetName() {
+ $differ = new Wikidiff2TextDiffer();
+ $this->assertSame( 'wikidiff2', $differ->getName() );
+ }
+
+ public function testGetFormatContext() {
+ $differ = new Wikidiff2TextDiffer();
+ $this->assertSame( TextDiffer::CONTEXT_ROW, $differ->getFormatContext( 'table' ) );
+ }
+
+ public static function provideGetTablePrefixes() {
+ return [
+ [
+ 'table',
+ 'class="mw-diff-inline-legend oo-ui-element-hidden".*\(diff-inline-tooltip-ins\)'
+ ],
+ [
+ 'inline',
+ 'class="mw-diff-inline-legend".*\(diff-inline-tooltip-ins\)'
+ ],
+ ];
+ }
+
+ /**
+ * @dataProvider provideGetTablePrefixes
+ * @param string $format
+ * @param string $pattern
+ */
+ public function testGetTablePrefixes( $format, $pattern ) {
+ $differ = $this->createDiffer();
+ $result = $differ->getTablePrefixes( $format );
+ $this->assertMatchesRegularExpression(
+ '{' . $pattern . '}s',
+ $result[TextSlotDiffRenderer::INLINE_LEGEND_KEY]
+ );
+ }
+
+ public static function provideLocalize() {
+ return [
+ 'normal table' => [
+ 'table',
+ TextDifferData::WIKIDIFF2_TABLE,
+ [],
+ '<td colspan="2" class="diff-lineno">\(lineno: 1\)</td>'
+ ],
+ 'table with move tooltip' => [
+ 'table',
+ // From wikidiff2 001.phpt
+ '<td class="diff-marker"><a class="mw-diff-movedpara-left" href="#movedpara_7_0_rhs">&#x26AB;</a></td>',
+ [],
+ 'title="\(diff-paragraph-moved-tonew\)"'
+ ],
+ 'table with reduced line numbers' => [
+ 'table',
+ TextDifferData::WIKIDIFF2_TABLE,
+ [ 'reducedLineNumbers' => true ],
+ '<td colspan="2" class="diff-lineno"></td>'
+ ],
+ 'inline tooltip' => [
+ 'inline',
+ TextDifferData::WIKIDIFF2_INLINE,
+ [],
+ '<ins title="\(diff-inline-tooltip-ins\)">'
+ ],
+ ];
+ }
+
+ /**
+ * @dataProvider provideLocalize
+ * @param string $format
+ * @param string $input
+ * @param array $options
+ * @param string $pattern
+ */
+ public function testLocalize( $format, $input, $options, $pattern ) {
+ $differ = $this->createDiffer();
+ $result = $differ->localize( $format, $input, $options );
+ $this->assertMatchesRegularExpression(
+ '{' . $pattern . '}s',
+ $result
+ );
+ }
+
+ public static function provideAddLocalizedTitleTooltips() {
+ return [
+ 'moved paragraph left shoud get new location title' => [
+ '<a class="mw-diff-movedpara-left">⚫</a>',
+ '<a class="mw-diff-movedpara-left" title="(diff-paragraph-moved-tonew)">⚫</a>',
+ ],
+ 'moved paragraph right shoud get old location title' => [
+ '<a class="mw-diff-movedpara-right">⚫</a>',
+ '<a class="mw-diff-movedpara-right" title="(diff-paragraph-moved-toold)">⚫</a>',
+ ],
+ 'nothing changed when key not hit' => [
+ '<a class="mw-diff-movedpara-rightis">⚫</a>',
+ '<a class="mw-diff-movedpara-rightis">⚫</a>',
+ ],
+ ];
+ }
+
+ /**
+ * @dataProvider provideAddLocalizedTitleTooltips
+ */
+ public function testAddLocalizedTitleTooltips( $input, $expected ) {
+ $differ = TestingAccessWrapper::newFromObject( $this->createDiffer() );
+
+ $this->assertEquals( $expected, $differ->addLocalizedTitleTooltips( 'table', $input ) );
+ }
+
+}