DateTimeConverterTest.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Extbase\Tests\Unit\Property\TypeConverter;

/*                                                                        *
 * This script belongs to the Extbase framework.                            *
 *                                                                        *
 * It is free software; you can redistribute it and/or modify it under    *
 * the terms of the GNU Lesser General Public License as published by the *
 * Free Software Foundation, either version 3 of the License, or (at your *
 * option) any later version.                                             *
 *                                                                        *
 * This script is distributed in the hope that it will be useful, but     *
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHAN-    *
 * TABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser       *
 * General Public License for more details.                               *
 *                                                                        *
 * You should have received a copy of the GNU Lesser General Public       *
 * License along with the script.                                         *
 * If not, see http://www.gnu.org/licenses/lgpl.html                      *
 *                                                                        *
 * The TYPO3 project - inspiring people to share!                         *
 *                                                                        */

class DateTimeConverterTest extends \TYPO3\CMS\Core\Tests\UnitTestCase {

    protected $converter;

    public function setUp() {
        $this->converter = new \TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter();
    }

    public function checkMetadata() {
        $this->assertEquals(array('string', 'integer', 'array'), $this->converter->getSupportedSourceTypes(), 'Source types do not match');
        $this->assertEquals('DateTime', $this->converter->getSupportedTargetType(), 'Target type does not match');
        $this->assertEquals(1, $this->converter->getPriority(), 'Priority does not match');
    }


    public function canConvertFromReturnsFalseIfTargetTypeIsNotDateTime() {
        $this->assertFalse($this->converter->canConvertFrom('Foo', 'SomeOtherType'));
    }

    public function canConvertFromReturnsTrueIfSourceTypeIsAString() {
        $this->assertTrue($this->converter->canConvertFrom('Foo', 'DateTime'));
    }

    public function canConvertFromReturnsTrueIfSourceTypeIsAnEmptyString() {
        $this->assertTrue($this->converter->canConvertFrom('', 'DateTime'));
    }

    public function convertFromReturnsErrorIfGivenStringCantBeConverted() {
        $error = $this->converter->convertFrom('1980-12-13', 'DateTime');
        $this->assertInstanceOf('TYPO3\\CMS\\Extbase\\Error\\Error', $error);
    }

    public function convertFromProperlyConvertsStringWithDefaultDateFormat() {
        $expectedResult = '1980-12-13T20:15:07+01:23';
        $date = $this->converter->convertFrom($expectedResult, 'DateTime');
        $actualResult = $date->format('Y-m-d\\TH:i:sP');
        $this->assertSame($expectedResult, $actualResult);
    }

    public function convertFromUsesDefaultDateFormatIfItIsNotConfigured() {
        $expectedResult = '1980-12-13T20:15:07+01:23';
        $mockMappingConfiguration = $this->getMock('TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface');
        $mockMappingConfiguration
                ->expects($this->atLeastOnce())
                ->method('getConfigurationValue')
                ->with('TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter', \TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter::CONFIGURATION_DATE_FORMAT)
                ->will($this->returnValue(NULL));

        $date = $this->converter->convertFrom($expectedResult, 'DateTime', array(), $mockMappingConfiguration);
        $actualResult = $date->format(\TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter::DEFAULT_DATE_FORMAT);
        $this->assertSame($expectedResult, $actualResult);
    }

    public function convertFromEmptyStringReturnsNull() {
        $date = $this->converter->convertFrom('', 'DateTime', array(), NULL);
        $this->assertNull($date);
    }

    public function convertFromStringDataProvider() {
        return array(
            array('1308174051', '', FALSE),
            array('13-12-1980', 'd.m.Y', FALSE),
            array('1308174051', 'Y-m-d', FALSE),
            array('12:13', 'H:i', TRUE),
            array('13.12.1980', 'd.m.Y', TRUE),
            array('2005-08-15T15:52:01+00:00', NULL, TRUE),
            array('2005-08-15T15:52:01+0000', \DateTime::ISO8601, TRUE),
            array('1308174051', 'U', TRUE),
        );
    }

