Allow mutability of the container

This patch reverts the changes that implemented immutability, and
re-instates the various set/add methods used in v2 for configuring the
container. Specifically:

- `withConfig()` was removed.
- `configure()` was made public.
- Re-added:
  - `setAlias()`
  - `setInvokableClass()`
  - `setFactory()`
  - `addAbstractFactory()`
  - `addDelegator()`
  - `addInitializer()`
  - `setService()`
  - `setShared()`
  - all of which proxy to `configure()`
- Added `mapLazyService($name, $class = null)`, for creating a lazy service mapping
  from a service name to a given class.
- Re-added `setAllowOverride()` for toggling immutability. When toggled
  on, all calls to `configure()` raise `ContainerModificationsNotAllowedException`.
  Its counterpart getter, `getAllowOverride()`, was also re-isntated.

Tests were added for all new behaviors, and the tests for `withConfig()`
were removed.

Author: weierophinney

src/Config.php

@@ -66,11 +66,11 @@ public function __construct(array $config = [])
      * Configure service manager
      *
      * @param ServiceManager $serviceManager
-     * @return ServiceManager Returns a new instance with the merged configuration.
+     * @return ServiceManager Returns the updated service manager instance.
      */
     public function configureServiceManager(ServiceManager $serviceManager)
     {
-        return $serviceManager->withConfig($this->config);
+        return $serviceManager->configure($this->config);
     }
 
     /**

src/Exception/ContainerModificationsNotAllowedException.php

@@ -0,0 +1,19 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\ServiceManager\Exception;
+
+use DomainException;
+
+/**
+ * @inheritDoc
+ */
+class ContainerModificationsNotAllowedException extends DomainException implements ExceptionInterface
+{
+}

src/ServiceManager.php

@@ -15,6 +15,7 @@
 use ProxyManager\Configuration as ProxyConfiguration;
 use ProxyManager\Factory\LazyLoadingValueHolderFactory;
 use ProxyManager\GeneratorStrategy\EvaluatingGeneratorStrategy;
+use Zend\ServiceManager\Exception\ContainerModificationsNotAllowedException;
 use Zend\ServiceManager\Exception\InvalidArgumentException;
 use Zend\ServiceManager\Exception\ServiceNotCreatedException;
 use Zend\ServiceManager\Factory\AbstractFactoryInterface;
@@ -53,6 +54,13 @@ class ServiceManager implements ServiceLocatorInterface
      */
     protected $aliases = [];
 
+    /**
+     * Whether or not changes may be made to this instance.
+     *
+     * @param bool
+     */
+    protected $allowOverride = true;
+
     /**
      * @var ContainerInterface
      */
@@ -132,26 +140,6 @@ public function __construct(array $config = [])
         $this->configure($config);
     }
 
-    /**
-     * Create a new service locator that merges the provided configuration.
-     *
-     * Note that the original service locator is left untouched (as with PSR-7
-     * interfaces).
-     *
-     * See {@see \Zend\ServiceManager\ServiceManager::configure()} for details
-     * on what $config accepts.
-     *
-     * @param  array $config
-     * @return ContainerInterface
-     */
-    public function withConfig(array $config)
-    {
-        $container                  = clone $this;
-        $container->creationContext = ($this === $this->creationContext) ? $container : $this->creationContext;
-        $container->configure($config);
-        return $container;
-    }
-
     /**
      * {@inheritDoc}
      */
@@ -230,6 +218,26 @@ public function has($name)
         return false;
     }
 
+    /**
+     * Indicate whether or not the instance is immutable.
+     *
+     * @param bool $flag
+     */
+    public function setAllowOverride($flag)
+    {
+        $this->allowOverride = (bool) $flag;
+    }
+
+    /**
+     * Retrieve the flag indicating immutability status.
+     *
+     * @return bool
+     */
+    public function getAllowOverride()
+    {
+        return $this->allowOverride;
+    }
+
     /**
      * Configure the service manager
      *
@@ -265,10 +273,18 @@ public function has($name)
      *   should be shared by default.
      *
      * @param  array $config
-     * @return void
+     * @return self
+     * @throws ContainerModificationsNotAllowedException if the allow
+     *     override flag has been toggled off.
      */
-    protected function configure(array $config)
+    public function configure(array $config)
     {
+        if ($this->allowOverride === false) {
+            throw new ContainerModificationsNotAllowedException(
+                'Overrides have been disabled on this container instance'
+            );
+        }
+
         if (isset($config['services'])) {
             $this->services = $config['services'] + $this->services;
         }
@@ -326,6 +342,109 @@ protected function configure(array $config)
         }
 
         $this->resolveAliases();
