Format generated config files using the short array syntax

Author: cykirsch

lib/internal/Magento/Framework/App/DeploymentConfig/Writer/PhpFormatter.php

@@ -11,6 +11,8 @@
  */
 class PhpFormatter implements FormatterInterface
 {
+    const INDENT = '  ';
+
     /**
      * Format deployment configuration.
      * If $comments is present, each item will be added
@@ -23,7 +25,7 @@ public function format($data, array $comments = [])
         if (!empty($comments) && is_array($data)) {
             return "<?php\nreturn array (\n" . $this->formatData($data, $comments) . "\n);\n";
         }
-        return "<?php\nreturn " . var_export($data, true) . ";\n";
+        return "<?php\nreturn " . $this->varExportShort($data, true) . ";\n";
     }
 
     /**
@@ -65,4 +67,27 @@ private function formatData($data, $comments = [], $prefix = '  ')
 
         return var_export($data, true);
     }
+
+    /**
+     * If variable to export is an array, format with the php >= 5.4 short array syntax. Otherwise use
+     * default var_export functionality.
+     *
+     * @param mixed   $var
+     * @param integer $depth
+     * @return string
+     */
+    private function varExportShort($var, $depth=0) {
+        if (gettype($var) === 'array') {
+            $indexed = array_keys($var) === range(0, count($var) - 1);
+            $r = [];
+            foreach ($var as $key => $value) {
+                $r[] = str_repeat(self::INDENT, $depth)
+                    . ($indexed ? '' : $this->varExportShort($key) . ' => ')
+                    . $this->varExportShort($value, $depth + 1);
+            }
+            return sprintf("[\n%s\n%s]", implode(",\n", $r), str_repeat(self::INDENT, $depth - 1));
+        }
+
+        return var_export($var, TRUE);
+    }
 }

lib/internal/Magento/Framework/App/Test/Unit/DeploymentConfig/Writer/PhpFormatterTest.php

@@ -129,13 +129,37 @@ public function formatWithCommentDataProvider()
   'ns4' => 'just text',
 );
 
+TEXT;
+
+        $expectedResult3 = <<<TEXT
+<?php
+return [
+  'ns1' => [
+    's1' => [
+      's11',
+      's12'
+    ],
+    's2' => [
+      's21',
+      's22'
+    ]
+  ],
+  'ns2' => [
+    's1' => [
+      's11'
+    ]
+  ],
+  'ns3' => 'just text',
+  'ns4' => 'just text'
+];
+
 TEXT;
         return [
             ['string', [], "<?php\nreturn 'string';\n"],
             ['string', ['comment'], "<?php\nreturn 'string';\n"],
-            [$array, [], "<?php\nreturn " . var_export($array, true) . ";\n"],
             [$array, $comments1, $expectedResult1],
             [$array, $comments2, $expectedResult2],
+            [$array, [], $expectedResult3],
         ];
     }
 }