Merge branch 'develop'

Promote develop to master, becoming the next stable release.
zendframework · Mar 12, 2014 · 3b54f16 · 3b54f16
commit 3b54f16
Show file tree

Hide file tree

Showing 36 changed files with 146 additions and 49 deletions.
diff --git a/composer.json b/composer.json
@@ -12,13 +12,25 @@
         }
     },
     "require": {
-        "php": ">=5.3.3",
+        "php": ">=5.3.23",
         "zendframework/zend-eventmanager": "self.version",
         "zendframework/zend-stdlib": "self.version"
     },
+    "require-dev": {
+        "zendframework/zend-config": "self.version",
+        "zendframework/zend-console": "self.version",
+        "zendframework/zend-loader": "self.version",
+        "zendframework/zend-mvc": "self.version",
+        "zendframework/zend-servicemanager": "self.version",
+        "fabpot/php-cs-fixer": "1.7.*",
+        "satooshi/php-coveralls": "dev-master",
+        "phpunit/PHPUnit": "~4.0"
+    },
     "suggest": {
         "zendframework/zend-config": "Zend\\Config component",
+        "zendframework/zend-console": "Zend\\Console component",
         "zendframework/zend-loader": "Zend\\Loader component",
+        "zendframework/zend-mvc": "Zend\\Mvc component",
         "zendframework/zend-servicemanager": "Zend\\ServiceManager component"
     },
     "extra": {
@@ -32,10 +44,5 @@
         "psr-4": {
             "ZendTest\\ModuleManager\\": "test/"
         }
-    },
-    "require-dev": {
-        "fabpot/php-cs-fixer": "1.7.*",
-        "satooshi/php-coveralls": "dev-master",
-        "phpunit/PHPUnit": "~4.0"
     }
 }
diff --git a/src/Feature/LogProcessorProviderInterface.php b/src/Feature/LogProcessorProviderInterface.php
@@ -0,0 +1,21 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\ModuleManager\Feature;
+
+interface LogProcessorProviderInterface
+{
+    /**
+     * Expected to return \Zend\ServiceManager\Config object or array to
+     * seed such an object.
+     *
+     * @return array|\Zend\ServiceManager\Config
+     */
+    public function getLogProcessorConfig();
+}
diff --git a/src/Feature/LogWriterProviderInterface.php b/src/Feature/LogWriterProviderInterface.php
@@ -0,0 +1,21 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\ModuleManager\Feature;
+
+interface LogWriterProviderInterface
+{
+    /**
+     * Expected to return \Zend\ServiceManager\Config object or array to
+     * seed such an object.
+     *
+     * @return array|\Zend\ServiceManager\Config
+     */
+    public function getLogWriterConfig();
+}
diff --git a/src/Listener/ConfigListener.php b/src/Listener/ConfigListener.php
@@ -89,8 +89,8 @@ public function attach(EventManagerInterface $events)
         }
 
         $this->callbacks[] = $events->attach(ModuleEvent::EVENT_LOAD_MODULE, array($this, 'onLoadModule'));
-        $this->callbacks[] = $events->attach(ModuleEvent::EVENT_LOAD_MODULES, array($this, 'onLoadModulesPost'), -1000);
-
+        $this->callbacks[] = $events->attach(ModuleEvent::EVENT_LOAD_MODULES, array($this, 'onLoadModules'), -1000);
+        $this->callbacks[] = $events->attach(ModuleEvent::EVENT_MERGE_CONFIG, array($this, 'onMergeConfig'), 1000);
         return $this;
     }
 
@@ -137,7 +137,7 @@ public function onLoadModule(ModuleEvent $e)
      * @param  ModuleEvent $e
      * @return ConfigListener
      */
