Replace test annotations with attributes

Author: Valentin Wotschel

tests/Dissect/Lexer/AbstractLexerTest.php

@@ -4,6 +4,7 @@
 
 use Dissect\Lexer\Exception\RecognitionException;
 use Dissect\Parser\Parser;
+use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
 
 class AbstractLexerTest extends TestCase
@@ -15,9 +16,7 @@ public function setUp(): void
         $this->lexer = new StubLexer();
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function lexShouldDelegateToExtractTokenUpdatingTheLineAndOffsetAccordingly()
     {
         $stream = $this->lexer->lex("ab\nc");
@@ -38,9 +37,7 @@ public function lexShouldDelegateToExtractTokenUpdatingTheLineAndOffsetAccording
         $this->assertEquals(2, $stream->getCurrentToken()->getLine());
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function lexShouldAppendAnEofTokenAutomatically()
     {
         $stream = $this->lexer->lex("abc");
@@ -50,9 +47,7 @@ public function lexShouldAppendAnEofTokenAutomatically()
         $this->assertEquals(1, $stream->getCurrentToken()->getLine());
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function lexShouldThrowAnExceptionOnAnUnrecognizableToken()
     {
         try {
@@ -63,18 +58,14 @@ public function lexShouldThrowAnExceptionOnAnUnrecognizableToken()
         }
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function lexShouldNormalizeLineEndingsBeforeLexing()
     {
         $stream = $this->lexer->lex("a\r\nb");
         $this->assertEquals("\n", $stream->get(1)->getValue());
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function lexShouldSkipTokensIfToldToDoSo()
     {
         $stream = $this->lexer->lex('aeb');

tests/Dissect/Lexer/Recognizer/RegexRecognizerTest.php

@@ -2,13 +2,12 @@
 
 namespace Dissect\Lexer\Recognizer;
 
+use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
 
 class RegexRecognizerTest extends TestCase
 {
-    /**
-     * @test
-     */
+    #[Test]
     public function recognizerShouldMatchAndPassTheValueByReference()
     {
         $recognizer = new RegexRecognizer('/[a-z]+/');
@@ -19,9 +18,7 @@ public function recognizerShouldMatchAndPassTheValueByReference()
         $this->assertEquals('lorem', $value);
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function recognizerShouldFailAndTheValueShouldStayNull()
     {
         $recognizer = new RegexRecognizer('/[a-z]+/');
@@ -31,9 +28,7 @@ public function recognizerShouldFailAndTheValueShouldStayNull()
         $this->assertNull($value);
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function recognizerShouldFailIfTheMatchIsNotAtTheBeginningOfTheString()
     {
         $recognizer = new RegexRecognizer('/[a-z]+/');

tests/Dissect/Lexer/Recognizer/SimpleRecognizerTest.php

@@ -2,13 +2,12 @@
 
 namespace Dissect\Lexer\Recognizer;
 
+use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
 
 class SimpleRecognizerTest extends TestCase
 {
-    /**
-     * @test
-     */
+    #[Test]
     public function recognizerShouldMatchAndPassTheValueByReference()
     {
         $recognizer = new SimpleRecognizer('class');
@@ -19,9 +18,7 @@ public function recognizerShouldMatchAndPassTheValueByReference()
         $this->assertEquals('class', $value);
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function recognizerShouldFailAndTheValueShouldStayNull()
     {
         $recognizer = new SimpleRecognizer('class');

tests/Dissect/Lexer/RegexLexerTest.php

@@ -3,6 +3,7 @@
 namespace Dissect\Lexer;
 
 use Dissect\Parser\Parser;
+use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
 
 class RegexLexerTest extends TestCase
@@ -14,9 +15,7 @@ protected function setUp(): void
         $this->lexer = new StubRegexLexer();
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function itShouldCallGetTypeToRetrieveTokenType()
     {
         $stream = $this->lexer->lex('5 + 6');
@@ -27,9 +26,7 @@ public function itShouldCallGetTypeToRetrieveTokenType()
         $this->assertEquals(Parser::EOF_TOKEN_TYPE, $stream->get(3)->getType());
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function itShouldTrackLineNumbers()
     {
         $stream = $this->lexer->lex("5\n+\n\n5");

tests/Dissect/Lexer/SimpleLexerTest.php

@@ -2,6 +2,7 @@
 
 namespace Dissect\Lexer;
 
+use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
 
 class SimpleLexerTest extends TestCase
@@ -23,9 +24,7 @@ public function setUp(): void
             ->skip('WS');
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function simpleLexerShouldWalkThroughTheRecognizers()
     {
         $stream = $this->lexer->lex('a (b) c');
@@ -36,9 +35,7 @@ public function simpleLexerShouldWalkThroughTheRecognizers()
         $this->assertEquals('C', $stream->get(4)->getType());
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function simpleLexerShouldSkipSpecifiedTokens()
     {
         $stream = $this->lexer->lex('a (b) c');
@@ -48,9 +45,7 @@ public function simpleLexerShouldSkipSpecifiedTokens()
         }
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function simpleLexerShouldReturnTheBestMatch()
     {
         $this->lexer->token('CLASS', 'class');

tests/Dissect/Lexer/StatefulLexerTest.php

@@ -3,6 +3,7 @@
 namespace Dissect\Lexer;
 
 use LogicException;
+use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
 
 class StatefulLexerTest extends TestCase
@@ -14,29 +15,23 @@ protected function setUp(): void
         $this->lexer = new StatefulLexer();
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function addingNewTokenShouldThrowAnExceptionWhenNoStateIsBeingBuilt()
     {
         $this->expectExceptionMessage("Define a lexer state first.");
         $this->expectException(LogicException::class);
         $this->lexer->regex('WORD', '/[a-z]+/');
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function anExceptionShouldBeThrownOnLexingWithoutAStartingState()
     {
         $this->expectException(LogicException::class);
         $this->lexer->state('root');
         $this->lexer->lex('foo');
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function theStateMechanismShouldCorrectlyPushAndPopStatesFromTheStack()
     {
         /** @noinspection PhpPossiblePolymorphicInvocationInspection */
@@ -61,9 +56,7 @@ public function theStateMechanismShouldCorrectlyPushAndPopStatesFromTheStack()
         $this->assertEquals('quux', $stream->get(6)->getValue());
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function defaultActionShouldBeNop()
     {
         $this->lexer->state('root')

tests/Dissect/Lexer/StubLexer.php

@@ -6,7 +6,7 @@ class StubLexer extends AbstractLexer
 {
     protected function extractToken(string $string): ?Token
     {
-        if (strlen(utf8_decode($string)) === 0) {
+        if (strlen(mb_convert_encoding($string, 'ISO-8859-1', 'UTF-8')) === 0) {
             return null;
         }
 

tests/Dissect/Lexer/TokenStream/ArrayTokenStreamTest.php

@@ -4,6 +4,7 @@
 
 use Dissect\Lexer\CommonToken;
 use OutOfBoundsException;
+use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
 
 class ArrayTokenStreamTest extends TestCase
@@ -21,17 +22,13 @@ protected function setUp(): void
         ]);
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function theCursorShouldBeOnFirstTokenByDefault()
     {
         $this->assertEquals('6', $this->stream->getCurrentToken()->getValue());
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function getPositionShouldReturnCurrentPosition()
     {
         $this->stream->seek(2);
@@ -40,79 +37,61 @@ public function getPositionShouldReturnCurrentPosition()
         $this->assertEquals(3, $this->stream->getPosition());
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function lookAheadShouldReturnTheCorrectToken()
     {
         $this->assertEquals('5', $this->stream->lookAhead(2)->getValue());
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function lookAheadShouldThrowAnExceptionWhenInvalid()
     {
         $this->expectException(OutOfBoundsException::class);
         $this->stream->lookAhead(15);
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function getShouldReturnATokenByAbsolutePosition()
     {
         $this->assertEquals('3', $this->stream->get(4)->getValue());
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function getShouldThrowAnExceptionWhenInvalid()
     {
         $this->expectException(OutOfBoundsException::class);
         $this->stream->get(15);
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function moveShouldMoveTheCursorByToAnAbsolutePosition()
     {
         $this->stream->move(2);
         $this->assertEquals('5', $this->stream->getCurrentToken()->getValue());
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function moveShouldThrowAnExceptionWhenInvalid()
     {
         $this->expectException(OutOfBoundsException::class);
         $this->stream->move(15);
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function seekShouldMoveTheCursorByRelativeOffset()
     {
         $this->stream->seek(4);
         $this->assertEquals('3', $this->stream->getCurrentToken()->getValue());
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function seekShouldThrowAnExceptionWhenInvalid()
     {
         $this->expectException(OutOfBoundsException::class);
         $this->stream->seek(15);
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function nextShouldMoveTheCursorOneTokenAhead()
     {
         $this->stream->next();
@@ -122,9 +101,7 @@ public function nextShouldMoveTheCursorOneTokenAhead()
         $this->assertEquals('5', $this->stream->getCurrentToken()->getValue());
     }
 
-    /**
-     * @test
-     */
+    #[Test]
     public function nextShouldThrowAnExceptionWhenAtTheEndOfTheStream()
     {
         $this->expectException(OutOfBoundsException::class);