[2.5] cleanup deprecated uses

* 2.3:
  [ClassLoader] removes deprecated classes from documentation.
  [Yaml] Update README.md
  [Security] fixed wrong phpdoc

ApcUniversalClassLoader.php

@@ -59,6 +59,8 @@ namespace Symfony\Component\ClassLoader;
  * @author Kris Wallsmith <kris@symfony.com>
  *
  * @api
+ *
+ * @deprecated Deprecated since version 2.4, to be removed in 3.0. Use the ApcClassLoader class instead.
  */
 class ApcUniversalClassLoader extends UniversalClassLoader
 {

CHANGELOG.md

@@ -1,6 +1,14 @@
 CHANGELOG
 =========
 
+2.4.0
+-----
+
+ * deprecated the UniversalClassLoader in favor of the ClassLoader class instead
+ * deprecated the ApcUniversalClassLoader in favor of the ApcClassLoader class instead
+ * deprecated the DebugUniversalClassLoader in favor of the DebugClassLoader class from the Debug component
+ * deprecated the DebugClassLoader as it has been moved to the Debug component instead
+
 2.3.0
 -----
 

ClassCollectionLoader.php

@@ -53,7 +53,7 @@ class ClassCollectionLoader
             $classes = array_diff($classes, $declared);
 
             // the cache is different depending on which classes are already declared
-            $name = $name.'-'.substr(md5(implode('|', $classes)), 0, 5);
+            $name = $name.'-'.substr(hash('sha256', implode('|', $classes)), 0, 5);
         }
 
         $classes = array_unique($classes);

DebugClassLoader.php

@@ -22,6 +22,8 @@ namespace Symfony\Component\ClassLoader;
  * @author Christophe Coevoet <stof@notk.org>
  *
  * @api
+ *
+ * @deprecated Deprecated since version 2.4, to be removed in 3.0. Use the DebugClassLoader provided by the Debug component instead.
  */
 class DebugClassLoader
 {
@@ -39,6 +41,16 @@ class DebugClassLoader
         $this->classFinder = $classFinder;
     }
 
+    /**
+     * Gets the wrapped class loader.
+     *
+     * @return object a class loader instance
+     */
+    public function getClassLoader()
+    {
+        return $this->classFinder;
+    }
+
     /**
      * Replaces all autoloaders implementing a findFile method by a DebugClassLoader wrapper.
      */

DebugUniversalClassLoader.php

