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

Roave · Jun 26, 2022 · e10a503 · e10a503
1 parent 74f000a
commit e10a503
Show file tree

Hide file tree

Showing 9 changed files with 43 additions and 43 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;
 
@@ -21,20 +20,11 @@
 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
@@ -126,6 +126,8 @@ public function testGetDeclaringClass(): void
     }
 
     /**
+     * @param non-empty-string $php
+     *
      * @dataProvider startEndLineProvider
      */
     public function testStartEndLine(string $php, int $startLine, int $endLine): void
@@ -138,7 +140,7 @@ public function testStartEndLine(string $php, int $startLine, int $endLine): voi
     }
 
     /**
-     * @return list<array{0: string, 1: int, 2: int}>
+     * @return list<array{0: non-empty-string, 1: int, 2: int}>
      */
     public function startEndLineProvider(): array
     {
@@ -151,7 +153,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
     {
@@ -163,6 +165,8 @@ public function columnsProvider(): array
     }
 
     /**
+     * @param non-empty-string $php
+     *
      * @dataProvider columnsProvider
      */
     public function testGetStartColumnAndEndColumn(string $php, int $startColumn, int $endColumn): void

diff --git a/test/unit/Reflection/ReflectionClassTest.php b/test/unit/Reflection/ReflectionClassTest.php
@@ -835,7 +835,7 @@ public function testGetParentClassNames(): void
     }
 
     /**
-     * @return list<array{0: string, 1: int, 2: int}>
+     * @return list<array{0: non-empty-string, 1: int, 2: int}>
      */
     public function startEndLineProvider(): array
     {
@@ -847,6 +847,8 @@ public function startEndLineProvider(): array
     }
 
     /**
+     * @param non-empty-string $php
+     *
      * @dataProvider startEndLineProvider
      */
     public function testStartEndLine(string $php, int $expectedStart, int $expectedEnd): void
@@ -859,7 +861,7 @@ public function testStartEndLine(string $php, int $expectedStart, int $expectedE
     }
 
     /**
-     * @return list<array{0: string, 1: int, 2: int}>
+     * @return list<array{0: non-empty-string, 1: int, 2: int}>
      */
     public function columnsProvider(): array
     {
@@ -871,6 +873,8 @@ public function columnsProvider(): array
     }
 
     /**
+     * @param non-empty-string $php
+     *
      * @dataProvider columnsProvider
      */
     public function testGetStartColumnAndEndColumn(string $php, int $startColumn, int $endColumn): void

diff --git a/test/unit/Reflection/ReflectionConstantTest.php b/test/unit/Reflection/ReflectionConstantTest.php
@@ -258,7 +258,7 @@ public function testGetDocCommentByDefine(): void
     }
 
     /**
-     * @return list<array{0: string, 1: int, 2: int}>
+     * @return list<array{0: non-empty-string, 1: int, 2: int}>
      */
     public function startEndLineProvider(): array
     {
@@ -270,6 +270,8 @@ public function startEndLineProvider(): array
     }
 
     /**
+     * @param non-empty-string $php
+     *
      * @dataProvider startEndLineProvider
      */
     public function testStartEndLine(string $php, int $expectedStart, int $expectedEnd): void
@@ -282,7 +284,7 @@ public function testStartEndLine(string $php, int $expectedStart, int $expectedE
     }
 
     /**
-     * @return list<array{0: string, 1: int, 2: int}>
+     * @return list<array{0: non-empty-string, 1: int, 2: int}>
      */
     public function columnsProvider(): array
     {
@@ -293,6 +295,8 @@ public function columnsProvider(): array
     }
 
     /**
+     * @param non-empty-string $php
+     *
      * @dataProvider columnsProvider
      */
     public function testGetStartColumnAndEndColumn(string $php, int $startColumn, int $endColumn): void

diff --git a/test/unit/Reflection/ReflectionFunctionAbstractTest.php b/test/unit/Reflection/ReflectionFunctionAbstractTest.php
@@ -184,7 +184,7 @@ public function testIsInternal(): void
     }
 
     /**
-     * @return list<array{0: string, 1: bool}>
+     * @return list<array{0: non-empty-string, 1: bool}>
      */
     public function variadicProvider(): array
     {
@@ -196,6 +196,8 @@ public function variadicProvider(): array
     }
 
     /**
+     * @param non-empty-string $php
+     *
      * @dataProvider variadicProvider
      */
     public function testIsVariadic(string $php, bool $expectingVariadic): void
