Merge pull request #373 from kukulich/source-stubber

Source stubber based on `jetbrains/phpstorm-stubs`

composer.json

@@ -4,6 +4,7 @@
     "license": "MIT",
     "require": {
         "php": ">=7.1.0,<7.4.0",
+        "jetbrains/phpstorm-stubs": "2019.1",
         "nikic/php-parser": "^4.0.4",
         "phpdocumentor/reflection-docblock": "^4.1.1",
         "phpdocumentor/type-resolver": "^0.4.0",

phpstan.neon

@@ -3,3 +3,5 @@ parameters:
         # Some parent constructors are explicitly to be ignored
         - '#does not call parent constructor#'
         - '#Access to an undefined property PhpParser\\Node\\Param::\$isOptional#'
+        # Impossible to define type hint for anonymous class
+        - '#Call to an undefined method PhpParser\\NodeVisitorAbstract::getNode\(\)#'

src/BetterReflection.php

@@ -11,6 +11,10 @@
 use Roave\BetterReflection\Reflector\FunctionReflector;
 use Roave\BetterReflection\SourceLocator\Ast\Locator as AstLocator;
 use Roave\BetterReflection\SourceLocator\Ast\Parser\MemoizingParser;
+use Roave\BetterReflection\SourceLocator\SourceStubber\AggregateSourceStubber;
+use Roave\BetterReflection\SourceLocator\SourceStubber\PhpStormStubsSourceStubber;
+use Roave\BetterReflection\SourceLocator\SourceStubber\ReflectionSourceStubber;
+use Roave\BetterReflection\SourceLocator\SourceStubber\SourceStubber;
 use Roave\BetterReflection\SourceLocator\Type\AggregateSourceLocator;
 use Roave\BetterReflection\SourceLocator\Type\AutoloadSourceLocator;
 use Roave\BetterReflection\SourceLocator\Type\EvaledCodeSourceLocator;
@@ -39,14 +43,18 @@ final class BetterReflection
     /** @var FindReflectionOnLine|null */
     private $findReflectionOnLine;
 
+    /** @var SourceStubber */
+    private $sourceStubber;
+
     public function sourceLocator() : SourceLocator
     {
-        $astLocator = $this->astLocator();
+        $astLocator    = $this->astLocator();
+        $sourceStubber = $this->sourceStubber();
 
         return $this->sourceLocator
             ?? $this->sourceLocator = new MemoizingSourceLocator(new AggregateSourceLocator([
-                new PhpInternalSourceLocator($astLocator),
-                new EvaledCodeSourceLocator($astLocator),
+                new PhpInternalSourceLocator($astLocator, $sourceStubber),
+                new EvaledCodeSourceLocator($astLocator, $sourceStubber),
                 new AutoloadSourceLocator($astLocator),
             ]));
     }
@@ -84,4 +92,13 @@ public function findReflectionsOnLine() : FindReflectionOnLine
         return $this->findReflectionOnLine
             ?? $this->findReflectionOnLine = new FindReflectionOnLine($this->sourceLocator(), $this->astLocator());
     }
+
+    public function sourceStubber() : SourceStubber
+    {
+        return $this->sourceStubber
+            ?? $this->sourceStubber = new AggregateSourceStubber(
+                new PhpStormStubsSourceStubber($this->phpParser()),
+                new ReflectionSourceStubber()
+            );
+    }
 }

src/Reflection/ReflectionFunction.php

@@ -82,16 +82,6 @@ public function isDisabled() : bool
         return false;
     }
 
-    /**
-     * Note - we cannot reflect on internal functions (as there is no PHP source
-     * code we can access. This means, at present, we can only EVER return null
-     * from this function.
-     */
-    public function getExtensionName() : ?string
-    {
-        return null;
-    }
-
     /**
      * @throws NotImplemented
      * @throws FunctionDoesNotExist

src/Reflection/ReflectionFunctionAbstract.php

@@ -272,18 +272,9 @@ public function isDeprecated() : bool
         return false;
     }
 
-    /**
-     * Is this an internal function?
-     *
-     * Note - we cannot reflect on internal functions (as there is no PHP source
-     * code we can access. This means, at present, we can only EVER return false
-     * from this function.
-     *
-     * @see https://github.com/Roave/BetterReflection/issues/38
-     */
     public function isInternal() : bool
     {
-        return false;
+        return $this->locatedSource->isInternal();
     }
 
     /**
@@ -295,6 +286,11 @@ public function isUserDefined() : bool
         return ! $this->isInternal();
     }
 
+    public function getExtensionName() : ?string
+    {
+        return $this->locatedSource->getExtensionName();
+    }
+
     /**
      * Check if the function has a variadic parameter.
      */

src/Reflection/ReflectionMethod.php

@@ -251,11 +251,6 @@ public function getImplementingClass() : ReflectionClass
         return $this->implementingClass;
     }
 
-    public function getExtensionName() : ?string
-    {
-        return $this->getDeclaringClass()->getExtensionName();
-    }
-
     public function isInternal() : bool
     {
         return $this->declaringClass->getLocatedSource()->isInternal();

src/SourceLocator/SourceStubber/AggregateSourceStubber.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Roave\BetterReflection\SourceLocator\SourceStubber;
+
+use ReflectionClass as CoreReflectionClass;
+use ReflectionFunction as CoreReflectionFunction;
+use function array_merge;
+
+class AggregateSourceStubber implements SourceStubber
+{
+    /** @var SourceStubber[] */
+    private $sourceStubbers;
+
+    public function __construct(SourceStubber $sourceStubber, SourceStubber ...$otherSourceStubbers)
+    {
+        $this->sourceStubbers = array_merge([$sourceStubber], $otherSourceStubbers);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function generateClassStub(CoreReflectionClass $classReflection) : ?string
+    {
+        foreach ($this->sourceStubbers as $sourceStubber) {
+            $stub = $sourceStubber->generateClassStub($classReflection);
+
+            if ($stub !== null) {
+                return $stub;
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function generateFunctionStub(CoreReflectionFunction $functionReflection) : ?string
+    {
+        foreach ($this->sourceStubbers as $sourceStubber) {
+            $stub = $sourceStubber->generateFunctionStub($functionReflection);
+
+            if ($stub !== null) {
+                return $stub;
+            }
+        }
+
+        return null;
+    }
+}

src/SourceLocator/SourceStubber/Exception/CouldNotFindPhpStormStubs.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Roave\BetterReflection\SourceLocator\SourceStubber\Exception;
+
+use RuntimeException;
+
+class CouldNotFindPhpStormStubs extends RuntimeException
+{
+    public static function create() : self
+    {
+        return new self('Could not find PhpStorm stubs');
+    }
+}