MagicVariableTest.php

Go to the documentation of this file.

<?php
class MagicVariableTest extends MediaWikiTestCase {
    private $testParser = null;

    private $expectedAsInteger = [
        'revisionday',
        'revisionmonth1',
    ];

    protected function setUp() {
        parent::setUp();

        $contLang = Language::factory( 'en' );
        $this->setMwGlobals( [
            'wgLanguageCode' => 'en',
            'wgContLang' => $contLang,
        ] );

        $this->testParser = new Parser();
        $this->testParser->Options( ParserOptions::newFromUserAndLang( new User, $contLang ) );

        # initialize parser output
        $this->testParser->clearState();

        # Needs a title to do magic word stuff
        $title = Title::newFromText( 'Tests' );
        # Else it needs a db connection just to check if it's a redirect
        # (when deciding the page language).
        $title->mRedirect = false;

        $this->testParser->setTitle( $title );
    }

    private static function createProviderUpTo( $num ) {
        $ret = [];
        for ( $i = 1; $i <= $num; $i++ ) {
            $ret[] = [ $i ];
        }

        return $ret;
    }

    public static function provideMonths() {
        return self::createProviderUpTo( 12 );
    }

    public static function provideDays() {
        return self::createProviderUpTo( 31 );
    }

    # ############## TESTS #############################################
    # @todo FIXME:
    #  - those got copy pasted, we can probably make them cleaner
    #  - tests are lacking useful messages

    # day

    public function testCurrentdayIsUnPadded( $day ) {
        $this->assertUnPadded( 'currentday', $day );
    }

    public function testCurrentdaytwoIsZeroPadded( $day ) {
        $this->assertZeroPadded( 'currentday2', $day );
    }

    public function testLocaldayIsUnPadded( $day ) {
        $this->assertUnPadded( 'localday', $day );
    }

    public function testLocaldaytwoIsZeroPadded( $day ) {
        $this->assertZeroPadded( 'localday2', $day );
    }

    # month

    public function testCurrentmonthIsZeroPadded( $month ) {
        $this->assertZeroPadded( 'currentmonth', $month );
    }

    public function testCurrentmonthoneIsUnPadded( $month ) {
        $this->assertUnPadded( 'currentmonth1', $month );
    }

    public function testLocalmonthIsZeroPadded( $month ) {
        $this->assertZeroPadded( 'localmonth', $month );
    }

    public function testLocalmonthoneIsUnPadded( $month ) {
        $this->assertUnPadded( 'localmonth1', $month );
    }

    # revision day

    public function testRevisiondayIsUnPadded( $day ) {
        $this->assertUnPadded( 'revisionday', $day );
    }

    public function testRevisiondaytwoIsZeroPadded( $day ) {
        $this->assertZeroPadded( 'revisionday2', $day );
    }

    # revision month

    public function testRevisionmonthIsZeroPadded( $month ) {
        $this->assertZeroPadded( 'revisionmonth', $month );
    }

    public function testRevisionmonthoneIsUnPadded( $month ) {
        $this->assertUnPadded( 'revisionmonth1', $month );
    }

    # ############## HELPERS ############################################

    public function assertZeroPadded( $magic, $value ) {
        $this->assertMagicPadding( $magic, $value, '%02d' );
    }

    public function assertUnPadded( $magic, $value ) {
        $this->assertMagicPadding( $magic, $value, '%d' );
    }

    private function assertMagicPadding( $magic, $value, $format ) {
        # Initialize parser timestamp as year 2010 at 12h34 56s.
        # month and day are given by the caller ($value). Month < 12!
        if ( $value > 12 ) {
            $month = $value % 12;
        } else {
            $month = $value;
        }

        $this->setParserTS(
            sprintf( '2010%02d%02d123456', $month, $value )
        );

        # please keep the following commented line of code. It helps debugging.
        // print "\nDEBUG (value $value):" . sprintf( '2010%02d%02d123456', $value, $value ) . "\n";

        # format expectation and test it
        $expected = sprintf( $format, $value );
        $this->assertMagic( $expected, $magic );
    }

    private function setParserTS( $ts ) {
        $this->testParser->Options()->setTimestamp( $ts );
        $this->testParser->mRevisionTimestamp = $ts;
    }

    private function assertMagic( $expected, $magic ) {
        if ( in_array( $magic, $this->expectedAsInteger ) ) {
            $expected = (int)$expected;
        }

        # Generate a message for the assertion
        $msg = sprintf( "Magic %s should be <%s:%s>",
            $magic,
            $expected,
            gettype( $expected )
        );

        $this->assertSame(
            $expected,
            $this->testParser->getVariableValue( $magic ),
            $msg
        );
    }
}