    public function convertFromStringTests($source, $dateFormat, $isValid) {
        if ($dateFormat !== NULL) {
            $mockMappingConfiguration = $this->getMock('TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface');
            $mockMappingConfiguration
                    ->expects($this->atLeastOnce())
                    ->method('getConfigurationValue')
                    ->with('TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter', \TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter::CONFIGURATION_DATE_FORMAT)
                    ->will($this->returnValue($dateFormat));
        } else {
            $mockMappingConfiguration = NULL;
        }
        $date = $this->converter->convertFrom($source, 'DateTime', array(), $mockMappingConfiguration);
        if ($isValid !== TRUE) {
            $this->assertInstanceOf('TYPO3\\CMS\\Extbase\\Error\\Error', $date);
            return;
        }
        $this->assertInstanceOf('DateTime', $date);

        if ($dateFormat === NULL) {
            $dateFormat = \TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter::DEFAULT_DATE_FORMAT;
        }
        $this->assertSame($source, $date->format($dateFormat));
    }

    public function convertFromIntegerOrDigitStringsWithoutConfigurationDataProvider() {
        return array(
            array('1308174051'),
            array(1308174051),
        );
    }

    public function convertFromIntegerOrDigitStringWithoutConfigurationTests($source) {
        $date = $this->converter->convertFrom($source, 'DateTime', array(), NULL);
        $this->assertInstanceOf('DateTime', $date);
        $this->assertSame(strval($source), $date->format('U'));

    }

    public function convertFromIntegerOrDigitStringInArrayWithoutConfigurationTests($source) {
        $date = $this->converter->convertFrom(array('date' => $source), 'DateTime', array(), NULL);
        $this->assertInstanceOf('DateTime', $date);
        $this->assertSame(strval($source), $date->format('U'));

    }

    public function canConvertFromReturnsTrueIfSourceTypeIsAnArray() {
        $this->assertTrue($this->converter->canConvertFrom(array(), 'DateTime'));
    }

    public function convertFromReturnsErrorIfGivenArrayCantBeConverted() {
        $error = $this->converter->convertFrom(array('date' => '1980-12-13'), 'DateTime');
        $this->assertInstanceOf('TYPO3\\CMS\\Extbase\\Error\\Error', $error);
    }

    public function convertFromThrowsExceptionIfGivenArrayDoesNotSpecifyTheDate() {
        $this->converter->convertFrom(array('hour' => '12', 'minute' => '30'), 'DateTime');
    }

    public function convertFromProperlyConvertsArrayWithDefaultDateFormat() {
        $expectedResult = '1980-12-13T20:15:07+01:23';
        $date = $this->converter->convertFrom(array('date' => $expectedResult), 'DateTime');
        $actualResult = $date->format('Y-m-d\\TH:i:sP');
        $this->assertSame($expectedResult, $actualResult);
    }

    public function invalidDatePartKeyValuesDataProvider() {
        return array(
            array(array('day' => '13.0', 'month' => '10', 'year' => '2010')),
            array(array('day' => '13', 'month' => '10.0', 'year' => '2010')),
            array(array('day' => '13', 'month' => '10', 'year' => '2010.0')),
            array(array('day' => '-13', 'month' => '10', 'year' => '2010')),
            array(array('day' => '13', 'month' => '-10', 'year' => '2010')),
            array(array('day' => '13', 'month' => '10', 'year' => '-2010')),
        );
    }

    public function convertFromThrowsExceptionIfDatePartKeysHaveInvalidValuesSpecified($source) {
        $this->converter->convertFrom($source, 'DateTime');
    }

    public function convertFromProperlyConvertsArrayWithDateAsArray() {
        $source = array('day' => '13', 'month' => '10', 'year' => '2010');
        $mappingConfiguration = new \TYPO3\CMS\Extbase\Property\PropertyMappingConfiguration();
        $mappingConfiguration->setTypeConverterOption(
                'TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter',
                \TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter::CONFIGURATION_DATE_FORMAT,
                'Y-m-d'
        );

        $date = $this->converter->convertFrom($source, 'DateTime', array(), $mappingConfiguration);
        $actualResult = $date->format('Y-m-d');
        $this->assertSame('2010-10-13', $actualResult);
    }

    public function convertFromAllowsToOverrideTheTime() {
        $source = array(
            'date' => '2011-06-16',
            'dateFormat' => 'Y-m-d',
            'hour' => '12',
            'minute' => '30',
            'second' => '59',
        );
        $date = $this->converter->convertFrom($source, 'DateTime');
        $this->assertSame('2011-06-16', $date->format('Y-m-d'));
        $this->assertSame('12', $date->format('H'));
        $this->assertSame('30', $date->format('i'));
        $this->assertSame('59', $date->format('s'));
    }

