Refactoring the StorageManager

Author: Florian Krämer

src/Storage/StorageManager.php

@@ -2,13 +2,14 @@
 namespace Burzum\FileStorage\Storage;
 
 use InvalidArgumentException;
+use ReflectionClass;
 use RuntimeException;
 
 /**
  * StorageManager - manages and instantiates Gaufrette storage engine instances
  *
  * @author Florian Krämer
- * @copyright 2012 - 2016 Florian Krämer
+ * @copyright 2012 - 2017 Florian Krämer
  * @license MIT
  */
 class StorageManager {
@@ -26,6 +27,13 @@ class StorageManager {
 		]
 	];
 
+	/**
+	 * Adapter objects
+	 *
+	 * @var array
+	 */
+	protected $_adapterInstances = [];
+
 	/**
 	 * Return a singleton instance of the StorageManager.
 	 *
@@ -71,22 +79,23 @@ public static function config($adapter, $options = array()) {
 	public static function setConfig($configName, array $configOptions) {
 		$_this = StorageManager::getInstance();
 		$_this->_adapterConfig[$configName] = $configOptions;
+		unset($_this->_adapterInstances[$configName]);
 	}
 
 	/**
 	 * Get an adapter config
 	 *
-	 * @param string $configName Configuration name
+	 * @param string $name Configuration name
 	 * @return array
 	 */
-	public static function getConfig($configName) {
+	public static function getConfig($name) {
 		$_this = StorageManager::getInstance();
 
-		if (!isset($_this->_adapterConfig[$configName])) {
-			throw new RuntimeException(sprintf('Storage adapter config `%s` does not exist', $configName));
+		if (!isset($_this->_adapterConfig[$name])) {
+			throw new RuntimeException(sprintf('Storage adapter config `%s` does not exist', $name));
 		}
 
-		return $_this->_adapterConfig[$configName];
+		return $_this->_adapterConfig[$name];
 	}
 
 	/**
@@ -100,6 +109,7 @@ public static function flush($name = null) {
 
 		if (isset($_this->_adapterConfig[$name])) {
 			unset($_this->_adapterConfig[$name]);
+			unset($_this->_adapterInstances[$name]);
 			return true;
 		}
 
@@ -113,6 +123,7 @@ public static function flush($name = null) {
 	 * @param boolean $renewObject Creates a new instance of the given adapter in the configuration
 	 * @throws \RuntimeException
 	 * @return \Gaufrette\Filesystem
+	 * @deprecated Use StorageManager::getAdapter() instead
 	 */
 	public static function adapter($adapterName, $renewObject = false) {
 		return self::getAdapter($adapterName, $renewObject);
@@ -121,44 +132,54 @@ public static function adapter($adapterName, $renewObject = false) {
 	/**
 	 * Gets a configured instance of a storage adapter.
 	 *
-	 * @param mixed $adapterName string of adapter configuration or array of settings
+	 * @param mixed $name string of adapter configuration or array of settings
 	 * @param boolean $renewObject Creates a new instance of the given adapter in the configuration
 	 * @throws \RuntimeException
 	 * @return \Gaufrette\Filesystem
 	 */
-	public static function getAdapter($adapterName, $renewObject = false) {
+	public static function getAdapter($name, $renewObject = false) {
 		$_this = StorageManager::getInstance();
 
-		$isConfigured = true;
-		if (is_string($adapterName)) {
-			if (!empty($_this->_adapterConfig[$adapterName])) {
-				$adapter = $_this->_adapterConfig[$adapterName];
-			} else {
-				throw new RuntimeException(sprintf('Invalid Storage Adapter %s!', $adapterName));
+		if (is_string($name)) {
+			if (!empty($_this->_adapterInstances[$name]) && $renewObject === false) {
+				return $_this->_adapterInstances[$name];
 			}
 
-			if (!empty($_this->_adapterConfig[$adapterName]['object']) && $renewObject === false) {
-				return $_this->_adapterConfig[$adapterName]['object'];
+			if (!empty($_this->_adapterConfig[$name])) {
+				$adapter = $_this->_adapterConfig[$name];
+			} else {
+				throw new RuntimeException(sprintf('Invalid Storage Adapter %s!', $name));
 			}
 		}
 
-		if (is_array($adapterName)) {
-			$adapter = $adapterName;
-			$isConfigured = false;
+		if (is_array($name)) {
+			$adapter = $name;
 		}
 
 		$class = $adapter['adapterClass'];
-		$Reflection = new \ReflectionClass($class);
+		$Reflection = new ReflectionClass($class);
 		if (!is_array($adapter['adapterOptions'])) {
-			throw new InvalidArgumentException(sprintf('%s: The adapter options must be an array!', $adapterName));
+			throw new InvalidArgumentException(sprintf('%s: The adapter options must be an array!', $name));
 		}
 
 		$adapterObject = $Reflection->newInstanceArgs($adapter['adapterOptions']);
 		$engineObject = new $adapter['class']($adapterObject);
-		if ($isConfigured) {
-			$_this->_adapterConfig[$adapterName]['object'] = &$engineObject;
-		}
+		$_this->_adapterInstances[$name] = &$engineObject;
 
 		return $engineObject;
 	}
+
+	/**
+	 * Returns an array that can be used to describe the internal state of this
+	 * object.
+	 *
+	 * @return array
+	 */
+	public function __debugInfo() {
+		$_this = StorageManager::getInstance();
+		return [
+			'_adapterConfig' => $_this->_adapterConfig,
+			'_adapterInstances' => $_this->_adapterInstances,
+		];
+	}
 }

tests/TestCase/Storage/StorageManagerTest.php

@@ -3,7 +3,7 @@
  * StorageManagerTest
  *
  * @author Florian Krämer
- * @copyright 2012 - 2016 Florian Krämer
+ * @copyright 2012 - 2017 Florian Krämer
  * @license MIT
  */
 namespace Burzum\FileStorage\Test\TestCase\Lib;
@@ -12,11 +12,12 @@
 use Burzum\FileStorage\Storage\StorageManager;
 
 class StorageManagerTest extends FileStorageTestCase {
-/**
- * testAdapter
- *
- * @return void
- */
+
+	/**
+	 * testAdapter
+	 *
+	 * @return void
+	 */
 	public function testAdapter() {
 		$result = StorageManager::adapter('Local');
 		$this->assertEquals(get_class($result), 'Gaufrette\Filesystem');
@@ -27,11 +28,11 @@ public function testAdapter() {
 		} catch (\RuntimeException $e) {}
 	}
 
-/**
- * testConfig
- *
- * @return void
- */
+	/**
+	 * testConfig
+	 *
+	 * @return void
+	 */
 	public function testConfig() {
 		$result = StorageManager::config('Local');
 		$expected = [
@@ -42,16 +43,15 @@ public function testConfig() {
 			'adapterClass' => '\Gaufrette\Adapter\Local',
 			'class' => '\Gaufrette\Filesystem'
 		];
-
 		$this->assertEquals($result, $expected);
 		$this->assertFalse(StorageManager::config('Does not exist'));
 	}
 
-/**
- * testFlush
- *
- * @return void
- */
+	/**
+	 * testFlush
+	 *
+	 * @return void
+	 */
 	public function testFlush() {
 		$config = StorageManager::config('Local');
 		$result  = StorageManager::flush('Local');