Page MenuHomeWickedGov Phorge
Files F5976460

CommentFormatterTest.php
No OneTemporary
Actions

Size
8 KB
Referenced Files
None
Subscribers
None

CommentFormatterTest.php
View Options

<?php
namespace MediaWiki\Tests\Integration\CommentFormatter;
use MediaWiki\CommentFormatter\CommentFormatter;
use MediaWiki\CommentFormatter\CommentItem;
use MediaWiki\CommentFormatter\CommentParser;
use MediaWiki\CommentStore\CommentStoreComment;
use MediaWiki\Linker\LinkTarget;
use MediaWiki\Page\PageIdentityValue;
use MediaWiki\Permissions\Authority;
use MediaWiki\Permissions\SimpleAuthority;
use MediaWiki\Revision\MutableRevisionRecord;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Tests\Unit\CommentFormatter\CommentFormatterTestUtils;
use MediaWiki\Tests\Unit\DummyServicesTrait;
use MediaWiki\Title\TitleValue;
use MediaWiki\User\UserIdentityValue;
use MediaWikiIntegrationTestCase;
/**
* Trivial comment formatting with a mocked parser. Can't be a unit test because
* of the wfMessage() calls.
*
* @covers \MediaWiki\CommentFormatter\CommentFormatter
*/
class CommentFormatterTest extends MediaWikiIntegrationTestCase {
use DummyServicesTrait;
private function getParser() {
return new class extends CommentParser {
public function __construct() {
}
public function preprocess(
string $comment, ?LinkTarget $selfLinkTarget = null, $samePage = false,
$wikiId = null, $enableSectionLinks = true
) {
if ( $comment === '' || $comment === '*' ) {
return $comment; // Hack to make it work more like the real parser
}
return CommentFormatterTestUtils::dumpArray( [
'comment' => $comment,
'selfLinkTarget' => $selfLinkTarget,
'samePage' => $samePage,
'wikiId' => $wikiId,
'enableSectionLinks' => $enableSectionLinks
] );
}
public function preprocessUnsafe(
$comment, ?LinkTarget $selfLinkTarget = null, $samePage = false, $wikiId = null,
$enableSectionLinks = true
) {
return CommentFormatterTestUtils::dumpArray( [
'comment' => $comment,
'selfLinkTarget' => $selfLinkTarget,
'samePage' => $samePage,
'wikiId' => $wikiId,
'enableSectionLinks' => $enableSectionLinks,
'unsafe' => true
] );
}
public function finalize( $comments ) {
return $comments;
}
};
}
private function newCommentFormatter() {
return new CommentFormatter(
$this->getDummyCommentParserFactory( $this->getParser() )
);
}
public function testCreateBatch() {
$formatter = $this->newCommentFormatter();
$result = $formatter->createBatch()
->strings( [ 'key' => 'c' ] )
->useBlock()
->useParentheses()
->samePage()
->execute();
$this->assertSame(
[
'key' =>
// parentheses have to come after something so I guess it
// makes sense that there is a space here
' ' .
'<span class="comment">(comment=c, samePage, !wikiId, enableSectionLinks)</span>'
],
$result
);
}
public function testFormatItems() {
$formatter = $this->newCommentFormatter();
$result = $formatter->formatItems( [
'key' => new CommentItem( 'c' )
] );
$this->assertSame(
[ 'key' => 'comment=c, !samePage, !wikiId, enableSectionLinks' ],
$result
);
}
public function testFormat() {
$formatter = $this->newCommentFormatter();
$result = $formatter->format(
'c',
new TitleValue( 0, 'Page' ),
true,
'enwiki'
);
$this->assertSame(
'comment=c, selfLinkTarget=0:Page, samePage, wikiId=enwiki, enableSectionLinks',
$result
);
}
public function testFormatBlock() {
$formatter = $this->newCommentFormatter();
$result = $formatter->formatBlock(
'c',
new TitleValue( 0, 'Page' ),
true,
'enwiki',
true
);
$this->assertSame(
' <span class="comment">' .
'(comment=c, selfLinkTarget=0:Page, samePage, wikiId=enwiki, enableSectionLinks)' .
'</span>',
$result
);
}
public function testFormatLinksUnsafe() {
$formatter = $this->newCommentFormatter();
$result = $formatter->formatLinksUnsafe(
'c',
new TitleValue( 0, 'Page' ),
true,
'enwiki'
);
$this->assertSame(
'comment=c, selfLinkTarget=0:Page, samePage, wikiId=enwiki, !enableSectionLinks, unsafe',
$result
);
}
public function testFormatLinks() {
$formatter = $this->newCommentFormatter();
$result = $formatter->formatLinks(
'c',
new TitleValue( 0, 'Page' ),
true,
'enwiki'
);
$this->assertSame(
'comment=c, selfLinkTarget=0:Page, samePage, wikiId=enwiki, !enableSectionLinks',
$result
);
}
public function testFormatStrings() {
$formatter = $this->newCommentFormatter();
$result = $formatter->formatStrings(
[
'a' => 'A',
'b' => 'B'
],
new TitleValue( 0, 'Page' ),
true,
'enwiki'
);
$this->assertSame(
[
'a' => 'comment=A, selfLinkTarget=0:Page, samePage, wikiId=enwiki, enableSectionLinks',
'b' => 'comment=B, selfLinkTarget=0:Page, samePage, wikiId=enwiki, enableSectionLinks'
],
$result
);
}
public static function provideFormatRevision() {
$normal = ' <span class="comment">(' .
'comment=hello, selfLinkTarget=Page, !samePage, enableSectionLinks' .
')</span>';
$deleted = ' <span class="history-deleted comment"> ' .
'<span class="comment">(edit summary removed)</span></span>';
$deletedAllowed = ' <span class="history-deleted comment"> ' .
'<span class="comment">(' .
'comment=hello, selfLinkTarget=Page, !samePage, enableSectionLinks' .
')</span></span>';
return [
'not deleted' => [
'hello', false, false, false, true,
$normal,
],
'deleted, for public, not allowed' => [
'hello', true, true, false, true,
$deleted
],
'deleted, for public, allowed' => [
'hello', true, true, true, true,
$deleted
],
'deleted, for private, not allowed' => [
'hello', false, true, false, true,
$deleted
],
'deleted, for private, allowed' => [
'hello', false, true, true, true,
$deletedAllowed,
],
'empty' => [
'', false, false, false, true,
''
],
'asterisk' => [
'*', false, false, false, true,
''
]
];
}
/**
* @param string $text
* @param bool $isDeleted
* @param bool $isAllowed
* @return array<RevisionRecord|Authority>
*/
private function makeRevisionAndAuthority( $text, $isDeleted, $isAllowed ) {
$page = new PageIdentityValue( 1, 0, 'Page', false );
$rev = new MutableRevisionRecord( $page );
$comment = new CommentStoreComment( 1, $text );
$rev->setId( 100 );
$rev->setComment( $comment );
$rev->setVisibility( $isDeleted ? RevisionRecord::DELETED_COMMENT : 0 );
$user = new UserIdentityValue( 1, 'Sysop' );
$rights = $isAllowed ? [ 'deletedhistory' ] : [];
$authority = new SimpleAuthority( $user, $rights );
return [ $rev, $authority ];
}
/** @dataProvider provideFormatRevision */
public function testFormatRevision( $comment, $isPublic, $isDeleted, $isAllowed, $useParentheses,
$expected
) {
[ $rev, $authority ] = $this->makeRevisionAndAuthority(
$comment, $isDeleted, $isAllowed );
$formatter = $this->newCommentFormatter();
$result = $formatter->formatRevision(
$rev,
$authority,
false,
$isPublic
);
$this->assertSame(
$expected,
$result
);
}
/** @dataProvider provideFormatRevision */
public function testFormatRevisions( $comment, $isPublic, $isDeleted, $isAllowed, $useParentheses,
$expected
) {
[ $rev, $authority ] = $this->makeRevisionAndAuthority(
$comment, $isDeleted, $isAllowed );
$formatter = $this->newCommentFormatter();
$result = $formatter->formatRevisions(
[ 'key' => $rev ],
$authority,
false,
$isPublic
);
$this->assertSame(
[ 'key' => $expected ],
$result
);
}
public function testFormatRevisionsById() {
[ $rev, $authority ] = $this->makeRevisionAndAuthority(
'hello', false, false );
$formatter = $this->newCommentFormatter();
$result = $formatter->formatRevisions(
[ 'key' => $rev ],
$authority,
false,
false,
true,
true
);
$this->assertSame(
[ 100 => ' <span class="comment">(' .
'comment=hello, selfLinkTarget=Page, !samePage, enableSectionLinks' .
')</span>'
],
$result
);
}
/** @dataProvider provideFormatRevision */
public function testCreateRevisionBatch( $comment, $isPublic, $isDeleted, $isAllowed, $useParentheses,
$expected
) {
[ $rev, $authority ] = $this->makeRevisionAndAuthority(
$comment, $isDeleted, $isAllowed );
$formatter = $this->newCommentFormatter();
$result = $formatter->createRevisionBatch()
->authority( $authority )
->hideIfDeleted( $isPublic )
->useParentheses()
->revisions( [ 'key' => $rev ] )
->execute();
$this->assertSame(
[ 'key' => $expected ],
$result
);
}
public function testCreateRevisionBatchById() {
[ $rev, $authority ] = $this->makeRevisionAndAuthority(
'hello', false, false );
$formatter = $this->newCommentFormatter();
$result = $formatter->createRevisionBatch()
->authority( $authority )
->useParentheses()
->indexById()
->revisions( [ 'key' => $rev ] )
->execute();
$this->assertSame(
[ 100 => ' <span class="comment">(' .
'comment=hello, selfLinkTarget=Page, !samePage, enableSectionLinks' .
')</span>'
],
$result
);
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Oct 3, 19:09 (2 d, 8 h ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
63/31/f4fe76b1379b0439f26ff29d649f
Default Alt Text
CommentFormatterTest.php (8 KB)

Event Timeline