Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge "SlotDiffRenderer: add utility method for parameter type checks"

Browse source
This commit is contained in:
jenkins-bot 2018-10-13 05:27:16 +00:00 committed by Gerrit Code Review
commit 6928652735
5 changed files with 115 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
includes/diff/DifferenceEngineSlotDiffRenderer.php
View file

@ -46,15 +46,7 @@ class DifferenceEngineSlotDiffRenderer extends SlotDiffRenderer {
/** @inheritDoc */
public function getDiff( Content $oldContent = null, Content $newContent = null ) {
if ( !$oldContent && !$newContent ) {
throw new InvalidArgumentException( '$oldContent and $newContent cannot both be null' );
}
if ( !$oldContent || !$newContent ) {
$someContent = $newContent ?: $oldContent;
$emptyContent = $someContent->getContentHandler()->makeEmptyContent();
$oldContent = $oldContent ?: $emptyContent;
$newContent = $newContent ?: $emptyContent;
}
$this->normalizeContents( $oldContent, $newContent );
return $this->differenceEngine->generateContentDiffBody( $oldContent, $newContent );
}

32
includes/diff/SlotDiffRenderer.php
View file

@ -20,6 +20,7 @@
* @file
* @ingroup DifferenceEngine
*/
use Wikimedia\Assert\Assert;
/**
* Renders a diff for a single slot (that is, a diff between two content objects).
@ -62,4 +63,35 @@ abstract class SlotDiffRenderer {
return [];
}
/**
* Helper method to normalize the input of getDiff().
* Verifies that at least one of $oldContent and $newContent is not null, verifies that
* they are instances of one of the allowed classes (if provided), and replaces null with
* empty content.
* @param Content|null &$oldContent
* @param Content|null &$newContent
* @param string|array|null $allowedClasses
*/
protected function normalizeContents(
Content &$oldContent = null, Content &$newContent = null, $allowedClasses = null
) {
if ( !$oldContent && !$newContent ) {
throw new InvalidArgumentException( '$oldContent and $newContent cannot both be null' );
}
if ( $allowedClasses ) {
if ( is_array( $allowedClasses ) ) {
$allowedClasses = implode( '|', $allowedClasses );
}
Assert::parameterType( $allowedClasses . '|null', $oldContent, '$oldContent' );
Assert::parameterType( $allowedClasses . '|null', $newContent, '$newContent' );
}
if ( !$oldContent ) {
$oldContent = $newContent->getContentHandler()->makeEmptyContent();
} elseif ( !$newContent ) {
$newContent = $oldContent->getContentHandler()->makeEmptyContent();
}
}
}

14
includes/diff/TextSlotDiffRenderer.php
View file

