Throw more informative error when file has PHP syntax error (#18)

* Throw more informative error when file has PHP syntax error

* Fix warning, passing generator to count

Author: cspray

fixture_src/BadPhpFileFixture.php

@@ -0,0 +1,11 @@
+<?php declare(strict_types=1);
+
+namespace Cspray\AnnotatedTargetFixture;
+
+class BadPhpFileFixture implements Fixture {
+
+    public function getPath() : string {
+        return __DIR__ . '/InvalidPhpSyntax';
+    }
+
+}

fixture_src/Fixtures.php

@@ -85,4 +85,8 @@ public static function classOnlyAttributeSingleInterface() : ClassOnlyAttributeS
     public static function targetAttributeInterface() : TargetAttributeInterfaceFixture {
         return new TargetAttributeInterfaceFixture();
     }
+
+    public static function invalidSyntax() : BadPhpFileFixture {
+        return new BadPhpFileFixture();
+    }
 }

fixture_src/InvalidPhpSyntax/BadPhpFile.php

@@ -0,0 +1,11 @@
+<?php declare(strict_types=1);
+
+namespace Cspray\AnnotatedTargetFixture\InvalidPhpSyntax;
+
+class BadPhpFile {
+
+    public function method() : string {
+        return '':
+    }
+
+}

src/Exception/InvalidPhpSyntax.php

@@ -0,0 +1,7 @@
+<?php declare(strict_types=1);
+
+namespace Cspray\AnnotatedTarget\Exception;
+
+final class InvalidPhpSyntax extends Exception {
+
+}

src/PhpParserAnnotatedTargetParser.php

@@ -2,9 +2,11 @@
 
 namespace Cspray\AnnotatedTarget;
 
+use Cspray\AnnotatedTarget\Exception\InvalidPhpSyntax;
 use FilesystemIterator;
 use Generator;
 use Iterator;
+use PhpParser\Error;
 use PhpParser\Node;
 use PhpParser\NodeTraverser;
 use PhpParser\NodeVisitor;
@@ -42,9 +44,17 @@ public function parse(AnnotatedTargetParserOptions $options) : Generator {
         ));
 
         foreach ($this->getSourceIterator($options) as $sourceFile) {
-            $nodes = $this->parser->parse(file_get_contents($sourceFile->getPathname()));
-            $nodeTraverser->traverse($nodes);
-            unset($nodes);
+            try {
+                $nodes = $this->parser->parse(file_get_contents($sourceFile->getPathname()));
+                $nodeTraverser->traverse($nodes);
+            } catch (Error $error) {
+                throw new InvalidPhpSyntax(
+                    message: sprintf('Encountered error parsing %s. Message: %s', $sourceFile, $error->getMessage()),
+                    previous: $error
+                );
+            } finally {
+                unset($nodes);
+            }
         }
 
         yield from $data->targets;

tests/Unit/InvalidPhpSyntaxTest.php

@@ -0,0 +1,17 @@
+<?php declare(strict_types=1);
+
+namespace Cspray\AnnotatedTarget\Unit;
+
+use Cspray\AnnotatedTarget\Exception\InvalidPhpSyntax;
+use Cspray\AnnotatedTargetFixture\Fixtures;
+
+uses(AnnotatedTargetParserTestCase::class);
+
+beforeEach()->withFixtures(Fixtures::invalidSyntax());
+
+
+it('throws an exception if invalid PHP syntax is encountered', fn() => $this->getTargets())
+    ->throws(
+        InvalidPhpSyntax::class,
+        'Encountered error parsing ' . Fixtures::invalidSyntax()->getPath() . '/BadPhpFile.php. Message: Syntax error, unexpected \':\', expecting \';\' on line 8'
+    );

tests/Unit/ParseAttributesMultipleDirectoryTest.php

@@ -8,7 +8,7 @@
 use function Cspray\AnnotatedTarget\parseAttributes;
 use function Cspray\Typiphy\objectType;
 
-$targets = fn() => parseAttributes([Fixtures::classOnlyAttributeSingleClass()->getPath(), Fixtures::propertyOnlyAttributeSingleClass()->getPath()]);
+$targets = fn() => iterator_to_array(parseAttributes([Fixtures::classOnlyAttributeSingleClass()->getPath(), Fixtures::propertyOnlyAttributeSingleClass()->getPath()]));
 
 it('counts targets for single class')
     ->expect($targets)