WikitextContentTest.php

Go to the documentation of this file.

<?php

class WikitextContentTest extends TextContentTest {
    public static $sections = "Intro

== stuff ==
hello world

== test ==
just a test

== foo ==
more stuff
";

    public function newContent( $text ) {
        return new WikitextContent( $text );
    }

    public static function dataGetParserOutput() {
        return [
            [
                "WikitextContentTest_testGetParserOutput",
                CONTENT_MODEL_WIKITEXT,
                "hello ''world''\n",
                "<p>hello <i>world</i>\n</p>"
            ],
            // TODO: more...?
        ];
    }

    public static function dataGetSecondaryDataUpdates() {
        return [
            [ "WikitextContentTest_testGetSecondaryDataUpdates_1",
                CONTENT_MODEL_WIKITEXT, "hello ''world''\n",
                [
                    'LinksUpdate' => [
                        'mRecursive' => true,
                        'mLinks' => []
                    ]
                ]
            ],
            [ "WikitextContentTest_testGetSecondaryDataUpdates_2",
                CONTENT_MODEL_WIKITEXT, "hello [[world test 21344]]\n",
                [
                    'LinksUpdate' => [
                        'mRecursive' => true,
                        'mLinks' => [
                            [ 'World_test_21344' => 0 ]
                        ]
                    ]
                ]
            ],
            // TODO: more...?
        ];
    }

    public function testGetSecondaryDataUpdates( $title, $model, $text, $expectedStuff ) {
        $ns = $this->getDefaultWikitextNS();
        $title = Title::newFromText( $title, $ns );

        $content = ContentHandler::makeContent( $text, $title, $model );

        $page = WikiPage::factory( $title );
        $page->doEditContent( $content, '' );

        $updates = $content->getSecondaryDataUpdates( $title );

        // make updates accessible by class name
        foreach ( $updates as $update ) {
            $class = get_class( $update );
            $updates[$class] = $update;
        }

        foreach ( $expectedStuff as $class => $fieldValues ) {
            $this->assertArrayHasKey( $class, $updates, "missing an update of type $class" );

            $update = $updates[$class];

            foreach ( $fieldValues as $field => $value ) {
                $v = $update->$field; # if the field doesn't exist, just crash and burn
                $this->assertEquals(
                    $value,
                    $v,
                    "unexpected value for field $field in instance of $class"
                );
            }
        }

        $page->doDeleteArticle( '' );
    }

    public static function dataGetSection() {
        return [
            [ WikitextContentTest::$sections,
                "0",
                "Intro"
            ],
            [ WikitextContentTest::$sections,
                "2",
                "== test ==
just a test"
            ],
            [ WikitextContentTest::$sections,
                "8",
                false
            ],
        ];
    }

    public function testGetSection( $text, $sectionId, $expectedText ) {
        $content = $this->newContent( $text );

        $sectionContent = $content->getSection( $sectionId );
        if ( is_object( $sectionContent ) ) {
            $sectionText = $sectionContent->getNativeData();
        } else {
            $sectionText = $sectionContent;
        }

        $this->assertEquals( $expectedText, $sectionText );
    }

    public static function dataReplaceSection() {
        return [
            [ WikitextContentTest::$sections,
                "0",
                "No more",
                null,
                trim( preg_replace( '/^Intro/sm', 'No more', WikitextContentTest::$sections ) )
            ],
            [ WikitextContentTest::$sections,
                "",
                "No more",
                null,
                "No more"
            ],
            [ WikitextContentTest::$sections,
                "2",
                "== TEST ==\nmore fun",
                null,
                trim( preg_replace(
                    '/^== test ==.*== foo ==/sm', "== TEST ==\nmore fun\n\n== foo ==",
                    WikitextContentTest::$sections
                ) )
            ],
            [ WikitextContentTest::$sections,
                "8",
                "No more",
                null,
                WikitextContentTest::$sections
            ],
            [ WikitextContentTest::$sections,
                "new",
                "No more",
                "New",
                trim( WikitextContentTest::$sections ) . "\n\n\n== New ==\n\nNo more"
            ],
        ];
    }

