reduce config complexity by converting php format to js format (#734)

config/packages/kimai.yaml

@@ -118,81 +118,61 @@ kimai:
     languages:
         de:
             date_time_type: 'dd.MM.yyyy HH:mm'
-            date_time_picker: 'DD.MM.YYYY HH:mm'
             date_type: 'dd.MM.yyyy'
-            date_picker: 'DD.MM.YYYY'
             date: 'd.m.Y'
             date_time: 'd.m. H:i'
             duration: '%%h:%%m h'
         en:
             date_time_type: 'yyyy-MM-dd HH:mm'
-            date_time_picker: 'YYYY-MM-DD HH:mm'
             date_type: 'yyyy-MM-dd'
-            date_picker: 'YYYY-MM-DD'
             date: 'Y-m-d'
             date_time: 'm-d H:i'
             duration: '%%h:%%m h'
         pt_BR:
             date_time_type: 'dd-MM-yyyy HH:mm'
-            date_time_picker: 'DD-MM-YYYY HH:mm'
             date_type: 'dd-MM-yyyy'
-            date_picker: 'DD-MM-YYYY'
             date: 'd-m-Y'
             date_time: 'd-m H:i'
             duration: '%%h:%%m h'
         it:
             date_time_type: 'dd.MM.yyyy HH:mm'
-            date_time_picker: 'DD.MM.YYYY HH:mm'
             date_type: 'dd.MM.yyyy'
-            date_picker: 'DD.MM.YYYY'
             date: 'd.m.Y'
             date_time: 'd.m. H:i'
             duration: '%%h:%%m h'
         fr:
             date_time_type: 'dd/MM/yyyy HH:mm'
-            date_time_picker: 'DD/MM/YYYY HH:mm'
             date_type: 'dd/MM/yyyy'
-            date_picker: 'DD/MM/YYYY'
             date: 'd/m/Y'
             date_time: 'd/m H:i'
             duration: '%%h h %%m'
         es:
             date_time_type: 'dd.MM.yyyy HH:mm'
-            date_time_picker: 'DD.MM.YYYY HH:mm'
             date_type: 'dd.MM.yyyy'
-            date_picker: 'DD.MM.YYYY'
             date: 'd.m.Y'
             date_time: 'd.m. H:i'
             duration: '%%h:%%m h'
         ru:
             date_time_type: 'dd.MM.yyyy HH:mm'
-            date_time_picker: 'DD.MM.YYYY HH:mm'
             date_type: 'dd.MM.yyyy'
-            date_picker: 'DD.MM.YYYY'
             date: 'd.m.Y'
             date_time: 'd.m. H:i'
             duration: '%%h:%%m h'
         ar:
             date_time_type: 'yyyy-MM-dd HH:mm'
-            date_time_picker: 'YYYY-MM-DD HH:mm'
             date_type: 'yyyy-MM-dd'
-            date_picker: 'YYYY-MM-DD'
             date: 'Y-m-d'
             date_time: 'm-d H:i'
             duration: '%%h:%%m h'
         hu:
             date_time_type: 'yyyy.MM.dd. HH:mm'
-            date_time_picker: 'YYYY.MM.DD. HH:mm'
             date_type: 'yyyy.MM.dd.'
-            date_picker: 'YYYY.MM.DD.'
             date: 'Y.m.d.'
             date_time: 'm.d. H:i'
             duration: '%%h:%%m h'
         sv:
             date_time_type: 'yyyy-MM-dd HH:mm'
-            date_time_picker: 'YYYY-MM-DD HH:mm'
             date_type: 'yyyy-MM-dd'
-            date_picker: 'YYYY-MM-DD'
             date: 'Y-m-d'
             date_time: 'm-d H:i'
             duration: '%%h:%%m tim'

src/Configuration/LanguageFormattings.php

@@ -9,12 +9,18 @@
 
 namespace App\Configuration;
 
+use App\Utils\MomentFormatConverter;
+
 class LanguageFormattings
 {
     /**
      * @var array
      */
     protected $settings;
+    /**
+     * @var MomentFormatConverter
+     */
+    protected $momentFormatter;
 
     /**
      * @param array $languageSettings
@@ -22,6 +28,7 @@ class LanguageFormattings
     public function __construct(array $languageSettings)
     {
         $this->settings = $languageSettings;
+        $this->momentFormatter = new MomentFormatConverter();
     }
 
     /**
@@ -53,7 +60,7 @@ class LanguageFormattings
      */
     public function getDatePickerFormat(string $locale): string
     {
-        return $this->getConfig('date_picker', $locale);
+        return $this->momentFormatter->convert($this->getDateTypeFormat($locale));
     }
 
     /**
@@ -75,7 +82,7 @@ class LanguageFormattings
      */
     public function getDateTimePickerFormat(string $locale): string
     {
-        return $this->getConfig('date_time_picker', $locale);
+        return $this->momentFormatter->convert($this->getDateTimeTypeFormat($locale));
     }
 
     /**

src/DependencyInjection/Configuration.php

@@ -226,9 +226,7 @@ class Configuration implements ConfigurationInterface
             ->arrayPrototype()
                 ->children()
                     ->scalarNode('date_time_type')->defaultValue('yyyy-MM-dd HH:mm')->end()     // for DateTimeType
-                    ->scalarNode('date_time_picker')->defaultValue('YYYY-MM-DD HH:mm')->end()   // for DateTimeType JS component
                     ->scalarNode('date_type')->defaultValue('yyyy-MM-dd')->end()                // for DateType
-                    ->scalarNode('date_picker')->defaultValue('YYYY-MM-DD')->end()              // for DateType JS component
                     ->scalarNode('date')->defaultValue('Y-m-d')->end()                          // for display via twig
                     ->scalarNode('date_time')->defaultValue('m-d H:i')->end()                   // for display via twig
                     ->scalarNode('duration')->defaultValue('%%h:%%m h')->end()                  // for display via twig

src/Utils/MomentFormatConverter.php

@@ -0,0 +1,49 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Utils;
+
+/**
+ * This class is used to convert PHP date format to moment.js format.
+ *
+ * @author Yonel Ceruto <yonelceruto@gmail.com>
+ */
+class MomentFormatConverter
+{
+    /**
+     * This defines the mapping between PHP ICU date format (key) and moment.js date format (value)
+     * For ICU formats see http://userguide.icu-project.org/formatparse/datetime#TOC-Date-Time-Format-Syntax
+     * For Moment formats see http://momentjs.com/docs/#/displaying/format/.
+     *
+     * @var array
+     */
+    private static $formatConvertRules = [
+        // year
+        'yyyy' => 'YYYY', 'yy' => 'YY', 'y' => 'YYYY',
+        // day
+        'dd' => 'DD', 'd' => 'D',
+        // day of week
+        'EE' => 'ddd', 'EEEEEE' => 'dd',
+        // timezone
+        'ZZZZZ' => 'Z', 'ZZZ' => 'ZZ',
+        // letter 'T'
+        '\'T\'' => 'T',
+    ];
+
+    /**
+     * Returns associated moment.js format.
+     *
+     * @param string $format
+     * @return string
+     */
+    public function convert(string $format): string
+    {
+        return strtr($format, self::$formatConvertRules);
+    }
+}

tests/Configuration/LanguageFormattingsTest.php

@@ -27,9 +27,7 @@ class LanguageFormattingsTest extends TestCase
         return [
             'de' => [
                 'date_time_type' => 'dd.MM.yyyy HH:mm',
-                'date_time_picker' => 'DD.MM.YYYY HH:mm',
                 'date_type' => 'dd.MM.yyyy',
-                'date_picker' => 'DD.MM.YYYY',
                 'date' => 'd.m.Y',
                 'date_time' => 'd.m. H:i',
                 'duration' => '%h:%m h',
@@ -38,9 +36,7 @@ class LanguageFormattingsTest extends TestCase
             ],
             'en' => [
                 'date_time_type' => 'yyyy-MM-dd HH:mm',
-                'date_time_picker' => 'YYYY-MM-DD HH:mm',
                 'date_type' => 'yyyy-MM-dd',
-                'date_picker' => 'YYYY-MM-DD',
                 'date' => 'Y-m-d',
                 'date_time' => 'm-d H:i',
                 'duration' => '%h:%m h',
@@ -49,57 +45,43 @@ class LanguageFormattingsTest extends TestCase
             ],
             'pt_BR' => [
                 'date_time_type' => 'dd-MM-yyyy HH:mm',
-                'date_time_picker' => 'DD-MM-YYYY HH:mm',
                 'date_type' => 'dd-MM-yyyy',
-                'date_picker' => 'DD-MM-YYYY',
                 'date' => 'd-m-Y',
                 'duration' => '%h:%m h',
             ],
             'it' => [
                 'date_time_type' => 'dd.MM.yyyy HH:mm',
-                'date_time_picker' => 'DD.MM.YYYY HH:mm',
                 'date_type' => 'dd.MM.yyyy',
-                'date_picker' => 'DD.MM.YYYY',
                 'date' => 'd.m.Y',
                 'duration' => '%h:%m h',
             ],
             'fr' => [
                 'date_time_type' => 'dd/MM/yyyy HH:mm',
-                'date_time_picker' => 'DD/MM/YYYY HH:mm',
                 'date_type' => 'dd/MM/yyyy',
-                'date_picker' => 'DD/MM/YYYY',
                 'date' => 'd/m/Y',
                 'duration' => '%h h %m',
             ],
             'es' => [
                 'date_time_type' => 'dd.MM.yyyy HH:mm',
-                'date_time_picker' => 'DD.MM.YYYY HH:mm',
                 'date_type' => 'dd.MM.yyyy',
-                'date_picker' => 'DD.MM.YYYY',
                 'date' => 'd.m.Y',
                 'duration' => '%h:%m h',
             ],
             'ru' => [
                 'date_time_type' => 'dd.MM.yyyy HH:mm',
-                'date_time_picker' => 'DD.MM.YYYY HH:mm',
                 'date_type' => 'dd.MM.yyyy',
-                'date_picker' => 'DD.MM.YYYY',
                 'date' => 'd.m.Y',
                 'duration' => '%h:%m h',
             ],
             'ar' => [
                 'date_time_type' => 'yyyy-MM-dd HH:mm',
-                'date_time_picker' => 'YYYY-MM-DD HH:mm',
                 'date_type' => 'yyyy-MM-dd',
-                'date_picker' => 'YYYY-MM-DD',
                 'date' => 'Y-m-d',
                 'duration' => '%h:%m h',
             ],
             'hu' => [
                 'date_time_type' => 'yyyy.MM.dd HH:mm',
-                'date_time_picker' => 'YYYY.MM.DD HH:mm',
                 'date_type' => 'yyyy.MM.dd',
-                'date_picker' => 'YYYY.MM.DD',
                 'date' => 'Y.m.d.',
                 'duration' => '%h:%m h',
             ],
@@ -183,7 +165,7 @@ class LanguageFormattingsTest extends TestCase
 
     /**
      * @expectedException \InvalidArgumentException
-     * @expectedExceptionMessage Unknown setting for locale en: date_time_picker
+     * @expectedExceptionMessage Unknown setting for locale en: date_time_type
      */
     public function testUnknownSetting()
     {

tests/Utils/LocaleSettingsTest.php

@@ -41,9 +41,7 @@ class LocaleSettingsTest extends TestCase
         return [
             'de' => [
                 'date_time_type' => 'dd.MM.yyyy HH:mm',
-                'date_time_picker' => 'DD.MM.YYYY HH:mm',
                 'date_type' => 'dd.MM.yyyy',
-                'date_picker' => 'DD.MM.YYYY',
                 'date' => 'd.m.Y',
                 'date_time' => 'd.m. H:i',
                 'duration' => '%h:%m h',
@@ -52,9 +50,7 @@ class LocaleSettingsTest extends TestCase
             ],
             'en' => [
                 'date_time_type' => 'yyyy-MM-dd HH:mm',
-                'date_time_picker' => 'YYYY-MM-DD HH:mm',
                 'date_type' => 'yyyy-MM-dd',
-                'date_picker' => 'YYYY-MM-DD',
                 'date' => 'Y-m-d',
                 'date_time' => 'm-d H:i',
                 'duration' => '%h:%m h',
@@ -63,57 +59,43 @@ class LocaleSettingsTest extends TestCase
             ],
             'pt_BR' => [
                 'date_time_type' => 'dd-MM-yyyy HH:mm',
-                'date_time_picker' => 'DD-MM-YYYY HH:mm',
                 'date_type' => 'dd-MM-yyyy',
-                'date_picker' => 'DD-MM-YYYY',
                 'date' => 'd-m-Y',
                 'duration' => '%h:%m h',
             ],
             'it' => [
                 'date_time_type' => 'dd.MM.yyyy HH:mm',
-                'date_time_picker' => 'DD.MM.YYYY HH:mm',
                 'date_type' => 'dd.MM.yyyy',
-                'date_picker' => 'DD.MM.YYYY',
                 'date' => 'd.m.Y',
                 'duration' => '%h:%m h',
             ],
             'fr' => [
                 'date_time_type' => 'dd/MM/yyyy HH:mm',
-                'date_time_picker' => 'DD/MM/YYYY HH:mm',
                 'date_type' => 'dd/MM/yyyy',
-                'date_picker' => 'DD/MM/YYYY',
                 'date' => 'd/m/Y',
                 'duration' => '%h h %m',
             ],
             'es' => [
                 'date_time_type' => 'dd.MM.yyyy HH:mm',
-                'date_time_picker' => 'DD.MM.YYYY HH:mm',
                 'date_type' => 'dd.MM.yyyy',
-                'date_picker' => 'DD.MM.YYYY',
                 'date' => 'd.m.Y',
                 'duration' => '%h:%m h',
             ],
             'ru' => [
                 'date_time_type' => 'dd.MM.yyyy HH:mm',
-                'date_time_picker' => 'DD.MM.YYYY HH:mm',
                 'date_type' => 'dd.MM.yyyy',
-                'date_picker' => 'DD.MM.YYYY',
                 'date' => 'd.m.Y',
                 'duration' => '%h:%m h',
             ],
             'ar' => [
                 'date_time_type' => 'yyyy-MM-dd HH:mm',
-                'date_time_picker' => 'YYYY-MM-DD HH:mm',
                 'date_type' => 'yyyy-MM-dd',
-                'date_picker' => 'YYYY-MM-DD',
                 'date' => 'Y-m-d',
                 'duration' => '%h:%m h',
             ],
             'hu' => [
                 'date_time_type' => 'yyyy.MM.dd HH:mm',
-                'date_time_picker' => 'YYYY.MM.DD HH:mm',
                 'date_type' => 'yyyy.MM.dd',
-                'date_picker' => 'YYYY.MM.DD',
                 'date' => 'Y.m.d.',
                 'duration' => '%h:%m h',
             ],
@@ -212,7 +194,7 @@ class LocaleSettingsTest extends TestCase
 
     /**
      * @expectedException \InvalidArgumentException
-     * @expectedExceptionMessage Unknown setting for locale en: date_time_picker
+     * @expectedExceptionMessage Unknown setting for locale en: date_time_type
      */
     public function testUnknownSetting()
     {

tests/Utils/MomentFormatConverterTest.php

@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Tests\Utils;
+
+use App\Utils\MomentFormatConverter;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+
+/**
+ * @covers \App\Utils\MomentFormatConverter
+ */
+class MomentFormatConverterTest extends KernelTestCase
+{
+    public function test()
+    {
+        $sut = new MomentFormatConverter();
+        $this->assertEquals('DD.MM.YYYY HH:mm', $sut->convert('dd.MM.yyyy HH:mm'));
+        $this->assertEquals('DD-MM-YYYY HH:mm', $sut->convert('dd-MM-yyyy HH:mm'));
+        $this->assertEquals('DD/MM/YYYY HH:mm', $sut->convert('dd/MM/yyyy HH:mm'));
+        $this->assertEquals('YYYY-MM-DD HH:mm', $sut->convert('yyyy-MM-dd HH:mm'));
+        $this->assertEquals('YYYY.MM.DD. HH:mm', $sut->convert('yyyy.MM.dd. HH:mm'));
+    }
+}