Modernize codebase for PHP 8

.github/workflows/coding-standards.yml

@@ -0,0 +1,15 @@
+
+name: "Coding Standards"
+
+on:
+  pull_request:
+    branches:
+      - "*.x"
+  push:
+    branches:
+      - "*.x"
+
+jobs:
+  coding-standards:
+    name: "Coding Standards"
+    uses: "doctrine/.github/.github/workflows/[email protected]"

.github/workflows/continuous-integration.yml

@@ -1,4 +1,3 @@
-
 name: "Continuous Integration"
 
 on:
@@ -9,125 +8,11 @@ on:
     branches:
       - "*.x"
 
-env:
-  fail-fast: true
-
 jobs:
-
-  unit-tests:
-    name: "Unit tests"
-    runs-on: "ubuntu-20.04"
-
-    strategy:
-      matrix:
-        php-version:
-          - "7.2"
-          - "7.3"
-          - "7.4"
-          - "8.0"
-          - "8.1"
-
-    steps:
-      - name: "Checkout code"
-        uses: "actions/checkout@v4"
-
-      - name: "Install PHP"
-        uses: "shivammathur/setup-php@v2"
-        with:
-          coverage: "none"
-          php-version: "${{ matrix.php-version }}"
-          tools: "cs2pr"
-
-      - name: "Install dependencies with Composer"
-        uses: "ramsey/composer-install@v3"
-        with:
-          dependency-versions: "highest"
-
-      - name: "Test fixes"
-        run: "vendor/bin/phpunit --coverage-text"
-
-  static-analysis-phpstan:
-    name: "Static Analysis with PHPStan"
-    runs-on: "ubuntu-20.04"
-
-    strategy:
-      matrix:
-        php-version:
-          - "7.4"
-
-    steps:
-      - name: "Checkout code"
-        uses: "actions/checkout@v4"
-
-      - name: "Install PHP"
-        uses: "shivammathur/setup-php@v2"
-        with:
-          coverage: "none"
-          php-version: "${{ matrix.php-version }}"
-          extensions: "mbstring"
-          tools: "cs2pr"
-
-      - name: "Install dependencies with Composer"
-        uses: "ramsey/composer-install@v3"
-        with:
-          dependency-versions: "highest"
-
-      - name: "Run a static analysis with phpstan/phpstan"
-        run: "vendor/bin/phpstan analyse --error-format=checkstyle | cs2pr"
-
-
-  static-analysis-psalm:
-    name: "Static Analysis with Psalm"
-    runs-on: "ubuntu-20.04"
-
-    strategy:
-      matrix:
-        php-version:
-          - "7.4"
-
-    steps:
-      - name: "Checkout code"
-        uses: "actions/checkout@v4"
-
-      - name: "Install PHP"
-        uses: "shivammathur/setup-php@v2"
-        with:
-          coverage: "none"
-          php-version: "${{ matrix.php-version }}"
-
-      - name: "Install dependencies with Composer"
-        uses: "ramsey/composer-install@v3"
-        with:
-          dependency-versions: "highest"
-
-      - name: "Run a static analysis with vimeo/psalm"
-        run: "vendor/bin/psalm --show-info=false --stats --output-format=github --threads=4"
-
-  coding-standards:
-    name: "Coding Standards"
-    runs-on: "ubuntu-20.04"
-
-    strategy:
-      matrix:
-        php-version:
-          - "7.4"
-
-    steps:
-      - name: "Checkout"
-        uses: "actions/checkout@v4"
-
-      - name: "Install PHP"
-        uses: "shivammathur/setup-php@v2"
-        with:
-          coverage: "none"
-          php-version: "${{ matrix.php-version }}"
-          tools: "cs2pr"
-
-      - name: "Install dependencies with Composer"
-        uses: "ramsey/composer-install@v3"
-        with:
-          dependency-versions: "highest"
-
-      # Remove -q when updating to phpcs v4
-      - name: "Run squizlabs/php_codesniffer"
-        run: "vendor/bin/phpcs -q --no-colors --report=checkstyle | cs2pr"
+  phpunit:
+    name: "PHPUnit"
+    uses: "doctrine/.github/.github/workflows/[email protected]"
+    with:
+      php-versions: '["8.1", "8.2", "8.3"]'
+    secrets:
+      CODECOV_TOKEN: "${{ secrets.CODECOV_TOKEN }}"

