Add PHP 8.4 (alpha build) tests support

src/ConfigurableParserInterface.php

@@ -11,23 +11,25 @@
 
 /**
  * @template TNode of object
+ *
  * @template-extends ParserInterface<TNode>
  */
 interface ConfigurableParserInterface extends ParserInterface
 {
     /**
      * Parses sources into an abstract source tree (AST) or list of AST nodes.
      *
-     * @param array<non-empty-string, mixed> $options list of additional
-     *        runtime options for the parser (parsing context)
+     * @param array<non-empty-string, mixed> $options List of additional
+     *        runtime options for the parser (parsing context).
      *
      * @return iterable<array-key, TNode>
-     * @throws ParserExceptionInterface an error occurs before source processing
+     *
+     * @throws ParserExceptionInterface An error occurs before source processing
      *         starts, when the given source cannot be recognized or if the
-     *         parser settings contain errors
-     * @throws ParserRuntimeExceptionInterface an exception that occurs after
+     *         parser settings contain errors.
+     * @throws ParserRuntimeExceptionInterface An exception that occurs after
      *         starting the parsing and indicates problems in the analyzed
-     *         source
+     *         source.
      */
     public function parse(ReadableInterface $source, array $options = []): iterable;
 }

src/Context.php

@@ -5,6 +5,7 @@
 namespace Phplrt\Parser;
 
 use Phplrt\Buffer\BufferInterface;
+use Phplrt\Contracts\Ast\NodeInterface;
 use Phplrt\Contracts\Lexer\TokenInterface;
 use Phplrt\Contracts\Source\ReadableInterface;
 use Phplrt\Parser\Context\ContextOptionsTrait;
@@ -74,7 +75,6 @@ class Context implements ContextInterface
      * Contains information about the processed source.
      *
      * @readonly marked as readonly since phplrt 3.4 and will be readonly since 4.0
-     *
      * @psalm-readonly-allow-private-mutation
      */
     public ReadableInterface $source;
@@ -83,7 +83,6 @@ class Context implements ContextInterface
      * Contains a buffer of tokens that were collected from lexical analysis.
      *
      * @readonly marked as readonly since phplrt 3.4 and will be readonly since 4.0
-     *
      * @psalm-readonly-allow-private-mutation
      */
     public BufferInterface $buffer;

src/Context/ContextOptionsTrait.php

