[Debug] Correctly detect methods not from the same vendor

GuilhemN · GuilhemN · commit 9ad1d27a3213 · 2017-08-09T18:49:26.000+02:00
diff --git a/src/Symfony/Component/Debug/DebugClassLoader.php b/src/Symfony/Component/Debug/DebugClassLoader.php
@@ -232,19 +232,28 @@ public function loadClass($class)
                     continue;
                 }
 
+                // Method from a trait
+                if ($method->getFilename() !== $refl->getFileName()) {
+                    continue;
+                }
+
                 if ($isClass && $parent && isset(self::$finalMethods[$parent][$method->name])) {
-                    list($methodShortName, $message) = self::$finalMethods[$parent][$method->name];
-                    @trigger_error(sprintf('The "%s" method is considered final%s. It may change without further notice as of its next major version. You should not extend it from "%s".', $methodShortName, $message, $name), E_USER_DEPRECATED);
+                    list($declaringClass, $message) = self::$finalMethods[$parent][$method->name];
+                    @trigger_error(sprintf('The "%s::%s()" method is considered final%s. It may change without further notice as of its next major version. You should not extend it from "%s".', $declaringClass, $method->name, $message, $name), E_USER_DEPRECATED);
                 }
 
                 foreach ($parentAndTraits as $use) {
-                    if (isset(self::$deprecatedMethods[$use][$method->name]) && strncmp($ns, $use, $len)) {
-                        list($methodShortName, $message) = self::$deprecatedMethods[$use][$method->name];
-                        @trigger_error(sprintf('The "%s" method is deprecated%s. You should not extend it from "%s".', $methodShortName, $message, $name), E_USER_DEPRECATED);
+                    if (isset(self::$deprecatedMethods[$use][$method->name])) {
+                        list($declaringClass, $message) = self::$deprecatedMethods[$use][$method->name];
+                        if (strncmp($ns, $declaringClass, $len)) {
+                            @trigger_error(sprintf('The "%s::%s()" method is deprecated%s. You should not extend it from "%s".', $declaringClass, $method->name, $message, $name), E_USER_DEPRECATED);
+                        }
                     }
-                    if (isset(self::$internalMethods[$use][$method->name]) && strncmp($ns, $use, $len)) {
-                        list($methodShortName, $message) = self::$internalMethods[$use][$method->name];
-                        @trigger_error(sprintf('The "%s" method is considered internal%s. It may change without further notice. You should not use it from "%s".', $methodShortName, $message, $name), E_USER_DEPRECATED);
+                    if (isset(self::$internalMethods[$use][$method->name])) {
+                        list($declaringClass, $message) = self::$internalMethods[$use][$method->name];
+                        if (strncmp($ns, $declaringClass, $len)) {
+                            @trigger_error(sprintf('The "%s::%s()" method is considered internal%s. It may change without further notice. You should not extend it from "%s".', $declaringClass, $method->name, $message, $name), E_USER_DEPRECATED);
+                        }
                     }
                 }
 
@@ -256,7 +265,7 @@ public function loadClass($class)
                 foreach (array('final', 'deprecated', 'internal') as $annotation) {
                     if (false !== strpos($doc, '@'.$annotation) && preg_match('#\n\s+\* @'.$annotation.'(?:( .+?)\.?)?\r?\n\s+\*(?: @|/$)#s', $doc, $notice)) {
                         $message = isset($notice[1]) ? preg_replace('#\s*\r?\n \* +#', ' ', $notice[1]) : '';
-                        self::${$annotation.'Methods'}[$name][$method->name] = array(sprintf('%s::%s()', $name, $method->name), $message);
+                        self::${$annotation.'Methods'}[$name][$method->name] = array($name, $message);
                     }
                 }
             }
diff --git a/src/Symfony/Component/Debug/Tests/DebugClassLoaderTest.php b/src/Symfony/Component/Debug/Tests/DebugClassLoaderTest.php
@@ -347,10 +347,10 @@ class_exists('Test\\'.__NAMESPACE__.'\\ExtendsInternals', true);
         restore_error_handler();
 
         $this->assertSame($deprecations, array(
+            'The "Symfony\Component\Debug\Tests\Fixtures\InternalClass" class is considered internal since version 3.4. It may change without further notice. You should not use it from "Test\Symfony\Component\Debug\Tests\ExtendsInternalsParent".',
+            'The "Symfony\Component\Debug\Tests\Fixtures\InternalInterface" interface is considered internal. It may change without further notice. You should not use it from "Test\Symfony\Component\Debug\Tests\ExtendsInternalsParent".',
             'The "Symfony\Component\Debug\Tests\Fixtures\InternalTrait" trait is considered internal. It may change without further notice. You should not use it from "Test\Symfony\Component\Debug\Tests\ExtendsInternals".',
-            'The "Symfony\Component\Debug\Tests\Fixtures\InternalClass" class is considered internal since version 3.4. It may change without further notice. You should not use it from "Test\Symfony\Component\Debug\Tests\ExtendsInternals".',
-            'The "Symfony\Component\Debug\Tests\Fixtures\InternalInterface" interface is considered internal. It may change without further notice. You should not use it from "Test\Symfony\Component\Debug\Tests\ExtendsInternals".',
-            'The "Symfony\Component\Debug\Tests\Fixtures\InternalClass::internalMethod()" method is considered internal since version 3.4. It may change without further notice. You should not use it from "Test\Symfony\Component\Debug\Tests\ExtendsInternals".',
+            'The "Symfony\Component\Debug\Tests\Fixtures\InternalTrait2::internalMethod()" method is considered internal since version 3.4. It may change without further notice. You should not extend it from "Test\Symfony\Component\Debug\Tests\ExtendsInternals".',
         ));
     }
 }