.github/workflows/static-analysis.yml

@@ -0,0 +1,15 @@
+
+name: "Static Analysis"
+
+on:
+  pull_request:
+    branches:
+      - "*.x"
+  push:
+    branches:
+      - "*.x"
+
+jobs:
+  static-analysis:
+    name: "Static Analysis"
+    uses: "doctrine/.github/.github/workflows/[email protected]"

.gitignore

@@ -1,4 +1,4 @@
-/.phpunit.result.cache
+/.phpunit.cache
 /.phpcs-cache
-vendor/
+/vendor
 /composer.lock

composer.json

@@ -6,13 +6,13 @@
     "license": "MIT",
     "type": "library",
     "require": {
-        "php": "^7.2 || ^8.0"
+        "php": "^8.1"
     },
     "require-dev": {
-        "doctrine/coding-standard": "^9.0",
-        "phpstan/phpstan": "^1.0",
-        "phpunit/phpunit": "^8.5 || ^9.6",
-        "vimeo/psalm": "^4.11"
+        "doctrine/coding-standard": "^12",
+        "phpstan/phpstan": "^1.10",
+        "phpunit/phpunit": "^10.5",
+        "vimeo/psalm": "^5.24"
     },
     "authors": [
         {

examples/examples.php

@@ -154,7 +154,7 @@
             Usage:
             <pre>
             <?php highlight_string(
-                '<?php' . "\n" . '$formatted = (new SqlFormatter())->format($sql);' . "\n" . '?>'
+                '<?php' . "\n" . '$formatted = (new SqlFormatter())->format($sql);' . "\n" . '?>',
             ); ?>
             </pre>
         </div>
@@ -195,7 +195,7 @@
                     <pre><?= $sql; ?></pre>
                 </td>
                 <td><pre><?= htmlentities((new SqlFormatter(
-                    new NullHighlighter()
+                    new NullHighlighter(),
                 ))->format($sql)); ?></pre></td>
             </tr>
             <?php endforeach ?>
@@ -208,7 +208,7 @@
             Usage:
             <pre>
             <?php highlight_string(
-                '<?php' . "\n" . '$highlighted = (new SqlFormatter())->highlight($sql);' . "\n" . '?>'
+                '<?php' . "\n" . '$highlighted = (new SqlFormatter())->highlight($sql);' . "\n" . '?>',
             ); ?>
             </pre>
         </div>
@@ -234,7 +234,7 @@
             Usage:
             <pre>
             <?php highlight_string(
-                '<?php' . "\n" . '$compressed = (new SqlFormatter())->compress($sql);' . "\n" . '?>'
+                '<?php' . "\n" . '$compressed = (new SqlFormatter())->compress($sql);' . "\n" . '?>',
             ); ?>
             </pre>
         </div>

phpunit.xml.dist

@@ -1,24 +1,24 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.0/phpunit.xsd"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
          bootstrap="vendor/autoload.php"
          executionOrder="depends,defects"
-         forceCoversAnnotation="true"
-         beStrictAboutCoversAnnotation="true"
          beStrictAboutOutputDuringTests="true"
-         beStrictAboutTodoAnnotatedTests="true"
          colors="true"
-         verbose="true">
+         cacheDirectory=".phpunit.cache"
+         requireCoverageMetadata="true"
+         beStrictAboutCoverageMetadata="true"
+>
     <testsuites>
         <testsuite name="default">
             <directory suffix="Test.php">tests</directory>
         </testsuite>
     </testsuites>
 
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
+    <source>
+        <include>
             <directory suffix=".php">src</directory>
-        </whitelist>
-    </filter>
+        </include>
+    </source>
 </phpunit>

psalm.xml

@@ -2,6 +2,8 @@
 <psalm
     errorLevel="5"
     resolveFromConfigFile="true"
+    findUnusedBaselineEntry="true"
+    findUnusedCode="false"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"

src/CliHighlighter.php

@@ -13,11 +13,9 @@ final class CliHighlighter implements Highlighter
     public const HIGHLIGHT_FUNCTIONS = 'functions';
 
     /** @var array<string, string> */
-    private $escapeSequences;
+    private array $escapeSequences;
 
-    /**
-     * @param array<string, string> $escapeSequences
-     */
+    /** @param array<string, string> $escapeSequences */
     public function __construct(array $escapeSequences = [])
     {
         $this->escapeSequences = $escapeSequences + [
@@ -48,7 +46,7 @@ public function highlightToken(int $type, string $value): string
         return $prefix . $value . "\x1b[0m";
     }
 
-    private function prefix(int $type): ?string
+    private function prefix(int $type): string|null
     {
         if (! isset(self::TOKEN_TYPE_TO_HIGHLIGHT[$type])) {
             return null;
@@ -64,7 +62,7 @@ public function highlightError(string $value): string
             PHP_EOL,
             $this->escapeSequences[self::HIGHLIGHT_ERROR],
             $value,
-            "\x1b[0m"
+            "\x1b[0m",
         );
     }
 

src/Cursor.php

@@ -6,21 +6,15 @@
 
 final class Cursor
 {
-    /** @var int */
-    private $position = -1;
+    private int $position = -1;
 
-    /** @var Token[] */
-    private $tokens;
-
-    /**
-     * @param Token[] $tokens
-     */
-    public function __construct(array $tokens)
-    {
-        $this->tokens = $tokens;
+    /** @param Token[] $tokens */
+    public function __construct(
+        private readonly array $tokens,
+    ) {
     }
 
-    public function next(?int $exceptTokenType = null): ?Token
+    public function next(int|null $exceptTokenType = null): Token|null
     {
         while ($token = $this->tokens[++$this->position] ?? null) {
             if ($exceptTokenType !== null && $token->isOfType($exceptTokenType)) {
@@ -33,7 +27,7 @@ public function next(?int $exceptTokenType = null): ?Token
         return null;
     }
 
-    public function previous(?int $exceptTokenType = null): ?Token
+    public function previous(int|null $exceptTokenType = null): Token|null
     {
         while ($token = $this->tokens[--$this->position] ?? null) {
             if ($exceptTokenType !== null && $token->isOfType($exceptTokenType)) {

src/HtmlHighlighter.php

@@ -16,21 +16,17 @@ final class HtmlHighlighter implements Highlighter
 {
     public const HIGHLIGHT_PRE = 'pre';
 
-    /**
-     * This flag tells us if queries need to be enclosed in <pre> tags
-     *
-     * @var bool
-     */
-    private $usePre;
-
     /** @var array<string, string> */
-    private $htmlAttributes;
+    private readonly array $htmlAttributes;
 
     /**
      * @param array<string, string> $htmlAttributes
+     * @param bool                  $usePre         This flag tells us if queries need to be enclosed in <pre> tags
      */
-    public function __construct(array $htmlAttributes = [], bool $usePre = true)
-    {
+    public function __construct(
+        array $htmlAttributes = [],
+        private readonly bool $usePre = true,
+    ) {
         $this->htmlAttributes = $htmlAttributes + [
             self::HIGHLIGHT_QUOTE => 'style="color: blue;"',
             self::HIGHLIGHT_BACKTICK_QUOTE => 'style="color: purple;"',
@@ -43,7 +39,6 @@ public function __construct(array $htmlAttributes = [], bool $usePre = true)
             self::HIGHLIGHT_VARIABLE => 'style="color: orange;"',
             self::HIGHLIGHT_PRE => 'style="color: black; background-color: white;"',
         ];
-        $this->usePre         = $usePre;
     }
 
     public function highlightToken(int $type, string $value): string
@@ -62,7 +57,7 @@ public function highlightToken(int $type, string $value): string
         return '<span ' . $attributes . '>' . $value . '</span>';
     }
 
-    public function attributes(int $type): ?string
+    public function attributes(int $type): string|null
     {
         if (! isset(self::TOKEN_TYPE_TO_HIGHLIGHT[$type])) {
             return null;
@@ -77,7 +72,7 @@ public function highlightError(string $value): string
             '%s<span %s>%s</span>',
             PHP_EOL,
             $this->htmlAttributes[self::HIGHLIGHT_ERROR],
-            $value
+            $value,
         );
     }