Merge branch 'release/7.0.1'

Author: markwatney2016

CHANGELOG.md

@@ -1,5 +1,10 @@
 # In2publish Core Change Log
 
+7.0.1:
+
+[BUGFIX] Merge configuration more decently
+[BUGFIX] Handle optional configuration nodes appropriately
+
 7.0.0:
 
 - [TYPO] Correctly write "applies"

Classes/Config/Builder.php

@@ -115,6 +115,18 @@ public function addString($key, $default, array $validators = [])
         return $this;
     }
 
+    /**
+     * @param string $key
+     * @param string $default
+     * @param array $validators
+     * @return $this
+     */
+    public function addOptionalString($key, $default, array $validators = [])
+    {
+        $this->addNode(Node::T_OPTIONAL_STRING, $key, $default, $validators);
+        return $this;
+    }
+
     /**
      * @param string $key
      * @param int $default

Classes/Config/ConfigContainer.php

@@ -33,6 +33,7 @@
 use In2code\In2publishCore\Config\Provider\ProviderInterface;
 use In2code\In2publishCore\Service\Context\ContextService;
 use In2code\In2publishCore\Utility\ArrayUtility;
+use In2code\In2publishCore\Utility\ConfigurationUtility;
 use TYPO3\CMS\Core\SingletonInterface;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
@@ -157,7 +158,7 @@ protected function processConfig(array $priority)
         $config = [];
         foreach (array_keys($priority) as $class) {
             $providerConfig = $this->providers[$class];
-            \TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule($config, $providerConfig);
+            $config = ConfigurationUtility::mergeConfiguration($config, $providerConfig);
         }
 
         if (GeneralUtility::makeInstance(ContextService::class)->isLocal()) {

Classes/Config/Definer/SshConnectionDefiner.php

@@ -55,7 +55,7 @@ public function getLocalDefinition()
                                      '/home/ssh-account/.ssh/id_rsa.pub',
                                      [FEV::class]
                                  )
-                                 ->addString('privateKeyPassphrase', '')
+                                 ->addOptionalString('privateKeyPassphrase', '')
                                  ->addString('foreignKeyFingerprint', '00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00')
                                  ->addString('foreignKeyFingerprintHashingMethod', 'SSH2_FINGERPRINT_MD5')
                                  ->addBoolean('ignoreChmodFail', false)

Classes/Config/Node/AbstractNode.php

@@ -56,6 +56,11 @@ abstract class AbstractNode implements Node
      */
     protected $default;
 
+    /**
+     * @var bool
+     */
+    protected $skipValidators = false;
+
     /**
      * AbstractNode constructor.
      *
@@ -107,12 +112,14 @@ public function validate(ValidationContainer $container, $value)
             $container->addError('Configuration format is wrong');
         } elseif (!array_key_exists($this->name, $value)) {
             $container->addError('Configuration value is not set');
-        } elseif ('' === $value[$this->name] || null === $value[$this->name]) {
-            $container->addError('Configuration value must not be empty');
         } else {
             $this->validateType($container, $value[$this->name]);
-            $this->validateByValidators($container, $value);
-            $this->nodes->validate($container, $value[$this->name]);
+
+            if (!$this->validatorsShouldBeSkipped()) {
+                $this->validateByValidators($container, $value);
+                $this->nodes->validate($container, $value[$this->name]);
+            }
+
         }
     }
 
@@ -168,4 +175,17 @@ public function merge(Node $node)
      * @param mixed $value
      */
     abstract protected function validateType(ValidationContainer $container, $value);
+
+    /**
+     * @return bool
+     */
+    public function validatorsShouldBeSkipped()
+    {
+        return $this->skipValidators;
+    }
+
+    public function skipValidators()
+    {
+        $this->skipValidators = true;
+    }
 }

Classes/Config/Node/Node.php

@@ -36,6 +36,7 @@ interface Node
     const T_ARRAY = 'array';
     const T_STRICT_ARRAY = 'strict_array';
     const T_STRING = 'string';
+    const T_OPTIONAL_STRING = 'optional_string';
     const T_INTEGER = 'integer';
     const T_BOOLEAN = 'boolean';
 

Classes/Config/Node/Specific/AbsSpecNode.php

