#869 cleanups and hardening of tests around date-related types

lib/Doctrine/DBAL/Types/ConversionException.php

@@ -41,7 +41,7 @@ class ConversionException extends \Doctrine\DBAL\DBALException
      */
     static public function conversionFailed($value, $toType)
     {
-        $value = (strlen($value) > 32) ? substr($value, 0, 20) . "..." : $value;
+        $value = (strlen($value) > 32) ? substr($value, 0, 20) . '...' : $value;
 
         return new self('Could not convert database value "' . $value . '" to Doctrine Type ' . $toType);
     }
@@ -50,44 +50,53 @@ static public function conversionFailed($value, $toType)
      * Thrown when a Database to Doctrine Type Conversion fails and we can make a statement
      * about the expected format.
      *
-     * @param string $value
-     * @param string $toType
-     * @param string $expectedFormat
+     * @param string          $value
+     * @param string          $toType
+     * @param string          $expectedFormat
+     * @param \Exception|null $previous
      *
      * @return \Doctrine\DBAL\Types\ConversionException
      */
-    static public function conversionFailedFormat($value, $toType, $expectedFormat)
+    static public function conversionFailedFormat($value, $toType, $expectedFormat, \Exception $previous = null)
     {
-        $value = (strlen($value) > 32) ? substr($value, 0, 20) . "..." : $value;
+        $value = (strlen($value) > 32) ? substr($value, 0, 20) . '...' : $value;
 
         return new self(
             'Could not convert database value "' . $value . '" to Doctrine Type ' .
-            $toType . '. Expected format: ' . $expectedFormat
+            $toType . '. Expected format: ' . $expectedFormat,
+            0,
+            $previous
         );
     }
 
     /**
      * Thrown when the PHP value passed to the converter was not of the expected type.
      *
-     * @param mixed $value
-     * @param string $fromType
+     * @param mixed    $value
+     * @param string   $toType
+     * @param string[] $possibleTypes
      *
      * @return \Doctrine\DBAL\Types\ConversionException
      */
-    static public function conversionFailedInvalidType($value, $toType, $fromType)
+    static public function conversionFailedInvalidType($value, $toType, array $possibleTypes)
     {
-        $actualType = gettype($value);
-        if ($actualType === 'object') {
-            $actualType .= " (" . get_class($value) . ")";
-            if (!method_exists($value, '__toString')) {
-                $value = 'object';
-            }
+        $actualType = is_object($value) ? get_class($value) : gettype($value);
+
+        if (is_scalar($value)) {
+            return new self(sprintf(
+                "Could not convert PHP value '%s' of type '%s' to type '%s'. Expected one of the following types: %s",
+                $value,
+                $actualType,
+                $toType,
+                implode(', ', $possibleTypes)
+            ));
         }
-        $value = (string)$value;
-        $value = (strlen($value) > 32) ? substr($value, 0, 20) . "..." : $value;
 
-        return new self(
-            "Could not convert PHP value '$value' of type '$actualType' to type $toType. Expected type: $fromType"
-        );
+        return new self(sprintf(
+            "Could not convert PHP value of type '%s' to type '%s'. Expected one of the following types: %s",
+            $actualType,
+            $toType,
+            implode(', ', $possibleTypes)
+        ));
     }
 }

lib/Doctrine/DBAL/Types/DateIntervalType.php

