createNoOpMock( Parser::class, [ 'recursiveTagParse' ] );
$mockParser->method( 'recursiveTagParse' )->willReturnArgument( 0 );
$mockErrorReporter = $this->createMock( ErrorReporter::class );
$mockErrorReporter->method( 'plain' )->willReturnCallback(
static fn ( $parser, ...$args ) => '(' . implode( '|', $args ) . ')'
);
$mockMessageLocalizer = $this->createMock( ReferenceMessageLocalizer::class );
$mockMessageLocalizer->method( 'msg' )->willReturnCallback(
function ( ...$args ) {
$msg = $this->createMock( Message::class );
$msg->method( 'plain' )->willReturn( '(' . implode( '|', $args ) . ')' );
return $msg;
}
);
$formatter = new ReferencesFormatter(
$mockErrorReporter,
$this->createMock( AnchorFormatter::class ),
$mockMessageLocalizer
);
$output = $formatter->formatReferences( $mockParser, $refs, true, false );
$this->assertSame( $expectedOutput, $output );
}
public static function provideFormatReferences() {
return [
'Empty' => [
'refs' => [],
'expectedOutput' => ''
],
'Minimal ref' => [
'refs' => [
0 => [
'count' => 1,
'key' => 1,
'text' => 't',
]
],
'expectedOutput' => '' . "\n" .
'- (cite_references_link_one|||t' .
"\n|)
\n
' . "\n" .
'- (cite_references_link_one|||t1' . "\n" .
'|)
- (cite_references_link_one|||' .
't2' . "\n|)
\n" .
"
\n" .
'- (cite_references_link_one|||t3' .
"\n|)
\n" .
'
' . "\n" .
'- (cite_references_link_one|||t3' . "\n" .
'|)
- (cite_references_link_one|||' .
't1 (cite_error_ref_nested_extends|a|b)' .
"\n|)
\n" .
'- (cite_references_link_one|||t2' .
"\n|)
\n
\n" .
'
' .
"\n" . '- (cite_references_link_one|||t' .
"\n|)
\n" .
'- (cite_references_link_one|||t' .
"\n|)
\n" .
'- (cite_references_link_one|||t' .
"\n|)
\n" .
'- (cite_references_link_one|||t' .
"\n|)
\n" .
'- (cite_references_link_one|||t' .
"\n|)
\n" .
'- (cite_references_link_one|||t' .
"\n|)
\n" .
'- (cite_references_link_one|||t' .
"\n|)
\n" .
'- (cite_references_link_one|||t' .
"\n|)
\n" .
'- (cite_references_link_one|||t' .
"\n|)
\n" .
'- (cite_references_link_one|||t' .
"\n|)
\n" .
'- (cite_references_link_one|||t' .
"\n|)
\n
t\n
"
],
'Count one' => [
'ref' => [
'count' => 1,
'key' => 5,
'name' => 'a',
'text' => 't',
],
'expectedOutput' => '(cite_references_link_one|1-5|1+5-0|t'
. "\n|)"
],
'Anonymous' => [
'ref' => [
'count' => 1,
'key' => 5,
'number' => 3,
'text' => 't',
],
'expectedOutput' => '(cite_references_link_one|5|5+|t' . "\n|)"
],
'Count many' => [
'ref' => [
'count' => 3,
'key' => 5,
'name' => 'a',
'number' => 3,
'text' => 't',
],
'expectedOutput' => '(cite_references_link_many|1-5|(cite_references_link_many_format|1+5-0|3.0|' .
'(cite_references_link_many_format_backlink_labels))' .
'(cite_references_link_many_sep)(cite_references_link_many_format|1+5-1|3.1|' .
'(cite_error_references_no_backlink_label))(cite_references_link_many_and)' .
'(cite_references_link_many_format|1+5-2|3.2|(cite_error_references_no_backlink_label' .
'))|t' . "\n|)"
],
];
}
/**
* @dataProvider provideReferenceText
*/
public function testReferenceText(
?string $text,
bool $isSectionPreview,
string $expectedOutput
) {
$mockErrorReporter = $this->createMock( ErrorReporter::class );
$mockErrorReporter->method( 'plain' )->willReturnCallback(
static fn ( $parser, ...$args ) => '(' . implode( '|', $args ) . ')'
);
/** @var ReferencesFormatter $formatter */
$formatter = TestingAccessWrapper::newFromObject( new ReferencesFormatter(
$mockErrorReporter,
$this->createMock( AnchorFormatter::class ),
$this->createMock( ReferenceMessageLocalizer::class )
) );
$parser = $this->createNoOpMock( Parser::class );
$output = $formatter->referenceText( $parser, 1, [ 'text' => $text ], $isSectionPreview );
$this->assertSame( $expectedOutput, $output );
}
public static function provideReferenceText() {
return [
'No text, not preview' => [
'text' => null,
'isSectionPreview' => false,
'expectedOutput' => '(cite_error_references_no_text|1)'
],
'No text, is preview' => [
'text' => null,
'isSectionPreview' => true,
'expectedOutput' => '(cite_warning_sectionpreview_no_text|1)'
],
'Has text' => [
'text' => 'text',
'isSectionPreview' => true,
'expectedOutput' => 'text' . "\n"
],
'Trims text' => [
'text' => "text\n\n",
'isSectionPreview' => true,
'expectedOutput' => 'text' . "\n"
],
];
}
/**
* @dataProvider provideReferencesFormatEntryAlternateBacklinkLabel
*/
public function testReferencesFormatEntryAlternateBacklinkLabel(
?string $expectedLabel, ?string $labelList, int $offset
) {
$mockMessage = $this->createMock( Message::class );
$mockMessage->method( 'exists' )->willReturn( (bool)$labelList );
$mockMessage->method( 'plain' )->willReturn( $labelList ?? '' );
$mockMessageLocalizer = $this->createMock( ReferenceMessageLocalizer::class );
$mockMessageLocalizer->method( 'msg' )
->willReturn( $mockMessage );
$errorReporter = $this->createMock( ErrorReporter::class );
$errorReporter->expects( $expectedLabel ? $this->never() : $this->once() )
->method( 'plain' );
/** @var ReferencesFormatter $formatter */
$formatter = TestingAccessWrapper::newFromObject( new ReferencesFormatter(
$errorReporter,
$this->createMock( AnchorFormatter::class ),
$mockMessageLocalizer
) );
$parser = $this->createNoOpMock( Parser::class );
$label = $formatter->referencesFormatEntryAlternateBacklinkLabel( $parser, $offset );
if ( $expectedLabel !== null ) {
$this->assertSame( $expectedLabel, $label );
}
}
public static function provideReferencesFormatEntryAlternateBacklinkLabel() {
yield [ 'aa', 'aa ab ac', 0 ];
yield [ 'ab', 'aa ab ac', 1 ];
yield [ 'å', 'å b c', 0 ];
yield [ null, 'a b c', 10 ];
}
/**
* @dataProvider provideReferencesFormatEntryNumericBacklinkLabel
*/
public function testReferencesFormatEntryNumericBacklinkLabel(
string $expectedLabel, int $base, int $offset, int $max
) {
$mockMessageLocalizer = $this->createMock( ReferenceMessageLocalizer::class );
$mockMessageLocalizer->method( 'localizeSeparators' )->willReturnArgument( 0 );
$mockMessageLocalizer->method( 'localizeDigits' )->willReturnArgument( 0 );
/** @var ReferencesFormatter $formatter */
$formatter = TestingAccessWrapper::newFromObject( new ReferencesFormatter(
$this->createMock( ErrorReporter::class ),
$this->createMock( AnchorFormatter::class ),
$mockMessageLocalizer
) );
$label = $formatter->referencesFormatEntryNumericBacklinkLabel( $base, $offset, $max );
$this->assertSame( $expectedLabel, $label );
}
public static function provideReferencesFormatEntryNumericBacklinkLabel() {
yield [ '1.2', 1, 2, 9 ];
yield [ '1.02', 1, 2, 99 ];
yield [ '1.002', 1, 2, 100 ];
yield [ '1.50005', 1, 50005, 50005 ];
yield [ '2.1', 2, 1, 1 ];
}
/**
* @dataProvider provideLists
*/
public function testListToText( array $list, $expected ) {
$mockMessageLocalizer = $this->createMock( ReferenceMessageLocalizer::class );
$mockMessageLocalizer->method( 'msg' )->willReturnCallback(
function ( ...$args ) {
$msg = $this->createMock( Message::class );
$msg->method( 'plain' )->willReturn( '(' . implode( '|', $args ) . ')' );
return $msg;
}
);
/** @var ReferencesFormatter $formatter */
$formatter = TestingAccessWrapper::newFromObject( new ReferencesFormatter(
$this->createMock( ErrorReporter::class ),
$this->createMock( AnchorFormatter::class ),
$mockMessageLocalizer
) );
$this->assertSame( $expected, $formatter->listToText( $list ) );
}
public static function provideLists() {
return [
[
'list' => [],
'expected' => ''
],
[
// This is intentionally using numbers to test the to-string cast
'list' => [ 1 ],
'expected' => '1'
],
[
'list' => [ 1, 2 ],
'expected' => '1(cite_references_link_many_and)2'
],
[
'list' => [ 1, 2, 3 ],
'expected' => '1(cite_references_link_many_sep)2(cite_references_link_many_and)3'
],
];
}
}