Merge pull request #69 from inpsyde/development

[In Progress] Modernize to PHP 8 WPCS 3
inpsyde · Aug 29, 2023 · 725b79b · 725b79b
2 parents 7880c1e + efa0869
commit 725b79b
Show file tree

Hide file tree

Showing 37 changed files with 611 additions and 879 deletions.
diff --git a/.github/workflows/php-qa.yml b/.github/workflows/php-qa.yml
diff --git a/.github/workflows/quality-assurance-php.yml b/.github/workflows/quality-assurance-php.yml
@@ -0,0 +1,51 @@
+name: PHP Quality Assurance
+
+on:
+    push:
+        paths:
+            - '**workflows/quality-assurance-php.yml'
+            - '**.php'
+            - '**phpcs.xml.dist'
+            - '**phpunit.xml.dist'
+            - '**psalm.xml'
+    workflow_dispatch:
+        inputs:
+            jobs:
+                required: true
+                type: choice
+                default: 'Run all'
+                description: 'Choose jobs to run'
+                options:
+                    - 'Run all'
+                    - 'Run PHPCS only'
+                    - 'Run Psalm only'
+                    - 'Run lint only'
+                    - 'Run static analysis'
+                    - 'Run unit tests only'
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.ref }}
+    cancel-in-progress: true
+
+jobs:
+    lint-php:
+        uses: inpsyde/reusable-workflows/.github/workflows/lint-php.yml@main
+        if: ${{ (github.event_name != 'workflow_dispatch') || ((github.event.inputs.jobs == 'Run all') || (github.event.inputs.jobs == 'Run lint only') || (github.event.inputs.jobs == 'Run static analysis')) }}
+        with:
+            PHP_MATRIX: '["7.4", "8.0", "8.1", "8.2"]'
+            LINT_ARGS: '-e php --colors --show-deprecated ./Inpsyde'
+
+    coding-standards-analysis-php:
+        if: ${{ (github.event_name != 'workflow_dispatch') || ((github.event.inputs.jobs == 'Run all') || (github.event.inputs.jobs == 'Run PHPCS only') || (github.event.inputs.jobs == 'Run static analysis')) }}
+        uses: inpsyde/reusable-workflows/.github/workflows/coding-standards-php.yml@main
+
+    static-code-analysis-php:
+        if: ${{ (github.event_name != 'workflow_dispatch') || ((github.event.inputs.jobs == 'Run all') || (github.event.inputs.jobs == 'Run Psalm only') || (github.event.inputs.jobs == 'Run static analysis')) }}
+        uses: inpsyde/reusable-workflows/.github/workflows/static-analysis-php.yml@main
+
+    tests-unit-php:
+        if: ${{ (github.event_name != 'workflow_dispatch') || ((github.event.inputs.jobs == 'Run all') || (github.event.inputs.jobs == 'Run unit tests only')) }}
+        uses: inpsyde/reusable-workflows/.github/workflows/tests-unit-php.yml@main
+        with:
+            PHP_MATRIX: '["7.4", "8.0", "8.1", "8.2"]'
+            PHPUNIT_ARGS: '--no-coverage'
diff --git a/.gitignore b/.gitignore
@@ -2,11 +2,4 @@ composer.phar
 composer.lock
 /vendor/
 /phpunit.xml
-
-# Commit your application's lock file http://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file
-# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
-# composer.lock
-.buildpath
-.project
-.settings/
 .phpunit.result.cache
diff --git a/Inpsyde/PhpcsHelpers.php b/Inpsyde/PhpcsHelpers.php
@@ -119,13 +119,14 @@ public static function findOopContext(File $file, int $position): int
         $targetLevel = (int)$tokens[$position]['level'] - 1;
 
         foreach ($tokens[$position]['conditions'] as $condPosition => $condCode) {
+            assert(is_int($condPosition));
             $condLevel = (int)($tokens[$condPosition]['level'] ?? -1);
 
             if (
                 in_array($condCode, Tokens::$ooScopeTokens, true)
                 && ($condLevel === $targetLevel)
             ) {
-                return (int)$condPosition;
+                return $condPosition;
             }
         }
 
