Merge branch 'hotfix/config-writing' into develop

Close #155

Author: weierophinney

composer.json

@@ -22,7 +22,8 @@
         "phpunit/phpunit": "^4.6 || ^5.2.10",
         "ocramius/proxy-manager": "^1.0 || ^2.0",
         "squizlabs/php_codesniffer": "^2.5.1",
-        "phpbench/phpbench": "^0.10.0"
+        "phpbench/phpbench": "^0.10.0",
+        "mikey179/vfsStream": "^1.6"
     },
     "suggest": {
         "ocramius/proxy-manager": "ProxyManager 1.* to handle lazy initialization of services",

doc/book/console-tools.md

@@ -19,25 +19,17 @@ Arguments:
   <className>       Name of the class to reflect and for which to generate
                     dependency configuration.
 
-Generates to STDOUT a replacement configuration file containing dependency
-configuration for the named class with which to configure the
-ConfigAbstractFactory.
+
+Reads the provided configuration file, 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, emitting the updated version to STDOUT.
-This allows you to pipe it back to the original:
-
-```bash
-$ ./vendor/bin/generate-deps-for-config-factory \
-> ./config/autoload/dependencies.local.php \
-> "Application\\Model\\AlbumModel" > ./config/autoload/dependencies.local.php
-```
-
-Alternately, you can pipe them to a new file, so that you can diff the original
-to the generated file.
+with the return values of that file, writing the changes back to the original
+file.
 
 ## generate-factory-for-class
 

src/Tool/ConfigDumperCommand.php

@@ -31,9 +31,9 @@ class ConfigDumperCommand
   <info><className></info>       Name of the class to reflect and for which to generate
                     dependency configuration.
 
-Generates to STDOUT a replacement configuration file containing dependency
-configuration for the named class with which to configure the
-ConfigAbstractFactory.
+Reads the provided configuration file, and injects it with
+ConfigAbstractFactory dependency configuration for the provided class
+name, writing the changes back to the file.
 EOH;
 
     /**
@@ -90,7 +90,12 @@ public function __invoke(array $args)
             return 1;
         }
 
-        $this->helper->write($dumper->dumpConfigFile($config), false);
+        file_put_contents($arguments->configFile, $dumper->dumpConfigFile($config));
+
+        $this->helper->writeLine(sprintf(
+            '<info>[DONE]</info> Changes written to %s',
+            $arguments->configFile
+        ));
         return 0;
     }
 
@@ -101,45 +106,46 @@ public function __invoke(array $args)
     private function parseArgs(array $args)
     {
         if (! count($args)) {
-            return $this->createArguments(self::COMMAND_HELP);
+            return $this->createHelpArgument();
         }
 
         $arg1 = array_shift($args);
 
         if (in_array($arg1, ['-h', '--help', 'help'], true)) {
-            return $this->createArguments(self::COMMAND_HELP);
+            return $this->createHelpArgument();
         }
 
         if (! count($args)) {
-            return $this->createArguments(self::COMMAND_ERROR, null, null, 'Missing class name');
+            return $this->createErrorArgument('Missing class name');
         }
 
         if (! file_exists($arg1)) {
-            return $this->createArguments(self::COMMAND_ERROR, null, null, sprintf(
+            return $this->createErrorArgument(sprintf(
                 'Cannot find configuration file at path "%s"',
                 $arg1
             ));
         }
 
-        $config = require $arg1;
+        $configFile = $arg1;
+        $config = require $configFile;
 
         if (! is_array($config)) {
-            return $this->createArguments(self::COMMAND_ERROR, null, null, sprintf(
+            return $this->createErrorArgument(sprintf(
                 'Configuration at path "%s" does not return an array.',
-                $arg1
+                $configFile
             ));
         }
 
         $class = array_shift($args);
 
         if (! class_exists($class)) {
-            return $this->createArguments(self::COMMAND_ERROR, null, null, sprintf(
+            return $this->createErrorArgument(sprintf(
                 'Class "%s" does not exist or could not be autoloaded.',
                 $class
             ));
         }
 
-        return $this->createArguments(self::COMMAND_DUMP, $config, $class);
+        return $this->createArguments(self::COMMAND_DUMP, $configFile, $config, $class);
     }
 
     /**
@@ -156,18 +162,41 @@ private function help($resource = STDOUT)
 
     /**
      * @param string $command
-     * @param array|null $config Parsed configuration.
-     * @param string|null $class Name of class to reflect.
-     * @param string|null $message Error message, if any.
+     * @param string $configFile File from which config originates, and to
+     *     which it will be written.
+     * @param array $config Parsed configuration.
+     * @param string $class Name of class to reflect.
+     * @return \stdClass
+     */
+    private function createArguments($command, $configFile, $config, $class)
+    {
+        return (object) [
+            'command'    => $command,
+            'configFile' => $configFile,
+            'config'     => $config,
+            'class'      => $class,
+        ];
+    }
+
+    /**
+     * @param string $message
+     * @return \stdClass
+     */
+    private function createErrorArgument($message)
+    {
+        return (object) [
+            'command' => self::COMMAND_ERROR,
+            'message' => $message,
+        ];
+    }
+
+    /**
      * @return \stdClass
      */
-    private function createArguments($command, $config = null, $class = null, $error = null)
+    private function createHelpArgument()
     {
         return (object) [
-            'command' => $command,
-            'config'  => $config,
-            'class'   => $class,
-            'message' => $error,
+            'command' => self::COMMAND_HELP,
         ];
     }
 }

