Revert "Modernize codebase for PHP 8"

atk4 · Jun 8, 2024 · 71fe98d · 71fe98d
1 parent 69e4144
commit 71fe98d
Show file tree

Hide file tree

Showing 15 changed files with 212 additions and 84 deletions.
diff --git a/.github/workflows/coding-standards.yml b/.github/workflows/coding-standards.yml
@@ -5,10 +5,35 @@ on:
     branches:
       - "*.x"
   push:
-    branches:
-      - "*.x"
 
 jobs:
   coding-standards:
     name: "Coding Standards"
-    uses: "doctrine/.github/.github/workflows/coding-standards.yml@5.0.1"
+    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=diff || true
+          vendor/bin/phpcs -q --no-colors --report=checkstyle | cs2pr
diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml
@@ -5,14 +5,38 @@ on:
     branches:
       - "*.x"
   push:
-    branches:
-      - "*.x"
+
+env:
+  fail-fast: false
 
 jobs:
-  phpunit:
-    name: "PHPUnit"
-    uses: "doctrine/.github/.github/workflows/continuous-integration.yml@5.0.1"
-    with:
-      php-versions: '["8.1", "8.2", "8.3"]'
-    secrets:
-      CODECOV_TOKEN: "${{ secrets.CODECOV_TOKEN }}"
+  unit-tests:
+    name: "Unit tests"
+    runs-on: "ubuntu-20.04"
+
+    strategy:
+      matrix:
+        php-version:
+          - "7.4"
+          - "8.0"
+          - "8.1"
+          - "8.2"
+          - "8.3"
+
+    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: "Test fixes"
+        run: "vendor/bin/phpunit --coverage-text"
diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml
@@ -5,10 +5,64 @@ on:
     branches:
       - "*.x"
   push:
-    branches:
-      - "*.x"
+
+env:
+  fail-fast: false
 
 jobs:
-  static-analysis:
-    name: "Static Analysis"
-    uses: "doctrine/.github/.github/workflows/static-analysis.yml@5.0.1"
+  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"
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 /.phpunit.cache
+/.phpunit.result.cache
 /.phpcs-cache
 /vendor
 /composer.lock
