mirror of
https://github.com/Universal-Omega/PortableInfobox.git
synced 2024-12-18 11:10:29 +00:00
eb55d89e77
* Output any image candidate markers generated by PageImages wikimedia/mediawiki-extensions-PageImages#768464d changed how lead images are identified within PageImages, and since then an HTML comment in the form of `MW-PAGEIMAGES-CANDIDATE-$ID` is output by`doParserModifyImageHTML`, where the ID is an index in the extension output data's list of image metadata. These comments should find a way into the ParserOutput as the extension looks for those comments in a chosen document fragment when identifying qualifying candidates out of all images gathered through `onParserModifyImageHTML`. This change does not affect compatibility with older PageImages (only the "new" hook's being called already). * Default htmlAfter to null and update tests to expect it Follow-up to my previous PageImages commit.
491 lines
11 KiB
PHP
491 lines
11 KiB
PHP
<?php
|
||
|
||
use PortableInfobox\Helpers\PortableInfoboxDataBag;
|
||
use PortableInfobox\Helpers\PortableInfoboxImagesHelper;
|
||
use PortableInfobox\Parser\Nodes\NodeFactory;
|
||
use PortableInfobox\Parser\Nodes\NodeMedia;
|
||
use PortableInfobox\Parser\XmlMarkupParseErrorException;
|
||
|
||
/**
|
||
* @group PortableInfobox
|
||
* @covers \PortableInfobox\Parser\Nodes\NodeMedia
|
||
* @coversDefaultClass \PortableInfobox\Parser\Nodes\NodeMedia
|
||
*/
|
||
class NodeMediaTest extends MediaWikiIntegrationTestCase {
|
||
|
||
/**
|
||
* @covers ::getGalleryData
|
||
* @covers \PortableInfobox\Helpers\PortableInfoboxDataBag
|
||
* @dataProvider galleryDataProvider
|
||
* @param $marker
|
||
* @param $expected
|
||
*/
|
||
public function testGalleryData( $marker, $gallery, $expected ) {
|
||
PortableInfoboxDataBag::getInstance()->setGallery( $marker, $gallery );
|
||
$this->assertEquals( $expected, NodeMedia::getGalleryData( $marker ) );
|
||
}
|
||
|
||
public function galleryDataProvider() {
|
||
$markers = [
|
||
"'\"`UNIQabcd-gAlLeRy-1-QINU`\"'",
|
||
"'\"`UNIQabcd-gAlLeRy-2-QINU`\"'",
|
||
"'\"`UNIQabcd-gAlLeRy-3-QINU`\"'"
|
||
];
|
||
$galleries = [
|
||
new GalleryMock( [
|
||
[
|
||
'image0_name.jpg',
|
||
'image0_caption'
|
||
],
|
||
[
|
||
'image01_name.jpg',
|
||
'image01_caption'
|
||
],
|
||
] ),
|
||
new GalleryMock( [
|
||
[
|
||
'image1_name.jpg',
|
||
'image1_caption'
|
||
]
|
||
] ),
|
||
new GalleryMock()
|
||
];
|
||
|
||
return [
|
||
[
|
||
'marker' => $markers[0],
|
||
'gallery' => $galleries[0],
|
||
'expected' => [
|
||
[
|
||
'label' => 'image0_caption',
|
||
'title' => 'image0_name.jpg',
|
||
],
|
||
[
|
||
'label' => 'image01_caption',
|
||
'title' => 'image01_name.jpg',
|
||
],
|
||
]
|
||
],
|
||
[
|
||
'marker' => $markers[1],
|
||
'gallery' => $galleries[1],
|
||
'expected' => [
|
||
[
|
||
'label' => 'image1_caption',
|
||
'title' => 'image1_name.jpg',
|
||
]
|
||
]
|
||
],
|
||
[
|
||
'marker' => $markers[2],
|
||
'gallery' => $galleries[2],
|
||
'expected' => []
|
||
],
|
||
];
|
||
}
|
||
|
||
/**
|
||
* @covers ::getTabberData
|
||
*/
|
||
public function testTabberData() {
|
||
$input = '<div class="tabber"><div class="tabbertab" title="_title_">' .
|
||
'<p><a><img src="_src_"></a></p></div></div>';
|
||
$expected = [
|
||
[
|
||
'label' => '_title_',
|
||
'title' => '_src_',
|
||
]
|
||
];
|
||
$this->assertEquals( $expected, NodeMedia::getTabberData( $input ) );
|
||
}
|
||
|
||
/**
|
||
* @covers ::getMarkers
|
||
* @dataProvider markersProvider
|
||
* @param $ext
|
||
* @param $value
|
||
* @param $expected
|
||
*/
|
||
public function testMarkers( $ext, $value, $expected ) {
|
||
$this->assertEquals( $expected, NodeMedia::getMarkers( $value, $ext ) );
|
||
}
|
||
|
||
public function markersProvider() {
|
||
return [
|
||
[
|
||
'TABBER',
|
||
"<div>\x7f'\"`UNIQ--tAbBeR-12345678-QINU`\"'\x7f</div>",
|
||
[ "\x7f'\"`UNIQ--tAbBeR-12345678-QINU`\"'\x7f" ]
|
||
],
|
||
[
|
||
'GALLERY',
|
||
"\x7f'\"`UNIQ--tAbBeR-12345678-QINU`\"'\x7f" .
|
||
"<center>\x7f'\"`UNIQ--gAlLeRy-12345678-QINU`\"'\x7f</center>" .
|
||
"\x7f'\"`UNIQ--gAlLeRy-87654321-QINU`\"'\x7f",
|
||
[ "\x7f'\"`UNIQ--gAlLeRy-12345678-QINU`\"'\x7f", "\x7f'\"`UNIQ--gAlLeRy-87654321-QINU`\"'\x7f" ]
|
||
],
|
||
[
|
||
'GALLERY',
|
||
"\x7f'\"`UNIQ--somethingelse-12345678-QINU`\"'\x7f",
|
||
[]
|
||
]
|
||
];
|
||
}
|
||
|
||
/**
|
||
* @covers ::getData
|
||
* @dataProvider dataProvider
|
||
*
|
||
* @param $markup
|
||
* @param $params
|
||
* @param $mediaType
|
||
* @param $expected
|
||
*/
|
||
public function testData( $markup, $params, $mediaType, $expected ) {
|
||
$fileMock = is_null( $mediaType ) ? null : new FileMock( $mediaType );
|
||
$node = NodeFactory::newFromXML( $markup, $params );
|
||
|
||
$helper = $this->getMockBuilder( PortableInfoboxImagesHelper::class )
|
||
->setMethods( [ 'getFile', 'extendImageData' ] )
|
||
->getMock();
|
||
$helper->expects( $this->any() )
|
||
->method( 'getFile' )
|
||
->willReturn( $fileMock );
|
||
$helper->expects( $this->any() )
|
||
->method( 'extendImageData' )
|
||
->willReturn( [] );
|
||
|
||
$reflection = new ReflectionClass( $node );
|
||
$reflectionProperty = $reflection->getProperty( 'helper' );
|
||
$reflectionProperty->setAccessible( true );
|
||
$reflectionProperty->setValue( $node, $helper );
|
||
|
||
$this->assertEquals( $expected, $node->getData() );
|
||
}
|
||
|
||
public function dataProvider() {
|
||
// markup, params, expected
|
||
return [
|
||
[
|
||
'<media source="img"></media>',
|
||
[],
|
||
null,
|
||
[ [] ]
|
||
],
|
||
[
|
||
'<media source="img"></media>',
|
||
[ 'img' => 'test.jpg' ],
|
||
MEDIATYPE_BITMAP,
|
||
[ [
|
||
'url' => 'http://test.url',
|
||
'name' => 'Test.jpg',
|
||
'alt' => 'Test.jpg',
|
||
'caption' => null,
|
||
'isImage' => true,
|
||
'isVideo' => false,
|
||
'isAudio' => false,
|
||
'source' => 'img',
|
||
'item-name' => null,
|
||
'htmlAfter' => null,
|
||
] ]
|
||
],
|
||
[
|
||
'<media source="img"><alt><default>test alt</default></alt></media>',
|
||
[ 'img' => 'test.jpg' ],
|
||
MEDIATYPE_BITMAP,
|
||
[ [
|
||
'url' => 'http://test.url',
|
||
'name' => 'Test.jpg',
|
||
'alt' => 'test alt',
|
||
'caption' => null,
|
||
'isImage' => true,
|
||
'isVideo' => false,
|
||
'isAudio' => false,
|
||
'source' => 'img',
|
||
'item-name' => null,
|
||
'htmlAfter' => null,
|
||
] ]
|
||
],
|
||
[
|
||
'<media source="img"><alt source="alt source"><default>test alt</default></alt></media>',
|
||
[ 'img' => 'test.jpg', 'alt source' => 2 ],
|
||
MEDIATYPE_BITMAP,
|
||
[ [
|
||
'url' => 'http://test.url',
|
||
'name' => 'Test.jpg',
|
||
'alt' => 2,
|
||
'caption' => null,
|
||
'isImage' => true,
|
||
'isVideo' => false,
|
||
'isAudio' => false,
|
||
'source' => 'img',
|
||
'item-name' => null,
|
||
'htmlAfter' => null,
|
||
] ]
|
||
],
|
||
[
|
||
'<media source="img"><alt><default>test alt</default></alt><caption source="img"/></media>',
|
||
[ 'img' => 'test.jpg' ],
|
||
MEDIATYPE_BITMAP,
|
||
[ [
|
||
'url' => 'http://test.url',
|
||
'name' => 'Test.jpg',
|
||
'alt' => 'test alt',
|
||
'caption' => 'test.jpg',
|
||
'isImage' => true,
|
||
'isVideo' => false,
|
||
'isAudio' => false,
|
||
'source' => 'img',
|
||
'item-name' => null,
|
||
'htmlAfter' => null,
|
||
] ]
|
||
],
|
||
[
|
||
'<media source="img" name="img" />',
|
||
[ 'img' => 'test.jpg' ],
|
||
MEDIATYPE_BITMAP,
|
||
[ [
|
||
'url' => 'http://test.url',
|
||
'name' => 'Test.jpg',
|
||
'alt' => 'Test.jpg',
|
||
'caption' => null,
|
||
'isImage' => true,
|
||
'isVideo' => false,
|
||
'isAudio' => false,
|
||
'source' => 'img',
|
||
'item-name' => 'img',
|
||
'htmlAfter' => null,
|
||
] ]
|
||
],
|
||
[
|
||
'<media source="media" />',
|
||
[ 'media' => 'test.webm' ],
|
||
MEDIATYPE_VIDEO,
|
||
[ [
|
||
'url' => 'http://test.url',
|
||
'name' => 'Test.webm',
|
||
'alt' => 'Test.webm',
|
||
'caption' => null,
|
||
'isImage' => false,
|
||
'isVideo' => true,
|
||
'isAudio' => false,
|
||
'source' => 'media',
|
||
'item-name' => null,
|
||
'htmlAfter' => null,
|
||
] ]
|
||
],
|
||
[
|
||
'<media source="media" video="false" />',
|
||
[ 'media' => 'test.webm' ],
|
||
MEDIATYPE_VIDEO,
|
||
[ [] ]
|
||
],
|
||
[
|
||
'<media source="media" />',
|
||
[ 'media' => 'test.ogg' ],
|
||
MEDIATYPE_AUDIO,
|
||
[ [
|
||
'url' => 'http://test.url',
|
||
'name' => 'Test.ogg',
|
||
'alt' => 'Test.ogg',
|
||
'caption' => null,
|
||
'isImage' => false,
|
||
'isVideo' => false,
|
||
'isAudio' => true,
|
||
'source' => 'media',
|
||
'item-name' => null,
|
||
'htmlAfter' => null,
|
||
] ]
|
||
],
|
||
[
|
||
'<media source="media" audio="false" />',
|
||
[ 'media' => 'test.ogg' ],
|
||
MEDIATYPE_AUDIO,
|
||
[ [] ]
|
||
]
|
||
];
|
||
}
|
||
|
||
/**
|
||
* @covers ::isEmpty
|
||
* @dataProvider isEmptyProvider
|
||
*
|
||
* @param $markup
|
||
* @param $params
|
||
* @param $expected
|
||
*/
|
||
public function testIsEmpty( $markup, $params, $expected ) {
|
||
$node = NodeFactory::newFromXML( $markup, $params );
|
||
|
||
$this->assertEquals( $expected, $node->isEmpty() );
|
||
}
|
||
|
||
public function isEmptyProvider() {
|
||
return [
|
||
[ '<media></media>', [], true ],
|
||
];
|
||
}
|
||
|
||
/**
|
||
* @covers ::getSources
|
||
* @dataProvider sourcesProvider
|
||
*
|
||
* @param $markup
|
||
* @param $expected
|
||
*/
|
||
public function testSources( $markup, $expected ) {
|
||
$node = NodeFactory::newFromXML( $markup, [] );
|
||
|
||
$this->assertEquals( $expected, $node->getSources() );
|
||
}
|
||
|
||
public function sourcesProvider() {
|
||
return [
|
||
[
|
||
'<media source="img"/>',
|
||
[ 'img' ]
|
||
],
|
||
[
|
||
'<media source="img"><default>{{{img}}}</default><alt source="img" /></media>',
|
||
[ 'img' ]
|
||
],
|
||
[
|
||
'<media source="img"><alt source="alt"/><caption source="cap"/></media>',
|
||
[ 'img', 'alt', 'cap' ]
|
||
],
|
||
[
|
||
'<media source="img">' .
|
||
'<alt source="alt"><default>{{{def}}}</default></alt><caption source="cap"/>' .
|
||
'</media>',
|
||
[ 'img', 'alt', 'def', 'cap' ] ],
|
||
[
|
||
'<media/>',
|
||
[]
|
||
],
|
||
[
|
||
'<image source="img">' .
|
||
'<caption source="cap"><format>Test {{{cap}}} and {{{fcap}}}</format></caption>' .
|
||
'</image>',
|
||
[ 'img', 'cap', 'fcap' ]
|
||
]
|
||
];
|
||
}
|
||
|
||
/** @dataProvider metadataProvider */
|
||
public function testMetadata( $markup, $expected ) {
|
||
$node = NodeFactory::newFromXML( $markup, [] );
|
||
|
||
$this->assertEquals( $expected, $node->getMetadata() );
|
||
}
|
||
|
||
public function metadataProvider() {
|
||
return [
|
||
[
|
||
'<media source="img">' .
|
||
'<caption source="cap"><format>Test {{{cap}}} and {{{fcap}}}</format></caption>' .
|
||
'</media>',
|
||
[
|
||
'type' => 'media',
|
||
'sources' => [
|
||
'img' => [ 'label' => '', 'primary' => true ],
|
||
'cap' => [ 'label' => '' ],
|
||
'fcap' => [ 'label' => '' ]
|
||
]
|
||
]
|
||
]
|
||
];
|
||
}
|
||
|
||
/**
|
||
* @covers ::isTypeAllowed
|
||
* @covers \PortableInfobox\Parser\Nodes\NodeAudio
|
||
* @covers \PortableInfobox\Parser\Nodes\NodeImage
|
||
* @covers \PortableInfobox\Parser\Nodes\NodeVideo
|
||
* @dataProvider isTypeAllowedProvider
|
||
* @param $markup
|
||
* @param $expected
|
||
* @throws XmlMarkupParseErrorException
|
||
*/
|
||
public function testIsTypeAllowed( $markup, $expected ) {
|
||
$types = [ MEDIATYPE_BITMAP, MEDIATYPE_DRAWING, MEDIATYPE_VIDEO, MEDIATYPE_AUDIO, 'unknown' ];
|
||
|
||
$node = NodeFactory::newFromXML( $markup, [] );
|
||
|
||
$reflection = new ReflectionClass( $node );
|
||
$reflection_method = $reflection->getMethod( 'isTypeAllowed' );
|
||
$reflection_method->setAccessible( true );
|
||
|
||
foreach ( $types as $i => $type ) {
|
||
$this->assertEquals( $expected[$i], $reflection_method->invoke( $node, $type ) );
|
||
}
|
||
}
|
||
|
||
public function isTypeAllowedProvider() {
|
||
return [
|
||
[
|
||
'<media />',
|
||
[ true, true, true, true, false ]
|
||
],
|
||
[
|
||
'<media image="false" />',
|
||
[ false, false, true, true, false ]
|
||
],
|
||
[
|
||
'<media video="false" />',
|
||
[ true, true, false, true, false ]
|
||
],
|
||
[
|
||
'<media audio="false" />',
|
||
[ true, true, true, false, false ]
|
||
],
|
||
[
|
||
'<media image="false" video="false" audio="false" />',
|
||
[ false, false, false, false, false ]
|
||
],
|
||
[
|
||
'<image />',
|
||
[ true, true, true, false, false ]
|
||
],
|
||
[
|
||
'<image video="false" />',
|
||
[ true, true, false, false, false ]
|
||
],
|
||
[
|
||
'<video />',
|
||
[ false, false, true, false, false ]
|
||
],
|
||
[
|
||
'<audio />',
|
||
[ false, false, false, true, false ]
|
||
]
|
||
];
|
||
}
|
||
}
|
||
|
||
class FileMock {
|
||
protected $mediaType;
|
||
|
||
public function __construct( $mediaType ) {
|
||
$this->mediaType = $mediaType;
|
||
}
|
||
|
||
public function getMediaType() {
|
||
return $this->mediaType;
|
||
}
|
||
|
||
public function getUrl() {
|
||
return 'http://test.url';
|
||
}
|
||
}
|
||
|
||
class GalleryMock {
|
||
private $images;
|
||
public function __construct( array $images = [] ) {
|
||
$this->images = $images;
|
||
}
|
||
|
||
public function getImages() {
|
||
return $this->images;
|
||
}
|
||
}
|