@@ -33,20 +33,17 @@ public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $pla
      */
     public function convertToDatabaseValue($value, AbstractPlatform $platform)
     {
-        $spec = null;
-        if ($value !== null) {
-            /** @var \DateInterval $value */
-            $spec = 'P'
+        if (null === $value) {
+            return null;
+        }
+
+        if ($value instanceof \DateInterval) {
+            return 'P'
                 . str_pad($value->y, 4, '0', STR_PAD_LEFT) . '-'
-                . $value->format('%M') . '-'
-                . $value->format('%D') . 'T'
-                . $value->format('%H') . ':'
-                . $value->format('%I') . ':'
-                . $value->format('%S')
-            ;
+                . $value->format('%M-%DT%H:%I:%S');
         }
 
-        return $spec;
+        throw ConversionException::conversionFailedInvalidType($value, $this->getName(), ['null', 'DateInterval']);
     }
 
     /**
@@ -59,13 +56,10 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
         }
 
         try {
-            $interval = new \DateInterval($value);
-        } catch (\Exception $e) {
-            throw ConversionException::conversionFailedFormat($value, $this->getName(), 'PY-m-dTH:i:s');
-
+            return new \DateInterval($value);
+        } catch (\Exception $exception) {
+            throw ConversionException::conversionFailedFormat($value, $this->getName(), 'PY-m-dTH:i:s', $exception);
         }
-
-        return $interval;
     }
 
     /**

lib/Doctrine/DBAL/Types/DateTimeType.php

@@ -49,12 +49,15 @@ public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $pla
      */
     public function convertToDatabaseValue($value, AbstractPlatform $platform)
     {
-        if ($value !== null && !$value instanceof \DateTime) {
-            throw ConversionException::conversionFailedInvalidType($value, $this->getName(), "DateTime");
+        if (null === $value) {
+            return $value;
+        }
+
+        if ($value instanceof \DateTime) {
+            return $value->format($platform->getDateTimeFormatString());
         }
 
-        return ($value !== null)
-            ? $value->format($platform->getDateTimeFormatString()) : null;
+        throw ConversionException::conversionFailedInvalidType($value, $this->getName(), ['null', 'DateTime']);
     }
 
     /**

lib/Doctrine/DBAL/Types/DateTimeTzType.php

@@ -67,12 +67,15 @@ public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $pla
      */
     public function convertToDatabaseValue($value, AbstractPlatform $platform)
     {
-        if ($value !== null && !$value instanceof \DateTime) {
-            throw ConversionException::conversionFailedInvalidType($value, $this->getName(), "DateTime");
+        if (null === $value) {
+            return $value;
+        }
+
+        if ($value instanceof \DateTime) {
+            return $value->format($platform->getDateTimeTzFormatString());
         }
-
-        return ($value !== null)
-            ? $value->format($platform->getDateTimeTzFormatString()) : null;
+
+        throw ConversionException::conversionFailedInvalidType($value, $this->getName(), ['null', 'DateTime']);
     }
 
     /**

lib/Doctrine/DBAL/Types/DateType.php

@@ -49,12 +49,15 @@ public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $pla
      */
     public function convertToDatabaseValue($value, AbstractPlatform $platform)
     {
-        if ($value !== null && !$value instanceof \DateTime) {
-            throw ConversionException::conversionFailedInvalidType($value, $this->getName(), "DateTime");
+        if (null === $value) {
+            return $value;
+        }
+
+        if ($value instanceof \DateTime) {
+            return $value->format($platform->getDateFormatString());
         }
 
-        return ($value !== null)
-            ? $value->format($platform->getDateFormatString()) : null;
+        throw ConversionException::conversionFailedInvalidType($value, $this->getName(), ['null', 'DateTime']);
     }
 
     /**

lib/Doctrine/DBAL/Types/TimeType.php

@@ -49,12 +49,15 @@ public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $pla
      */
     public function convertToDatabaseValue($value, AbstractPlatform $platform)
     {
-        if ($value !== null && !$value instanceof \DateTime) {
-            throw ConversionException::conversionFailedInvalidType($value, $this->getName(), "DateTime");
+        if (null === $value) {
+            return $value;
+        }
+
+        if ($value instanceof \DateTime) {
+            return $value->format($platform->getTimeFormatString());
         }
 
-        return ($value !== null)
-            ? $value->format($platform->getTimeFormatString()) : null;
+        throw ConversionException::conversionFailedInvalidType($value, $this->getName(), ['null', 'DateTime']);
     }
 
     /**

tests/Doctrine/Tests/DBAL/Types/BaseDateTypeTestCase.php

@@ -0,0 +1,94 @@
+<?php
+
+namespace Doctrine\Tests\DBAL\Types;
+
+use Doctrine\Tests\DBAL\Mocks\MockPlatform;
+use PHPUnit_Framework_TestCase;
+
+abstract class BaseDateTypeTestCase extends PHPUnit_Framework_TestCase
+{
+    /**
+     * @var MockPlatform
+     */
+    protected $platform;
+
+    /**
+     * @var \Doctrine\DBAL\Types\Type
+     */
+    protected $type;
+
+    /**
+     * @var string
+     */
+    private $currentTimezone;
+
+    /**
+     * {@inheritDoc}
+     */
+    protected function setUp()
+    {
+        $this->platform        = new MockPlatform();
+        $this->currentTimezone = date_default_timezone_get();
+
+        $this->assertInstanceOf('Doctrine\DBAL\Types\Type', $this->type);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    protected function tearDown()
+    {
+        date_default_timezone_set($this->currentTimezone);
+    }
+
+    public function testDateConvertsToDatabaseValue()
+    {
+        $this->assertInternalType('string', $this->type->convertToDatabaseValue(new \DateTime(), $this->platform));
+    }
+
+    /**
+     * @dataProvider invalidPHPValuesProvider
+     *
+     * @param mixed $value
+     */
+    public function testInvalidTypeConversionToDatabaseValue($value)
+    {
+        $this->setExpectedException('Doctrine\DBAL\Types\ConversionException');
+
+        $this->type->convertToDatabaseValue($value, $this->platform);
+    }
+
+    public function testNullConversion()
+    {
+        $this->assertNull($this->type->convertToPHPValue(null, $this->platform));
+    }
+
+    public function testConvertDateTimeToPHPValue()
+    {
+        $date = new \DateTime('now');
+
+        $this->assertSame($date, $this->type->convertToPHPValue($date, $this->platform));
+    }
+
+    /**
+     * @return mixed[][]
+     */
+    public function invalidPHPValuesProvider()
+    {
+        return [
+            [0],
+            [''],
+            ['foo'],
+            ['10:11:12'],
+            ['2015-01-31'],
+            ['2015-01-31 10:11:12'],
+            [new \stdClass()],
+            [$this],
+            [27],
+            [-1],
+            [1.2],
+            [[]],
+            [['an array']],
+        ];
+    }
+}

tests/Doctrine/Tests/DBAL/Types/ConversionExceptionTest.php

@@ -0,0 +1,83 @@
+<?php
+
+namespace Doctrine\Tests\DBAL\Types;
+
+use Doctrine\DBAL\Types\ConversionException;
+use PHPUnit_Framework_TestCase;
+
+class ConversionExceptionTest extends PHPUnit_Framework_TestCase
+{
+    /**
+     * @dataProvider scalarsProvider
+     *
+     * @param mixed $scalarValue
+     */
+    public function testConversionFailedInvalidTypeWithScalar($scalarValue)
+    {
+        $exception = ConversionException::conversionFailedInvalidType($scalarValue, 'foo', ['bar', 'baz']);
+
+        $this->assertInstanceOf('Doctrine\DBAL\Types\ConversionException', $exception);
+        $this->assertRegExp(
+            '/^Could not convert PHP value \'.*\' of type \'(string|boolean|float|double|integer)\' to type \'foo\'. '
+            . 'Expected one of the following types: bar, baz$/',
+            $exception->getMessage()
+        );
+    }
+    /**
+     * @dataProvider nonScalarsProvider
+     *
+     * @param mixed $nonScalar
+     */
+    public function testConversionFailedInvalidTypeWithNonScalar($nonScalar)
+    {
+        $exception = ConversionException::conversionFailedInvalidType($nonScalar, 'foo', ['bar', 'baz']);
+
+        $this->assertInstanceOf('Doctrine\DBAL\Types\ConversionException', $exception);
+        $this->assertRegExp(
+            '/^Could not convert PHP value of type \'(.*)\' to type \'foo\'. '
+            . 'Expected one of the following types: bar, baz$/',
+            $exception->getMessage()
+        );
+    }
+
+    public function testConversionFailedFormatPreservesPreviousException()
+    {
+        $previous = new \Exception();
+
+        $exception = ConversionException::conversionFailedFormat('foo', 'bar', 'baz', $previous);
+
+        $this->assertInstanceOf('Doctrine\DBAL\Types\ConversionException', $exception);
+        $this->assertSame($previous, $exception->getPrevious());
+    }
+
+    /**
+     * @return mixed[][]
+     */
+    public function nonScalarsProvider()
+    {
+        return [
+            [[]],
+            [['foo']],
+            [null],
+            [$this],
+            [new \stdClass()],
+            [tmpfile()],
+        ];
+    }
+
+    /**
+     * @return mixed[][]
+     */
+    public function scalarsProvider()
+    {
+        return [
+            [''],
+            ['foo'],
+            [123],
+            [-123],
+            [12.34],
+            [true],
+            [false],
+        ];
+    }
+}