Make SimpleNormalizer better extendable + update CI

.github/workflows/ci.yml

@@ -2,9 +2,6 @@ name: CI
 
 on: [ push ]
 
-env:
-    SYMFONY_PHPUNIT_DIR: "$HOME/symfony-bridge/.phpunit"
-
 jobs:
     build-test:
         runs-on: ubuntu-latest

CHANGELOG.md

@@ -1,3 +1,10 @@
+1.3.0
+=====
+
+* (feature) Make `SimpleNormalizer` extendable (for testing).
+* (improvement) Make `SimpleNormalizer` readonly.
+
+
 1.2.2
 =====
 

composer.json

@@ -17,9 +17,9 @@
 		"symfony/http-kernel": "^6.4 || ^7.0"
 	},
 	"require-dev": {
+		"21torr/janus": "^1.3",
 		"bamarni/composer-bin-plugin": "^1.8",
 		"doctrine/common": "^3.4",
-		"phpunit/phpunit": "^9.6",
 		"roave/security-advisories": "dev-latest",
 		"symfony/phpunit-bridge": "^7.0"
 	},
@@ -47,16 +47,16 @@
 	},
 	"scripts": {
 		"fix-lint": [
-			"vendor-bin/cs-fixer/vendor/bin/php-cs-fixer fix --diff --config vendor-bin/cs-fixer/vendor/21torr/php-cs-fixer/.php-cs-fixer.dist.php --no-interaction --ansi",
-			"@composer bin c-norm normalize \"$(pwd)/composer.json\"  --indent-style tab --indent-size 1 --ansi"
+			"@composer bin c-norm normalize \"$(pwd)/composer.json\" --indent-style tab --indent-size 1 --ansi",
+			"vendor-bin/cs-fixer/vendor/bin/php-cs-fixer fix --diff --config vendor-bin/cs-fixer/vendor/21torr/php-cs-fixer/.php-cs-fixer.dist.php --no-interaction --ansi"
 		],
 		"lint": [
-			"@composer bin c-norm normalize \"$(pwd)/composer.json\"  --indent-style tab --indent-size 1 --dry-run --ansi",
-			"vendor-bin/cs-fixer/vendor/bin/php-cs-fixer fix --diff --config vendor-bin/cs-fixer/vendor/21torr/php-cs-fixer/.php-cs-fixer.dist.php --dry-run --no-interaction --ansi"
+			"@composer bin c-norm normalize \"$(pwd)/composer.json\" --indent-style tab --indent-size 1 --dry-run --ansi",
+			"vendor-bin/cs-fixer/vendor/bin/php-cs-fixer check --diff --config vendor-bin/cs-fixer/vendor/21torr/php-cs-fixer/.php-cs-fixer.dist.php --no-interaction --ansi"
 		],
 		"test": [
-			"phpunit",
-			"vendor-bin/test/vendor/bin/phpstan analyze -c phpstan.neon . --ansi"
+			"simple-phpunit",
+			"vendor-bin/phpstan/vendor/bin/phpstan analyze -c phpstan.neon . --ansi -v"
 		]
 	}
 }

phpstan.neon

@@ -1,5 +1,8 @@
-parameters:
-    level: 9
-
 includes:
-    - vendor-bin/test/vendor/21torr/php-cs/phpstan/lib.neon
+	- vendor/21torr/janus/phpstan/lib.neon
+
+# If you use simple-phpunit, you need to uncomment the following line.
+# Always make sure to first run simple-phpunit and then PHPStan.
+parameters:
+	bootstrapFiles:
+		- vendor/bin/.phpunit/phpunit/vendor/autoload.php

phpunit.xml

@@ -1,14 +1,15 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd"
-         colors="true"
-         bootstrap="vendor/autoload.php"
+     xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.6/phpunit.xsd"
+     colors="true"
+     bootstrap="vendor/autoload.php"
 >
     <php>
         <ini name="error_reporting" value="-1" />
         <server name="APP_ENV" value="test" force="true" />
         <server name="SHELL_VERBOSITY" value="-1" />
         <env name="SYMFONY_DEPRECATIONS_HELPER" value="max[direct]=0"/>
+        <env name="SYMFONY_PHPUNIT_VERSION" value="9.6" />
     </php>
 
     <testsuites>

src/Normalizer/SimpleNormalizer.php

@@ -8,12 +8,16 @@
 use Torr\SimpleNormalizer\Exception\ObjectTypeNotSupportedException;
 use Torr\SimpleNormalizer\Exception\UnsupportedTypeException;
 
