DateViewHelperTest.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Fluid\Tests\Unit\ViewHelpers\Format;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use TYPO3\CMS\Fluid\Core\ViewHelper\Exception;
use TYPO3\CMS\Fluid\ViewHelpers\Format\DateViewHelper;
use TYPO3\TestingFramework\Fluid\Unit\ViewHelpers\ViewHelperBaseTestcase;

class DateViewHelperTest extends ViewHelperBaseTestcase
{
    protected $subject;

    protected $timezone;

    protected $viewHelper;

    protected function setUp()
    {
        parent::setUp();
        $this->timezone = @date_default_timezone_get();
        $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'] = 'Y-m-d';
        $this->viewHelper = new DateViewHelper();
        $this->injectDependenciesIntoViewHelper($this->viewHelper);
    }

    protected function tearDown()
    {
        date_default_timezone_set($this->timezone);
        parent::tearDown();
    }

    public function viewHelperFormatsDateCorrectly()
    {
        $this->setArgumentsUnderTest(
            $this->viewHelper,
            [
                'date' => new \DateTime('1980-12-13')
            ]
        );
        $actualResult = $this->viewHelper->initializeArgumentsAndRender();
        $this->assertEquals('1980-12-13', $actualResult);
    }

    public function viewHelperFormatsDateStringCorrectly()
    {
        $this->setArgumentsUnderTest(
            $this->viewHelper,
            [
                'date' => '1980-12-13'
            ]
        );
        $actualResult = $this->viewHelper->initializeArgumentsAndRender();
        $this->assertEquals('1980-12-13', $actualResult);
    }

    public function viewHelperRespectsCustomFormat()
    {
        $this->setArgumentsUnderTest(
            $this->viewHelper,
            [
                'date' => new \DateTime('1980-02-01'),
                'format' => 'd.m.Y'
            ]
        );
        $actualResult = $this->viewHelper->initializeArgumentsAndRender();
        $this->assertEquals('01.02.1980', $actualResult);
    }

    public function viewHelperSupportsDateTimeImmutable()
    {
        $this->setArgumentsUnderTest(
            $this->viewHelper,
            [
                'date' => new \DateTimeImmutable('1980-02-01'),
                'format' => 'd.m.Y'
            ]
        );
        $actualResult = $this->viewHelper->initializeArgumentsAndRender();
        $this->assertEquals('01.02.1980', $actualResult);
    }

    public function viewHelperReturnsEmptyStringIfChildrenIsNULL()
    {
        $this->viewHelper->setRenderChildrenClosure(
            function () {
                return null;
            }
        );
        $this->setArgumentsUnderTest(
            $this->viewHelper,
            [
            ]
        );
        $actualResult = $this->viewHelper->initializeArgumentsAndRender();
        $this->assertEquals('', $actualResult);
    }

    public function viewHelperReturnsCurrentDateIfEmptyStringIsGiven()
    {
        $this->setArgumentsUnderTest(
            $this->viewHelper,
            [
                'date' => ''
            ]
        );
        $actualResult = $this->viewHelper->initializeArgumentsAndRender();
        $expectedResult = (new \DateTime())->format('Y-m-d');
        $this->assertEquals($expectedResult, $actualResult);
    }

    public function viewHelperReturnsCurrentDateIfChildrenIsEmptyString()
    {
        $this->viewHelper->setRenderChildrenClosure(
            function () {
                return '';
            }
        );
        $this->setArgumentsUnderTest(
            $this->viewHelper,
            [
            ]
        );
        $actualResult = $this->viewHelper->initializeArgumentsAndRender();
        $expectedResult = (new \DateTime())->format('Y-m-d');
        $this->assertEquals($expectedResult, $actualResult);
    }

    public function viewHelperUsesDefaultIfNoSystemFormatIsAvailable()
    {
        $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'] = '';
        $this->setArgumentsUnderTest(
            $this->viewHelper,
            [
                'date' => '@1391876733'
            ]
        );
        $actualResult = $this->viewHelper->initializeArgumentsAndRender();
        $this->assertEquals('2014-02-08', $actualResult);
    }

    public function viewHelperUsesSystemFormat()
    {
        $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'] = 'l, j. M y';
        $this->setArgumentsUnderTest(
            $this->viewHelper,
            [
                'date' => '@1391876733'
            ]
        );
        $actualResult = $this->viewHelper->initializeArgumentsAndRender();
        $this->assertEquals('Saturday, 8. Feb 14', $actualResult);
    }

    public function viewHelperThrowsExceptionWithOriginalMessageIfDateStringCantBeParsed()
    {
        $this->expectException(Exception::class);
        $this->expectExceptionCode(1241722579);

        $this->setArgumentsUnderTest(
            $this->viewHelper,
            [
                'date' => 'foo'
            ]
        );
        $this->viewHelper->initializeArgumentsAndRender();
    }

    public function viewHelperUsesChildNodesIfDateAttributeIsNotSpecified()
    {
        $this->viewHelper->setRenderChildrenClosure(
            function () {
                return new \DateTime('1980-12-13');
            }
        );
        $this->setArgumentsUnderTest(
            $this->viewHelper,
            [
            ]
        );
        $actualResult = $this->viewHelper->initializeArgumentsAndRender();
        $this->assertEquals('1980-12-13', $actualResult);
    }

