Add BoolColumn support

Author: curry684

CHANGELOG.md

@@ -3,7 +3,11 @@ All notable changes to `omines\datatables-bundle` will be documented in this fil
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
-Nothing yet.
+### Added
+ - Add BoolColumn for handling strict boolean columns
+
+### Changed
+ - Column values default to 'data' only on NULL instead of any 'emptiness'
 
 ## [0.1.2] - 2017-12-14
 ### Added

src/Column/AbstractColumn.php

@@ -70,7 +70,7 @@ public function transform($value = null, $context = null)
         $data = $this->options['data'];
         if (is_callable($data)) {
             $value = call_user_func($data, $context, $value);
-        } elseif (empty($value)) {
+        } elseif (null === $value) {
             $value = $data;
         }
 

src/Column/BoolColumn.php

@@ -0,0 +1,78 @@
+<?php
+
+/*
+ * Symfony DataTables Bundle
+ * (c) Omines Internetbureau B.V. - https://omines.nl/
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Omines\DataTablesBundle\Column;
+
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+/**
+ * BoolColumn.
+ *
+ * @author Niels Keurentjes <[email protected]>
+ */
+class BoolColumn extends AbstractColumn
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function normalize($value): string
+    {
+        if (null === $value) {
+            return $this->getNullValue();
+        }
+
+        return ((bool) $value) ? $this->getTrueValue() : $this->getFalseValue();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function configureOptions(OptionsResolver $resolver)
+    {
+        parent::configureOptions($resolver);
+
+        $resolver
+            ->setDefault('trueValue', 'true')
+            ->setDefault('falseValue', 'false')
+            ->setDefault('nullValue', 'null')
+            ->setAllowedTypes('trueValue', 'string')
+            ->setAllowedTypes('falseValue', 'string')
+            ->setAllowedTypes('nullValue', 'string')
+        ;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getTrueValue(): string
+    {
+        return $this->options['trueValue'];
+    }
+
+    /**
+     * @return string
+     */
+    public function getFalseValue(): string
+    {
+        return $this->options['falseValue'];
+    }
+
+    /**
+     * @return string
+     */
+    public function getNullValue(): string
+    {
+        return $this->options['nullValue'];
+    }
+}

tests/Unit/ColumnTest.php

@@ -12,6 +12,7 @@
 
 namespace Tests\Unit;
 
+use Omines\DataTablesBundle\Column\BoolColumn;
 use Omines\DataTablesBundle\Column\TextColumn;
 use Omines\DataTablesBundle\DataTable;
 use PHPUnit\Framework\TestCase;
@@ -37,6 +38,19 @@ public function testTextColumn()
         $this->assertSame('foo', $column->getDataTable()->getName());
     }
 
+    public function testBoolColumn()
+    {
+        $column = new BoolColumn('test', 1, [
+             'trueValue' => 'yes',
+             'nullValue' => '<em>null</em>',
+        ]);
+
+        $this->assertSame('yes', $column->transform(5));
+        $this->assertSame('yes', $column->transform(true));
+        $this->assertSame('false', $column->transform(false));
+        $this->assertStringStartsWith('<em>', $column->transform());
+    }
+
     public function testColumnWithClosures()
     {
         $column = new TextColumn('test', 1, [