diff --git a/composer.json b/composer.json
@@ -6,14 +6,14 @@
     "license": "MIT",
     "type": "library",
     "require": {
-        "php": "^8.1"
+        "php": "^7.4 || ^8.0"
     },
     "require-dev": {
-        "doctrine/coding-standard": "^12",
+        "doctrine/coding-standard": "^9.0",
         "ergebnis/phpunit-slow-test-detector": "^2.14",
         "phpstan/phpstan": "^1.10",
-        "phpunit/phpunit": "^10.5",
-        "vimeo/psalm": "^5.24"
+        "phpunit/phpunit": "^8.5 || ^9.6",
+        "vimeo/psalm": "^4.11"
     },
     "authors": [
         {

diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -7,14 +7,11 @@
 
     <arg name="basepath" value="."/>
     <arg name="extensions" value="php"/>
-    <arg name="parallel" value="80"/>
     <arg name="cache" value=".phpcs-cache"/>
     <arg name="colors" />
 
-    <!-- Ignore warnings, show progress of the run and show sniff names -->
-    <arg value="nps"/>
-
-    <config name="php_version" value="80100"/>
+    <!-- Show progress of the run -->
+    <arg value="p"/>
 
     <rule ref="Doctrine"/>
 

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,11 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.0/phpunit.xsd"
          bootstrap="vendor/autoload.php"
          executionOrder="depends,defects"
          beStrictAboutOutputDuringTests="true"
          colors="true"
+         verbose="true">
          cacheDirectory=".phpunit.cache"
 >
     <testsuites>
@@ -18,9 +19,9 @@
         <bootstrap class="Ergebnis\PHPUnit\SlowTestDetector\Extension"/>
     </extensions>
 
-    <source>
-        <include>
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
             <directory suffix=".php">src</directory>
-        </include>
-    </source>
+        </whitelist>
+    </filter>
 </phpunit>
diff --git a/src/CliHighlighter.php b/src/CliHighlighter.php
@@ -45,7 +45,7 @@ public function highlightToken(int $type, string $value): string
     }
 
     /** @param Token::TOKEN_TYPE_* $type */
-    private function prefix(int $type): string|null
+    private function prefix(int $type): ?string
     {
         if (! isset(self::TOKEN_TYPE_TO_HIGHLIGHT[$type])) {
             return null;
@@ -61,7 +61,7 @@ public function highlightError(string $value): string
             "\n",
             $this->escapeSequences[self::HIGHLIGHT_ERROR],
             $value,
-            "\x1b[0m",
+            "\x1b[0m"
         );
     }
 

diff --git a/src/Cursor.php b/src/Cursor.php
@@ -8,14 +8,19 @@ final class Cursor
 {
     private int $position = -1;
 
-    /** @param list<Token> $tokens */
-    public function __construct(
-        private readonly array $tokens,
-    ) {
+    /** @var Token[] */
+    private array $tokens;
+
+    /**
+     * @param Token[] $tokens
+     */
+    public function __construct(array $tokens)
+    {
+        $this->tokens = $tokens;
     }
 
     /** @param Token::TOKEN_TYPE_* $exceptTokenType */
-    public function next(int|null $exceptTokenType = null): Token|null
+    public function next(?int $exceptTokenType = null): ?Token
     {
         while ($token = $this->tokens[++$this->position] ?? null) {
             if ($exceptTokenType !== null && $token->isOfType($exceptTokenType)) {
@@ -29,7 +34,7 @@ public function next(int|null $exceptTokenType = null): Token|null
     }
 
     /** @param Token::TOKEN_TYPE_* $exceptTokenType */
-    public function previous(int|null $exceptTokenType = null): Token|null
+    public function previous(?int $exceptTokenType = null): ?Token
     {
         while ($token = $this->tokens[--$this->position] ?? null) {
             if ($exceptTokenType !== null && $token->isOfType($exceptTokenType)) {

diff --git a/src/HtmlHighlighter.php b/src/HtmlHighlighter.php
@@ -15,17 +15,17 @@ final class HtmlHighlighter implements Highlighter
 {
     public const HIGHLIGHT_PRE = 'pre';
 
+    /** This flag tells us if queries need to be enclosed in <pre> tags */
+    private bool $usePre;
+
     /** @var array<string, string> */
-    private readonly array $htmlAttributes;
+    private 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 = [],
-        private readonly bool $usePre = true,
-    ) {
+    public function __construct(array $htmlAttributes = [], bool $usePre = true)
+    {
         $this->htmlAttributes = $htmlAttributes + [
             self::HIGHLIGHT_QUOTE => 'style="color: blue;"',
             self::HIGHLIGHT_BACKTICK_QUOTE => 'style="color: purple;"',
@@ -38,6 +38,7 @@ public function __construct(
             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
@@ -57,7 +58,7 @@ public function highlightToken(int $type, string $value): string
     }
 
     /** @param Token::TOKEN_TYPE_* $type */
-    public function attributes(int $type): string|null
+    public function attributes(int $type): ?string
     {
         if (! isset(self::TOKEN_TYPE_TO_HIGHLIGHT[$type])) {
             return null;
@@ -72,7 +73,7 @@ public function highlightError(string $value): string
             '%s<span %s>%s</span>',
             "\n",
             $this->htmlAttributes[self::HIGHLIGHT_ERROR],
-            $value,
+            $value
         );
     }
 

diff --git a/src/SqlFormatter.php b/src/SqlFormatter.php
@@ -29,13 +29,13 @@
 
 final class SqlFormatter
 {
-    private readonly Highlighter $highlighter;
-    private readonly Tokenizer $tokenizer;
+    private Highlighter $highlighter;
+    private Tokenizer $tokenizer;
 
     private const INDENT_TYPE_BLOCK   = 'block';
     private const INDENT_TYPE_SPECIAL = 'special';
 
-    public function __construct(Highlighter|null $highlighter = null)
+    public function __construct(?Highlighter $highlighter = null)
     {
         $this->tokenizer   = new Tokenizer();
         $this->highlighter = $highlighter ?? (PHP_SAPI === 'cli' ? new CliHighlighter() : new HtmlHighlighter());
@@ -101,7 +101,7 @@ public function format(string $string, string $indentString = '  '): string
         while ($token = $cursor->next(Token::TOKEN_TYPE_WHITESPACE)) {
             $highlighted = $this->highlighter->highlightToken(
                 $token->type(),
-                $token->value(),
+                $token->value()
             );
 
             // If we are increasing the special indent level now
@@ -209,7 +209,7 @@ public function format(string $string, string $indentString = '  '): string
                             Token::TOKEN_TYPE_RESERVED_TOPLEVEL,
                             Token::TOKEN_TYPE_RESERVED_NEWLINE,
                             Token::TOKEN_TYPE_COMMENT,
-                            Token::TOKEN_TYPE_BLOCK_COMMENT,
+                            Token::TOKEN_TYPE_BLOCK_COMMENT
                         )
                     ) {
                         break;
@@ -383,7 +383,7 @@ public function format(string $string, string $indentString = '  '): string
                     Token::TOKEN_TYPE_QUOTE,
                     Token::TOKEN_TYPE_BACKTICK_QUOTE,
                     Token::TOKEN_TYPE_WORD,
-                    Token::TOKEN_TYPE_NUMBER,
+                    Token::TOKEN_TYPE_NUMBER
                 )
             ) {
                 continue;
@@ -396,7 +396,7 @@ public function format(string $string, string $indentString = '  '): string
         if (array_search(self::INDENT_TYPE_BLOCK, $indentTypes) !== false) {
             $return  = rtrim($return, ' ');
             $return .= $this->highlighter->highlightErrorMessage(
-                'WARNING: unclosed parentheses or section',
+                'WARNING: unclosed parentheses or section'
             );
         }
 
@@ -422,7 +422,7 @@ public function highlight(string $string): string
         while ($token = $cursor->next()) {
             $return .= $this->highlighter->highlightToken(
                 $token->type(),
-                $token->value(),
+                $token->value()
             );
         }
 
@@ -454,7 +454,7 @@ public function compress(string $string): string
                 $token->isOfType(
                     Token::TOKEN_TYPE_RESERVED,
                     Token::TOKEN_TYPE_RESERVED_NEWLINE,
-                    Token::TOKEN_TYPE_RESERVED_TOPLEVEL,
+                    Token::TOKEN_TYPE_RESERVED_TOPLEVEL
                 )
             ) {
                 $newValue = preg_replace('/\s+/', ' ', $token->value());