-final class SimpleNormalizer
+/**
+ * @final
+ */
+readonly class SimpleNormalizer
 {
 	/**
+	 * @param ServiceLocator<SimpleObjectNormalizerInterface> $objectNormalizers
 	 */
 	public function __construct (
-		private readonly ServiceLocator $objectNormalizers,
+		private ServiceLocator $objectNormalizers,
 	) {}
 
 	/**

tests/Normalizer/ArrayNormalizerTest.php

@@ -5,14 +5,17 @@
 use PHPUnit\Framework\TestCase;
 use Torr\SimpleNormalizer\Test\SimpleNormalizerTestTrait;
 
+/**
+ * @internal
+ */
 final class ArrayNormalizerTest extends TestCase
 {
 	use SimpleNormalizerTestTrait;
 
 	/**
 	 *
 	 */
-	public function provideListArray () : iterable
+	public static function provideListArray () : iterable
 	{
 		yield [[1, 2, 3, 4], [1, 2, 3, 4]];
 		yield [[1, null, 3, null], [1, 3]];
@@ -28,14 +31,14 @@ public function testListArray (array $input, array $expected) : void
 		$normalizer = $this->createNormalizer();
 		$actual = $normalizer->normalize($input);
 
-		self::assertEquals($expected, $actual);
-		self::assertTrue(\array_is_list($actual));
+		self::assertSame($expected, $actual);
+		self::assertTrue(array_is_list($actual));
 	}
 
 	/**
 	 *
 	 */
-	public function provideAssociativeArray () : iterable
+	public static function provideAssociativeArray () : iterable
 	{
 		yield [["a" => 1, "b" => 2, "c" => 3, "d" => 4], ["a" => 1, "b" => 2, "c" => 3, "d" => 4]];
 		yield [["a" => 1, "b" => null, "c" => 3, "d" => null], ["a" => 1, "b" => null, "c" => 3, "d" => null]];
@@ -50,7 +53,7 @@ public function testAssociativeArray (array $input, array $expected) : void
 		$normalizer = $this->createNormalizer();
 		$actual = $normalizer->normalize($input);
 
-		self::assertEquals($expected, $actual);
-		self::assertFalse(\array_is_list($actual));
+		self::assertSame($expected, $actual);
+		self::assertFalse(array_is_list($actual));
 	}
 }

tests/Normalizer/BasicTypesNormalizerTest.php

@@ -3,17 +3,20 @@
 namespace Tests\Torr\SimpleNormalizer\Normalizer;
 
 use PHPUnit\Framework\TestCase;
-use Torr\SimpleNormalizer\Test\SimpleNormalizerTestTrait;
 use Torr\SimpleNormalizer\Exception\UnsupportedTypeException;
+use Torr\SimpleNormalizer\Test\SimpleNormalizerTestTrait;
 
+/**
+ * @internal
+ */
 final class BasicTypesNormalizerTest extends TestCase
 {
 	use SimpleNormalizerTestTrait;
 
 	/**
 	 *
 	 */
-	public function provideBasicValue () : iterable
+	public static function provideBasicValue () : iterable
 	{
 		yield [null, null];
 		yield [5, 5];
@@ -34,7 +37,7 @@ public function testBasicValue (mixed $input, mixed $expected) : void
 	/**
 	 *
 	 */
-	public function provideInvalidValue () : iterable
+	public static function provideInvalidValue () : iterable
 	{
 		yield [fopen("php://memory", "rb")];
 	}

tests/Normalizer/MapNormalizerTest.php

@@ -6,20 +6,22 @@
 use Symfony\Component\DependencyInjection\ServiceLocator;
 use Torr\SimpleNormalizer\Normalizer\SimpleNormalizer;
 
+/**
+ * @internal
+ */
 final class MapNormalizerTest extends TestCase
 {
 	/**
 	 *
 	 */
 	public function testNonEmptyMap () : void
 	{
-
 		$normalizer = new SimpleNormalizer(new ServiceLocator([]));
 		$result = $normalizer->normalizeMap([
 			"o" => "hai",
 		], []);
 
-		self::assertSame('{"o":"hai"}', \json_encode($result));
+		self::assertSame('{"o":"hai"}', json_encode($result));
 	}
 
 	/**
@@ -30,6 +32,6 @@ public function testEmptyMap () : void
 		$normalizer = new SimpleNormalizer(new ServiceLocator([]));
 		$result = $normalizer->normalizeMap([], []);
 
-		self::assertSame('{}', \json_encode($result));
+		self::assertSame('{}', json_encode($result));
 	}
 }

tests/Normalizer/ObjectNormalizationTest.php

@@ -4,11 +4,14 @@
 
 use PHPUnit\Framework\TestCase;
 use Tests\Torr\SimpleNormalizer\Fixture\DummyVO;
-use Torr\SimpleNormalizer\Test\SimpleNormalizerTestTrait;
 use Torr\SimpleNormalizer\Exception\ObjectTypeNotSupportedException;
 use Torr\SimpleNormalizer\Normalizer\SimpleNormalizer;
 use Torr\SimpleNormalizer\Normalizer\SimpleObjectNormalizerInterface;
+use Torr\SimpleNormalizer\Test\SimpleNormalizerTestTrait;
 
+/**
+ * @internal
+ */
 final class ObjectNormalizationTest extends TestCase
 {
 	use SimpleNormalizerTestTrait;
@@ -18,11 +21,11 @@ final class ObjectNormalizationTest extends TestCase
 	 */
 	public function testNormalizeObject () : void
 	{
-		$dummyNormalizer = new class implements SimpleObjectNormalizerInterface
-		{
+		$dummyNormalizer = new class() implements SimpleObjectNormalizerInterface {
 			public function normalize (object $value, array $context, SimpleNormalizer $normalizer) : mixed
 			{
 				\assert($value instanceof DummyVO);
+
 				return [
 					"id" => $value->id,
 				];
@@ -37,7 +40,7 @@ public static function getNormalizedType () : string
 		$value = new DummyVO(42);
 		$normalizer = $this->createNormalizer($dummyNormalizer);
 
-		self::assertEquals(["id" => 42], $normalizer->normalize($value));
+		self::assertSame(["id" => 42], $normalizer->normalize($value));
 	}
 
 	/**

tests/Normalizer/ObjectNormalizer/ValueWithContextNormalizerTest.php

@@ -10,6 +10,9 @@
 use Torr\SimpleNormalizer\Normalizer\SimpleNormalizer;
 use Torr\SimpleNormalizer\Normalizer\SimpleObjectNormalizerInterface;
 
+/**
+ * @internal
+ */
 final class ValueWithContextNormalizerTest extends TestCase
 {
 	/**
@@ -37,8 +40,8 @@ public function testContextPassing () : void
 			);
 
 		$normalizer = new SimpleNormalizer(new ServiceLocator([
-			ValueWithContext::class => fn () => new ValueWithContextNormalizer(),
-			DummyVO::class => fn () => $dummyNormalizer,
+			ValueWithContext::class => static fn () => new ValueWithContextNormalizer(),
+			DummyVO::class => static fn () => $dummyNormalizer,
 		]));
 
 		$normalizer->normalize($value, [

vendor-bin/c-norm/composer.json

@@ -1,10 +1,11 @@
 {
-    "require": {
-        "ergebnis/composer-normalize": "^2.28"
-    },
-    "config": {
-        "allow-plugins": {
-            "ergebnis/composer-normalize": true
-        }
-    }
+	"require-dev": {
+		"ergebnis/composer-normalize": "^2.42",
+		"roave/security-advisories": "dev-latest"
+	},
+	"config": {
+		"allow-plugins": {
+			"ergebnis/composer-normalize": true
+		}
+	}
 }

vendor-bin/cs-fixer/composer.json

@@ -1,5 +1,6 @@
 {
-    "require": {
-        "21torr/php-cs-fixer": "^1.0"
-    }
+	"require-dev": {
+		"21torr/php-cs-fixer": "^1.1.1",
+		"roave/security-advisories": "dev-latest"
+	}
 }

vendor-bin/phpstan/composer.json

@@ -0,0 +1,21 @@
+{
+	"require": {
+		"php": "^8.3"
+	},
+	"require-dev": {
+		"phpstan/extension-installer": "^1.3.1",
+		"phpstan/phpstan": "^1.11",
+		"phpstan/phpstan-deprecation-rules": "^1.2",
+		"phpstan/phpstan-doctrine": "^1.4",
+		"phpstan/phpstan-phpunit": "^1.4",
+		"phpstan/phpstan-symfony": "^1.4",
+		"roave/security-advisories": "dev-latest",
+		"staabm/phpstan-todo-by": "^0.1.25"
+	},
+	"config": {
+		"sort-packages": true,
+		"allow-plugins": {
+			"phpstan/extension-installer": true
+		}
+	}
+}