Create logic to generate valid config file output

- Added `dumpConfigFile` static method, which will dump a config file
  written in PHP that returns an array. Values use array notation and
  `::class` notation.
- Updated bin script to echo results of `dumpConfigFile()`, and to use
  try/catch block around `createDependencyConfig()`, reporting errors if
  necessary.

Author: weierophinney

bin/dump-config.php

@@ -33,9 +33,15 @@
     exit(1);
 }
 
-if (! class_exists($className)) {
-    fwrite(STDERR, sprintf('Class "%s" does not exist%s', $className, PHP_EOL));
-    exit(1);
+try {
+    $config = Tool\CliTool::createDependencyConfig($appConfig, $className);
+} catch (Exception\InvalidArgumentException $e) {
+    fwrite(STDERR, sprintf(
+        'Unable to create config for "%s": %s%s',
+        $className,
+        $e->getMessage(),
+        PHP_EOL
+    ));
 }
-
-Tool\CliTool::createDependencyConfig($appConfig, $className);
+echo Tool\CliTool::dumpConfigFile($config);
+exit(0);

src/Tool/CliTool.php

@@ -9,11 +9,22 @@
 
 namespace Zend\ServiceManager\Tool;
 
+use Traversable;
 use Zend\ServiceManager\AbstractFactory\ConfigAbstractFactory;
 use Zend\ServiceManager\Exception\InvalidArgumentException;
 
 class CliTool
 {
+    const CONFIG_TEMPLATE = <<<EOC
+<?php
+/**
+ * This file generated by Zend\ServiceManager\Tool\CliTool.
+ * Generated %s
+ */
+
+return %s;
+EOC;
+
     /**
      * @param array $config
      * @param $className
@@ -107,4 +118,38 @@ public static function createFactoryMappings(array $config, $className)
         $config['service_manager']['factories'][$className] = ConfigAbstractFactory::class;
         return $config;
     }
+
+    public static function dumpConfigFile(array $config)
+    {
+        $prepared = self::prepareConfig($config);
+        return sprintf(self::CONFIG_TEMPLATE, date('Y-m-d H:i:s'), $prepared);
+    }
+
+    private static function prepareConfig($config, $indentLevel = 1)
+    {
+        $indent = str_repeat(' ', $indentLevel * 4);
+        $entries = [];
+        foreach ($config as $key => $value) {
+            $key = class_exists($key)
+                ? sprintf('\\%s::class', $key)
+                : sprintf("'%s'", $key);
+            $value = is_array($value) || $value instanceof Traversable
+                ? self::prepareConfig($value, $indentLevel + 1)
+                : var_export($value, true);
+            $entries[] = sprintf(
+                '%s%s => %s,',
+                $indent,
+                $key,
+                $value
+            );
+        }
+
+        $outerIndent = str_repeat(' ', ($indentLevel - 1) * 4);
+
+        return sprintf(
+            "[\n%s\n%s]",
+            implode("\n", $entries),
+            $outerIndent
+        );
+    }
 }

test/Tool/CliToolTest.php

@@ -10,6 +10,7 @@
 
 namespace ZendTest\ServiceManager\Tool;
 
+use PHPUnit_Framework_TestCase as TestCase;
 use Zend\ServiceManager\AbstractFactory\ConfigAbstractFactory;
 use Zend\ServiceManager\Exception\InvalidArgumentException;
 use Zend\ServiceManager\Tool\CliTool;
@@ -19,7 +20,7 @@
 use ZendTest\ServiceManager\TestAsset\SecondComplexDependencyObject;
 use ZendTest\ServiceManager\TestAsset\SimpleDependencyObject;
 
-class CliToolTest extends \PHPUnit_Framework_TestCase
+class CliToolTest extends TestCase
 {
     public function testCreateDependencyConfigExceptsIfClassNameIsNotString()
     {
@@ -63,6 +64,7 @@ public function testCreateDependencyConfigSimpleDependencyReturnsCorrectly()
             ],
             $config
         );
+        return $config;
     }
 
     public function testCreateDependencyConfigClassWithoutConstructorChangesNothing()
@@ -188,4 +190,26 @@ public function testCreateFactoryMappingsFromConfigWithWorkingConfig()
 
         self::assertEquals($expectedConfig, CliTool::createFactoryMappingsFromConfig($config));
     }
+
+    /**
+     * @depends testCreateDependencyConfigSimpleDependencyReturnsCorrectly
+     */
+    public function testDumpConfigFileReturnsContentsForConfigFileUsingUsingClassNotationAndShortArrays(array $config)
+    {
+        $formatted = CliTool::dumpConfigFile($config);
+        $this->assertContains(
+            '<' . "?php\n/**\n * This file generated by Zend\ServiceManager\Tool\CliTool.\n",
+            $formatted
+        );
+
+        $this->assertNotContains('array(', $formatted);
+        $this->assertContains('::class', $formatted);
+
+        $file = tempnam(sys_get_temp_dir(), 'ZSCLI');
+        file_put_contents($file, $formatted);
+        $test = include($file);
+        unlink($file);
+
+        $this->assertEquals($test, $config);
+    }
 }