Renaming Cache Resource plugin to CacheManager

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@20057 44c647ce-9c0f-0410-b52a-842ac1e357ba

documentation/manual/en/module_specs/Zend_Application-AvailableResources-Cache.xml → documentation/manual/en/module_specs/Zend_Application-AvailableResources-CacheManager.xml

@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- Reviewed: no -->
-<sect2 id="zend.application.available-resources.cache">
-    <title>Zend_Application_Resource_Cache</title>
+<sect2 id="zend.application.available-resources.cachemanager">
+    <title>Zend_Application_Resource_Cachemanager</title>
 
     <para>
-        <classname>Zend_Application_Resource_Cache</classname> may be
+        <classname>Zend_Application_Resource_Cachemanager</classname> may be
         utilised to configure a set of <classname>Zend_Cache</classname> option
         bundles for use when lazy loading caches using
         <classname>Zend_Cache_Manager</classname>
@@ -15,24 +15,24 @@
         to option templates used to instantiate a cache object on request.
     </para>
 
-    <example id="zend.application.available-resources.cache.configExample">
-        <title>Sample Cache resource configuration</title>
+    <example id="zend.application.available-resources.cachemanager.configExample">
+        <title>Sample Cachemanager resource configuration</title>
 
         <para>
             Below is a sample <acronym>INI</acronym> file showing how
             <classname>Zend_Cache_Manager</classname> may be configured. The format
-            is the Cache resource prefix (resources.cache) followed
-            by the name to assign to an option cache template/bundle (e.g.
-            resources.cache.database) and finally followed by a typical
+            is the Cachemanager resource prefix (resources.cachemanager) followed
+            be the name to assign to an option cache template/bundle (e.g.
+            resources.cachemanager.database) and finally followed by a typical
             <classname>Zend_Cache</classname> option.
         </para>
 
         <programlisting language="ini"><![CDATA[
-resources.cache.database.frontend.name = Core
-resources.cache.database.frontend.options.lifetime = 7200
-resources.cache.database.frontend.options.automatic_serialization = true
-resources.cache.database.backend.name = File
-resources.cache.database.backend.options.cache_dir = "/path/to/cache"
+resources.cachemanager.database.frontend.name = Core
+resources.cachemanager.database.frontend.options.lifetime = 7200
+resources.cachemanager.database.frontend.options.automatic_serialization = true
+resources.cachemanager.database.backend.name = File
+resources.cachemanager.database.backend.options.cache_dir = "/path/to/cache"
 ]]></programlisting>
 
         <para>

documentation/manual/en/module_specs/Zend_Cache-Cache_Manager.xml

@@ -178,7 +178,7 @@ $databaseCache = $manager->getCache('database');
 
     <para>
         To assist in making the Cache Manager more useful, it is accompanied by
-        <classname>Zend_Application_Resource_Cache</classname> and also
+        <classname>Zend_Application_Resource_Cachemanager</classname> and also
         the <classname>Zend_Controller_Action_Helper_Cache</classname> Action
         Helper. Both of these are described in their relevant areas of the
         Reference Guide.

library/Zend/Application/Resource/Cache.php

@@ -45,21 +45,7 @@ class Zend_Application_Resource_Cache extends Zend_Application_Resource_Resource
      */
     public function init()
     {
-        $manager = $this->getCache();
-
-        foreach ($this->getOptions() as $key => $value) {
-            if ($manager->hasCacheTemplate($key)) {
-                $manager->setTemplateOptions($key, $value);
-            } else {
-                $manager->setCacheTemplate($key, $value);
-            }
-        }
-
-        if (null !== ($bootstrap = $this->getBootstrap())) {
-            $this->getBootstrap()->cacheManager = $manager;
-        }
-
-        return $manager;
+        return $this->getCacheManager();
     }
 
     /**
@@ -67,10 +53,19 @@ class Zend_Application_Resource_Cache extends Zend_Application_Resource_Resource
      *
      * @return Zend_Cache_Manager
      */