+
+        return $this;
+    }
+
+    /**
+     * Add an alias.
+     *
+     * @param string $alias
+     * @param string $target
+     */
+    public function setAlias($alias, $target)
+    {
+        $this->configure(['aliases' => [$alias => $target]]);
+    }
+
+    /**
+     * Add an invokable class mapping.
+     *
+     * @param string $name Service name
+     * @param null|string $class Class to which to map; if omitted, $name is
+     *     assumed.
+     */
+    public function setInvokableClass($name, $class = null)
+    {
+        $this->configure(['invokables' => [$name => $class ?: $name]]);
+    }
+
+    /**
+     * Specify a factory for a given service name.
+     *
+     * @param string $name Service name
+     * @param string|callable|Factory\FactoryInterface $factory Factory to which
+     *     to map.
+     */
+    public function setFactory($name, $factory)
+    {
+        $this->configure(['factories' => [$name => $factory]]);
+    }
+
+    /**
+     * Create a lazy service mapping to a class.
+     *
+     * @param string $name Service name to map
+     * @param null|string $class Class to which to map; if not provided, $name
+     *     will be used for the mapping.
+     */
+    public function mapLazyService($name, $class = null)
+    {
+        $this->configure(['lazy_services' => ['class_map' => [$name => $class ?: $name]]]);
+    }
+
+    /**
+     * Add an abstract factory for resolving services.
+     *
+     * @param string|Factory\AbstractFactoryInterface $name Service name
+     */
+    public function addAbstractFactory($factory)
+    {
+        $this->configure(['abstract_factories' => [$factory]]);
+    }
+
+    /**
+     * Add a delegator for a given service.
+     *
+     * @param string $name Service name
+     * @param string|callable|Factory\DelegatorFactoryInterface $factory Delegator
+     *     factory to assign.
+     */
+    public function addDelegator($name, $factory)
+    {
+        $this->configure(['delegators' => [$name => [$factory]]]);
+    }
+
+    /**
+     * Add an initializer.
+     *
+     * @param string|callable|Initalizer\InitializerInterface $initalizer
+     */
+    public function addInitializer($initializer)
+    {
+        $this->configure(['initializers' => [$initializer]]);
+    }
+
+    /**
+     * Map a service.
+     *
+     * @param string $name Service name
+     * @param array|object $service
+     */
+    public function setService($name, $service)
+    {
+        $this->configure(['services' => [$name => $service]]);
+    }
+
+    /**
+     * Add a service sharing rule.
+     *
+     * @param string $name Service name
+     * @param boolean $flag Whether or not the service should be shared.
+     */
+    public function setShared($name, $flag)
+    {
+        $this->configure(['shared' => [$name => (bool) $flag]]);
     }
 
     /**

test/AbstractPluginManagerTest.php

@@ -164,52 +164,4 @@ function ($container, $name, $callback) {
         );
         $this->assertEquals('bar', $instance->foo);
     }
-
-    public function testWithConfigProperlySetsCreationContextToOriginalCreationContext()
-    {
-        $config = [
-            'factories' => [
-                InvokableObject::class => new InvokableFactory(),
-            ],
-        ];
-
-        $services = new ServiceManager();
-        $plugins  = new SimplePluginManager($services);
-
-        $revised = $plugins->withConfig(['factories' => [
-            'foo' => function ($container, $name) {
-            },
-        ]]);
-
-        $this->assertAttributeSame($services, 'creationContext', $revised);
-    }
-
-    /**
-     * Overrides test from CommonServiceLocatorBehaviorsTrait
-     *
-     * Behavior of creation context differs for plugin managers.
-     */
-    public function testCanCreateNewLocatorWithMergedConfig()
-    {
-        $serviceManager = $this->createContainer([
-            'factories' => [
-                DateTime::class => InvokableFactory::class
-            ]
-        ]);
-
-        $newServiceManager = $serviceManager->withConfig([
-            'factories' => [
-                stdClass::class => InvokableFactory::class
-            ]
-        ]);
-
-        $this->assertTrue($serviceManager->has(DateTime::class));
-        $this->assertFalse($serviceManager->has(stdClass::class));
-
-        $this->assertTrue($newServiceManager->has(DateTime::class));
-        $this->assertTrue($newServiceManager->has(stdClass::class));
-
-        // Make sure the context has been updated for the new container
-        $this->assertAttributeSame($this->creationContext, 'creationContext', $newServiceManager);
-    }
 }