Merge pull request tedious#168 from tedivm/DriverList

Renamed Drivers class to DriverList

Author: tedivm

CHANGELOG.md

@@ -30,9 +30,11 @@
 
 * Replaced "Item->setDriver" with "Item->setPool" function. This should have no effect on typical consumers of this library but may effect those extending the Item or Pool class.
 
-* Added Drivers::getAllDrivers which returns an unfiltered list of registered drivers.
+* Renamed Drivers class to DriversList to prevent confusion when talking about "Drivers".
 
-* Added Drivers::getAvailableDrivers to replace the existing Drivers::getDrivers, which is now deprecated.
+* Added DriversList::getAllDrivers which returns an unfiltered list of registered drivers.
+
+* Added DriversList::getAvailableDrivers to replace the existing DriversList::getDrivers, which is now deprecated.
 
 * Added "setDriver(DriverInterface $driver)" and "setKey($key, $namespace = null)" functions to the Item Interface. These functions are used by Pool to initialize the Item class.
 

src/Stash/Drivers.php renamed to src/Stash/DriverList.php

@@ -12,12 +12,12 @@
 namespace Stash;
 
 /**
- * Drivers contains various functions used to organize Driver classes that are available in the system.
+ * DriverList contains various functions used to organize Driver classes that are available in the system.
  *
  * @package Stash
  * @author Robert Hafner <tedivm@tedivm.com>
  */
-class Drivers
+class DriverList
 {
  /**
  * An array of possible cache storage data methods, with the driver class as the array value.

tests/Stash/Test/DriversTest.php renamed to tests/Stash/Test/DriverListTest.php

@@ -11,42 +11,42 @@
 
 namespace Stash\Test;
 
-use Stash\Drivers;
+use Stash\DriverList;
 
 /**
  * @package Stash
  * @author Robert Hafner <tedivm@tedivm.com>
  */
-class DriversTest extends \PHPUnit_Framework_TestCase
+class DriverListTest extends \PHPUnit_Framework_TestCase
 {
  public function testGetAvailableDrivers()
  {
- $drivers = Drivers::getAvailableDrivers();
+ $drivers = DriverList::getAvailableDrivers();
  $this->assertArrayHasKey('FileSystem', $drivers, 'getDrivers returns FileSystem driver');
  $this->assertArrayNotHasKey('Array', $drivers, 'getDrivers doesn\'t return Array driver');
  }
 
  public function testGetDrivers()
  {
- $availableDrivers = Drivers::getAvailableDrivers();
- $getDrivers = Drivers::getDrivers();
+ $availableDrivers = DriverList::getAvailableDrivers();
+ $getDrivers = DriverList::getDrivers();
  $this->assertEquals($availableDrivers, $getDrivers, 'getDrivers is an alias for getAvailableDrivers');
 
  }
 
  public function testRegisterDriver()
  {
- Drivers::registerDriver('Array', 'Stash\Driver\Ephemeral');
+ DriverList::registerDriver('Array', 'Stash\Driver\Ephemeral');
 
- $drivers = Drivers::getDrivers();
+ $drivers = DriverList::getDrivers();
  $this->assertArrayHasKey('Array', $drivers, 'getDrivers returns Array driver');
  }
 
  public function testGetDriverClass()
  {
- $this->assertEquals('Stash\Driver\Ephemeral', Drivers::getDriverClass('Array'), 'getDriverClass returns proper classname for Array driver');
+ $this->assertEquals('Stash\Driver\Ephemeral', DriverList::getDriverClass('Array'), 'getDriverClass returns proper classname for Array driver');
 
- $this->assertFalse(Drivers::getDriverClass('FakeName'), 'getDriverClass returns false for nonexistent class.');
+ $this->assertFalse(DriverList::getDriverClass('FakeName'), 'getDriverClass returns false for nonexistent class.');
 
  }