-    public function getCache()
+    public function getCacheManager()
     {
         if (null === $this->_manager) {
             $this->_manager = new Zend_Cache_Manager;
+
+            $options = $this->getOptions();
+            foreach ($options as $key => $value) {
+                if ($this->_manager->hasCacheTemplate($key)) {
+                    $this->_manager->setTemplateOptions($key, $value);
+                } else {
+                    $this->_manager->setCacheTemplate($key, $value);
+                }
+            }
         }
 
         return $this->_manager;

library/Zend/Application/Resource/Cachemanager.php

@@ -0,0 +1,77 @@
+<?php
+/**
+ * Zend Framework
+ *
+ * LICENSE
+ *
+ * This source file is subject to the new BSD license that is bundled
+ * with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://framework.zend.com/license/new-bsd
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@zend.com so we can send you a copy immediately.
+ *
+ * @category   Zend
+ * @package    Zend_Application
+ * @subpackage Resource
+ * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ * @version    $Id$
+ */
+
+require_once 'Zend/Application/Resource/ResourceAbstract.php';
+
+/**
+ * Cache Manager resource
+ *
+ * @category   Zend
+ * @package    Zend_Application
+ * @subpackage Resource
+ * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ */
+class Zend_Application_Resource_Cachemanager extends Zend_Application_Resource_ResourceAbstract
+{
+    /**
+     * @var Zend_Cache_Manager
+     */
+    protected $_manager = null;
+
+    /**
+     * Initialize Cache_Manager
+     *
+     * @return Zend_Cache_Manager
+     */
+    public function init()
+    {
+        $manager = $this->getCacheManager();
+
+        foreach ($this->getOptions() as $key => $value) {
+            if ($manager->hasCacheTemplate($key)) {
+                $manager->setTemplateOptions($key, $value);
+            } else {
+                $manager->setCacheTemplate($key, $value);
+            }
+        }
+
+        if (null !== ($bootstrap = $this->getBootstrap())) {
+            $this->getBootstrap()->cacheManager = $manager;
+        }
+
+        return $manager;
+    }
+
+    /**
+     * Retrieve front controller instance
+     *
+     * @return Zend_Controller_Front
+     */
+    public function getCacheManager()
+    {
+        if (null === $this->_manager) {
+            $this->_manager = new Zend_Cache_Manager;
+        }
+        return $this->_manager;
+    }
+}

tests/Zend/Application/Resource/AllTests.php

@@ -27,7 +27,7 @@ if (!defined('PHPUnit_MAIN_METHOD')) {
 }
 
 require_once 'Zend/Application/Resource/ResourceAbstractTest.php';
-require_once 'Zend/Application/Resource/CacheTest.php';
+require_once 'Zend/Application/Resource/CacheManagerTest.php';
 require_once 'Zend/Application/Resource/DbTest.php';
 require_once 'Zend/Application/Resource/DojoTest.php';
 require_once 'Zend/Application/Resource/FrontcontrollerTest.php';
@@ -61,7 +61,7 @@ class Zend_Application_Resource_AllTests
         $suite = new PHPUnit_Framework_TestSuite('Zend Framework - Zend_Application_Resource');
 
         $suite->addTestSuite('Zend_Application_Resource_ResourceAbstractTest');
-        $suite->addTestSuite('Zend_Application_Resource_CacheTest');
+        $suite->addTestSuite('Zend_Application_Resource_CacheManagerTest');
         $suite->addTestSuite('Zend_Application_Resource_DbTest');
         $suite->addTestSuite('Zend_Application_Resource_DojoTest');
         $suite->addTestSuite('Zend_Application_Resource_FrontcontrollerTest');

tests/Zend/Application/Resource/CacheManagerTest.php

@@ -0,0 +1,161 @@
+<?php
+/**
+ * Zend Framework
+ *
+ * LICENSE
+ *
+ * This source file is subject to the new BSD license that is bundled
+ * with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://framework.zend.com/license/new-bsd
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@zend.com so we can send you a copy immediately.
+ *
+ * @category   Zend
+ * @package    Zend_Application
+ * @subpackage UnitTests
+ * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ * @version    $Id$
+ */
+
+if (!defined('PHPUnit_MAIN_METHOD')) {
+    define('PHPUnit_MAIN_METHOD', 'Zend_Application_Resource_CacheManagerTest::main');
+}
+
+/**
+ * Test helper
+ */
+require_once dirname(__FILE__) . '/../../../TestHelper.php';
+
+/**
+ * Zend_Loader_Autoloader
+ */
+require_once 'Zend/Loader/Autoloader.php';
+
+/**
+ * Zend_Controller_Front
+ */
+require_once 'Zend/Controller/Front.php';
+
+/**
+ * Zend_Application_Resource_Cachemanager
+ */
+require_once 'Zend/Application/Resource/Cachemanager.php';
+
+/**
+ * @category   Zend
+ * @package    Zend_Application
+ * @subpackage UnitTests
+ * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ * @group      Zend_Application
+ */
+class Zend_Application_Resource_CacheManagerTest extends PHPUnit_Framework_TestCase
+{
+    public static function main()
+    {
+        $suite  = new PHPUnit_Framework_TestSuite(__CLASS__);
+        $result = PHPUnit_TextUI_TestRunner::run($suite);
+    }
+
+    public function setUp()
+    {
+        // Store original autoloaders
+        $this->loaders = spl_autoload_functions();
+        if (!is_array($this->loaders)) {
+            // spl_autoload_functions does not return empty array when no
+            // autoloaders registered...
+            $this->loaders = array();
+        }
+
+        Zend_Loader_Autoloader::resetInstance();
+        $this->autoloader = Zend_Loader_Autoloader::getInstance();
+
+        $this->application = new Zend_Application('testing');
+
+        require_once dirname(__FILE__) . '/../_files/ZfAppBootstrap.php';
+        $this->bootstrap = new ZfAppBootstrap($this->application);
+    }
+
+    public function tearDown()
+    {
+        // Restore original autoloaders
+        $loaders = spl_autoload_functions();
+        foreach ($loaders as $loader) {
+            spl_autoload_unregister($loader);
+        }
+
+        foreach ($this->loaders as $loader) {
+            spl_autoload_register($loader);
+        }
+
+        Zend_Controller_Front::getInstance()->resetInstance();
+
+        // Reset autoloader instance so it doesn't affect other tests
+        Zend_Loader_Autoloader::resetInstance();
+    }
+
+    public function testInitializationCreatesCacheManagerInstance()
+    {
+
+        $resource = new Zend_Application_Resource_Cachemanager(array());
+        $resource->init();
+        $this->assertTrue($resource->getCachemanager() instanceof Zend_Cache_Manager);
+    }
+
+    public function testInitializationPushesCacheManagerToBootstrapWhenPresent()
+    {
+        $resource = new Zend_Application_Resource_Cachemanager(array());
+        $resource->setBootstrap($this->bootstrap);
+        $resource->init();
+        $this->assertSame($resource->getCachemanager(), $this->bootstrap->cacheManager);
+    }
+
+    public function testShouldReturnCacheManagerWhenComplete()
+    {
+        $resource = new Zend_Application_Resource_Cachemanager(array());
+        $manager = $resource->init();
+        $this->assertTrue($manager instanceof Zend_Cache_Manager);
+    }
+
+    public function testShouldMergeConfigsIfOptionsPassedForDefaultCacheTemplate()
+    {
+        $options = array(
+            'page' => array(
+                'backend' => array(
+                    'options' => array(
+                        'cache_dir' => '/foo'
+                    )
+                )
+            )
+        );
+        $resource = new Zend_Application_Resource_Cachemanager($options);
+        $manager = $resource->init();
+        $cacheTemplate = $manager->getCacheTemplate('page');
+        $this->assertEquals('/foo', $cacheTemplate['backend']['options']['cache_dir']);
+
+    }
+    public function testShouldCreateNewCacheTemplateIfConfigNotMatchesADefaultTemplate()
+    {
+        $options = array(
+            'foo' => array(
+                'backend' => array(
+                    'options' => array(
+                        'cache_dir' => '/foo'
+                    )
+                )
+            )
+        );
+        $resource = new Zend_Application_Resource_Cachemanager($options);
+        $manager = $resource->init();
+        $cacheTemplate = $manager->getCacheTemplate('foo');
+        $this->assertSame($options['foo'], $cacheTemplate);
+    }
+
+}
+
+if (PHPUnit_MAIN_METHOD == 'Zend_Application_Resource_CacheManagerTest::main') {
+    Zend_Application_Resource_CacheManagerTest::main();
+}

tests/Zend/Application/Resource/CacheTest.php

@@ -105,13 +105,15 @@ class Zend_Application_Resource_CacheTest extends PHPUnit_Framework_TestCase
         $this->assertTrue($resource->getCache() instanceof Zend_Cache_Manager);
     }
 
-    public function testInitializationPushesCacheManagerToBootstrapWhenPresent()
+/*    public function testInitializationPushesCacheManagerToBootstrapWhenPresent()
     {
         $resource = new Zend_Application_Resource_Cache(array());
         $resource->setBootstrap($this->bootstrap);
         $resource->init();
-        $this->assertSame($resource->getCache(), $this->bootstrap->cacheManager);
-    }
+        $this->bootstrap->registerPluginResource('cache');
+        $this->bootstrap->bootstrap();
+        $this->assertSame($resource->getCache(), $this->bootstrap->getResource('cache'));
+    }*/
 
     public function testShouldReturnCacheManagerWhenComplete()
     {