Use a delegator factory + HelperConfig

`HelperConfig` contains a lot of logic for ensuring that the navigation helpers
are injected with the view helper plugin manager as well as the application
container, and cannot be deprecated safely. As a result, this patch uses a new
approach: a delegator factory, which uses `HelperConfig` to configure the helper
manager before returning it.

This approach should still be safe, as the various other approaches that
configure it operate on the already retrieved helper manager instance.

Author: weierophinney

CHANGELOG.md

@@ -7,16 +7,17 @@ All notable changes to this project will be documented in this file, in reverse
 ### Added
 
 - [#26](https://github.com/zendframework/zend-navigation/pull/26) adds:
+  - `Zend\Navigation\View\ViewHelperManagerDelegatorFactory`, which decorates
+    the `ViewHelperManager` service to configure it using
+    `Zend\Navigation\View\HelperConfig`.
   - `ConfigProvider`, which maps the default navigation factory and the
     navigation abstract factory, as well as the navigation view helper.
   - `Module`, which does the same as the above, but for zend-mvc
     applications.
 
 ### Deprecated
 
-- [#26](https://github.com/zendframework/zend-navigation/pull/26) deprecates
-  `Zend\Navigation\View\HelperConfig`, as the functionality is now provided
-  by the above additions.
+- Nothing.
 
 ### Removed
 

src/ConfigProvider.php

@@ -7,8 +7,6 @@
 
 namespace Zend\Navigation;
 
-use Zend\View\Helper\Havigation as NavigationHelper;
-
 class ConfigProvider
 {
     /**
@@ -38,29 +36,11 @@ public function getDependencyConfig()
             'aliases' => [
                 'navigation' => Navigation::class,
             ],
-            'factories' => [
-                Navigation::class => Service/DefaultNavigationFactory::class,
-            ],
-        ];
-    }
-
-    /**
-     * Return zend-navigation helper configuration.
-     *
-     * Obsoletes View\HelperConfig.
-     *
-     * @return array
-     */
-    public function getViewHelperConfig()
-    {
-        return [
-            'aliases' => [
-                'navigation' => NavigationHelper::class,
-                'Navigation' => NavigationHelper::class,
+            'delegators' => [
+                'ViewHelperManager' => [ View\ViewHelperManagerDelegatorFactory::class ],
             ],
             'factories' => [
-                NavigationHelper::class    => View\NavigationHelperFactory::class,
-                'zendviewhelpernavigation' => View\NavigationHelperFactory::class,
+                Navigation::class => Service/DefaultNavigationFactory::class,
             ],
         ];
     }

src/View/HelperConfig.php

@@ -11,7 +11,6 @@
 
 use ReflectionProperty;
 use Traversable;
-use Zend\Navigation\ConfigProvider;
 use Zend\ServiceManager\Config;
 use Zend\ServiceManager\Factory\InvokableFactory;
 use Zend\ServiceManager\ServiceManager;
@@ -20,26 +19,30 @@
 
 /**
  * Service manager configuration for navigation view helpers
- *
- * @deprecated since 2.7.0, by \Zend\Navigation\ConfigProvider
  */
 class HelperConfig extends Config
 {
     /**
-     * Default configuration keys.
+     * Default configuration to apply.
      *
      * @var string[][]
      */
     protected $config = [
         'abstract_factories' => [],
-        'aliases'            => [],
-        'delegators'         => [],
-        'factories'          => [],
-        'initializers'       => [],
-        'invokables'         => [],
-        'lazy_services'      => [],
-        'services'           => [],
-        'shared'             => [],
+        'aliases' => [
+            'navigation' => NavigationHelper::class,
+            'Navigation' => NavigationHelper::class,
+        ],
+        'delegators' => [],
+        'factories' => [
+            NavigationHelper::class    => NavigationHelperFactory::class,
+            'zendviewhelpernavigation' => NavigationHelperFactory::class,
+        ],
+        'initializers'  => [],
+        'invokables'    => [],
+        'lazy_services' => [],
+        'services'      => [],
+        'shared'        => [],
     ];
 
     /**
@@ -52,17 +55,12 @@ class HelperConfig extends Config
     /**
      * Constructor.
      *
-     * Imports the configuration from the ConfigProvider, and then ensures
-     * incoming configuration is merged with it.
+     * Ensure incoming configuration is *merged* with the defaults defined.
      *
      * @param array
      */
     public function __construct(array $config = [])
     {
-        $this->config = ArrayUtils::merge(
-            $this->config,
-            (new ConfigProvider())->getViewHelperConfig()
-        );
         $this->mergeConfig($config);
     }
 

src/View/ViewHelperManagerDelegatorFactory.php

@@ -0,0 +1,44 @@
+<?php
+/**
+ * @link      http://github.com/zendframework/zend-navigation for the canonical source repository
+ * @copyright Copyright (c) 2005-2016 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\Navigation\View;
+
+use Interop\Container\ContainerInterface;
+use Zend\ServiceManager\DelegatorFactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+
+/**
+ * Inject the zend-view HelperManager with zend-navigation view helper configuration.
+ *
+ * This approach is used for backwards compatibility. The HelperConfig class performs
+ * work to ensure that the navigation helper and all its sub-helpers are injected
+ * with the view helper manager and application container.
+ */
+class ViewHelperManagerDelegatorFactory implements DelegatorFactoryInterface
+{
+    /**
+     * {@inheritDoc}
+     *
+     * @return \Zend\View\HelperPluginManager
+     */
+    public function __invoke(ContainerInterface $container, $name, callable $callback, array $options = [])
+    {
+        $viewHelpers = $callback();
+        (new HelperConfig())->configureServiceManager($viewHelpers);
+        return $viewHelpers;
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * @return \Zend\View\HelperPluginManager
+     */
+    public function createDelegatorWithName(ServiceLocatorInterface $container, $name, $requestedName, $callback)
+    {
+        return $this($container, $requestedName, $callback);
+    }
+}

test/View/ViewHelperManagerDelegatorFactoryTest.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * @link      http://github.com/zendframework/zend-navigation for the canonical source repository
+ * @copyright Copyright (c) 2005-2016 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace ZendTest\Navigation\View;
+
+use PHPUnit_Framework_TestCase as TestCase;
+use Zend\Navigation\View\ViewHelperManagerDelegatorFactory;
+use Zend\ServiceManager\ServiceManager;
+use Zend\View\HelperPluginManager;
+use Zend\View\Helper\Navigation as NavigationHelper;
+
+class ViewHelperManagerDelegatorFactoryTest extends TestCase
+{
+    public function testFactoryConfiguresViewHelperManagerWithNavigationHelpers()
+    {
+        $services = new ServiceManager();
+        $helpers = new HelperPluginManager($services);
+        $callback = function () use ($helpers) {
+            return $helpers;
+        };
+
+        $factory = new ViewHelperManagerDelegatorFactory();
+        $this->assertSame($helpers, $factory($services, 'ViewHelperManager', $callback));
+
+        $this->assertTrue($helpers->has('navigation'));
+        $this->assertTrue($helpers->has(NavigationHelper::class));
+    }
+}