test/Tool/ConfigDumperCommandTest.php

@@ -7,8 +7,11 @@
 
 namespace ZendTest\ServiceManager\Tool;
 
+use org\bovigo\vfs\vfsStream;
+use org\bovigo\vfs\vfsStreamDirectory;
 use PHPUnit_Framework_TestCase as TestCase;
 use Prophecy\Argument;
+use Zend\ServiceManager\AbstractFactory\ConfigAbstractFactory;
 use Zend\ServiceManager\Tool\ConfigDumperCommand;
 use Zend\Stdlib\ConsoleHelper;
 use ZendTest\ServiceManager\TestAsset\InvokableObject;
@@ -19,6 +22,7 @@ class ConfigDumperCommandTest extends TestCase
 {
     public function setUp()
     {
+        $this->configDir = vfsStream::setup('project');
         $this->helper = $this->prophesize(ConsoleHelper::class);
         $this->command = new ConfigDumperCommand(ConfigDumperCommand::class, $this->helper->reveal());
     }
@@ -84,7 +88,10 @@ public function testEmitsErrorWhenConfigurationFileNotFound()
     public function testEmitsErrorWhenConfigurationFileDoesNotReturnArray()
     {
         $command = $this->command;
-        $config = realpath(__DIR__ . '/../TestAsset/config/invalid.config.php');
+        vfsStream::newFile('config/invalid.config.php')
+            ->at($this->configDir)
+            ->setContent(file_get_contents(realpath(__DIR__ . '/../TestAsset/config/invalid.config.php')));
+        $config = vfsStream::url('project/config/invalid.config.php');
         $this->assertErrorRaised('Configuration at path "' . $config . '" does not return an array.');
         $this->assertHelp(STDERR);
         $this->assertEquals(1, $command([$config, 'Not\A\Real\Class']));
@@ -93,7 +100,10 @@ public function testEmitsErrorWhenConfigurationFileDoesNotReturnArray()
     public function testEmitsErrorWhenClassDoesNotExist()
     {
         $command = $this->command;
-        $config = realpath(__DIR__ . '/../TestAsset/config/test.config.php');
+        vfsStream::newFile('config/test.config.php')
+            ->at($this->configDir)
+            ->setContent(file_get_contents(realpath(__DIR__ . '/../TestAsset/config/test.config.php')));
+        $config = vfsStream::url('project/config/test.config.php');
         $this->assertErrorRaised('Class "Not\\A\\Real\\Class" does not exist or could not be autoloaded.');
         $this->assertHelp(STDERR);
         $this->assertEquals(1, $command([$config, 'Not\A\Real\Class']));
@@ -102,7 +112,10 @@ public function testEmitsErrorWhenClassDoesNotExist()
     public function testEmitsErrorWhenUnableToCreateConfiguration()
     {
         $command = $this->command;
-        $config = realpath(__DIR__ . '/../TestAsset/config/test.config.php');
+        vfsStream::newFile('config/test.config.php')
+            ->at($this->configDir)
+            ->setContent(file_get_contents(realpath(__DIR__ . '/../TestAsset/config/test.config.php')));
+        $config = vfsStream::url('project/config/test.config.php');
         $this->assertErrorRaised('Unable to create config for "' . ObjectWithScalarDependency::class . '":');
         $this->assertHelp(STDERR);
         $this->assertEquals(1, $command([$config, ObjectWithScalarDependency::class]));
@@ -111,24 +124,23 @@ public function testEmitsErrorWhenUnableToCreateConfiguration()
     public function testEmitsConfigFileToStdoutWhenSuccessful()
     {
         $command = $this->command;
-        $config = realpath(__DIR__ . '/../TestAsset/config/test.config.php');
+        vfsStream::newFile('config/test.config.php')
+            ->at($this->configDir)
+            ->setContent(file_get_contents(realpath(__DIR__ . '/../TestAsset/config/test.config.php')));
+        $config = vfsStream::url('project/config/test.config.php');
 
-        $this->helper->write(Argument::that(function ($config) {
-            if (! strstr($config, 'return [')) {
-                return false;
-            }
-
-            if (! strstr($config, SimpleDependencyObject::class . '::class => [')) {
-                return false;
-            }
-
-            if (! strstr($config, InvokableObject::class . '::class => [')) {
-                return false;
-            }
-
-            return true;
-        }), false)->shouldBeCalled();
+        $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]);
     }
 }