Merge branch 'hotfix/allow-generating-config-file' into develop

Close #160

Author: weierophinney

doc/book/console-tools.md

@@ -14,22 +14,24 @@ Usage:
 Arguments:
 
   -h|--help|help    This usage message
-  <configFile>      Path to an existing config file for which to generate
-                    additional configuration. Must return an array.
+  <configFile>      Path to a config file for which to generate configuration.
+                    If the file does not exist, it will be created. If it does
+                    exist, it must return an array, and the file will be
+                    updated with new configuration.
   <className>       Name of the class to reflect and for which to generate
                     dependency configuration.
 
 
-Reads the provided configuration file, and injects it with
-ConfigAbstractFactory dependency configuration for the provided class
-name, writing the changes back to the file.
+Reads the provided configuration file (creating it if it does not exist),
+and injects it with ConfigAbstractFactory dependency configuration for
+the provided class name, writing the changes back to the file.
 ```
 
 This utility will generate dependency configuration for the named class for use
 with the [ConfigAbstractFactory](config-abstract-factory.md). When doing so, it
-will read the named configuration file, and merge any configuration it generates
-with the return values of that file, writing the changes back to the original
-file.
+will read the named configuration file (creating it if it does not exist), and
+merge any configuration it generates with the return values of that file,
+writing the changes back to the original file.
 
 ## generate-factory-for-class
 

src/Tool/ConfigDumperCommand.php

@@ -26,14 +26,16 @@ class ConfigDumperCommand
 <info>Arguments:</info>
 
   <info>-h|--help|help</info>    This usage message
-  <info><configFile></info>      Path to an existing config file for which to generate
-                    additional configuration. Must return an array.
+  <info><configFile></info>      Path to a config file for which to generate configuration.
+                    If the file does not exist, it will be created. If it does
+                    exist, it must return an array, and the file will be
+                    updated with new configuration.
   <info><className></info>       Name of the class to reflect and for which to generate
                     dependency configuration.
 
-Reads the provided configuration file, and injects it with
-ConfigAbstractFactory dependency configuration for the provided class
-name, writing the changes back to the file.
+Reads the provided configuration file (creating it if it does not exist),
+and injects it with ConfigAbstractFactory dependency configuration for
+the provided class name, writing the changes back to the file.
 EOH;
 
     /**
@@ -119,21 +121,31 @@ private function parseArgs(array $args)
             return $this->createErrorArgument('Missing class name');
         }
 
-        if (! file_exists($arg1)) {
-            return $this->createErrorArgument(sprintf(
-                'Cannot find configuration file at path "%s"',
-                $arg1
-            ));
-        }
-
         $configFile = $arg1;
-        $config = require $configFile;
+        switch (file_exists($configFile)) {
+            case true:
+                $config = require $configFile;
 
-        if (! is_array($config)) {
-            return $this->createErrorArgument(sprintf(
-                'Configuration at path "%s" does not return an array.',
-                $configFile
-            ));
+                if (! is_array($config)) {
+                    return $this->createErrorArgument(sprintf(
+                        'Configuration at path "%s" does not return an array.',
+                        $configFile
+                    ));
+                }
+
+                break;
+            case false:
+                // fall-through
+            default:
+                if (! is_writable(dirname($configFile))) {
+                    return $this->createErrorArgument(sprintf(
+                        'Cannot create configuration at path "%s"; not writable.',
+                        $configFile
+                    ));
+                }
+
+                $config = [];
+                break;
         }
 
         $class = array_shift($args);

test/Tool/ConfigDumperCommandTest.php

@@ -77,12 +77,37 @@ public function testEmitsErrorWhenTooFewArgumentsPresent()
         $this->assertEquals(1, $command(['foo']));
     }
 
-    public function testEmitsErrorWhenConfigurationFileNotFound()
+    public function testRaisesExceptionIfConfigFileNotFoundAndDirectoryNotWritable()
     {
         $command = $this->command;
-        $this->assertErrorRaised('Cannot find configuration file at path "foo"');
+        vfsStream::newDirectory('config', 0550)
+            ->at($this->configDir);
+        $config = vfsStream::url('project/config/test.config.php');
+        $this->assertErrorRaised(sprintf('Cannot create configuration at path "%s"; not writable.', $config));
         $this->assertHelp(STDERR);
-        $this->assertEquals(1, $command(['foo', 'Not\A\Real\Class']));
+        $this->assertEquals(1, $command([$config, 'Not\A\Real\Class']));
+    }
+
+    public function testGeneratesConfigFileWhenProvidedConfigurationFileNotFound()
+    {
+        $command = $this->command;
+        vfsStream::newDirectory('config', 0775)
+            ->at($this->configDir);
+        $config = vfsStream::url('project/config/test.config.php');
+
+        $this->helper->writeLine('<info>[DONE]</info> Changes written to ' . $config)->shouldBeCalled();
+
+        $this->assertEquals(0, $command([$config, SimpleDependencyObject::class]));
+
+        $generated = include $config;
+        $this->assertInternalType('array', $generated);
+        $this->assertArrayHasKey(ConfigAbstractFactory::class, $generated);
+        $factoryConfig = $generated[ConfigAbstractFactory::class];
+        $this->assertInternalType('array', $factoryConfig);
+        $this->assertArrayHasKey(SimpleDependencyObject::class, $factoryConfig);
+        $this->assertArrayHasKey(InvokableObject::class, $factoryConfig);
+        $this->assertContains(InvokableObject::class, $factoryConfig[SimpleDependencyObject::class]);
+        $this->assertEquals([], $factoryConfig[InvokableObject::class]);
     }
 
     public function testEmitsErrorWhenConfigurationFileDoesNotReturnArray()