Update PHPUnit and PHPCS, require 8.2+ (#39)

Firehed · web-flow · commit e56d8e396cb9 · 2026-05-09T16:08:48.000-07:00
- Updates to current PHPUnit versions
- Updates to current PHPCS
- PHPStan ignored, will deal with it in a separate PR
- Bumped min PHP to 8.2, oldest currently supported version
- Update test syntax for newer PHPUnit
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -15,14 +15,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v6
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
 
       - name: Cache Composer packages
         id: composer-cache
-        uses: actions/cache@v2
+        uses: actions/cache@v5
         with:
           path: vendor
           key: ${{ runner.os }}-php-${{ hashFiles('**/composer.json') }}
diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml
@@ -15,14 +15,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v6
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.2'
 
       - name: Cache Composer packages
         id: composer-cache
-        uses: actions/cache@v2
+        uses: actions/cache@v5
         with:
           path: vendor
           key: ${{ runner.os }}-php-${{ hashFiles('**/composer.json') }}
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -20,11 +20,11 @@ jobs:
           - 'high'
           - 'low'
         php:
-          - '8.0'
+          - '8.2'
 
     steps:
       - name: Check out code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v6
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
@@ -35,7 +35,7 @@ jobs:
 
       - name: Cache Composer packages
         id: composer-cache
-        uses: actions/cache@v2
+        uses: actions/cache@v5
         with:
           path: vendor
           key: ${{ runner.os }}-php-${{ matrix.dependencies }}-${{ matrix.php }}-${{ hashFiles('**/composer.json') }}
@@ -70,4 +70,4 @@ jobs:
 
       - name: Submit code coverage
         if: ${{ always() }}
-        uses: codecov/codecov-action@v1
+        uses: codecov/codecov-action@v5
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,4 @@
 /build/
 /vendor/
 composer.lock
-.phpunit.result.cache
+.phpunit.cache
diff --git a/composer.json b/composer.json
@@ -22,13 +22,13 @@
         "sort-packages": true
     },
     "require": {
-        "php": "^8.0"
+        "php": "^8.2"
     },
     "require-dev": {
         "phpstan/phpstan": "^0.12.32",
         "phpstan/phpstan-phpunit": "^0.12",
-        "phpunit/phpunit": "^8.3 || ^9",
-        "squizlabs/php_codesniffer": "^3.6"
+        "phpunit/phpunit": "^11.0 || ^12.0 || ^13.0",
+        "squizlabs/php_codesniffer": "^4.0"
     },
     "scripts": {
         "test": [
diff --git a/phpunit.xml b/phpunit.xml
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         cacheDirectory=".phpunit.cache"
+         executionOrder="depends,defects"
+         shortenArraysForExportThreshold="10"
+         requireCoverageMetadata="true"
+         beStrictAboutCoverageMetadata="false"
+         beStrictAboutOutputDuringTests="true"
+         displayDetailsOnAllIssues="true"
+         failOnAllIssues="true">
+    <testsuites>
+        <testsuite name="default">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+
+    <source ignoreIndirectDeprecations="true" restrictNotices="true" restrictWarnings="true">
+        <include>
+            <directory>src</directory>
+        </include>
+    </source>
+</phpunit>
diff --git a/src/Containers/ParsedInput.php b/src/Containers/ParsedInput.php
@@ -151,7 +151,7 @@ public function asArray(): array
     /**
      * Invoked via `isset` and `empty`
      */
-    public function offsetExists($offset)
+    public function offsetExists($offset): bool
     {
         throw new BadMethodCallException(
             "ParsedInput is already validated, and contains all expected " .
@@ -161,9 +161,8 @@ public function offsetExists($offset)
 
     /**
      * Invoked by array access of the object
-     * @return mixed
      */
-    public function offsetGet($offset)
+    public function offsetGet($offset): mixed
     {
         $data = $this->getData();
         if (
@@ -182,15 +181,15 @@ public function offsetGet($offset)
     /**
      * Invoked by setting an array value on the object
      */
-    public function offsetSet($offset, $value)
+    public function offsetSet($offset, $value): never
     {
         throw new BadMethodCallException("ParsedInput is read-only");
     }
 
     /**
      * Invoked via `unset`
      */
-    public function offsetUnset($offset)
+    public function offsetUnset($offset): never
     {
         throw new BadMethodCallException("ParsedInput is read-only");
     }
diff --git a/src/Containers/SafeInput.php b/src/Containers/SafeInput.php
@@ -13,7 +13,6 @@
  */
 class SafeInput extends ParsedInput
 {
-
     public function __construct(ParsedInput $valid)
     {
         if (!$valid->isValidated()) {
diff --git a/src/Exceptions/InputException.php b/src/Exceptions/InputException.php
@@ -9,7 +9,6 @@
 
 class InputException extends UnexpectedValueException
 {
-
     public const PARSE_ERROR = 1;
     public const FORMAT_ERROR = 2;
     public const MISSING_VALUES = 3;
diff --git a/src/Interfaces/ParserInterface.php b/src/Interfaces/ParserInterface.php
@@ -8,7 +8,6 @@
 
 interface ParserInterface
 {
-
     /**
      * @param string $raw_input Unparsed, unvalidated input
      * @return array<mixed> Parsed, unvalidated input
diff --git a/src/Interfaces/ValidationInterface.php b/src/Interfaces/ValidationInterface.php
@@ -8,7 +8,6 @@
 
 interface ValidationInterface
 {
-
     /**
      * @return array<string, InputObject>
      */
diff --git a/src/Parsers/JSON.php b/src/Parsers/JSON.php
@@ -7,7 +7,6 @@
 
 class JSON implements ParserInterface
 {
-
     public function parse(string $raw_input): array
     {
         if (!strlen($raw_input)) {
diff --git a/src/Parsers/URLEncoded.php b/src/Parsers/URLEncoded.php
@@ -7,7 +7,6 @@
 
 class URLEncoded implements ParserInterface
 {
-
     public function parse(string $raw_input): array
     {
         if (!strlen($raw_input)) {
diff --git a/src/SafeInputTestTrait.php b/src/SafeInputTestTrait.php
@@ -4,7 +4,6 @@
 
 trait SafeInputTestTrait
 {
-
     /**
      * Transform an array of data to a SafeInput object. Intended for testing
      * consumers of validated input where testing the actual validation process
diff --git a/tests/Containers/ParsedInputTest.php b/tests/Containers/ParsedInputTest.php
@@ -1,20 +1,22 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Firehed\Input\Containers;
 
 use BadMethodCallException;
 use DomainException;
 use Firehed\Input\Exceptions\InputException;
 use Firehed\Input\Interfaces\ValidationInterface;
 use Firehed\Input\Objects\InputObject;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
 use UnexpectedValueException;
 
-/**
- * @covers Firehed\Input\Containers\ParsedInput
- */
-class ParsedInputTest extends \PHPUnit\Framework\TestCase
+#[CoversClass(ParsedInput::class)]
+class ParsedInputTest extends TestCase
 {
-
     // ----(Constructor)--------------------------------------------------------
 
     public function testConstructWorks(): void
@@ -125,7 +127,7 @@ public function testMissingRequiredParametersAreCaught(): void
     {
         $this->addRequired(
             'short',
-            $this->getMockForAbstractClass('Firehed\Input\Objects\InputObject')
+            $this->createStub(InputObject::class)
         );
 
         $parsed = new ParsedInput([]);
@@ -178,7 +180,7 @@ public function testMissingOptionalParametersAreSetToNull(): void
     {
         $this->addOptional(
             'short',
-            $this->getMockForAbstractClass('Firehed\Input\Objects\InputObject')
+            $this->createStub(InputObject::class)
         );
 
         $parsed = new ParsedInput([]);
@@ -231,9 +233,7 @@ public function testOptionalParametersWithValidNullWorksWhenNotProvided(): void
 
     // ----(Validation:Nesting)-------------------------------------------------
 
-    /**
-     * @dataProvider nestedValidationExceptions
-     */
+    #[DataProvider('nestedValidationExceptions')]
     public function testValidateHandlesInputExceptions(
         InputException $ex,
         array $invalid,
@@ -244,7 +244,7 @@ public function testValidateHandlesInputExceptions(
         $io = $this->createMock(InputObject::class);
         $io->expects($this->atLeastOnce())
             ->method('evaluate')
-            ->will($this->throwException($ex));
+            ->willThrowException($ex);
         if ($required) {
             $this->addRequired('struct', $io);
             $msg = 'Required:';
@@ -263,7 +263,7 @@ public function testValidateHandlesInputExceptions(
         }
     }
 
-    public function nestedValidationExceptions()
+    public static function nestedValidationExceptions(): array
     {
         return [
             // Required inputs
@@ -361,11 +361,11 @@ private function getValidation(): ValidationInterface
         $validation = $this->createMock(ValidationInterface::class);
         $validation->expects($this->atLeastOnce())
             ->method('getRequiredInputs')
-            ->will($this->returnValue($this->required));
+            ->willReturn($this->required);
 
         $validation->expects($this->atLeastOnce())
             ->method('getOptionalInputs')
-            ->will($this->returnValue($this->optional));
+            ->willReturn($this->optional);
 
         return $validation;
     }
@@ -387,17 +387,17 @@ private function addOptional(string $key, InputObject $type): void
     private function getMockIO(bool $valid, $ret = null): InputObject
     {
         $mock = $this->getMockBuilder(InputObject::class)
-            ->setMethods(['evaluate', 'getDefaultValue'])
-            ->getMockForAbstractClass();
+            ->onlyMethods(['evaluate', 'getDefaultValue', 'validate'])
+            ->getMock();
 
         if ($valid) {
             $mock->expects($this->atLeastOnce())
                 ->method('evaluate')
-                ->will($this->returnValue($ret));
+                ->willReturn($ret);
         } else {
             $mock->expects($this->atLeastOnce())
                 ->method('evaluate')
-                ->will($this->throwException(new UnexpectedValueException()));
+                ->willThrowException(new UnexpectedValueException());
         }
         return $mock;
     }
diff --git a/tests/Containers/RawInputTest.php b/tests/Containers/RawInputTest.php
@@ -1,13 +1,15 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Firehed\Input\Containers;
 
-/**
- * @covers Firehed\Input\Containers\RawInput
- */
-class RawInputTest extends \PHPUnit\Framework\TestCase
-{
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\TestCase;
 
+#[CoversClass(RawInput::class)]
+class RawInputTest extends TestCase
+{
     public function testConstruct(): void
     {
         $this->assertInstanceOf(
@@ -24,7 +26,7 @@ public function testParse(): void
         $mock->expects($this->once())
             ->method('parse')
             ->with($raw_data)
-            ->will($this->returnValue((array)$raw_data));
+            ->willReturn((array)$raw_data);
         $raw = new RawInput($raw_data);
         $parsed = $raw->parse($mock);
         $this->assertInstanceOf(
diff --git a/tests/Containers/SafeInputTest.php b/tests/Containers/SafeInputTest.php
diff --git a/tests/Exceptions/InputExceptionTest.php b/tests/Exceptions/InputExceptionTest.php
diff --git a/tests/Objects/InputObjectTest.php b/tests/Objects/InputObjectTest.php
diff --git a/tests/Parsers/JSONTest.php b/tests/Parsers/JSONTest.php
diff --git a/tests/Parsers/URLEncodedTest.php b/tests/Parsers/URLEncodedTest.php

Original file line number	Diff line number	Diff line change
`@@ -151,7 +151,7 @@ public function asArray(): array`
`151`	`151`	`/**`
`152`	`152`	* Invoked via `isset` and `empty`
`153`	`153`	`*/`
`154`		`- public function offsetExists($offset)`
	`154`	`+ public function offsetExists($offset): bool`
`155`	`155`	`{`
`156`	`156`	`throw new BadMethodCallException(`
`157`	`157`	`"ParsedInput is already validated, and contains all expected " .`
`@@ -161,9 +161,8 @@ public function offsetExists($offset)`
`161`	`161`
`162`	`162`	`/**`
`163`	`163`	`* Invoked by array access of the object`
`164`		`- * @return mixed`
`165`	`164`	`*/`
`166`		`- public function offsetGet($offset)`
	`165`	`+ public function offsetGet($offset): mixed`
`167`	`166`	`{`
`168`	`167`	`$data = $this->getData();`
`169`	`168`	`if (`
`@@ -182,15 +181,15 @@ public function offsetGet($offset)`
`182`	`181`	`/**`
`183`	`182`	`* Invoked by setting an array value on the object`
`184`	`183`	`*/`
`185`		`- public function offsetSet($offset, $value)`
	`184`	`+ public function offsetSet($offset, $value): never`
`186`	`185`	`{`
`187`	`186`	`throw new BadMethodCallException("ParsedInput is read-only");`
`188`	`187`	`}`
`189`	`188`
`190`	`189`	`/**`
`191`	`190`	* Invoked via `unset`
`192`	`191`	`*/`
`193`		`- public function offsetUnset($offset)`
	`192`	`+ public function offsetUnset($offset): never`
`194`	`193`	`{`
`195`	`194`	`throw new BadMethodCallException("ParsedInput is read-only");`
`196`	`195`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,6 @@`
`13`	`13`	`*/`
`14`	`14`	`class SafeInput extends ParsedInput`
`15`	`15`	`{`
`16`		`-`
`17`	`16`	`public function __construct(ParsedInput $valid)`
`18`	`17`	`{`
`19`	`18`	`if (!$valid->isValidated()) {`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,6 @@`
`9`	`9`
`10`	`10`	`class InputException extends UnexpectedValueException`
`11`	`11`	`{`
`12`		`-`
`13`	`12`	`public const PARSE_ERROR = 1;`
`14`	`13`	`public const FORMAT_ERROR = 2;`
`15`	`14`	`public const MISSING_VALUES = 3;`