    public function convertFromAllowsToOverrideTheTimezone() {
        $source = array(
            'date' => '2011-06-16 12:30:59',
            'dateFormat' => 'Y-m-d H:i:s',
            'timezone' => 'Atlantic/Reykjavik',
        );
        $date = $this->converter->convertFrom($source, 'DateTime');
        $this->assertSame('2011-06-16', $date->format('Y-m-d'));
        $this->assertSame('12', $date->format('H'));
        $this->assertSame('30', $date->format('i'));
        $this->assertSame('59', $date->format('s'));
        $this->assertSame('Atlantic/Reykjavik', $date->getTimezone()->getName());
    }

    public function convertFromThrowsExceptionIfSpecifiedTimezoneIsInvalid() {
        $source = array(
            'date' => '2011-06-16',
            'dateFormat' => 'Y-m-d',
            'timezone' => 'Invalid/Timezone',
        );
        $this->converter->convertFrom($source, 'DateTime');
    }

    public function convertFromArrayThrowsExceptionForEmptyArray() {
        $this->converter->convertFrom(array(), 'DateTime', array(), NULL);
    }

    public function convertFromArrayReturnsNullForEmptyDate() {
        $this->assertNull($this->converter->convertFrom(array('date' => ''), 'DateTime', array(), NULL));
    }

    public function convertFromArrayDataProvider() {
        return array(
            array(array('date' => '2005-08-15T15:52:01+01:00'), TRUE),
            array(array('date' => '1308174051', 'dateFormat' => ''), FALSE),
            array(array('date' => '13-12-1980', 'dateFormat' => 'd.m.Y'), FALSE),
            array(array('date' => '1308174051', 'dateFormat' => 'Y-m-d'), FALSE),
            array(array('date' => '12:13', 'dateFormat' => 'H:i'), TRUE),
            array(array('date' => '13.12.1980', 'dateFormat' => 'd.m.Y'), TRUE),
            array(array('date' => '2005-08-15T15:52:01+00:00', 'dateFormat' => ''), TRUE),
            array(array('date' => '2005-08-15T15:52:01+0000', 'dateFormat' => \DateTime::ISO8601), TRUE),
            array(array('date' => '1308174051', 'dateFormat' => 'U'), TRUE),
            array(array('date' => 1308174051, 'dateFormat' => 'U'), TRUE),
        );
    }

    public function convertFromArrayTests(array $source, $isValid) {
        $dateFormat = isset($source['dateFormat']) && strlen($source['dateFormat']) > 0 ? $source['dateFormat'] : NULL;
        if ($dateFormat !== NULL) {
            $mockMappingConfiguration = $this->getMock('TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface');
            $mockMappingConfiguration
                    ->expects($this->atLeastOnce())
                    ->method('getConfigurationValue')
                    ->with('TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter', \TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter::CONFIGURATION_DATE_FORMAT)
                    ->will($this->returnValue($dateFormat));
        } else {
            $mockMappingConfiguration = NULL;
        }
        $date = $this->converter->convertFrom($source, 'DateTime', array(), $mockMappingConfiguration);

        if ($isValid !== TRUE) {
            $this->assertInstanceOf('TYPO3\\CMS\\Extbase\\Error\\Error', $date);
            return;
        }

        $this->assertInstanceOf('DateTime', $date);
        if ($dateFormat === NULL) {
            $dateFormat = \TYPO3\CMS\Extbase\Property\TypeConverter\DateTimeConverter::DEFAULT_DATE_FORMAT;
        }
        $dateAsString = isset($source['date']) ? strval($source['date']) : '';
        $this->assertSame($dateAsString, $date->format($dateFormat));
    }

    public function convertFromSupportsDateTimeSubClasses() {
        $className = $this->getUniqueId('DateTimeSubClass');
        eval('
            class ' . $className . ' extends \\DateTime {
                public static function createFromFormat($format, $time, $timezone = NULL) {
                    return new ' . $className . '();
                }
                public function foo() { return "Bar"; }
            }
        ');
        $date = $this->converter->convertFrom('2005-08-15T15:52:01+00:00', $className);

        $this->assertInstanceOf($className, $date);
        $this->assertSame('Bar', $date->foo());
    }

}