@@ -15,6 +15,8 @@ namespace Symfony\Component\ClassLoader;
  * Checks that the class is actually declared in the included file.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated Deprecated since version 2.4, to be removed in 3.0. Use the DebugClassLoader provided by the Debug component instead.
  */
 class DebugUniversalClassLoader extends UniversalClassLoader
 {

Psr4ClassLoader.php

@@ -0,0 +1,94 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\ClassLoader;
+
+/**
+ * A PSR-4 compatible class loader.
+ *
+ * See http://www.php-fig.org/psr/psr-4/
+ *
+ * @author Alexander M. Turek <me@derrabus.de>
+ */
+class Psr4ClassLoader
+{
+    /**
+     * @var array
+     */
+    private $prefixes = array();
+
+    /**
+     * @param string $prefix
+     * @param string $baseDir
+     */
+    public function addPrefix($prefix, $baseDir)
+    {
+        $prefix = trim($prefix, '\\').'\\';
+        $baseDir = rtrim($baseDir, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR;
+        $this->prefixes[] = array($prefix, $baseDir);
+    }
+
+    /**
+     * @param string $class
+     *
+     * @return string|null
+     */
+    public function findFile($class)
+    {
+        $class = ltrim($class, '\\');
+
+        foreach ($this->prefixes as $current) {
+            list($currentPrefix, $currentBaseDir) = $current;
+            if (0 === strpos($class, $currentPrefix)) {
+                $classWithoutPrefix = substr($class, strlen($currentPrefix));
+                $file = $currentBaseDir.str_replace('\\', DIRECTORY_SEPARATOR, $classWithoutPrefix).'.php';
+                if (file_exists($file)) {
+                    return $file;
+                }
+            }
+        }
+    }
+
+    /**
+     * @param string $class
+     *
+     * @return bool
+     */
+    public function loadClass($class)
+    {
+        $file = $this->findFile($class);
+        if (null !== $file) {
+            require $file;
+
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Registers this instance as an autoloader.
+     *
+     * @param bool $prepend
+     */
+    public function register($prepend = false)
+    {
+        spl_autoload_register(array($this, 'loadClass'), true, $prepend);
+    }
+
+    /**
+     * Removes this instance from the registered autoloaders.
+     */
+    public function unregister()
+    {
+        spl_autoload_unregister(array($this, 'loadClass'));
+    }
+}

README.md

@@ -81,5 +81,5 @@ Resources
 You can run the unit tests with the following command:
 
     $ cd path/to/Symfony/Component/ClassLoader/
-    $ composer install
+    $ composer.phar install
     $ phpunit

Tests/ClassLoaderTest.php

@@ -72,7 +72,7 @@ class ClassLoaderTest extends \PHPUnit_Framework_TestCase
     public function getLoadNonexistentClassTests()
     {
         return array(
-            array('\\Pearlike3_Bar', '\\Pearlike3_Bar', '->loadClass() loads non exising Pearlike3_Bar class with a leading slash'),
+            array('\\Pearlike3_Bar', '\\Pearlike3_Bar', '->loadClass() loads non existing Pearlike3_Bar class with a leading slash'),
         );
     }
 

Tests/DebugClassLoaderTest.php

@@ -1,52 +0,0 @@
-<?php
-
-/*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-namespace Symfony\Component\ClassLoader\Tests;
-
-use Symfony\Component\ClassLoader\ClassLoader;
-use Symfony\Component\ClassLoader\DebugClassLoader;
-
-class DebugClassLoaderTest extends \PHPUnit_Framework_TestCase
-{
-    private $loader;
-
-    protected function setUp()
-    {
-        $this->loader = new ClassLoader();
-        spl_autoload_register(array($this->loader, 'loadClass'));
-    }
-
-    protected function tearDown()
-    {
-        spl_autoload_unregister(array($this->loader, 'loadClass'));
-    }
-
-    public function testIdempotence()
-    {
-        DebugClassLoader::enable();
-        DebugClassLoader::enable();
-
-        $functions = spl_autoload_functions();
-        foreach ($functions as $function) {
-            if (is_array($function) && $function[0] instanceof DebugClassLoader) {
-                $reflClass = new \ReflectionClass($function[0]);
-                $reflProp = $reflClass->getProperty('classFinder');
-                $reflProp->setAccessible(true);
-
-                $this->assertNotInstanceOf('Symfony\Component\ClassLoader\DebugClassLoader', $reflProp->getValue($function[0]));
-
-                return;
-            }
-        }
-
-        throw new \Exception('DebugClassLoader did not register');
-    }
-}

Tests/Fixtures/classmap/multipleNs.php

@@ -1,5 +1,4 @@
 <?php
-
 namespace {
     class A
     {

Tests/Fixtures/php5.4/traits.php

@@ -1,5 +1,4 @@
 <?php
-
 namespace {
     trait TFoo
     {

Tests/Fixtures/psr-4/Class_With_Underscores.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Acme\DemoLib;
+
+class Class_With_Underscores
+{
+}

Tests/Fixtures/psr-4/Foo.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Acme\DemoLib;
+
+class Foo
+{
+}

Tests/Fixtures/psr-4/Lets/Go/Deeper/Class_With_Underscores.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Acme\DemoLib\Lets\Go\Deeper;
+
+class Class_With_Underscores
+{
+}

Tests/Fixtures/psr-4/Lets/Go/Deeper/Foo.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Acme\DemoLib\Lets\Go\Deeper;
+
+class Foo
+{
+}

Tests/LegacyApcUniversalClassLoaderTest.php

@@ -13,10 +13,12 @@ namespace Symfony\Component\ClassLoader\Tests;
 
 use Symfony\Component\ClassLoader\ApcUniversalClassLoader;
 
-class ApcUniversalClassLoaderTest extends \PHPUnit_Framework_TestCase
+class LegacyApcUniversalClassLoaderTest extends \PHPUnit_Framework_TestCase
 {
     protected function setUp()
     {
+        $this->iniSet('error_reporting', -1 & ~E_USER_DEPRECATED);
+
         if (!extension_loaded('apc')) {
             $this->markTestSkipped('The apc extension is not available.');
         }

Tests/LegacyUniversalClassLoaderTest.php

@@ -13,8 +13,13 @@ namespace Symfony\Component\ClassLoader\Tests;
 
 use Symfony\Component\ClassLoader\UniversalClassLoader;
 
-class UniversalClassLoaderTest extends \PHPUnit_Framework_TestCase
+class LegacyUniversalClassLoaderTest extends \PHPUnit_Framework_TestCase
 {
+    public function setUp()
+    {
+        $this->iniSet('error_reporting', -1 & ~E_USER_DEPRECATED);
+    }
+
     /**
      * @dataProvider getLoadClassTests
      */

Tests/Psr4ClassLoaderTest.php

@@ -0,0 +1,71 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\ClassLoader\Tests;
+
+use Symfony\Component\ClassLoader\Psr4ClassLoader;
+
+class Psr4ClassLoaderTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @param string $className
+     * @dataProvider getLoadClassTests
+     */
+    public function testLoadClass($className)
+    {
+        $loader = new Psr4ClassLoader();
+        $loader->addPrefix(
+            'Acme\\DemoLib',
+            __DIR__.DIRECTORY_SEPARATOR.'Fixtures'.DIRECTORY_SEPARATOR.'psr-4'
+        );
+        $loader->loadClass($className);
+        $this->assertTrue(class_exists($className), sprintf('loadClass() should load %s', $className));
+    }
+
+    /**
+     * @return array
+     */
+    public function getLoadClassTests()
+    {
+        return array(
+            array('Acme\\DemoLib\\Foo'),
+            array('Acme\\DemoLib\\Class_With_Underscores'),
+            array('Acme\\DemoLib\\Lets\\Go\\Deeper\\Foo'),
+            array('Acme\\DemoLib\\Lets\\Go\\Deeper\\Class_With_Underscores'),
+        );
+    }
+
+    /**
+     * @param string $className
+     * @dataProvider getLoadNonexistentClassTests
+     */
+    public function testLoadNonexistentClass($className)
+    {
+        $loader = new Psr4ClassLoader();
+        $loader->addPrefix(
+            'Acme\\DemoLib',
+            __DIR__.DIRECTORY_SEPARATOR.'Fixtures'.DIRECTORY_SEPARATOR.'psr-4'
+        );
+        $loader->loadClass($className);
+        $this->assertFalse(class_exists($className), sprintf('loadClass() should not load %s', $className));
+    }
+
+    /**
+     * @return array
+     */
+    public function getLoadNonexistentClassTests()
+    {
+        return array(
+            array('Acme\\DemoLib\\I_Do_Not_Exist'),
+            array('UnknownVendor\\SomeLib\\I_Do_Not_Exist'),
+        );
+    }
+}

UniversalClassLoader.php

@@ -57,6 +57,8 @@ namespace Symfony\Component\ClassLoader;
  * @author Fabien Potencier <fabien@symfony.com>
  *
  * @api
+ *
+ * @deprecated Deprecated since version 2.4, to be removed in 3.0. Use the ClassLoader class instead.
  */
 class UniversalClassLoader
 {

composer.json

@@ -20,7 +20,6 @@
         "php": ">=5.3.3"
     },
     "require-dev": {
-        "symfony/phpunit-bridge": "~2.7",
         "symfony/finder": "~2.0,>=2.0.5"
     },
     "autoload": {
@@ -29,7 +28,7 @@
     "target-dir": "Symfony/Component/ClassLoader",
     "extra": {
         "branch-alias": {
-            "dev-master": "2.3-dev"
+            "dev-master": "2.5-dev"
         }
     }
 }

phpunit.xml.dist

@@ -7,7 +7,8 @@
          bootstrap="vendor/autoload.php"
 >
     <php>
-        <ini name="error_reporting" value="-1" />
+        <!-- Silence E_USER_DEPRECATED (-16385 == -1 & ~E_USER_DEPRECATED) -->
+        <ini name="error_reporting" value="-16385"/>
     </php>
     <testsuites>
         <testsuite name="Symfony ClassLoader Component Test Suite">