@@ -212,7 +214,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
     {
@@ -238,6 +240,8 @@ public function generatorProvider(): array
     }
 
     /**
+     * @param non-empty-string $php
+     *
      * @dataProvider generatorProvider
      */
     public function testIsGenerator(string $php, bool $expectingGenerator): void
@@ -249,7 +253,7 @@ public function testIsGenerator(string $php, bool $expectingGenerator): void
     }
 
     /**
-     * @return list<array{0: string, 1: int, 2: int}>
+     * @return list<array{0: non-empty-string, 1: int, 2: int}>
      */
     public function startEndLineProvider(): array
     {
@@ -261,6 +265,8 @@ public function startEndLineProvider(): array
     }
 
     /**
+     * @param non-empty-string $php
+     *
      * @dataProvider startEndLineProvider
      */
     public function testStartEndLine(string $php, int $expectedStart, int $expectedEnd): void
@@ -273,7 +279,7 @@ public function testStartEndLine(string $php, int $expectedStart, int $expectedE
     }
 
     /**
-     * @return list<array{0: string, 1: int, 2: int}>
+     * @return list<array{0: non-empty-string, 1: int, 2: int}>
      */
     public function columnsProvider(): array
     {
@@ -285,6 +291,8 @@ public function columnsProvider(): array
     }
 
     /**
+     * @param non-empty-string $php
+     *
      * @dataProvider columnsProvider
      */
     public function testGetStartColumnAndEndColumn(string $php, int $startColumn, int $endColumn): void
@@ -297,7 +305,7 @@ public function testGetStartColumnAndEndColumn(string $php, int $startColumn, in
     }
 
     /**
-     * @return list<array{0: string, 1: bool}>
+     * @return list<array{0: non-empty-string, 1: bool}>
      */
     public function returnsReferenceProvider(): array
     {
@@ -308,6 +316,8 @@ public function returnsReferenceProvider(): array
     }
 
     /**
+     * @param non-empty-string $php
+     *
      * @dataProvider returnsReferenceProvider
      */
     public function testReturnsReference(string $php, bool $expectingReturnsReference): void

diff --git a/test/unit/Reflection/ReflectionParameterTest.php b/test/unit/Reflection/ReflectionParameterTest.php
@@ -714,7 +714,7 @@ public function testGetClassFromObjectTypeHintedProperty(): void
     }
 
     /**
-     * @return list<array{0: string, 1: int, 2: int}>
+     * @return list<array{0: non-empty-string, 1: int, 2: int}>
      */
     public function columnsProvider(): array
     {
@@ -727,6 +727,8 @@ public function columnsProvider(): array
     }
 
     /**
+     * @param non-empty-string $php
+     *
      * @dataProvider columnsProvider
      */
     public function testGetStartColumnAndEndColumn(string $php, int $startColumn, int $endColumn): void

diff --git a/test/unit/Reflection/ReflectionPropertyTest.php b/test/unit/Reflection/ReflectionPropertyTest.php
@@ -277,6 +277,8 @@ public function testCannotClone(): void
     }
 
     /**
+     * @param non-empty-string $php
+     *
      * @dataProvider startEndLineProvider
      */
     public function testStartEndLine(string $php, int $startLine, int $endLine): void
@@ -289,7 +291,7 @@ public function testStartEndLine(string $php, int $startLine, int $endLine): voi
     }
 
     /**
-     * @return list<array{0: string, 1: int, 2: int}>
+     * @return list<array{0: non-empty-string, 1: int, 2: int}>
      */
     public function startEndLineProvider(): array
     {
@@ -302,7 +304,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
     {
@@ -314,6 +316,8 @@ public function columnsProvider(): array
     }
 
     /**
+     * @param non-empty-string $php
+     *
      * @dataProvider columnsProvider
      */
     public function testGetStartColumnAndEndColumn(string $php, int $startColumn, int $endColumn): void

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;
 
@@ -64,10 +63,4 @@ public function testReturnsReflectionWhenSourceHasClass(): void
 
         self::assertSame('Foo', $reflectionClass->getName());
     }
-
-    public function testConstructorThrowsExceptionIfEmptyStringGiven(): void
-    {
-        $this->expectException(EmptyPhpSourceCode::class);
-        new StringSourceLocator('', $this->astLocator);
-    }
 }