@@ -5,9 +5,8 @@
 namespace Phplrt\Parser\Context;
 
 /**
- * @psalm-require-implements ContextOptionsProviderInterface
- *
  * @mixin ContextOptionsProviderInterface
+ * @psalm-require-implements ContextOptionsProviderInterface
  */
 trait ContextOptionsTrait
 {

src/Context/TreeBuilder.php

@@ -8,7 +8,7 @@
 use Phplrt\Parser\Context;
 
 /**
- * @internal this is an internal library class, please do not use it in your code
+ * @internal This is an internal library class, please do not use it in your code.
  * @psalm-internal Phplrt\Parser
  */
 class TreeBuilder implements BuilderInterface

src/Environment/Factory.php

@@ -8,7 +8,6 @@ final class Factory implements SelectorInterface
 {
     /**
      * @var list<SelectorInterface>
-     *
      * @readonly
      */
     private array $selectors;

src/Environment/XdebugSelector.php

@@ -39,7 +39,6 @@ final class XdebugSelector implements SelectorInterface
 
     /**
      * @var int<0, max>
-     *
      * @readonly
      */
     private int $expectedRecursionDepth;

src/Exception/ParserRuntimeException.php

@@ -15,7 +15,7 @@ final public function __construct(
         string $message,
         ReadableInterface $src,
         ?TokenInterface $tok,
-        ?\Throwable $prev = null
+        \Throwable $prev = null
     ) {
         parent::__construct($message, 0, $prev);
 

src/Exception/UnexpectedTokenException.php

@@ -15,7 +15,7 @@ class UnexpectedTokenException extends UnrecognizedTokenException
     public static function fromToken(
         ReadableInterface $src,
         TokenInterface $tok,
-        ?\Throwable $prev = null,
+        \Throwable $prev = null,
         array $expected = []
     ): self {
         switch (\count($expected)) {

src/Exception/UnrecognizedTokenException.php

@@ -12,7 +12,7 @@
 
 class UnrecognizedTokenException extends ParserRuntimeException
 {
-    public static function fromToken(ReadableInterface $src, TokenInterface $tok, ?\Throwable $prev = null): self
+    public static function fromToken(ReadableInterface $src, TokenInterface $tok, \Throwable $prev = null): self
     {
         $message = \sprintf('Syntax error, unrecognized %s', self::getTokenValue($tok));
 

src/Grammar/Alternation.php

@@ -15,7 +15,6 @@ class Alternation extends Production
      * @var list<array-key>
      *
      * @readonly
-     *
      * @psalm-readonly-allow-private-mutation
      */
     public array $sequence = [];

src/Grammar/Builder.php

@@ -19,7 +19,7 @@ class Builder implements \IteratorAggregate
     /**
      * @param \Closure():\Generator|null $generator
      */
-    public function __construct(?\Closure $generator = null)
+    public function __construct(\Closure $generator = null)
     {
         if ($generator !== null) {
             $this->extend($generator);
@@ -48,6 +48,7 @@ public function extend(\Closure $rules): self
                 case \is_string($key) && $value instanceof RuleInterface:
                     $generator->send($this->add($value, $key));
                     continue 2;
+
                 case $value instanceof RuleInterface:
                     $generator->send($this->add($value));
                     continue 2;
@@ -93,7 +94,6 @@ public function maybe(...$of): Optional
 
     /**
      * @param non-empty-list<array-key> $args
-     *
      * @return array-key
      */
     private function unwrap(array $args)
@@ -126,7 +126,6 @@ private function read(\Closure $rules): \Generator
 
     /**
      * @param array-key|null $id
-     *
      * @return array-key
      */
     public function add(RuleInterface $rule, $id = null)

src/Grammar/Concatenation.php

@@ -15,7 +15,6 @@ class Concatenation extends Production
      * @var list<array-key>
      *
      * @readonly
-     *
      * @psalm-readonly-allow-private-mutation
      */
     public array $sequence = [];

src/Grammar/Lexeme.php

@@ -14,7 +14,6 @@ class Lexeme extends Terminal
 {
     /**
      * @var non-empty-string|int
-     *
      * @readonly
      */
     public $token;

src/Grammar/Optional.php

@@ -15,7 +15,6 @@ class Optional extends Production
      * @var array-key
      *
      * @readonly
-     *
      * @psalm-readonly-allow-private-mutation
      */
     public $rule;

src/Grammar/Production.php

@@ -12,7 +12,6 @@ abstract class Production extends Rule implements ProductionInterface
     /**
      * @param list<NodeInterface|TokenInterface> $children
      * @param NodeInterface|TokenInterface|array $result
-     *
      * @return list<NodeInterface|TokenInterface>
      */
     protected function mergeWith(array $children, $result): array

src/Grammar/Repetition.php

@@ -15,7 +15,6 @@ class Repetition extends Production
      * @var int<0, max>
      *
      * @readonly
-     *
      * @psalm-readonly-allow-private-mutation
      */
     public int $gte;
@@ -24,7 +23,6 @@ class Repetition extends Production
      * @var int<0, max>|float
      *
      * @readonly
-     *
      * @psalm-readonly-allow-private-mutation
      */
     public $lte;
@@ -33,7 +31,6 @@ class Repetition extends Production
      * @var array-key
      *
      * @readonly
-     *
      * @psalm-readonly-allow-private-mutation
      */
     public $rule;
@@ -48,8 +45,8 @@ public function __construct($rule, int $gte = 0, $lte = \INF)
         \assert($lte >= $gte, 'Min repetitions count must be greater or equal than max repetitions');
 
         $this->rule = $rule;
-        $this->gte = $gte;
-        $this->lte = \is_infinite($lte) ? \INF : (int) $lte;
+        $this->gte  = $gte;
+        $this->lte  = \is_infinite($lte) ? \INF : (int) $lte;
     }
 
     public function getTerminals(array $rules): iterable

src/Parser.php

@@ -5,6 +5,7 @@
 namespace Phplrt\Parser;
 
 use Phplrt\Buffer\BufferInterface;
+use Phplrt\Contracts\Ast\NodeInterface;
 use Phplrt\Contracts\Exception\RuntimeExceptionInterface;
 use Phplrt\Contracts\Lexer\LexerInterface;
 use Phplrt\Contracts\Lexer\LexerRuntimeExceptionInterface;
@@ -23,6 +24,7 @@
 use Phplrt\Parser\Grammar\ProductionInterface;
 use Phplrt\Parser\Grammar\RuleInterface;
 use Phplrt\Parser\Grammar\TerminalInterface;
+use Phplrt\Source\File;
 use Phplrt\Source\SourceFactory;
 
 /**
@@ -59,6 +61,7 @@
  * </code>
  *
  * @template TNode of object
+ *
  * @template-implements ConfigurableParserInterface<TNode>
  */
 final class Parser implements ConfigurableParserInterface, ParserConfigsInterface
@@ -104,7 +107,6 @@ final class Parser implements ConfigurableParserInterface, ParserConfigsInterfac
      * The initial state (initial rule identifier) of the parser.
      *
      * @var array-key
-     *
      * @psalm-readonly-allow-private-mutation
      */
     private $initial;
@@ -115,16 +117,15 @@ final class Parser implements ConfigurableParserInterface, ParserConfigsInterfac
      * @var array<array-key, RuleInterface>
      *
      * @readonly
-     *
      * @psalm-readonly-allow-private-mutation
      */
     private array $rules = [];
 
     private ?Context $context = null;
 
     /**
-     * @param iterable<array-key, RuleInterface> $grammar an iterable of the
-     *        transition rules for the parser
+     * @param iterable<array-key, RuleInterface> $grammar An iterable of the
+     *        transition rules for the parser.
      * @param array<ParserConfigsInterface::CONFIG_*, mixed> $options
      */
     public function __construct(
@@ -244,17 +245,18 @@ public function buildUsing(BuilderInterface $builder): self
     /**
      * Parses sources into an abstract source tree (AST) or list of AST nodes.
      *
-     * @param mixed $source any source supported by the {@see SourceFactoryInterface::create()}
-     * @param array<non-empty-string, mixed> $options list of additional
-     *        runtime options for the parser (parsing context)
+     * @param mixed $source Any source supported by the {@see SourceFactoryInterface::create()}.
+     * @param array<non-empty-string, mixed> $options List of additional
+     *        runtime options for the parser (parsing context).
      *
      * @return iterable<array-key, TNode>
-     * @throws ParserExceptionInterface an error occurs before source processing
+     *
+     * @throws ParserExceptionInterface An error occurs before source processing
      *         starts, when the given source cannot be recognized or if the
-     *         parser settings contain errors
-     * @throws ParserRuntimeExceptionInterface an exception that occurs after
+     *         parser settings contain errors.
+     * @throws ParserRuntimeExceptionInterface An exception that occurs after
      *         starting the parsing and indicates problems in the analyzed
-     *         source
+     *         source.
      */
     public function parse($source, array $options = []): iterable
     {
@@ -360,6 +362,9 @@ private function lookupExpectedTokens(Context $context): array
         return \array_values($tokens);
     }
 
+    /**
+     * @return mixed
+     */
     private function next(Context $context)
     {
         if ($this->step !== null) {
@@ -371,6 +376,9 @@ private function next(Context $context)
         return $this->runNextStep($context);
     }
 
+    /**
+     * @return mixed
+     */
     private function runNextStep(Context $context)
     {
         $rule = $context->rule = $this->rules[$context->state];

src/polyfill.php

@@ -1,6 +1,7 @@
 <?php
 
 namespace Phplrt\Grammar {
+
     if (
         !\class_exists(Alternation::class, false)
         && \class_exists(\Phplrt\Parser\Grammar\Alternation::class)

tests/Functional/GrammarGeneratorTest.php

@@ -48,10 +48,10 @@ public function testHelpers(): void
         });
 
         $expected = [
-            0 => new Lexeme('digit'),
-            1 => new Lexeme('plus'),
-            2 => new Concatenation([1, 0]),
-            3 => new Repetition(2),
+            0     => new Lexeme('digit'),
+            1     => new Lexeme('plus'),
+            2     => new Concatenation([1, 0]),
+            3     => new Repetition(2),
             'sum' => new Concatenation([0, 3]),
         ];
 

tests/Functional/SimpleSumParserTest.php

@@ -4,6 +4,7 @@
 
 namespace Phplrt\Parser\Tests\Functional;
 
+use Phplrt\Contracts\Exception\RuntimeExceptionInterface;
 use Phplrt\Lexer\Lexer;
 use Phplrt\Lexer\Token\Token;
 use Phplrt\Parser\BuilderInterface;
@@ -13,6 +14,7 @@
 use Phplrt\Parser\Grammar\Repetition;
 use Phplrt\Parser\Parser;
 use Phplrt\Parser\Tests\Functional\Stub\AstNode;
+use PHPUnit\Framework\ExpectationFailedException;
 
 class SimpleSumParserTest extends TestCase implements BuilderInterface
 {
@@ -53,21 +55,21 @@ private function parseSum(string $expr): iterable
     {
         $lexer = new Lexer([
             'T_WHITESPACE' => '\s+',
-            'T_DIGIT' => '\d+',
-            'T_PLUS' => '\+',
+            'T_DIGIT'      => '\d+',
+            'T_PLUS'       => '\+',
         ], ['T_WHITESPACE']);
 
         $grammar = [
-            0 => new Lexeme('T_DIGIT'),
-            1 => new Lexeme('T_PLUS'),
-            2 => new Repetition('suffix'),
-            'sum' => new Concatenation([0, 2]),
+            0        => new Lexeme('T_DIGIT'),
+            1        => new Lexeme('T_PLUS'),
+            2        => new Repetition('suffix'),
+            'sum'    => new Concatenation([0, 2]),
             'suffix' => new Concatenation([1, 0]),
         ];
 
         $parser = new Parser($lexer, $grammar, [
             Parser::CONFIG_INITIAL_RULE => 'sum',
-            Parser::CONFIG_AST_BUILDER => $this,
+            Parser::CONFIG_AST_BUILDER  => $this,
         ]);
 
         return $parser->parse($expr);

tests/Functional/TestCase.php

@@ -26,7 +26,6 @@ public function __construct(array &$result)
 
             /**
              * @param NodeInterface|AstNode $node
-             *
              * @return mixed|void|null
              */
             public function enter(NodeInterface $node)