@@ -41,6 +41,7 @@ abstract class AbsSpecNode extends AbstractNode
      */
     protected static $types = [
         Node::T_STRING => SpecString::class,
+        Node::T_OPTIONAL_STRING => SpecOptionalString::class,
         Node::T_INTEGER => SpecInteger::class,
         Node::T_ARRAY => SpecArray::class,
         Node::T_STRICT_ARRAY => SpecStrictArray::class,

Classes/Config/Node/Specific/SpecInteger.php

@@ -39,7 +39,9 @@ class SpecInteger extends AbsSpecNode
      */
     public function validateType(ValidationContainer $container, $value)
     {
-        if (!is_integer($value)) {
+        if ('' === $value || null === $value) {
+            $container->addError('Configuration value must not be empty');
+        } elseif (!is_integer($value)) {
             $container->addError('The value is not an integer');
         }
     }

Classes/Config/Node/Specific/SpecOptionalString.php

@@ -0,0 +1,60 @@
+<?php
+namespace In2code\In2publishCore\Config\Node\Specific;
+
+/***************************************************************
+ * Copyright notice
+ *
+ * (c) 2018 in2code.de and the following authors:
+ * Oliver Eglseder <[email protected]>
+ *
+ * All rights reserved
+ *
+ * This script is part of the TYPO3 project. The TYPO3 project is
+ * free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * The GNU General Public License can be found at
+ * http://www.gnu.org/copyleft/gpl.html.
+ *
+ * This script is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * This copyright notice MUST APPEAR in all copies of the script!
+ ***************************************************************/
+
+use In2code\In2publishCore\Config\ValidationContainer;
+
+/**
+ * Class SpecString
+ */
+class SpecOptionalString extends AbsSpecNode
+{
+    /**
+     * @param ValidationContainer $container
+     * @param mixed $value
+     */
+    public function validateType(ValidationContainer $container, $value)
+    {
+        if (!is_string($value) && null !== $value) {
+            $container->addError('The value is not a string');
+        }
+
+        if ('' === $value || null === $value) {
+            $this->skipValidators();
+        }
+    }
+
+    /**
+     * @param array|bool|int|string $value
+     *
+     * @return string
+     */
+    public function cast($value)
+    {
+        return (string)$value;
+    }
+}

Classes/Config/Node/Specific/SpecString.php

@@ -39,7 +39,9 @@ class SpecString extends AbsSpecNode
      */
     public function validateType(ValidationContainer $container, $value)
     {
-        if (!is_string($value)) {
+        if ('' === $value || null === $value) {
+            $container->addError('Configuration value must not be empty');
+        } elseif (!is_string($value)) {
             $container->addError('The value is not a string');
         }
     }

Classes/Utility/ConfigurationUtility.php

@@ -0,0 +1,59 @@
+<?php
+namespace In2code\In2publishCore\Utility;
+
+class ConfigurationUtility
+{
+    /**
+     * Merges two configuration arrays recursively
+     *
+     * - the value of items having an identical ALPHANUMERIC key will be REPLACED
+     * - the value of items having an identical NUMERIC key will be ADDED
+     *
+     * @param array $original
+     * @param array $additional
+     * @return array
+     */
+    public static function mergeConfiguration(array $original, array $additional)
+    {
+        $result = $original;
+
+        foreach ($additional as $key => $value) {
+            if (!is_int($key)) {
+                // Replace original value
+                $result[$key] = self::getResultingValue($original, $additional, $key);
+            } else {
+                if (!in_array($value, $original, true)) {
+                    // Add additional value
+                    $result[] = self::getResultingValue($original, $additional, $key);
+                }
+            }
+        }
+
+        return $result;
+    }
+
+    /**
+     * @param array $original
+     * @param array $additional
+     * @param mixed $key
+     * @return array|mixed|null
+     */
+    private static function getResultingValue(array $original, array $additional, $key)
+    {
+        $originalValue = array_key_exists($key, $original) ? $original[$key] : null;
+        $additionalValue = array_key_exists($key, $additional) ? $additional[$key] : null;
+
+        if (is_array($originalValue)
+            &&
+            is_array($additionalValue)
+        ) {
+            // Merge recursively
+            $result = self::mergeConfiguration($originalValue, $additionalValue);
+        } else {
+            // Use additional value (to add/replace)
+            $result = $additionalValue;
+        }
+
+        return $result;
+    }
+}