Merge branch 'feature/154' into develop

Close #154

Author: weierophinney

CHANGELOG.md

@@ -11,6 +11,17 @@ All notable changes to this project will be documented in this file, in reverse
   configuration-based approach to providing class dependencies when all
   dependencies are services known to the `ServiceManager`. Please see
   [the documentation](doc/book/config-abstract-factory.md) for details.
+- [#154](https://github.com/zendframework/zend-servicemanager/pull/154) adds
+  `Zend\ServiceManager\Tool\ConfigDumper`, which will introspect a given class
+  to determine dependencies, and then create configuration for
+  `Zend\ServiceManager\AbstractFactory\ConfigAbstractFactory`, merging it with
+  the provided configuration file. It also adds a vendor binary,
+  `generate-deps-for-config-factory`, for generating these from the command
+  line.
+- [#154](https://github.com/zendframework/zend-servicemanager/pull/154) adds
+  `Zend\ServiceManager\Tool\FactoryCreator`, which will introspect a given class
+  and generate a factory for it. It also adds a vendor binary,
+  `generate-factory-for-class`, for generating these from the command line.
 
 ### Deprecated
 

bin/generate-deps-for-config-factory

@@ -0,0 +1,25 @@
+#!/usr/bin/env php
+<?php
+/**
+ * @link      http://github.com/zendframework/zend-servicemanager for the canonical source repository
+ * @copyright Copyright (c) 2016 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\ServiceManager;
+
+// Setup/verify autoloading
+if (file_exists($a = getcwd() . '/vendor/autoload.php')) {
+    require $a;
+} elseif (file_exists($a = __DIR__ . '/../../../autoload.php')) {
+    require $a;
+} elseif (file_exists($a = __DIR__ . '/../vendor/autoload.php')) {
+    require $a;
+} else {
+    fwrite(STDERR, 'Cannot locate autoloader; please run "composer install"' . PHP_EOL);
+    exit(1);
+}
+
+$command = new Tool\ConfigDumperCommand($argv[0]);
+$status = $command(array_slice($argv, 1));
+exit($status);

bin/generate-factory-for-class

@@ -0,0 +1,25 @@
+#!/usr/bin/env php
+<?php
+/**
+ * @link      http://github.com/zendframework/zend-servicemanager for the canonical source repository
+ * @copyright Copyright (c) 2016 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\ServiceManager;
+
+// Setup/verify autoloading
+if (file_exists($a = getcwd() . '/vendor/autoload.php')) {
+    require $a;
+} elseif (file_exists($a = __DIR__ . '/../../../autoload.php')) {
+    require $a;
+} elseif (file_exists($a = __DIR__ . '/../vendor/autoload.php')) {
+    require $a;
+} else {
+    fwrite(STDERR, 'Cannot locate autoloader; please run "composer install"' . PHP_EOL);
+    exit(1);
+}
+
+$command = new Tool\FactoryCreatorCommand($argv[0]);
+$status = $command(array_slice($argv, 1));
+exit($status);

composer.json

@@ -15,7 +15,8 @@
     },
     "require": {
         "php": "^5.6 || ^7.0",
-        "container-interop/container-interop": "~1.0"
+        "container-interop/container-interop": "~1.0",
+        "zendframework/zend-stdlib": "^3.1"
     },
     "require-dev": {
         "phpunit/phpunit": "^4.6 || ^5.2.10",
@@ -43,5 +44,9 @@
     },
     "provide": {
         "container-interop/container-interop-implementation": "^1.1"
-    }
+    },
+    "bin": [
+        "bin/generate-deps-for-config-factory",
+        "bin/generate-factory-for-class"
+    ]
 }

doc/book/console-tools.md

@@ -0,0 +1,71 @@
+# Console Tools
+
+Starting in 3.2.0, zend-servicemanager began shipping with console tools. This
+document details each.
+
+## generate-deps-for-config-factory
+
+```bash
+$ ./vendor/bin/generate-deps-for-config-factory
+Usage:
+
+  generate-deps-for-config-factory [-h|--help|help] <configFile> <className>
+
+Arguments:
+
+  -h|--help|help    This usage message
+  <configFile>      Path to an existing config file for which to generate
+                    additional configuration. Must return an array.
+  <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.
+```
+
+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.
+
+## generate-factory-for-class
+
+```bash
+$ ./vendor/bin/generate-factory-for-class
+
+Usage:
+
+  ./bin/generate-factory-for-class [-h|--help|help] <className>
+
+Arguments:
+
+  -h|--help|help    This usage message
+  <className>       Name of the class to reflect and for which to generate
+                    a factory.
+
+Generates to STDOUT a factory for creating the specified class; this may then
+be added to your application, and configured as a factory for the class.
+```
+
+This utility generates a factory class for the given class, based on the
+typehints in its constructor. The factory is emitted to STDOUT, and may be piped
+to a file if desired:
+
+```bash
+$ ./vendor/bin/generate-factory-for-class \
+> "Application\\Model\\AlbumModel" > ./module/Application/src/Model/AlbumModelFactory.php
+```
+
+The class generated implements `Zend\ServiceManager\Factory\FactoryInterface`,
+and is generated within the same namespace as the originating class.

mkdocs.yml

@@ -9,6 +9,7 @@ pages:
       - 'Lazy services': lazy-services.md
       - 'Plugin managers': plugin-managers.md
       - 'Configuration-based Abstract Factory': config-abstract-factory.md
+      - 'Console Tools': console-tools.md
     - 'Migration Guide': migration.md
 site_name: zend-servicemanager
 site_description: 'zend-servicemanager: factory-driven dependency injection container'

phpcs.xml

@@ -9,13 +9,20 @@
     <!-- inherit rules from: -->
     <rule ref="PSR2"/>
     <rule ref="Generic.Arrays.DisallowLongArraySyntax"/>
+    <rule ref="Generic.Formatting.SpaceAfterNot"/>
+    <rule ref="Squiz.WhiteSpace.OperatorSpacing">
+        <properties>
+            <property name="ignoreNewlines" value="true"/>
+        </properties>
+    </rule>
     <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace">
         <properties>
             <property name="ignoreBlankLines" value="false"/>
         </properties>
     </rule>
 
     <!-- Paths to check -->
+    <file>bin</file>
     <file>src</file>
     <file>test</file>
     <exclude-pattern>*/test/log/*</exclude-pattern>

src/AbstractFactory/ConfigAbstractFactory.php

@@ -22,7 +22,7 @@ final class ConfigAbstractFactory implements AbstractFactoryInterface
      */
     public function canCreate(\Interop\Container\ContainerInterface $container, $requestedName)
     {
-        if (!$container->has('config') || !array_key_exists(self::class, $container->get('config'))) {
+        if (! $container->has('config') || ! array_key_exists(self::class, $container->get('config'))) {
             return false;
         }
         $config = $container->get('config');
@@ -36,25 +36,25 @@ public function canCreate(\Interop\Container\ContainerInterface $container, $req
      */
     public function __invoke(\Interop\Container\ContainerInterface $container, $requestedName, array $options = null)
     {
-        if (!$container->has('config')) {
+        if (! $container->has('config')) {
             throw new ServiceNotCreatedException('Cannot find a config array in the container');
         }
 
         $config = $container->get('config');
 
-        if (!is_array($config)) {
+        if (! is_array($config)) {
             throw new ServiceNotCreatedException('Config must be an array');
         }
 
-        if (!array_key_exists(self::class, $config)) {
+        if (! array_key_exists(self::class, $config)) {
             throw new ServiceNotCreatedException('Cannot find a `' . self::class . '` key in the config array');
         }
 
         $dependencies = $config[self::class];
 
-        if (!is_array($dependencies)
-            || !array_key_exists($requestedName, $dependencies)
-            || !is_array($dependencies[$requestedName])
+        if (! is_array($dependencies)
+            || ! array_key_exists($requestedName, $dependencies)
+            || ! is_array($dependencies[$requestedName])
         ) {
             throw new ServiceNotCreatedException('Dependencies config must exist and be an array');
         }

src/Config.php

@@ -111,7 +111,7 @@ private function merge(array $a, array $b)
                     $a[$key] = $value;
                 }
             } else {
-                if (!$value instanceof MergeRemoveKey) {
+                if (! $value instanceof MergeRemoveKey) {
                     $a[$key] = $value;
                 }
             }

src/ServiceManager.php

@@ -520,7 +520,7 @@ private function resolveAbstractFactories(array $abstractFactories)
         foreach ($abstractFactories as $abstractFactory) {
             if (is_string($abstractFactory) && class_exists($abstractFactory)) {
                 //Cached string
-                if (!isset($this->cachedAbstractFactories[$abstractFactory])) {
+                if (! isset($this->cachedAbstractFactories[$abstractFactory])) {
                     $this->cachedAbstractFactories[$abstractFactory] = new $abstractFactory();
                 }
 
@@ -754,7 +754,7 @@ private function createDelegatorFromName($name, array $options = null)
     private function doCreate($resolvedName, array $options = null)
     {
         try {
-            if (!isset($this->delegators[$resolvedName])) {
+            if (! isset($this->delegators[$resolvedName])) {
                 // Let's create the service by fetching the factory
                 $factory = $this->getFactory($resolvedName);
                 $object  = $factory($this->creationContext, $resolvedName, $options);
@@ -889,7 +889,7 @@ private function createFactoriesForInvokables(array $invokables)
      */
     private function validateOverrides(array $config)
     {
-        if ($this->allowOverride || !$this->configured) {
+        if ($this->allowOverride || ! $this->configured) {
             return;
         }