Fix DateTimeColumn behavior with default/null values

Author: curry684

CHANGELOG.md

@@ -2,8 +2,9 @@
 All notable changes to `omines\datatables-bundle` will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [Unreleased]
-Nothing yet.
+## [0.1.5] - 2018-01-25
+### Fixed
+ - Fixed inconsistency in DateTimeColumn with default/null values
 
 ## [0.1.4] - 2018-01-21
 ### Added

docs/source/index.html.md

@@ -373,6 +373,7 @@ result. If data of other types is encountered automatic conversion is attempted
 Option | Type | Description
 ------ | ---- | -----------
 format | string | A date format string as accepted by the [`date()`](http://php.net/manual/en/function.date.php) function. Default `'c'`.
+nullValue | string | Raw string to display for null values. Defaults to the empty string.
 
 ## TwigColumn
 

src/Column/DateTimeColumn.php

@@ -27,7 +27,7 @@ class DateTimeColumn extends AbstractColumn
     public function normalize($value)
     {
         if (null === $value) {
-            return $this->getData();
+            return $this->options['nullValue'];
         } elseif (!$value instanceof \DateTimeInterface) {
             $value = new \DateTime($value);
         }
@@ -45,8 +45,10 @@ protected function configureOptions(OptionsResolver $resolver)
         $resolver
             ->setDefaults([
                 'format' => 'c',
+                'nullValue' => '',
             ])
             ->setAllowedTypes('format', 'string')
+            ->setAllowedTypes('nullValue', 'string')
         ;
 
         return $this;

tests/Functional/FunctionalTest.php

@@ -62,7 +62,7 @@ public function testPlainDataTable()
         $sample = $json->data[5];
         $this->assertSame('FirstName94', $sample->firstName);
         $this->assertSame('LastName94', $sample->lastName);
-        $this->assertNull($sample->employedSince);
+        $this->assertEmpty($sample->employedSince);
         $this->assertSame('FirstName94 <img src="https://symfony.com/images/v5/logos/sf-positive.svg"> LastName94', $sample->fullName);
         $this->assertRegExp('#href="/employee/[0-9]+"#', $sample->buttons);
 

tests/Unit/ColumnTest.php

@@ -13,6 +13,7 @@
 namespace Tests\Unit;
 
 use Omines\DataTablesBundle\Column\BoolColumn;
+use Omines\DataTablesBundle\Column\DateTimeColumn;
 use Omines\DataTablesBundle\Column\TextColumn;
 use Omines\DataTablesBundle\Column\TwigColumn;
 use Omines\DataTablesBundle\DataTable;
@@ -25,6 +26,18 @@
  */
 class ColumnTest extends TestCase
 {
+    public function testDateTimeColumn()
+    {
+        $column = new DateTimeColumn();
+        $column->initialize('test', 1, [
+            'nullValue' => 'foo',
+            'format' => 'd-m-Y',
+        ], (new DataTable())->setName('foo'));
+
+        $this->assertSame('03-04-2015', $column->transform('2015-04-03'));
+        $this->assertSame('foo', $column->transform(null));
+    }
+
     public function testTextColumn()
     {
         $column = new TextColumn();