    public function viewHelperUsesChildNodesWithTimestamp()
    {
        $this->viewHelper->setRenderChildrenClosure(
            function () {
                return '1359891658' . LF;
            }
        );
        $this->setArgumentsUnderTest(
            $this->viewHelper,
            [
            ]
        );
        $actualResult = $this->viewHelper->initializeArgumentsAndRender();
        $this->assertEquals('2013-02-03', $actualResult);
    }

    public function dateArgumentHasPriorityOverChildNodes()
    {
        $this->setArgumentsUnderTest(
            $this->viewHelper,
            [
                'date' => '1980-12-12'
            ]
        );
        $actualResult = $this->viewHelper->initializeArgumentsAndRender();
        $this->assertEquals('1980-12-12', $actualResult);
    }

    public function relativeDateCalculationWorksWithoutBase()
    {
        $this->setArgumentsUnderTest(
            $this->viewHelper,
            [
                'date' => 'now',
                'format' => 'Y',
            ]
        );
        $actualResult = $this->viewHelper->initializeArgumentsAndRender();
        $this->assertEquals(date('Y'), $actualResult);
    }

    public function baseArgumentIsConsideredForRelativeDate()
    {
        $this->setArgumentsUnderTest(
            $this->viewHelper,
            [
                'date' => '-1 year',
                'format' => 'Y',
                'base' => '2017-01-01'
            ]
        );
        $actualResult = $this->viewHelper->initializeArgumentsAndRender();
        $this->assertEquals('2016', $actualResult);
    }

    public function baseArgumentAsDateTimeIsConsideredForRelativeDate()
    {
        $this->setArgumentsUnderTest(
            $this->viewHelper,
            [
                'date' => '-1 year',
                'format' => 'Y',
                'base' => new \DateTime('2017-01-01')
            ]
        );
        $actualResult = $this->viewHelper->initializeArgumentsAndRender();
        $this->assertEquals('2016', $actualResult);
    }

    public function baseArgumentDoesNotAffectAbsoluteTime()
    {
        $this->setArgumentsUnderTest(
            $this->viewHelper,
            [
                'date' => '@1435784732',
                'format' => 'Y',
                'base' => 1485907200
            ]
        );
        $actualResult = $this->viewHelper->initializeArgumentsAndRender();
        $this->assertEquals('2015', $actualResult);
    }

    public function viewHelperRespectsDefaultTimezoneForIntegerTimestampDataProvider()
    {
        return [
            'Europe/Berlin' => [
                'Europe/Berlin',
                '2013-02-03 12:40',
            ],
            'Asia/Riyadh' => [
                'Asia/Riyadh',
                '2013-02-03 14:40',
            ],
        ];
    }

    public function viewHelperRespectsDefaultTimezoneForIntegerTimestamp($timezone, $expected)
    {
        $date = 1359891658; // 2013-02-03 11:40 UTC
        $format = 'Y-m-d H:i';

        date_default_timezone_set($timezone);
        $this->setArgumentsUnderTest(
            $this->viewHelper,
            [
                'date' => $date,
                'format' => $format
            ]
        );
        $actualResult = $this->viewHelper->initializeArgumentsAndRender();
        $this->assertEquals($expected, $actualResult);
    }

    public function viewHelperRespectsDefaultTimezoneForStringTimestampDataProvider()
    {
        return [
            'Europe/Berlin UTC' => [
                'Europe/Berlin',
                '@1359891658',
                '2013-02-03 12:40'
            ],
            'Europe/Berlin Moscow' => [
                'Europe/Berlin',
                '03/Oct/2000:14:55:36 +0400',
                '2000-10-03 12:55'
            ],
            'Asia/Riyadh UTC' => [
                'Asia/Riyadh',
                '@1359891658',
                '2013-02-03 14:40'
            ],
            'Asia/Riyadh Moscow' => [
                'Asia/Riyadh',
                '03/Oct/2000:14:55:36 +0400',
                '2000-10-03 13:55'
            ],
        ];
    }

    public function viewHelperRespectsDefaultTimezoneForStringTimestamp($timeZone, $date, $expected)
    {
        $format = 'Y-m-d H:i';

        date_default_timezone_set($timeZone);
        $this->setArgumentsUnderTest(
            $this->viewHelper,
            [
                'date' => $date,
                'format' => $format
            ]
        );
        $actualResult = $this->viewHelper->initializeArgumentsAndRender();
        $this->assertEquals($expected, $actualResult);
    }

    public function dateViewHelperFormatsDateLocalizedDataProvider()
    {
        return [
            'de_DE.UTF-8' => [
                'de_DE.UTF-8',
                '03. Februar 2013'
            ],
            'en_ZW.utf8' => [
                'en_ZW.utf8',
                '03. February 2013'
            ]
        ];
    }

    public function dateViewHelperFormatsDateLocalized($locale, $expected)
    {
        $format = '%d. %B %Y';
        // 2013-02-03 11:40 UTC
        $timestamp = '@1359891658';

        try {
            $this->setLocale(LC_COLLATE, $locale);
            $this->setLocale(LC_CTYPE, $locale);
            $this->setLocale(LC_MONETARY, $locale);
            $this->setLocale(LC_TIME, $locale);
        } catch (\PHPUnit\Framework\Exception $e) {
            $this->markTestSkipped('Locale ' . $locale . ' is not available.');
        }
        $this->setArgumentsUnderTest(
            $this->viewHelper,
            [
                'date' => $timestamp,
                'format' => $format
            ]
        );
        $actualResult = $this->viewHelper->initializeArgumentsAndRender();
        $this->assertEquals($expected, $actualResult);
    }
}