-    public function onLoadModulesPost(ModuleEvent $e)
+    public function onMergeConfig(ModuleEvent $e)
     {
         // Load the config files
         foreach ($this->paths as $path) {
@@ -150,6 +150,24 @@ public function onLoadModulesPost(ModuleEvent $e)
             $this->mergedConfig = ArrayUtils::merge($this->mergedConfig, $config);
         }
 
+        return $this;
+    }
+
+    /**
+     * Optionally cache merged config
+     *
+     * This is only attached if config is not cached.
+     *
+     * @param  ModuleEvent $e
+     * @return ConfigListener
+     */
+    public function onLoadModules(ModuleEvent $e)
+    {
+
+        // Trigger MERGE_CONFIG event. This is a hook to allow the merged application config to be
+        // modified before it is cached (In particular, allows the removal of config keys)
+        $e->getTarget()->getEventManager()->trigger(ModuleEvent::EVENT_MERGE_CONFIG, $e->getTarget(), $e);
+
         // If enabled, update the config cache
         if (
             $this->getOptions()->getConfigCacheEnabled()

diff --git a/src/ModuleEvent.php b/src/ModuleEvent.php
@@ -20,11 +20,11 @@ class ModuleEvent extends Event
     /**
      * Module events triggered by eventmanager
      */
-    CONST EVENT_MERGE_CONFIG        = 'mergeConfig';
-    CONST EVENT_LOAD_MODULES        = 'loadModules';
-    CONST EVENT_LOAD_MODULE_RESOLVE = 'loadModule.resolve';
-    CONST EVENT_LOAD_MODULE         = 'loadModule';
-    CONST EVENT_LOAD_MODULES_POST   = 'loadModules.post';
+    const EVENT_MERGE_CONFIG        = 'mergeConfig';
+    const EVENT_LOAD_MODULES        = 'loadModules';
+    const EVENT_LOAD_MODULE_RESOLVE = 'loadModule.resolve';
+    const EVENT_LOAD_MODULE         = 'loadModule';
+    const EVENT_LOAD_MODULES_POST   = 'loadModules.post';
 
     /**
      * @var mixed

diff --git a/src/ModuleManager.php b/src/ModuleManager.php
@@ -140,10 +140,24 @@ public function loadModule($module)
             return $this->loadedModules[$moduleName];
         }
 
-        $event = ($this->loadFinished === false) ? clone $this->getEvent() : $this->getEvent();
+        /*
+         * Keep track of nested module loading using the $loadFinished
+         * property.
+         *
+         * Increment the value for each loadModule() call and then decrement
+         * once the loading process is complete.
+         *
+         * To load a module, we clone the event if we are inside a nested
+         * loadModule() call, and use the original event otherwise.
+         */
+        if (!isset($this->loadFinished)) {
+             $this->loadFinished = 0;
+        }
+
+        $event = ($this->loadFinished > 0) ? clone $this->getEvent() : $this->getEvent();
         $event->setModuleName($moduleName);
 
-        $this->loadFinished = false;
+        $this->loadFinished++;
 
         if (!is_object($module)) {
             $module = $this->loadModuleByName($event);
@@ -153,7 +167,7 @@ public function loadModule($module)
         $this->loadedModules[$moduleName] = $module;
         $this->getEventManager()->trigger(ModuleEvent::EVENT_LOAD_MODULE, $this, $event);
 
-        $this->loadFinished = true;
+        $this->loadFinished--;
 
         return $module;
     }

diff --git a/test/Listener/AutoloaderListenerTest.php b/test/Listener/AutoloaderListenerTest.php
@@ -3,7 +3,7 @@
  * Zend Framework (http://framework.zend.com/)
  *
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
- * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
  */
 

diff --git a/test/Listener/ConfigListenerTest.php b/test/Listener/ConfigListenerTest.php
@@ -3,7 +3,7 @@
  * Zend Framework (http://framework.zend.com/)
  *
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
- * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
  */
 
@@ -378,7 +378,7 @@ public function testConfigListenerFunctionsAsAggregateListener()
         $this->assertEquals(2, count($moduleManager->getEventManager()->getEvents()));
 
         $configListener->attach($moduleManager->getEventManager());
-        $this->assertEquals(3, count($moduleManager->getEventManager()->getEvents()));
+        $this->assertEquals(4, count($moduleManager->getEventManager()->getEvents()));
 
         $configListener->detach($moduleManager->getEventManager());
         $this->assertEquals(2, count($moduleManager->getEventManager()->getEvents()));

diff --git a/test/Listener/DefaultListenerAggregateTest.php b/test/Listener/DefaultListenerAggregateTest.php
@@ -3,7 +3,7 @@
  * Zend Framework (http://framework.zend.com/)
  *
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
- * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
  */
 
@@ -108,7 +108,7 @@ public function testDefaultListenerAggregateCanDetachItself()
         $this->assertEquals(1, count($moduleManager->getEventManager()->getEvents()));
 
         $listenerAggregate->attach($moduleManager->getEventManager());
-        $this->assertEquals(3, count($moduleManager->getEventManager()->getEvents()));
+        $this->assertEquals(4, count($moduleManager->getEventManager()->getEvents()));
 
         $listenerAggregate->detach($moduleManager->getEventManager());
         $this->assertEquals(1, count($moduleManager->getEventManager()->getEvents()));

diff --git a/test/Listener/InitTriggerTest.php b/test/Listener/InitTriggerTest.php
@@ -3,7 +3,7 @@
  * Zend Framework (http://framework.zend.com/)
  *
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
- * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
  */
 

diff --git a/test/Listener/ListenerOptionsTest.php b/test/Listener/ListenerOptionsTest.php
@@ -3,7 +3,7 @@
  * Zend Framework (http://framework.zend.com/)
  *
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
- * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
  */
 

diff --git a/test/Listener/LocatorRegistrationListenerTest.php b/test/Listener/LocatorRegistrationListenerTest.php
@@ -3,7 +3,7 @@
  * Zend Framework (http://framework.zend.com/)
  *
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
- * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
  */
 

diff --git a/test/Listener/ModuleDependencyCheckerListenerTest.php b/test/Listener/ModuleDependencyCheckerListenerTest.php
@@ -3,7 +3,7 @@
  * Zend Framework (http://framework.zend.com/)
  *
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
- * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
  */
 

diff --git a/test/Listener/ModuleLoaderListenerTest.php b/test/Listener/ModuleLoaderListenerTest.php
@@ -3,7 +3,7 @@
  * Zend Framework (http://framework.zend.com/)
  *
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
- * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
  */
 

diff --git a/test/Listener/ModuleResolverListenerTest.php b/test/Listener/ModuleResolverListenerTest.php
@@ -3,7 +3,7 @@
  * Zend Framework (http://framework.zend.com/)
  *
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
- * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
  */
 

diff --git a/test/Listener/OnBootstrapListenerTest.php b/test/Listener/OnBootstrapListenerTest.php
@@ -3,7 +3,7 @@
  * Zend Framework (http://framework.zend.com/)
  *
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
- * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
  */
 

diff --git a/test/Listener/ServiceListenerTest.php b/test/Listener/ServiceListenerTest.php
@@ -3,7 +3,7 @@
  * Zend Framework (http://framework.zend.com/)
  *
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
- * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
  */
 

diff --git a/test/Listener/TestAsset/ServiceInvalidReturnModule.php b/test/Listener/TestAsset/ServiceInvalidReturnModule.php
@@ -3,7 +3,7 @@
  * Zend Framework (http://framework.zend.com/)
  *
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
- * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
  */
 

diff --git a/test/Listener/TestAsset/ServiceProviderModule.php b/test/Listener/TestAsset/ServiceProviderModule.php
@@ -3,7 +3,7 @@
  * Zend Framework (http://framework.zend.com/)
  *
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
- * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
  */
 

diff --git a/test/ModuleEventTest.php b/test/ModuleEventTest.php
@@ -3,7 +3,7 @@
  * Zend Framework (http://framework.zend.com/)
  *
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
- * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
  */
 

diff --git a/test/ModuleManagerTest.php b/test/ModuleManagerTest.php
@@ -3,7 +3,7 @@
  * Zend Framework (http://framework.zend.com/)
  *
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
- * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
  */
 
@@ -146,6 +146,21 @@ public function testCanLoadModuleDuringTheLoadModuleEvent()
         $this->assertSame('oh, yeah baby!', $config['loaded']);
     }
 
+    /**
+     * @group 5651
+     */
+    public function testLoadingModuleFromAnotherModuleDemonstratesAppropriateSideEffects()
+    {
+        $configListener = $this->defaultListeners->getConfigListener();
+        $moduleManager  = new ModuleManager(array('LoadOtherModule', 'BarModule'));
+        $moduleManager->getEventManager()->attachAggregate($this->defaultListeners);
+        $moduleManager->loadModules();
+
+        $config = $configListener->getMergedConfig();
+        $this->assertTrue(isset($config['baz']));
+        $this->assertSame('bar', $config['baz']);
+    }
+
     public function testModuleIsMarkedAsLoadedWhenLoadModuleEventIsTriggered()
     {
         $test          = new stdClass;

diff --git a/test/TestAsset/BadConfigModule/Module.php b/test/TestAsset/BadConfigModule/Module.php
@@ -3,7 +3,7 @@
  * Zend Framework (http://framework.zend.com/)
  *
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
- * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
  */
 

diff --git a/test/TestAsset/BafModule/Module.php b/test/TestAsset/BafModule/Module.php
@@ -3,7 +3,7 @@
  * Zend Framework (http://framework.zend.com/)
  *
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
- * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
  */
 

diff --git a/test/TestAsset/BamModule/Module.php b/test/TestAsset/BamModule/Module.php
@@ -3,7 +3,7 @@
  * Zend Framework (http://framework.zend.com/)
  *
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
- * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
  */
 

diff --git a/test/TestAsset/BarModule/Module.php b/test/TestAsset/BarModule/Module.php
@@ -3,7 +3,7 @@
  * Zend Framework (http://framework.zend.com/)
  *
  * @link      http://github.com/zendframework/zf2 for the canonical source repository
- * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
  * @license   http://framework.zend.com/license/new-bsd New BSD License
  */