createMock( Parser::class ); $mockParser->method( 'recursiveTagParse' )->willReturnArgument( 0 ); $mockErrorReporter = $this->createMock( ErrorReporter::class ); $mockErrorReporter->method( 'plain' )->willReturnCallback( function ( $parser, ...$args ) { return '(' . 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; } ); /** @var Parser $mockParser */ /** @var ErrorReporter $mockErrorReporter */ /** @var ReferenceMessageLocalizer $mockMessageLocalizer */ $formatter = new ReferencesFormatter( $mockErrorReporter, $this->createMock( AnchorFormatter::class ), $mockMessageLocalizer ); $output = $formatter->formatReferences( $mockParser, $refs, true, false ); $this->assertSame( $expectedOutput, $output ); } public function provideFormatReferences() { return [ 'Empty' => [ [], '' ], 'Minimal ref' => [ [ 0 => [ 'key' => 1, 'text' => 't', ] ], '

' . "\n" . '
1. (cite_references_link_many|||t' . "\n|)
\n

" ], 'Ref with extends' => [ [ 0 => [ 'extends' => 'a', 'extendsIndex' => 1, 'key' => 2, 'number' => 10, 'text' => 't2', ], 1 => [ 'number' => 11, 'text' => 't3', ], 'a' => [ 'key' => 1, 'number' => 9, 'text' => 't1', ], ], '

' . "\n" . '
1. (cite_references_link_many|||t1' . "\n" . '|)
   1. (cite_references_link_many|||' . 't2' . "\n|)
   \n" . "
\n" . '
2. (cite_references_link_many|||t3' . "\n|)
\n" . '

' ], 'Subref of subref' => [ [ 0 => [ 'extends' => 'a', 'extendsIndex' => 1, 'key' => 1, 'number' => 1, 'text' => 't1', ], 'a' => [ 'extends' => 'b', 'extendsIndex' => 1, 'key' => 2, 'number' => 1, 'text' => 't2', ], 'b' => [ 'key' => 3, 'number' => 1, 'text' => 't3', ], ], '

' . "\n" . '
1. (cite_references_link_many|||t3' . "\n" . '|)
   1. (cite_references_link_many|||' . 't1 (cite_error_ref_too_many_keys)' . "\n|)
   \n" . '
   2. (cite_references_link_many|||t2' . "\n|)
   \n
\n" . '

' ], 'Use columns' => [ array_map( function ( $i ) { return [ 'key' => $i, 'text' => 't' ]; }, range( 0, 10 ) ), '

' . "\n" . '
1. (cite_references_link_many|||t' . "\n|)
\n" . '
2. (cite_references_link_many|||t' . "\n|)
\n" . '
3. (cite_references_link_many|||t' . "\n|)
\n" . '
4. (cite_references_link_many|||t' . "\n|)
\n" . '
5. (cite_references_link_many|||t' . "\n|)
\n" . '
6. (cite_references_link_many|||t' . "\n|)
\n" . '
7. (cite_references_link_many|||t' . "\n|)
\n" . '
8. (cite_references_link_many|||t' . "\n|)
\n" . '
9. (cite_references_link_many|||t' . "\n|)
\n" . '
10. (cite_references_link_many|||t' . "\n|)
\n" . '
11. (cite_references_link_many|||t' . "\n|)
\n

" ], ]; } /** * @covers ::closeIndention * @dataProvider provideCloseIndention */ public function testCloseIndention( $closingLi, $expectedOutput ) { /** @var ReferencesFormatter $formatter */ $formatter = TestingAccessWrapper::newFromObject( new ReferencesFormatter( $this->createMock( ErrorReporter::class ), $this->createMock( AnchorFormatter::class ), $this->createMock( ReferenceMessageLocalizer::class ) ) ); $output = $formatter->closeIndention( $closingLi ); $this->assertSame( $expectedOutput, $output ); } public function provideCloseIndention() { return [ 'No indention' => [ false, '' ], 'Indention string' => [ "\n", "\n" ], 'Indention without string' => [ true, '' ], ]; } /** * @covers ::formatListItem * @dataProvider provideFormatListItem */ public function testFormatListItem( $key, array $val, string $expectedOutput ) { $mockErrorReporter = $this->createMock( ErrorReporter::class ); $mockErrorReporter->method( 'plain' )->willReturnCallback( function ( $parser, ...$args ) { return '(' . implode( '|', $args ) . ')'; } ); $anchorFormatter = $this->createMock( AnchorFormatter::class ); $anchorFormatter->method( 'refKey' )->willReturnCallback( function ( ...$args ) { return implode( '+', $args ); } ); $mockMessageLocalizer = $this->createMock( ReferenceMessageLocalizer::class ); $mockMessageLocalizer->method( 'formatNum' )->willReturnArgument( 0 ); $mockMessageLocalizer->method( 'localizeDigits' )->willReturnArgument( 0 ); $mockMessageLocalizer->method( 'msg' )->willReturnCallback( function ( ...$args ) { $msg = $this->createMock( Message::class ); $msg->method( 'plain' )->willReturn( '(' . implode( '|', $args ) . ')' ); return $msg; } ); /** @var ErrorReporter $mockErrorReporter */ /** @var AnchorFormatter $anchorFormatter */ /** @var ReferenceMessageLocalizer $mockMessageLocalizer */ $formatter = TestingAccessWrapper::newFromObject( new ReferencesFormatter( $mockErrorReporter, $anchorFormatter, $mockMessageLocalizer ) ); /** @var ReferencesFormatter $formatter */ $output = $formatter->formatListItem( $this->createMock( Parser::class ), $key, $val, false ); $this->assertSame( $expectedOutput, $output ); } public function provideFormatListItem() { return [ 'Success' => [ 1, [ 'text' => 't', ], '(cite_references_link_many|||t' . "\n" . '|)' ], 'Good dir' => [ 1, [ 'dir' => 'rtl', 'text' => 't', ], '(cite_references_link_many|||t' . "\n" . '| class="mw-cite-dir-rtl")' ], 'Invalid dir' => [ 1, [ 'dir' => 'not', 'text' => 't', ], '(cite_references_link_many|||t' . "\n" . '(cite_error_ref_invalid_dir|not)' . "\n|)" ], 'Broken follow' => [ 1, [ 'follow' => 'f', 'text' => 't', ], '(cite_references_no_link||t' . "\n)" ], 'Count zero' => [ 1, [ 'count' => 0, 'key' => 5, 'text' => 't', ], '(cite_references_link_one||1+5-0|t' . "\n|)" ], 'Count negative' => [ 1, [ 'count' => -1, 'key' => 5, 'number' => 3, 'text' => 't', ], '(cite_references_link_one||5+|t' . "\n|)" ], 'Count positive' => [ 1, [ 'count' => 2, 'key' => 5, 'number' => 3, 'text' => 't', ], '(cite_references_link_many||(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|)" ], ]; } /** * @covers ::referenceText * @dataProvider provideReferenceText */ public function testReferenceText( $key, ?string $text, bool $isSectionPreview, string $expectedOutput ) { $mockErrorReporter = $this->createMock( ErrorReporter::class ); $mockErrorReporter->method( 'plain' )->willReturnCallback( function ( $parser, ...$args ) { return '(' . implode( '|', $args ) . ')'; } ); /** @var ErrorReporter $mockErrorReporter */ /** @var ReferencesFormatter $formatter */ $formatter = TestingAccessWrapper::newFromObject( new ReferencesFormatter( $mockErrorReporter, $this->createMock( AnchorFormatter::class ), $this->createMock( ReferenceMessageLocalizer::class ) ) ); $output = $formatter->referenceText( $this->createMock( Parser::class ), $key, $text, $isSectionPreview ); $this->assertSame( $expectedOutput, $output ); } public function provideReferenceText() { return [ 'No text, not preview' => [ 1, null, false, '(cite_error_references_no_text|1)' ], 'No text, is preview' => [ 1, null, true, '(cite_warning_sectionpreview_no_text|1)' ], 'Has text' => [ 1, 'text', true, 'text' . "\n" ], 'Trims text' => [ 1, "text\n\n", true, 'text' . "\n" ], ]; } /** * @covers ::referencesFormatEntryAlternateBacklinkLabel * @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 ); $mockErrorReporter = $this->createMock( ErrorReporter::class ); if ( $expectedLabel === null ) { $mockErrorReporter->expects( $this->once() )->method( 'plain' ); } else { $mockErrorReporter->expects( $this->never() )->method( 'plain' ); } /** @var ErrorReporter $mockErrorReporter */ /** @var ReferenceMessageLocalizer $mockMessageLocalizer */ /** @var ReferencesFormatter $formatter */ $formatter = TestingAccessWrapper::newFromObject( new ReferencesFormatter( $mockErrorReporter, $this->createMock( AnchorFormatter::class ), $mockMessageLocalizer ) ); $label = $formatter->referencesFormatEntryAlternateBacklinkLabel( $this->createMock( Parser::class ), $offset ); if ( $expectedLabel !== null ) { $this->assertSame( $expectedLabel, $label ); } } public function provideReferencesFormatEntryAlternateBacklinkLabel() { yield [ 'aa', 'aa ab ac', 0 ]; yield [ 'ab', 'aa ab ac', 1 ]; yield [ 'å', 'å b c', 0 ]; yield [ null, 'a b c', 10 ]; } /** * @covers ::referencesFormatEntryNumericBacklinkLabel * @dataProvider provideReferencesFormatEntryNumericBacklinkLabel */ public function testReferencesFormatEntryNumericBacklinkLabel( string $expectedLabel, int $base, int $offset, int $max ) { $mockMessageLocalizer = $this->createMock( ReferenceMessageLocalizer::class ); $mockMessageLocalizer->method( 'formatNum' )->willReturnArgument( 0 ); $mockMessageLocalizer->method( 'localizeDigits' )->willReturnArgument( 0 ); /** @var ReferenceMessageLocalizer $mockMessageLocalizer */ /** @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 function provideReferencesFormatEntryNumericBacklinkLabel() { yield [ '1.2', 1, 2, 9 ]; yield [ '1.02', 1, 2, 99 ]; yield [ '1.002', 1, 2, 100 ]; yield [ '2.1', 2, 1, 1 ]; } /** * @covers ::listToText * @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 ReferenceMessageLocalizer $mockMessageLocalizer */ /** @var ReferencesFormatter $formatter */ $formatter = TestingAccessWrapper::newFromObject( new ReferencesFormatter( $this->createMock( ErrorReporter::class ), $this->createMock( AnchorFormatter::class ), $mockMessageLocalizer ) ); $this->assertSame( $expected, $formatter->listToText( $list ) ); } public function provideLists() { return [ [ [], '' ], [ // This is intentionally using numbers to test the to-string cast [ 1 ], '1' ], [ [ 1, 2 ], '1(cite_references_link_many_and)2' ], [ [ 1, 2, 3 ], '1(cite_references_link_many_sep)2(cite_references_link_many_and)3' ], ]; } }