    public function testReplaceSection( $text, $section, $with, $sectionTitle, $expected ) {
        $content = $this->newContent( $text );
        $c = $content->replaceSection( $section, $this->newContent( $with ), $sectionTitle );

        $this->assertEquals( $expected, is_null( $c ) ? null : $c->getNativeData() );
    }

    public function testAddSectionHeader() {
        $content = $this->newContent( 'hello world' );
        $content = $content->addSectionHeader( 'test' );

        $this->assertEquals( "== test ==\n\nhello world", $content->getNativeData() );
    }

    public static function dataPreSaveTransform() {
        return [
            [ 'hello this is ~~~',
                "hello this is [[Special:Contributions/127.0.0.1|127.0.0.1]]",
            ],
            [ 'hello \'\'this\'\' is <nowiki>~~~</nowiki>',
                'hello \'\'this\'\' is <nowiki>~~~</nowiki>',
            ],
            [ // rtrim
                " Foo \n ",
                " Foo",
            ],
        ];
    }

    public static function dataPreloadTransform() {
        return [
            [
                'hello this is ~~~',
                "hello this is ~~~",
            ],
            [
                'hello \'\'this\'\' is <noinclude>foo</noinclude><includeonly>bar</includeonly>',
                'hello \'\'this\'\' is bar',
            ],
        ];
    }

    public static function dataGetRedirectTarget() {
        return [
            [ '#REDIRECT [[Test]]',
                'Test',
            ],
            [ '#REDIRECT Test',
                null,
            ],
            [ '* #REDIRECT [[Test]]',
                null,
            ],
        ];
    }

    public static function dataGetTextForSummary() {
        return [
            [ "hello\nworld.",
                16,
                'hello world.',
            ],
            [ 'hello world.',
                8,
                'hello...',
            ],
            [ '[[hello world]].',
                8,
                'hel...',
            ],
        ];
    }

    public static function dataIsCountable() {
        return [
            [ '',
                null,
                'any',
                true
            ],
            [ 'Foo',
                null,
                'any',
                true
            ],
            [ 'Foo',
                null,
                'comma',
                false
            ],
            [ 'Foo, bar',
                null,
                'comma',
                true
            ],
            [ 'Foo',
                null,
                'link',
                false
            ],
            [ 'Foo [[bar]]',
                null,
                'link',
                true
            ],
            [ 'Foo',
                true,
                'link',
                true
            ],
            [ 'Foo [[bar]]',
                false,
                'link',
                false
            ],
            [ '#REDIRECT [[bar]]',
                true,
                'any',
                false
            ],
            [ '#REDIRECT [[bar]]',
                true,
                'comma',
                false
            ],
            [ '#REDIRECT [[bar]]',
                true,
                'link',
                false
            ],
        ];
    }

    public function testMatchMagicWord() {
        $mw = MagicWord::get( "staticredirect" );

        $content = $this->newContent( "#REDIRECT [[FOO]]\n__STATICREDIRECT__" );
        $this->assertTrue( $content->matchMagicWord( $mw ), "should have matched magic word" );

        $content = $this->newContent( "#REDIRECT [[FOO]]" );
        $this->assertFalse(
            $content->matchMagicWord( $mw ),
            "should not have matched magic word"
        );
    }

    public function testUpdateRedirect() {
        $target = Title::newFromText( "testUpdateRedirect_target" );

        // test with non-redirect page
        $content = $this->newContent( "hello world." );
        $newContent = $content->updateRedirect( $target );

        $this->assertTrue( $content->equals( $newContent ), "content should be unchanged" );

        // test with actual redirect
        $content = $this->newContent( "#REDIRECT [[Someplace]]" );
        $newContent = $content->updateRedirect( $target );

        $this->assertFalse( $content->equals( $newContent ), "content should have changed" );
        $this->assertTrue( $newContent->isRedirect(), "new content should be a redirect" );

        $this->assertEquals(
            $target->getFullText(),
            $newContent->getRedirectTarget()->getFullText()
        );
    }

