StringSourceLocator is forced to be built with a non-empty-string

Roave · Sep 10, 2022 · cd0887f · cd0887f
1 parent 55b41a4
commit cd0887f
Show file tree

Hide file tree

Showing 9 changed files with 85 additions and 57 deletions.
diff --git a/src/SourceLocator/Exception/EmptyPhpSourceCode.php b/src/SourceLocator/Exception/EmptyPhpSourceCode.php
diff --git a/src/SourceLocator/Type/StringSourceLocator.php b/src/SourceLocator/Type/StringSourceLocator.php
@@ -7,7 +7,6 @@
 use InvalidArgumentException;
 use Roave\BetterReflection\Identifier\Identifier;
 use Roave\BetterReflection\SourceLocator\Ast\Locator;
-use Roave\BetterReflection\SourceLocator\Exception\EmptyPhpSourceCode;
 use Roave\BetterReflection\SourceLocator\Exception\InvalidFileLocation;
 use Roave\BetterReflection\SourceLocator\Located\LocatedSource;
 
@@ -20,19 +19,10 @@
  */
 class StringSourceLocator extends AbstractSourceLocator
 {
-    /** @throws EmptyPhpSourceCode */
+    /** @param non-empty-string $source */
     public function __construct(private string $source, Locator $astLocator)
     {
         parent::__construct($astLocator);
-
-        if (empty($source)) {
-            // Whilst an empty string is still "valid" PHP code, there is no
-            // point in us even trying to parse it because we won't find what
-            // we are looking for, therefore this throws an exception
-            throw new EmptyPhpSourceCode(
-                'Source code string was empty',
-            );
-        }
     }
 
     /**

diff --git a/test/unit/Reflection/ReflectionClassConstantTest.php b/test/unit/Reflection/ReflectionClassConstantTest.php
@@ -121,7 +121,11 @@ public function testGetDeclaringClass(): void
         self::assertSame($classInfo, $const->getDeclaringClass());
     }
 
-    /** @dataProvider startEndLineProvider */
+    /**
+     * @param non-empty-string $php
+     *
+     * @dataProvider startEndLineProvider
+     */
     public function testStartEndLine(string $php, int $startLine, int $endLine): void
     {
         $reflector       = new DefaultReflector(new StringSourceLocator($php, $this->astLocator));
@@ -131,7 +135,7 @@ public function testStartEndLine(string $php, int $startLine, int $endLine): voi
         self::assertEquals($endLine, $constReflection->getEndLine());
     }
 
-    /** @return list<array{0: string, 1: int, 2: int}> */
+    /** @return list<array{0: non-empty-string, 1: int, 2: int}> */
     public function startEndLineProvider(): array
     {
         return [
@@ -142,7 +146,7 @@ public function startEndLineProvider(): array
         ];
     }
 
-    /** @return list<array{0: string, 1: int, 2: int}> */
+    /** @return list<array{0: non-empty-string, 1: int, 2: int}> */
     public function columnsProvider(): array
     {
         return [
@@ -152,7 +156,11 @@ public function columnsProvider(): array
         ];
     }
 
-    /** @dataProvider columnsProvider */
+    /**
+     * @param non-empty-string $php
+     *
+     * @dataProvider columnsProvider
+     */
     public function testGetStartColumnAndEndColumn(string $php, int $startColumn, int $endColumn): void
     {
         $reflector          = new DefaultReflector(new StringSourceLocator($php, $this->astLocator));

diff --git a/test/unit/Reflection/ReflectionClassTest.php b/test/unit/Reflection/ReflectionClassTest.php
@@ -814,7 +814,7 @@ public function testGetParentClassNames(): void
         self::assertSame(['Roave\\BetterReflectionTest\\Fixture\\ClassWithParent', 'Roave\\BetterReflectionTest\\Fixture\\ExampleClass'], $childReflection->getParentClassNames());
     }
 
-    /** @return list<array{0: string, 1: int, 2: int}> */
+    /** @return list<array{0: non-empty-string, 1: int, 2: int}> */
     public function startEndLineProvider(): array
     {
         return [
@@ -824,7 +824,11 @@ public function startEndLineProvider(): array
         ];
     }
 
-    /** @dataProvider startEndLineProvider */
+    /**
+     * @param non-empty-string $php
+     *
+     * @dataProvider startEndLineProvider
+     */
     public function testStartEndLine(string $php, int $expectedStart, int $expectedEnd): void
     {
         $reflector = new DefaultReflector(new StringSourceLocator($php, $this->astLocator));
@@ -834,7 +838,7 @@ public function testStartEndLine(string $php, int $expectedStart, int $expectedE
         self::assertSame($expectedEnd, $classInfo->getEndLine());
     }
 
-    /** @return list<array{0: string, 1: int, 2: int}> */
+    /** @return list<array{0: non-empty-string, 1: int, 2: int}> */
     public function columnsProvider(): array
     {
         return [
@@ -844,7 +848,11 @@ public function columnsProvider(): array
         ];
     }
 
-    /** @dataProvider columnsProvider */
+    /**
+     * @param non-empty-string $php
+     *
+     * @dataProvider columnsProvider
+     */
     public function testGetStartColumnAndEndColumn(string $php, int $startColumn, int $endColumn): void
     {
         $reflector = new DefaultReflector(new StringSourceLocator($php, $this->astLocator));

diff --git a/test/unit/Reflection/ReflectionConstantTest.php b/test/unit/Reflection/ReflectionConstantTest.php
@@ -255,7 +255,7 @@ public function testGetDocCommentByDefine(): void
         self::assertStringContainsString('This constant comment should be used.', $reflection->getDocComment());
     }
 
-    /** @return list<array{0: string, 1: int, 2: int}> */
+    /** @return list<array{0: non-empty-string, 1: int, 2: int}> */
     public function startEndLineProvider(): array
     {
         return [
@@ -265,7 +265,11 @@ public function startEndLineProvider(): array
         ];
     }
 
-    /** @dataProvider startEndLineProvider */
+    /**
+     * @param non-empty-string $php
+     *
+     * @dataProvider startEndLineProvider
+     */
     public function testStartEndLine(string $php, int $expectedStart, int $expectedEnd): void
     {
         $reflector  = new DefaultReflector(new StringSourceLocator($php, $this->astLocator));
@@ -275,7 +279,7 @@ public function testStartEndLine(string $php, int $expectedStart, int $expectedE
         self::assertSame($expectedEnd, $reflection->getEndLine());
     }
 
-    /** @return list<array{0: string, 1: int, 2: int}> */
+    /** @return list<array{0: non-empty-string, 1: int, 2: int}> */
     public function columnsProvider(): array
     {
         return [
@@ -284,7 +288,11 @@ public function columnsProvider(): array
         ];
     }
 
-    /** @dataProvider columnsProvider */
+    /**
+     * @param non-empty-string $php
+     *
+     * @dataProvider columnsProvider
+     */
     public function testGetStartColumnAndEndColumn(string $php, int $startColumn, int $endColumn): void
     {
         $reflector  = new DefaultReflector(new StringSourceLocator($php, $this->astLocator));

diff --git a/test/unit/Reflection/ReflectionFunctionAbstractTest.php b/test/unit/Reflection/ReflectionFunctionAbstractTest.php
@@ -177,7 +177,7 @@ public function testIsInternal(): void
         self::assertNull($function->getExtensionName());
     }
 
-    /** @return list<array{0: string, 1: bool}> */
+    /** @return list<array{0: non-empty-string, 1: bool}> */
     public function variadicProvider(): array
     {
         return [
@@ -187,7 +187,11 @@ public function variadicProvider(): array
         ];
     }
 
-    /** @dataProvider variadicProvider */
+    /**
+     * @param non-empty-string $php
+     *
+     * @dataProvider variadicProvider
+     */
     public function testIsVariadic(string $php, bool $expectingVariadic): void
     {
         $reflector = new DefaultReflector(new StringSourceLocator($php, $this->astLocator));
@@ -202,7 +206,7 @@ public function testIsVariadic(string $php, bool $expectingVariadic): void
      *
      * @see https://github.com/nikic/PHP-Parser/blob/1.x/test/code/parser/stmt/function/generator.test
      *
-     * @return list<array{0: string, 1: bool}>
+     * @return list<array{0: non-empty-string, 1: bool}>
      */
     public function generatorProvider(): array
     {
@@ -227,7 +231,11 @@ public function generatorProvider(): array
         ];
     }
 
-    /** @dataProvider generatorProvider */
+    /**
+     * @param non-empty-string $php
+     *
+     * @dataProvider generatorProvider
+     */
     public function testIsGenerator(string $php, bool $expectingGenerator): void
     {
         $reflector = new DefaultReflector(new StringSourceLocator($php, $this->astLocator));
@@ -236,7 +244,7 @@ public function testIsGenerator(string $php, bool $expectingGenerator): void
         self::assertSame($expectingGenerator, $function->isGenerator());
     }
 
-    /** @return list<array{0: string, 1: int, 2: int}> */
+    /** @return list<array{0: non-empty-string, 1: int, 2: int}> */
     public function startEndLineProvider(): array
     {
         return [
@@ -246,7 +254,11 @@ public function startEndLineProvider(): array
         ];
     }
 
-    /** @dataProvider startEndLineProvider */
+    /**
+     * @param non-empty-string $php
+     *
+     * @dataProvider startEndLineProvider
+     */
     public function testStartEndLine(string $php, int $expectedStart, int $expectedEnd): void
     {
         $reflector = new DefaultReflector(new StringSourceLocator($php, $this->astLocator));
@@ -256,7 +268,7 @@ public function testStartEndLine(string $php, int $expectedStart, int $expectedE
         self::assertSame($expectedEnd, $function->getEndLine());
     }
 
-    /** @return list<array{0: string, 1: int, 2: int}> */
+    /** @return list<array{0: non-empty-string, 1: int, 2: int}> */
     public function columnsProvider(): array
     {
         return [
@@ -266,7 +278,11 @@ public function columnsProvider(): array
         ];
     }
 
-    /** @dataProvider columnsProvider */
+    /**
+     * @param non-empty-string $php
+     *
+     * @dataProvider columnsProvider
+     */
     public function testGetStartColumnAndEndColumn(string $php, int $startColumn, int $endColumn): void
     {
         $reflector = new DefaultReflector(new StringSourceLocator($php, $this->astLocator));
@@ -276,7 +292,7 @@ public function testGetStartColumnAndEndColumn(string $php, int $startColumn, in
         self::assertSame($endColumn, $function->getEndColumn());
     }
 
-    /** @return list<array{0: string, 1: bool}> */
+    /** @return list<array{0: non-empty-string, 1: bool}> */
     public function returnsReferenceProvider(): array
     {
         return [
@@ -285,7 +301,11 @@ public function returnsReferenceProvider(): array
         ];
     }
 
-    /** @dataProvider returnsReferenceProvider */
+    /**
+     * @param non-empty-string $php
+     *
+     * @dataProvider returnsReferenceProvider
+     */
     public function testReturnsReference(string $php, bool $expectingReturnsReference): void
     {
         $reflector = new DefaultReflector(new StringSourceLocator($php, $this->astLocator));

diff --git a/test/unit/Reflection/ReflectionParameterTest.php b/test/unit/Reflection/ReflectionParameterTest.php
@@ -687,7 +687,7 @@ public function testGetClassFromObjectTypeHintedProperty(): void
         self::assertSame('object', $type->__toString());
     }
 
-    /** @return list<array{0: string, 1: int, 2: int}> */
+    /** @return list<array{0: non-empty-string, 1: int, 2: int}> */
     public function columnsProvider(): array
     {
         return [
@@ -698,7 +698,11 @@ public function columnsProvider(): array
         ];
     }
 
-    /** @dataProvider columnsProvider */
+    /**
+     * @param non-empty-string $php
+     *
+     * @dataProvider columnsProvider
+     */
     public function testGetStartColumnAndEndColumn(string $php, int $startColumn, int $endColumn): void
     {
         $reflector = new DefaultReflector(new StringSourceLocator($php, $this->astLocator));

diff --git a/test/unit/Reflection/ReflectionPropertyTest.php b/test/unit/Reflection/ReflectionPropertyTest.php
@@ -268,7 +268,11 @@ public function testCannotClone(): void
         clone $publicProp;
     }
 
-    /** @dataProvider startEndLineProvider */
+    /**
+     * @param non-empty-string $php
+     *
+     * @dataProvider startEndLineProvider
+     */
     public function testStartEndLine(string $php, int $startLine, int $endLine): void
     {
         $reflector       = new DefaultReflector(new StringSourceLocator($php, $this->astLocator));
@@ -278,7 +282,7 @@ public function testStartEndLine(string $php, int $startLine, int $endLine): voi
         self::assertEquals($endLine, $constReflection->getEndLine());
     }
 
-    /** @return list<array{0: string, 1: int, 2: int}> */
+    /** @return list<array{0: non-empty-string, 1: int, 2: int}> */
     public function startEndLineProvider(): array
     {
         return [
@@ -289,7 +293,7 @@ public function startEndLineProvider(): array
         ];
     }
 
-    /** @return list<array{0: string, 1: int, 2: int}> */
+    /** @return list<array{0: non-empty-string, 1: int, 2: int}> */
     public function columnsProvider(): array
     {
         return [
@@ -299,7 +303,11 @@ public function columnsProvider(): array
         ];
     }
 
-    /** @dataProvider columnsProvider */
+    /**
+     * @param non-empty-string $php
+     *
+     * @dataProvider columnsProvider
+     */
     public function testGetStartColumnAndEndColumn(string $php, int $startColumn, int $endColumn): void
     {
         $reflector          = new DefaultReflector(new StringSourceLocator($php, $this->astLocator));

diff --git a/test/unit/SourceLocator/Type/StringSourceLocatorTest.php b/test/unit/SourceLocator/Type/StringSourceLocatorTest.php
@@ -10,7 +10,6 @@
 use Roave\BetterReflection\Identifier\IdentifierType;
 use Roave\BetterReflection\Reflector\Reflector;
 use Roave\BetterReflection\SourceLocator\Ast\Locator;
-use Roave\BetterReflection\SourceLocator\Exception\EmptyPhpSourceCode;
 use Roave\BetterReflection\SourceLocator\Type\StringSourceLocator;
 use Roave\BetterReflectionTest\BetterReflectionSingleton;
 
@@ -62,10 +61,4 @@ public function testReturnsReflectionWhenSourceHasClass(): void
 
         self::assertSame('Foo', $reflectionClass->getName());
     }
-
-    public function testConstructorThrowsExceptionIfEmptyStringGiven(): void
-    {
-        $this->expectException(EmptyPhpSourceCode::class);
-        new StringSourceLocator('', $this->astLocator);
-    }
 }