Merge pull request #107 from mairo744/refactor/final

gsteel · web-flow · commit 5ccfea723a4e · 2025-09-17T22:46:43.000+01:00
refactor: declare classes and tests as `final`
diff --git a/src/ConfigProvider.php b/src/ConfigProvider.php
@@ -20,8 +20,7 @@
 use Mezzio\Hal\ResourceGenerator\UrlBasedCollectionStrategy;
 use Mezzio\Hal\ResourceGenerator\UrlBasedResourceStrategy;
 
-/** @final */
-class ConfigProvider
+final class ConfigProvider
 {
     public function __invoke(): array
     {
diff --git a/src/Exception/InvalidObjectException.php b/src/Exception/InvalidObjectException.php
@@ -10,8 +10,7 @@
 use function gettype;
 use function sprintf;
 
-/** @final */
-class InvalidObjectException extends InvalidArgumentException implements ExceptionInterface
+final class InvalidObjectException extends InvalidArgumentException implements ExceptionInterface
 {
     /**
      * @param mixed $value Non-object value.
diff --git a/src/Exception/InvalidResourceValueException.php b/src/Exception/InvalidResourceValueException.php
@@ -10,8 +10,7 @@
 use function get_debug_type;
 use function sprintf;
 
-/** @final */
-class InvalidResourceValueException extends RuntimeException implements ExceptionInterface
+final class InvalidResourceValueException extends RuntimeException implements ExceptionInterface
 {
     public static function fromValue(mixed $value): self
     {
diff --git a/src/Exception/InvalidStrategyException.php b/src/Exception/InvalidStrategyException.php
@@ -10,8 +10,7 @@
 use function get_debug_type;
 use function sprintf;
 
-/** @final */
-class InvalidStrategyException extends InvalidArgumentException implements ExceptionInterface
+final class InvalidStrategyException extends InvalidArgumentException implements ExceptionInterface
 {
     public static function forType(string $strategy): self
     {
diff --git a/src/Exception/UnknownMetadataTypeException.php b/src/Exception/UnknownMetadataTypeException.php
@@ -9,8 +9,7 @@
 
 use function sprintf;
 
-/** @final */
-class UnknownMetadataTypeException extends RuntimeException implements ExceptionInterface
+final class UnknownMetadataTypeException extends RuntimeException implements ExceptionInterface
 {
     public static function forMetadata(AbstractMetadata $metadata): self
     {
diff --git a/src/HalResponseFactory.php b/src/HalResponseFactory.php
@@ -15,8 +15,7 @@
 use function is_callable;
 use function str_contains;
 
-/** @final */
-class HalResponseFactory
+final class HalResponseFactory
 {
     /**
      * @var string Default mediatype to use as the base Content-Type, minus the format.
diff --git a/src/HalResponseFactoryFactory.php b/src/HalResponseFactoryFactory.php
@@ -18,7 +18,7 @@
  *
  * @final
  */
-class HalResponseFactoryFactory
+final class HalResponseFactoryFactory
 {
     use Psr17ResponseFactoryTrait;
 
diff --git a/src/LinkGenerator/MezzioUrlGenerator.php b/src/LinkGenerator/MezzioUrlGenerator.php
@@ -8,8 +8,7 @@
 use Mezzio\Helper\UrlHelper;
 use Psr\Http\Message\ServerRequestInterface;
 
-/** @final */
-class MezzioUrlGenerator implements UrlGeneratorInterface
+final class MezzioUrlGenerator implements UrlGeneratorInterface
 {
     public function __construct(
         private readonly UrlHelper $urlHelper,
diff --git a/src/LinkGenerator/MezzioUrlGeneratorFactory.php b/src/LinkGenerator/MezzioUrlGeneratorFactory.php
@@ -11,8 +11,7 @@
 
 use function sprintf;
 
-/** @final */
-class MezzioUrlGeneratorFactory
+final class MezzioUrlGeneratorFactory
 {
     /**
      * Allow serialization
diff --git a/src/LinkGeneratorFactory.php b/src/LinkGeneratorFactory.php
@@ -6,8 +6,7 @@
 
 use Psr\Container\ContainerInterface;
 
-/** @final */
-class LinkGeneratorFactory
+final class LinkGeneratorFactory
 {
     /**
      * Allow serialization
diff --git a/src/Metadata/Exception/DuplicateMetadataException.php b/src/Metadata/Exception/DuplicateMetadataException.php
@@ -8,8 +8,7 @@
 
 use function sprintf;
 
-/** @final */
-class DuplicateMetadataException extends DomainException implements ExceptionInterface
+final class DuplicateMetadataException extends DomainException implements ExceptionInterface
 {
     public static function create(string $class): self
     {
diff --git a/src/Metadata/Exception/InvalidConfigException.php b/src/Metadata/Exception/InvalidConfigException.php
@@ -15,8 +15,7 @@
 use function is_string;
 use function sprintf;
 
-/** @final */
-class InvalidConfigException extends RuntimeException implements ExceptionInterface
+final class InvalidConfigException extends RuntimeException implements ExceptionInterface
 {
     public static function dueToNonArray(mixed $config): self
     {
diff --git a/src/Metadata/Exception/UndefinedClassException.php b/src/Metadata/Exception/UndefinedClassException.php
@@ -8,8 +8,7 @@
 
 use function sprintf;
 
-/** @final */
-class UndefinedClassException extends UnexpectedValueException implements ExceptionInterface
+final class UndefinedClassException extends UnexpectedValueException implements ExceptionInterface
 {
     public static function create(string $class): self
     {
diff --git a/src/Metadata/Exception/UndefinedMetadataException.php b/src/Metadata/Exception/UndefinedMetadataException.php
@@ -8,8 +8,7 @@
 
 use function sprintf;
 
-/** @final */
-class UndefinedMetadataException extends RuntimeException implements ExceptionInterface
+final class UndefinedMetadataException extends RuntimeException implements ExceptionInterface
 {
     public static function create(string $class): self
     {
diff --git a/src/Metadata/RouteBasedCollectionMetadataFactory.php b/src/Metadata/RouteBasedCollectionMetadataFactory.php
@@ -7,8 +7,7 @@
 use function array_intersect;
 use function array_keys;
 
-/** @final */
-class RouteBasedCollectionMetadataFactory implements MetadataFactoryInterface
+final class RouteBasedCollectionMetadataFactory implements MetadataFactoryInterface
 {
     /**
      * Creates a RouteBasedCollectionMetadata based on the MetadataMap configuration.
diff --git a/src/Metadata/RouteBasedResourceMetadataFactory.php b/src/Metadata/RouteBasedResourceMetadataFactory.php
@@ -7,8 +7,7 @@
 use function array_intersect;
 use function array_keys;
 
-/** @final */
-class RouteBasedResourceMetadataFactory implements MetadataFactoryInterface
+final class RouteBasedResourceMetadataFactory implements MetadataFactoryInterface
 {
     /**
      * Creates a RouteBasedResourceMetadata based on the MetadataMap configuration.
diff --git a/src/Metadata/UrlBasedCollectionMetadataFactory.php b/src/Metadata/UrlBasedCollectionMetadataFactory.php
@@ -7,8 +7,7 @@
 use function array_intersect;
 use function array_keys;
 
-/** @final */
-class UrlBasedCollectionMetadataFactory implements MetadataFactoryInterface
+final class UrlBasedCollectionMetadataFactory implements MetadataFactoryInterface
 {
     /**
      * Creates a UrlBasedCollectionMetadata based on the MetadataMap configuration.
diff --git a/src/Metadata/UrlBasedResourceMetadataFactory.php b/src/Metadata/UrlBasedResourceMetadataFactory.php
@@ -7,8 +7,7 @@
 use function array_intersect;
 use function array_keys;
 
-/** @final */
-class UrlBasedResourceMetadataFactory implements MetadataFactoryInterface
+final class UrlBasedResourceMetadataFactory implements MetadataFactoryInterface
 {
     /**
      * Creates a UrlBasedResourceMetadata based on the MetadataMap configuration.
diff --git a/src/ResourceGenerator/Exception/InvalidCollectionException.php b/src/ResourceGenerator/Exception/InvalidCollectionException.php
@@ -9,8 +9,7 @@
 use function get_debug_type;
 use function sprintf;
 
-/** @final */
-class InvalidCollectionException extends RuntimeException implements ExceptionInterface
+final class InvalidCollectionException extends RuntimeException implements ExceptionInterface
 {
     /**
      * @param mixed $instance The invalid collection instance or value.
diff --git a/src/ResourceGenerator/Exception/InvalidConfigException.php b/src/ResourceGenerator/Exception/InvalidConfigException.php
@@ -10,8 +10,7 @@
 use function get_debug_type;
 use function sprintf;
 
-/** @final */
-class InvalidConfigException extends RuntimeException implements ExceptionInterface
+final class InvalidConfigException extends RuntimeException implements ExceptionInterface
 {
     public static function dueToNonArray(mixed $config): self
     {
diff --git a/src/ResourceGenerator/Exception/InvalidExtractorException.php b/src/ResourceGenerator/Exception/InvalidExtractorException.php
@@ -10,8 +10,7 @@
 use function get_debug_type;
 use function sprintf;
 
-/** @final */
-class InvalidExtractorException extends RuntimeException implements ExceptionInterface
+final class InvalidExtractorException extends RuntimeException implements ExceptionInterface
 {
     public static function fromInstance(mixed $extractor): self
     {
diff --git a/src/ResourceGenerator/Exception/OutOfBoundsException.php b/src/ResourceGenerator/Exception/OutOfBoundsException.php
@@ -6,7 +6,6 @@
 
 use OutOfBoundsException as BaseOutOfBoundsException;
 
-/** @final */
-class OutOfBoundsException extends BaseOutOfBoundsException implements ExceptionInterface
+final class OutOfBoundsException extends BaseOutOfBoundsException implements ExceptionInterface
 {
 }
diff --git a/src/ResourceGenerator/Exception/UnexpectedMetadataTypeException.php b/src/ResourceGenerator/Exception/UnexpectedMetadataTypeException.php
@@ -10,8 +10,7 @@
 
 use function sprintf;
 
-/** @final */
-class UnexpectedMetadataTypeException extends RuntimeException implements ExceptionInterface
+final class UnexpectedMetadataTypeException extends RuntimeException implements ExceptionInterface
 {
     public static function forMetadata(AbstractMetadata $metadata, string $strategy, string $expected): self
     {
diff --git a/src/ResourceGenerator/RouteBasedResourceStrategy.php b/src/ResourceGenerator/RouteBasedResourceStrategy.php
@@ -13,8 +13,7 @@
 use function array_key_exists;
 use function is_scalar;
 
-/** @final */
-class RouteBasedResourceStrategy implements StrategyInterface
+final class RouteBasedResourceStrategy implements StrategyInterface
 {
     use ExtractInstanceTrait;
 
diff --git a/src/ResourceGenerator/UrlBasedCollectionStrategy.php b/src/ResourceGenerator/UrlBasedCollectionStrategy.php
@@ -23,8 +23,7 @@
 use const PHP_URL_FRAGMENT;
 use const PHP_URL_QUERY;
 
-/** @final */
-class UrlBasedCollectionStrategy implements StrategyInterface
+final class UrlBasedCollectionStrategy implements StrategyInterface
 {
     use ExtractCollectionTrait, GenerateSelfLinkTrait {
         GenerateSelfLinkTrait::generateSelfLink insteadof ExtractCollectionTrait;
@@ -46,7 +45,7 @@ public function createResource(
         }
 
         if (! $instance instanceof Traversable) {
-            throw Exception\InvalidCollectionException::fromInstance($instance, static::class);
+            throw Exception\InvalidCollectionException::fromInstance($instance, self::class);
         }
 
         return $this->extractCollection($instance, $metadata, $resourceGenerator, $request, $depth);
diff --git a/src/ResourceGenerator/UrlBasedResourceStrategy.php b/src/ResourceGenerator/UrlBasedResourceStrategy.php
@@ -10,8 +10,7 @@
 use Mezzio\Hal\ResourceGeneratorInterface;
 use Psr\Http\Message\ServerRequestInterface;
 
-/** @final */
-class UrlBasedResourceStrategy implements StrategyInterface
+final class UrlBasedResourceStrategy implements StrategyInterface
 {
     use ExtractInstanceTrait;
 
diff --git a/src/ResourceGeneratorFactory.php b/src/ResourceGeneratorFactory.php
@@ -13,8 +13,7 @@
 use function is_array;
 use function is_string;
 
-/** @final */
-class ResourceGeneratorFactory
+final class ResourceGeneratorFactory
 {
     /**
      * Allow serialization
diff --git a/test/TestAsset/TestMetadataMapFactory.php b/test/TestAsset/TestMetadataMapFactory.php
@@ -6,10 +6,9 @@
 
 use Mezzio\Hal\Metadata\MetadataMapFactory;
 
-/** @final */
-class TestMetadataMapFactory extends MetadataMapFactory
+final class TestMetadataMapFactory extends MetadataMapFactory
 {
-    protected function createTestMetadata(): TestMetadata
+    public function createTestMetadata(): TestMetadata
     {
         return new TestMetadata();
     }

Original file line number	Diff line number	Diff line change
`@@ -20,8 +20,7 @@`
`20`	`20`	`use Mezzio\Hal\ResourceGenerator\UrlBasedCollectionStrategy;`
`21`	`21`	`use Mezzio\Hal\ResourceGenerator\UrlBasedResourceStrategy;`
`22`	`22`
`23`		`-/** @final */`
`24`		`-class ConfigProvider`
	`23`	`+final class ConfigProvider`
`25`	`24`	`{`
`26`	`25`	`public function __invoke(): array`
`27`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -10,8 +10,7 @@`
`10`	`10`	`use function gettype;`
`11`	`11`	`use function sprintf;`
`12`	`12`
`13`		`-/** @final */`
`14`		`-class InvalidObjectException extends InvalidArgumentException implements ExceptionInterface`
	`13`	`+final class InvalidObjectException extends InvalidArgumentException implements ExceptionInterface`
`15`	`14`	`{`
`16`	`15`	`/**`
`17`	`16`	`* @param mixed $value Non-object value.`
Original file line number	Diff line number	Diff line change
`@@ -9,8 +9,7 @@`
`9`	`9`
`10`	`10`	`use function sprintf;`
`11`	`11`
`12`		`-/** @final */`
`13`		`-class UnknownMetadataTypeException extends RuntimeException implements ExceptionInterface`
	`12`	`+final class UnknownMetadataTypeException extends RuntimeException implements ExceptionInterface`
`14`	`13`	`{`
`15`	`14`	`public static function forMetadata(AbstractMetadata $metadata): self`
`16`	`15`	`{`
Original file line number	Diff line number	Diff line change
`@@ -15,8 +15,7 @@`
`15`	`15`	`use function is_callable;`
`16`	`16`	`use function str_contains;`
`17`	`17`
`18`		`-/** @final */`
`19`		`-class HalResponseFactory`
	`18`	`+final class HalResponseFactory`
`20`	`19`	`{`
`21`	`20`	`/**`
`22`	`21`	`* @var string Default mediatype to use as the base Content-Type, minus the format.`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`	`*`
`19`	`19`	`* @final`
`20`	`20`	`*/`
`21`		`-class HalResponseFactoryFactory`
	`21`	`+final class HalResponseFactoryFactory`
`22`	`22`	`{`
`23`	`23`	`use Psr17ResponseFactoryTrait;`
`24`	`24`
Original file line number	Diff line number	Diff line change
`@@ -8,8 +8,7 @@`
`8`	`8`	`use Mezzio\Helper\UrlHelper;`
`9`	`9`	`use Psr\Http\Message\ServerRequestInterface;`
`10`	`10`
`11`		`-/** @final */`
`12`		`-class MezzioUrlGenerator implements UrlGeneratorInterface`
	`11`	`+final class MezzioUrlGenerator implements UrlGeneratorInterface`
`13`	`12`	`{`
`14`	`13`	`public function __construct(`
`15`	`14`	`private readonly UrlHelper $urlHelper,`
Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,7 @@`
`11`	`11`
`12`	`12`	`use function sprintf;`
`13`	`13`
`14`		`-/** @final */`
`15`		`-class MezzioUrlGeneratorFactory`
	`14`	`+final class MezzioUrlGeneratorFactory`
`16`	`15`	`{`
`17`	`16`	`/**`
`18`	`17`	`* Allow serialization`
Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,7 @@`
`6`	`6`
`7`	`7`	`use Psr\Container\ContainerInterface;`
`8`	`8`
`9`		`-/** @final */`
`10`		`-class LinkGeneratorFactory`
	`9`	`+final class LinkGeneratorFactory`
`11`	`10`	`{`
`12`	`11`	`/**`
`13`	`12`	`* Allow serialization`