@@ -288,7 +289,7 @@ public static function isHookClosure(
         /** @var array<int, array<string, mixed>> $tokens */
         $tokens = $file->getTokens();
 
-        if (($tokens[$position]['code'] ?? '') !== T_CLOSURE) {
+        if (!in_array(($tokens[$position]['code'] ?? ''), [T_CLOSURE, T_FN], true)) {
             return false;
         }
 
@@ -341,7 +342,7 @@ public static function functionDocBlockTags(
 
         if (
             !array_key_exists($position, $tokens)
-            || !in_array($tokens[$position]['code'], [T_FUNCTION, T_CLOSURE], true)
+            || !in_array($tokens[$position]['code'], [T_FUNCTION, T_CLOSURE, T_FN], true)
         ) {
             return [];
         }
@@ -387,7 +388,7 @@ public static function functionDocBlockTags(
         $normalizedTags = [];
         static $rand;
         $rand or $rand = bin2hex(random_bytes(3));
-        foreach ($tags as list($tagName, $tagContent)) {
+        foreach ($tags as [$tagName, $tagContent]) {
             empty($normalizedTags[$tagName]) and $normalizedTags[$tagName] = [];
             if (!$normalizeContent) {
                 $normalizedTags[$tagName][] = $tagContent;
@@ -433,7 +434,7 @@ public static function functionDocBlockParamTypes(File $file, int $functionPosit
 
         $types = [];
         foreach ($params as $param) {
-            preg_match('~^([^$]+)\s*(\$(?:[^\s]+))~', trim($param), $matches);
+            preg_match('~^([^$]+)\s*(\$\S+)~', trim($param), $matches);
             if (empty($matches[1]) || empty($matches[2])) {
                 continue;
             }
@@ -461,7 +462,7 @@ public static function isHookFunction(File $file, int $position): bool
      */
     public static function functionBody(File $file, int $position): string
     {
-        list($start, $end) = static::functionBoundaries($file, $position);
+        [$start, $end] = static::functionBoundaries($file, $position);
         if ($start < 0 || $end < 0) {
             return '';
         }
@@ -470,7 +471,7 @@ public static function functionBody(File $file, int $position): string
         $tokens = $file->getTokens();
         $body = '';
         for ($i = $start + 1; $i < $end; $i++) {
-            $body .= (string)$tokens[$i]['content'];
+            $body .= (string)($tokens[$i]['content'] ?? '');
         }
 
         return $body;
@@ -479,30 +480,24 @@ public static function functionBody(File $file, int $position): string
     /**
      * @param File $file
      * @param int $position
-     * @return array{int, int}
+     * @return list{int, int}
      */
     public static function functionBoundaries(File $file, int $position): array
     {
         /** @var array<int, array<string, mixed>> $tokens */
         $tokens = $file->getTokens();
 
-        if (!in_array(($tokens[$position]['code'] ?? null), [T_FUNCTION, T_CLOSURE], true)) {
+        if (!in_array(($tokens[$position]['code'] ?? null), [T_FUNCTION, T_CLOSURE, T_FN], true)) {
             return [-1, -1];
         }
 
-        $functionStart = (int)($tokens[$position]['scope_opener'] ?? 0);
-        $functionEnd = (int)($tokens[$position]['scope_closer'] ?? 0);
-        if ($functionStart <= 0 || $functionEnd <= 0 || $functionStart >= ($functionEnd - 1)) {
-            return [-1, -1];
-        }
-
-        return [$functionStart, $functionEnd];
+        return static::boundaries($tokens, $position);
     }
 
     /**
      * @param File $file
      * @param int $position
-     * @return array{int, int}
+     * @return list{int, int}
      */
     public static function classBoundaries(File $file, int $position): array
     {
@@ -513,13 +508,7 @@ public static function classBoundaries(File $file, int $position): array
             return [-1, -1];
         }
 
-        $start = (int)($tokens[$position]['scope_opener'] ?? 0);
-        $end = (int)($tokens[$position]['scope_closer'] ?? 0);
-        if ($start <= 0 || $end <= 0 || $start >= ($end - 1)) {
-            return [-1, -1];
-        }
-
-        return [$start, $end];
+        return static::boundaries($tokens, $position);
     }
 
     /**
@@ -531,18 +520,22 @@ public static function returnsCountInfo(File $file, int $position): array
     {
         $returnCount = ['nonEmpty' => 0, 'void' => 0, 'null' => 0, 'total' => 0];
 
-        list($start, $end) = self::functionBoundaries($file, $position);
+        [$start, $end] = self::functionBoundaries($file, $position);
         if ($start < 0 || $end <= 0) {
             return $returnCount;
         }
 
         /** @var array<int, array<string, mixed>> $tokens */
         $tokens = $file->getTokens();
 
+        if (T_FN === ($tokens[$position]['code'] ?? null)) {
+            return ['nonEmpty' => 1, 'void' => 0, 'null' => 0, 'total' => 1];
+        }
+
         $pos = $start + 1;
         while ($pos < $end) {
-            list(, $innerFunctionEnd) = self::functionBoundaries($file, $pos);
-            list(, $innerClassEnd) = self::classBoundaries($file, $pos);
+            [, $innerFunctionEnd] = self::functionBoundaries($file, $pos);
+            [, $innerClassEnd] = self::classBoundaries($file, $pos);
             if ($innerFunctionEnd > 0 || $innerClassEnd > 0) {
                 $pos = ($innerFunctionEnd > 0) ? $innerFunctionEnd + 1 : $innerClassEnd + 1;
                 continue;
@@ -723,4 +716,20 @@ public static function isUntypedPsrMethod(File $file, int $position): bool
 
         return false;
     }
+
+    /**
+     * @param array<int, array<string, mixed>> $tokens
+     * @param int $position
+     * @return list{int, int}
+     */
+    private static function boundaries(array $tokens, int $position): array
+    {
+        $start = (int)($tokens[$position]['scope_opener'] ?? 0);
+        $end = (int)($tokens[$position]['scope_closer'] ?? 0);
+        if ($start <= 0 || $end <= 0 || $start >= ($end - 1)) {
+            return [-1, -1];
+        }
+
+        return [$start, $end];
+    }
 }