@@ -399,11 +399,13 @@ public function findFile($class)
                 public function deprecatedMethod() { }
             }');
         } elseif ('Test\\'.__NAMESPACE__.'\ExtendsInternals' === $class) {
-            eval('namespace Test\\'.__NAMESPACE__.'; class ExtendsInternals extends \\'.__NAMESPACE__.'\Fixtures\InternalClass implements \\'.__NAMESPACE__.'\Fixtures\InternalInterface {
+            eval('namespace Test\\'.__NAMESPACE__.'; class ExtendsInternals extends ExtendsInternalsParent {
                 use \\'.__NAMESPACE__.'\Fixtures\InternalTrait;
 
                 public function internalMethod() { }
             }');
+        } elseif ('Test\\'.__NAMESPACE__.'\ExtendsInternalsParent' === $class) {
+            eval('namespace Test\\'.__NAMESPACE__.'; class ExtendsInternalsParent extends \\'.__NAMESPACE__.'\Fixtures\InternalClass implements \\'.__NAMESPACE__.'\Fixtures\InternalInterface { }');
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -232,19 +232,28 @@ public function loadClass($class)`
`232`	`232`	`continue;`
`233`	`233`	`}`
`234`	`234`
	`235`	`+ // Method from a trait`
	`236`	`+ if ($method->getFilename() !== $refl->getFileName()) {`
	`237`	`+ continue;`
	`238`	`+ }`
	`239`	`+`
`235`	`240`	`if ($isClass && $parent && isset(self::$finalMethods[$parent][$method->name])) {`
`236`		`- list($methodShortName, $message) = self::$finalMethods[$parent][$method->name];`
`237`		`- @trigger_error(sprintf('The "%s" method is considered final%s. It may change without further notice as of its next major version. You should not extend it from "%s".', $methodShortName, $message, $name), E_USER_DEPRECATED);`
	`241`	`+ list($declaringClass, $message) = self::$finalMethods[$parent][$method->name];`
	`242`	`+ @trigger_error(sprintf('The "%s::%s()" method is considered final%s. It may change without further notice as of its next major version. You should not extend it from "%s".', $declaringClass, $method->name, $message, $name), E_USER_DEPRECATED);`
`238`	`243`	`}`
`239`	`244`
`240`	`245`	`foreach ($parentAndTraits as $use) {`
`241`		`- if (isset(self::$deprecatedMethods[$use][$method->name]) && strncmp($ns, $use, $len)) {`
`242`		`- list($methodShortName, $message) = self::$deprecatedMethods[$use][$method->name];`
`243`		`- @trigger_error(sprintf('The "%s" method is deprecated%s. You should not extend it from "%s".', $methodShortName, $message, $name), E_USER_DEPRECATED);`
	`246`	`+ if (isset(self::$deprecatedMethods[$use][$method->name])) {`
	`247`	`+ list($declaringClass, $message) = self::$deprecatedMethods[$use][$method->name];`
	`248`	`+ if (strncmp($ns, $declaringClass, $len)) {`
	`249`	`+ @trigger_error(sprintf('The "%s::%s()" method is deprecated%s. You should not extend it from "%s".', $declaringClass, $method->name, $message, $name), E_USER_DEPRECATED);`
	`250`	`+ }`
`244`	`251`	`}`
`245`		`- if (isset(self::$internalMethods[$use][$method->name]) && strncmp($ns, $use, $len)) {`
`246`		`- list($methodShortName, $message) = self::$internalMethods[$use][$method->name];`
`247`		`- @trigger_error(sprintf('The "%s" method is considered internal%s. It may change without further notice. You should not use it from "%s".', $methodShortName, $message, $name), E_USER_DEPRECATED);`
	`252`	`+ if (isset(self::$internalMethods[$use][$method->name])) {`
	`253`	`+ list($declaringClass, $message) = self::$internalMethods[$use][$method->name];`
	`254`	`+ if (strncmp($ns, $declaringClass, $len)) {`
	`255`	`+ @trigger_error(sprintf('The "%s::%s()" method is considered internal%s. It may change without further notice. You should not extend it from "%s".', $declaringClass, $method->name, $message, $name), E_USER_DEPRECATED);`
	`256`	`+ }`
`248`	`257`	`}`
`249`	`258`	`}`
`250`	`259`
`@@ -256,7 +265,7 @@ public function loadClass($class)`
`256`	`265`	`foreach (array('final', 'deprecated', 'internal') as $annotation) {`
`257`	`266`	`if (false !== strpos($doc, '@'.$annotation) && preg_match('#\n\s+\* @'.$annotation.'(?:( .+?)\.?)?\r?\n\s+\*(?: @\|/$)#s', $doc, $notice)) {`
`258`	`267`	`$message = isset($notice[1]) ? preg_replace('#\s\r?\n \ +#', ' ', $notice[1]) : '';`
`259`		`- self::${$annotation.'Methods'}[$name][$method->name] = array(sprintf('%s::%s()', $name, $method->name), $message);`
	`268`	`+ self::${$annotation.'Methods'}[$name][$method->name] = array($name, $message);`
`260`	`269`	`}`
`261`	`270`	`}`
`262`	`271`	`}`
Original file line number	Diff line number	Diff line change
`@@ -347,10 +347,10 @@ class_exists('Test\\'.__NAMESPACE__.'\\ExtendsInternals', true);`
`347`	`347`	`restore_error_handler();`
`348`	`348`
`349`	`349`	`$this->assertSame($deprecations, array(`
	`350`	`+ 'The "Symfony\Component\Debug\Tests\Fixtures\InternalClass" class is considered internal since version 3.4. It may change without further notice. You should not use it from "Test\Symfony\Component\Debug\Tests\ExtendsInternalsParent".',`
	`351`	`+ 'The "Symfony\Component\Debug\Tests\Fixtures\InternalInterface" interface is considered internal. It may change without further notice. You should not use it from "Test\Symfony\Component\Debug\Tests\ExtendsInternalsParent".',`
`350`	`352`	`'The "Symfony\Component\Debug\Tests\Fixtures\InternalTrait" trait is considered internal. It may change without further notice. You should not use it from "Test\Symfony\Component\Debug\Tests\ExtendsInternals".',`
`351`		`- 'The "Symfony\Component\Debug\Tests\Fixtures\InternalClass" class is considered internal since version 3.4. It may change without further notice. You should not use it from "Test\Symfony\Component\Debug\Tests\ExtendsInternals".',`
`352`		`- 'The "Symfony\Component\Debug\Tests\Fixtures\InternalInterface" interface is considered internal. It may change without further notice. You should not use it from "Test\Symfony\Component\Debug\Tests\ExtendsInternals".',`
`353`		`- 'The "Symfony\Component\Debug\Tests\Fixtures\InternalClass::internalMethod()" method is considered internal since version 3.4. It may change without further notice. You should not use it from "Test\Symfony\Component\Debug\Tests\ExtendsInternals".',`
	`353`	`+ 'The "Symfony\Component\Debug\Tests\Fixtures\InternalTrait2::internalMethod()" method is considered internal since version 3.4. It may change without further notice. You should not extend it from "Test\Symfony\Component\Debug\Tests\ExtendsInternals".',`
`354`	`354`	`));`
`355`	`355`	`}`
`356`	`356`	`}`
`@@ -399,11 +399,13 @@ public function findFile($class)`
`399`	`399`	`public function deprecatedMethod() { }`
`400`	`400`	`}');`
`401`	`401`	`} elseif ('Test\\'.__NAMESPACE__.'\ExtendsInternals' === $class) {`
`402`		`- eval('namespace Test\\'.__NAMESPACE__.'; class ExtendsInternals extends \\'.__NAMESPACE__.'\Fixtures\InternalClass implements \\'.__NAMESPACE__.'\Fixtures\InternalInterface {`
	`402`	`+ eval('namespace Test\\'.__NAMESPACE__.'; class ExtendsInternals extends ExtendsInternalsParent {`
`403`	`403`	`use \\'.__NAMESPACE__.'\Fixtures\InternalTrait;`
`404`	`404`
`405`	`405`	`public function internalMethod() { }`
`406`	`406`	`}');`
	`407`	`+ } elseif ('Test\\'.__NAMESPACE__.'\ExtendsInternalsParent' === $class) {`
	`408`	`+ eval('namespace Test\\'.__NAMESPACE__.'; class ExtendsInternalsParent extends \\'.__NAMESPACE__.'\Fixtures\InternalClass implements \\'.__NAMESPACE__.'\Fixtures\InternalInterface { }');`
`407`	`409`	`}`
`408`	`410`	`}`
`409`	`411`	`}`