@ -116,19 +116,7 @@ class TextSlotDiffRenderer extends SlotDiffRenderer {
/** @inheritDoc */
public function getDiff( Content $oldContent = null, Content $newContent = null ) {
if ( !$oldContent && !$newContent ) {
throw new InvalidArgumentException( '$oldContent and $newContent cannot both be null' );
} elseif ( $oldContent && !( $oldContent instanceof TextContent ) ) {
throw new InvalidArgumentException( __CLASS__ . ' does not handle ' . get_class( $oldContent ) );
} elseif ( $newContent && !( $newContent instanceof TextContent ) ) {
throw new InvalidArgumentException( __CLASS__ . ' does not handle ' . get_class( $newContent ) );
}
if ( !$oldContent ) {
$oldContent = $newContent->getContentHandler()->makeEmptyContent();
} elseif ( !$newContent ) {
$newContent = $oldContent->getContentHandler()->makeEmptyContent();
}
$this->normalizeContents( $oldContent, $newContent, TextContent::class );
$oldText = $oldContent->serialize();
$newText = $newContent->serialize();

77
tests/phpunit/includes/diff/SlotDiffRendererTest.php Normal file
View file

@ -0,0 +1,77 @@
<?php
use Wikimedia\Assert\ParameterTypeException;
use Wikimedia\TestingAccessWrapper;
/**
* @covers SlotDiffRenderer
*/
class SlotDiffRendererTest extends \PHPUnit\Framework\TestCase {
/**
* @dataProvider provideNormalizeContents
*/
public function testNormalizeContents(
$oldContent, $newContent, $allowedClasses,
$expectedOldContent, $expectedNewContent, $expectedExceptionClass
) {
$slotDiffRenderer = $this->getMockBuilder( SlotDiffRenderer::class )
->getMock();
try {
// __call needs help deciding which parameter to take by reference
call_user_func_array( [ TestingAccessWrapper::newFromObject( $slotDiffRenderer ),
'normalizeContents' ], [ &$oldContent, &$newContent, $allowedClasses ] );
$this->assertEquals( $expectedOldContent, $oldContent );
$this->assertEquals( $expectedNewContent, $newContent );
} catch ( Exception $e ) {
if ( !$expectedExceptionClass ) {
throw $e;
}
$this->assertInstanceOf( $expectedExceptionClass, $e );
}
}
public function provideNormalizeContents() {
return [
'both null' => [ null, null, null, null, null, InvalidArgumentException::class ],
'left null' => [
null, new WikitextContent( 'abc' ), null,
new WikitextContent( '' ), new WikitextContent( 'abc' ), null,
],
'right null' => [
new WikitextContent( 'def' ), null, null,
new WikitextContent( 'def' ), new WikitextContent( '' ), null,
],
'type filter' => [
new WikitextContent( 'abc' ), new WikitextContent( 'def' ), WikitextContent::class,
new WikitextContent( 'abc' ), new WikitextContent( 'def' ), null,
],
'type filter (subclass)' => [
new WikitextContent( 'abc' ), new WikitextContent( 'def' ), TextContent::class,
new WikitextContent( 'abc' ), new WikitextContent( 'def' ), null,
],
'type filter (null)' => [
new WikitextContent( 'abc' ), null, TextContent::class,
new WikitextContent( 'abc' ), new WikitextContent( '' ), null,
],
'type filter failure (left)' => [
new TextContent( 'abc' ), new WikitextContent( 'def' ), WikitextContent::class,
null, null, ParameterTypeException::class,
],
'type filter failure (right)' => [
new WikitextContent( 'abc' ), new TextContent( 'def' ), WikitextContent::class,
null, null, ParameterTypeException::class,
],
'type filter (array syntax)' => [
new WikitextContent( 'abc' ), new JsonContent( 'def' ),
[ JsonContent::class, WikitextContent::class ],
new WikitextContent( 'abc' ), new JsonContent( 'def' ), null,
],
'type filter failure (array syntax)' => [
new WikitextContent( 'abc' ), new CssContent( 'def' ),
[ JsonContent::class, WikitextContent::class ],
null, null, ParameterTypeException::class,
],
];
}
}

6
tests/phpunit/includes/diff/TextSlotDiffRendererTest.php
View file

@ -1,5 +1,7 @@
<?php
use Wikimedia\Assert\ParameterTypeException;
/**
* @covers TextSlotDiffRenderer
*/
@ -63,12 +65,12 @@ class TextSlotDiffRendererTest extends MediaWikiTestCase {
'non-text left content' => [
$this->makeContent( '', 'testing-nontext' ),
$this->makeContent( "aaa\nbbb\nccc" ),
new InvalidArgumentException( 'TextSlotDiffRenderer does not handle DummyNonTextContent' ),
new ParameterTypeException( '$oldContent', 'TextContent|null' ),
],
'non-text right content' => [
$this->makeContent( "aaa\nbbb\nccc" ),
$this->makeContent( '', 'testing-nontext' ),
new InvalidArgumentException( 'TextSlotDiffRenderer does not handle DummyNonTextContent' ),
new ParameterTypeException( '$newContent', 'TextContent|null' ),
],
];
}