    public function testGetModel() {
        $content = $this->newContent( "hello world." );

        $this->assertEquals( CONTENT_MODEL_WIKITEXT, $content->getModel() );
    }

    public function testGetContentHandler() {
        $content = $this->newContent( "hello world." );

        $this->assertEquals( CONTENT_MODEL_WIKITEXT, $content->getContentHandler()->getModelID() );
    }

    public function testRedirectParserOption() {
        $title = Title::newFromText( 'testRedirectParserOption' );

        // Set up hook and its reporting variables
        $wikitext = null;
        $redirectTarget = null;
        $this->mergeMwGlobalArrayValue( 'wgHooks', [
            'InternalParseBeforeLinks' => [
                function ( &$parser, &$text, &$stripState ) use ( &$wikitext, &$redirectTarget ) {
                    $wikitext = $text;
                    $redirectTarget = $parser->getOptions()->getRedirectTarget();
                }
            ]
        ] );

        // Test with non-redirect page
        $wikitext = false;
        $redirectTarget = false;
        $content = $this->newContent( 'hello world.' );
        $options = $content->getContentHandler()->makeParserOptions( 'canonical' );
        $options->setRedirectTarget( $title );
        $content->getParserOutput( $title, null, $options );
        $this->assertEquals( 'hello world.', $wikitext,
            'Wikitext passed to hook was not as expected'
        );
        $this->assertEquals( null, $redirectTarget, 'Redirect seen in hook was not null' );
        $this->assertEquals( $title, $options->getRedirectTarget(),
            'ParserOptions\' redirectTarget was changed'
        );

        // Test with a redirect page
        $wikitext = false;
        $redirectTarget = false;
        $content = $this->newContent(
            "#REDIRECT [[TestRedirectParserOption/redir]]\nhello redirect."
        );
        $options = $content->getContentHandler()->makeParserOptions( 'canonical' );
        $content->getParserOutput( $title, null, $options );
        $this->assertEquals(
            'hello redirect.',
            $wikitext,
            'Wikitext passed to hook was not as expected'
        );
        $this->assertNotEquals(
            null,
            $redirectTarget,
            'Redirect seen in hook was null' );
        $this->assertEquals(
            'TestRedirectParserOption/redir',
            $redirectTarget->getFullText(),
            'Redirect seen in hook was not the expected title'
        );
        $this->assertEquals(
            null,
            $options->getRedirectTarget(),
            'ParserOptions\' redirectTarget was changed'
        );
    }

    public static function dataEquals() {
        return [
            [ new WikitextContent( "hallo" ), null, false ],
            [ new WikitextContent( "hallo" ), new WikitextContent( "hallo" ), true ],
            [ new WikitextContent( "hallo" ), new JavaScriptContent( "hallo" ), false ],
            [ new WikitextContent( "hallo" ), new TextContent( "hallo" ), false ],
            [ new WikitextContent( "hallo" ), new WikitextContent( "HALLO" ), false ],
        ];
    }

    public static function dataGetDeletionUpdates() {
        return [
            [ "WikitextContentTest_testGetSecondaryDataUpdates_1",
                CONTENT_MODEL_WIKITEXT, "hello ''world''\n",
                [ 'LinksDeletionUpdate' => [] ]
            ],
            [ "WikitextContentTest_testGetSecondaryDataUpdates_2",
                CONTENT_MODEL_WIKITEXT, "hello [[world test 21344]]\n",
                [ 'LinksDeletionUpdate' => [] ]
            ],
            // @todo more...?
        ];
    }
}