Prefix constants (#158)

Author: theofidry

specs/const/global-scope-global-with-single-level-use-statement-and-alias.php

@@ -67,7 +67,7 @@
 namespace Humbug;
 
 use const Humbug\DUMMY_CONST as FOO;
-\FOO;
+\Humbug\FOO;
 
 PHP
     ],

specs/const/global-scope-global-with-single-level-use-statement.php

@@ -67,7 +67,7 @@
 namespace Humbug;
 
 use const Humbug\DUMMY_CONST;
-\DUMMY_CONST;
+\Humbug\DUMMY_CONST;
 
 PHP
     ],

specs/const/global-scope-global.php

@@ -23,6 +23,7 @@
     [
         'spec' => <<<'SPEC'
 Constant call in the global namespace:
+- prefix the constant
 - transforms the call into a FQ call
 SPEC
         ,
@@ -35,15 +36,36 @@
 
 namespace Humbug;
 
-\DUMMY_CONST;
+\Humbug\DUMMY_CONST;
+
+PHP
+    ],
+
+    [
+        'spec' => <<<'SPEC'
+Internal constant call in the global namespace:
+- do not prefix the constant
+- transforms the call into a FQ call
+SPEC
+        ,
+        'payload' => <<<'PHP'
+<?php
+
+DIRECTORY_SEPARATOR;
+----
+<?php
+
+namespace Humbug;
+
+\DIRECTORY_SEPARATOR;
 
 PHP
     ],
 
     [
         'spec' => <<<'SPEC'
 FQ constant call in the global namespace:
-- do nothing
+- prefix the constant
 SPEC
     ,
         'payload' => <<<'PHP'
@@ -55,7 +77,7 @@
 
 namespace Humbug;
 
-\DUMMY_CONST;
+\Humbug\DUMMY_CONST;
 
 PHP
     ],

specs/const/namespace-global-with-single-level-use-statement-and-alias.php

@@ -57,6 +57,7 @@
 Constant call imported with an aliased use statement:
 - prefix the namespace
 - prefix the use statement
+- prefix the constant call
 SPEC
         ,
         'payload' => <<<'PHP'
@@ -73,7 +74,7 @@
 namespace Humbug\A;
 
 use const Humbug\DUMMY_CONST as FOO;
-\FOO;
+\Humbug\FOO;
 
 PHP
     ],

specs/const/namespace-global-with-single-level-use-statement.php

@@ -57,6 +57,7 @@
 FQ constant call imported with a use statement:
 - prefix the namespace
 - prefix the use statement
+- prefix the constant call
 SPEC
         ,
         'payload' => <<<'PHP'
@@ -73,7 +74,7 @@
 namespace Humbug\A;
 
 use const Humbug\DUMMY_CONST;
-\DUMMY_CONST;
+\Humbug\DUMMY_CONST;
 
 PHP
     ],

specs/const/namespace-global.php

@@ -47,6 +47,7 @@
         'spec' => <<<'SPEC'
 FQ constant call in a namespace:
 - prefix the namespace
+- prefix the constant call
 SPEC
     ,
         'payload' => <<<'PHP'
@@ -60,7 +61,7 @@
 
 namespace Humbug\A;
 
-\DUMMY_CONST;
+\Humbug\DUMMY_CONST;
 
 PHP
     ],

specs/use/use-const.php

@@ -44,7 +44,7 @@
     [
         'spec' => <<<'SPEC'
 Constant use statement for an internal constant belonging to the global namespace:
-- prefix the use statement
+- do not prefix the use statement
 SPEC
         ,
         'payload' => <<<'PHP'
@@ -57,7 +57,7 @@
 
 namespace Humbug;
 
-use const Humbug\DIRECTORY_SEPARATOR;
+use const DIRECTORY_SEPARATOR;
 
 PHP
     ],

src/NodeVisitor/NameStmtPrefixer.php

@@ -128,8 +128,12 @@ private function prefixName(Name $name): Node
         }
 
         if ($parentNode instanceof ConstFetch
-            && 1 === count($resolvedName->parts)
-            && null === $resolvedValue->getUse()
+            && (
+                $this->reflector->isConstantInternal($resolvedName->toString())
+                // Constants have a fallback autoloading so we cannot prefix them when the name is ambiguous
+                // See https://wiki.php.net/rfc/fallback-to-root-scope-deprecation
+                || false === ($resolvedName instanceof FullyQualified)
+            )
         ) {
             return $resolvedName;
         }

src/NodeVisitor/UseStmt/UseStmtPrefixer.php

@@ -74,6 +74,10 @@ private function shouldPrefixUseStmt(UseUse $use): bool
                 return false === $this->reflector->isFunctionInternal($use->name->getFirst());
             }
 
+            if (Use_::TYPE_CONSTANT === $useType) {
+                return false === $this->reflector->isConstantInternal($use->name->getFirst());
+            }
+
             return Use_::TYPE_NORMAL !== $useType || false === $this->reflector->isClassInternal($use->name->getFirst());
         }
 

src/Reflector.php

@@ -19,11 +19,16 @@
 use Roave\BetterReflection\Reflector\ClassReflector;
 use Roave\BetterReflection\Reflector\Exception\IdentifierNotFound;
 use Roave\BetterReflection\Reflector\FunctionReflector;
+use function array_key_exists;
+use function array_values;
+use function get_defined_constants;
+use function strtoupper;
 
 final class Reflector
 {
     private $classReflector;
     private $functionReflector;
+    private $constants;
 
     public function __construct(ClassReflector $classReflector, FunctionReflector $functionReflector)
     {
@@ -51,4 +56,20 @@ public function isFunctionInternal(string $name): bool
             return false;
         }
     }
+
+    public function isConstantInternal(string $name): bool
+    {
+        if (null === $this->constants) {
+            $constants = get_defined_constants(true);
+
+            unset($constants['user']);
+
+            $this->constants = array_merge(...array_values($constants));
+
+            unset($constants);
+        }
+
+        // TODO: find a better solution
+        return array_key_exists(strtoupper($name), $this->constants);
+    }
 }