Merge pull request #161 from patchlevel/rename-metadata-hydrator-into-stack-hydrator

DavidBadura · web-flow · commit c2f24315d4f3 · 2026-02-27T11:34:04.000+01:00
rename metadata hydrator into stack hydrator
diff --git a/README.md b/README.md
@@ -27,9 +27,9 @@ composer require patchlevel/hydrator
 To use the hydrator you just have to create an instance of it.
 
 ```php
-use Patchlevel\Hydrator\MetadataHydrator;
+use Patchlevel\Hydrator\StackHydrator;
 
-$hydrator = MetadataHydrator::create();
+$hydrator = StackHydrator::create();
 ```
 
 After that you can hydrate any classes or objects. Also `final`, `readonly` classes with `property promotion`.
@@ -483,9 +483,9 @@ class NameGuesser implements Guesser
 To use this Guesser, you must specify it when creating the Hydrator:
 
 ```php
-use Patchlevel\Hydrator\MetadataHydrator;
+use Patchlevel\Hydrator\StackHydrator;
 
-$hydrator = MetadataHydrator::create([new NameGuesser()]);
+$hydrator = StackHydrator::create([new NameGuesser()]);
 ```
 
 > [!NOTE]
@@ -595,7 +595,7 @@ For this functionality we use the [symfony/event-dispatcher](https://symfony.com
 use Patchlevel\Hydrator\Cryptography\SensitiveDataPayloadCryptographer;
 use Patchlevel\Hydrator\Cryptography\Store\CipherKeyStore;
 use Patchlevel\Hydrator\Metadata\Event\EventMetadataFactory;
-use Patchlevel\Hydrator\MetadataHydrator;
+use Patchlevel\Hydrator\StackHydrator;
 use Symfony\Component\EventDispatcher\EventDispatcher;
 use Patchlevel\Hydrator\Event\PostExtract;
 use Patchlevel\Hydrator\Event\PreHydrate;
@@ -616,7 +616,7 @@ $eventDispatcher->addListener(
     }
 );
 
-$hydrator = new MetadataHydrator(eventDispatcher: $eventDispatcher);
+$hydrator = new StackHydrator(eventDispatcher: $eventDispatcher);
 ```
 
 ### Cryptography
@@ -742,11 +742,11 @@ Here we show you how to configure the cryptography.
 use Patchlevel\Hydrator\Cryptography\SensitiveDataPayloadCryptographer;
 use Patchlevel\Hydrator\Cryptography\Store\CipherKeyStore;
 use Patchlevel\Hydrator\Metadata\Event\EventMetadataFactory;
-use Patchlevel\Hydrator\MetadataHydrator;
+use Patchlevel\Hydrator\StackHydrator;
 
 $cipherKeyStore = new InMemoryCipherKeyStore();
 $cryptographer = SensitiveDataPayloadCryptographer::createWithDefaultSettings($cipherKeyStore);
-$hydrator = new MetadataHydrator(cryptographer: $cryptographer);
+$hydrator = new StackHydrator(cryptographer: $cryptographer);
 ```
 
 > [!WARNING]
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -72,12 +72,6 @@ parameters:
 			count: 1
 			path: src/Metadata/ClassMetadata.php
 
-		-
-			message: '#^Parameter \#2 \$data of method Patchlevel\\Hydrator\\Middleware\\Middleware\:\:hydrate\(\) expects array\<string, mixed\>, array\<mixed, mixed\> given\.$#'
-			identifier: argument.type
-			count: 3
-			path: src/MetadataHydrator.php
-
 		-
 			message: '#^Property Patchlevel\\Hydrator\\Normalizer\\EnumNormalizer\:\:\$enum \(class\-string\<BackedEnum\>\|null\) does not accept string\.$#'
 			identifier: assign.propertyType
@@ -90,6 +84,12 @@ parameters:
 			count: 1
 			path: src/Normalizer/ObjectNormalizer.php
 
+		-
+			message: '#^Parameter \#2 \$data of method Patchlevel\\Hydrator\\Middleware\\Middleware\:\:hydrate\(\) expects array\<string, mixed\>, array\<mixed, mixed\> given\.$#'
+			identifier: argument.type
+			count: 3
+			path: src/StackHydrator.php
+
 		-
 			message: '#^Property Patchlevel\\Hydrator\\Tests\\Unit\\Extension\\Cryptography\\Fixture\\ChildWithSensitiveDataWithIdentifierDto\:\:\$email is never read, only written\.$#'
 			identifier: property.onlyWritten
@@ -108,12 +108,6 @@ parameters:
 			count: 1
 			path: tests/Unit/Metadata/AttributeMetadataFactoryTest.php
 
-		-
-			message: '#^Parameter \#1 \$class of method Patchlevel\\Hydrator\\MetadataHydrator\:\:hydrate\(\) expects class\-string\<Unknown\>, string given\.$#'
-			identifier: argument.type
-			count: 1
-			path: tests/Unit/MetadataHydratorTest.php
-
 		-
 			message: '#^Cannot cast mixed to int\.$#'
 			identifier: cast.int
@@ -137,3 +131,9 @@ parameters:
 			identifier: cast.string
 			count: 2
 			path: tests/Unit/Normalizer/ArrayShapeNormalizerTest.php
+
+		-
+			message: '#^Parameter \#1 \$class of method Patchlevel\\Hydrator\\StackHydrator\:\:hydrate\(\) expects class\-string\<Unknown\>, string given\.$#'
+			identifier: argument.type
+			count: 1
+			path: tests/Unit/StackHydratorTest.php
diff --git a/src/CoreExtension.php b/src/CoreExtension.php
@@ -9,7 +9,7 @@
 
 final class CoreExtension implements Extension
 {
-    public function configure(HydratorBuilder $builder): void
+    public function configure(StackHydratorBuilder $builder): void
     {
         $builder->addMiddleware(new TransformMiddleware(), -64);
         $builder->addGuesser(new BuiltInGuesser(), -64);
diff --git a/src/Extension.php b/src/Extension.php
@@ -6,5 +6,5 @@
 
 interface Extension
 {
-    public function configure(HydratorBuilder $builder): void;
+    public function configure(StackHydratorBuilder $builder): void;
 }
diff --git a/src/Extension/Cryptography/CryptographyExtension.php b/src/Extension/Cryptography/CryptographyExtension.php
@@ -5,7 +5,7 @@
 namespace Patchlevel\Hydrator\Extension\Cryptography;
 
 use Patchlevel\Hydrator\Extension;
-use Patchlevel\Hydrator\HydratorBuilder;
+use Patchlevel\Hydrator\StackHydratorBuilder;
 
 final class CryptographyExtension implements Extension
 {
@@ -14,7 +14,7 @@ public function __construct(
     ) {
     }
 
-    public function configure(HydratorBuilder $builder): void
+    public function configure(StackHydratorBuilder $builder): void
     {
         $builder->addMetadataEnricher(new CryptographyMetadataEnricher(), 64);
         $builder->addMiddleware(new CryptographyMiddleware($this->cryptography), 64);
diff --git a/src/Extension/Lifecycle/LifecycleExtension.php b/src/Extension/Lifecycle/LifecycleExtension.php
@@ -5,11 +5,11 @@
 namespace Patchlevel\Hydrator\Extension\Lifecycle;
 
 use Patchlevel\Hydrator\Extension;
-use Patchlevel\Hydrator\HydratorBuilder;
+use Patchlevel\Hydrator\StackHydratorBuilder;
 
 final readonly class LifecycleExtension implements Extension
 {
-    public function configure(HydratorBuilder $builder): void
+    public function configure(StackHydratorBuilder $builder): void
     {
         $builder->addMiddleware(new LifecycleMiddleware());
         $builder->addMetadataEnricher(new LifecycleMetadataEnricher());
diff --git a/src/StackHydrator.php b/src/StackHydrator.php
@@ -19,7 +19,7 @@
 
 use const PHP_VERSION_ID;
 
-final class MetadataHydrator implements Hydrator
+final class StackHydrator implements Hydrator
 {
     /** @var array<class-string, ClassMetadata> */
     private array $classMetadata = [];
diff --git a/src/StackHydratorBuilder.php b/src/StackHydratorBuilder.php
@@ -18,7 +18,7 @@
 use function array_merge;
 use function krsort;
 
-final class HydratorBuilder
+final class StackHydratorBuilder
 {
     private bool $defaultLazy = false;
 
@@ -78,7 +78,7 @@ public function setCache(CacheItemPoolInterface|CacheInterface|null $cache): sta
         return $this;
     }
 
-    public function build(): Hydrator
+    public function build(): StackHydrator
     {
         krsort($this->guessers);
         krsort($this->metadataEnrichers);
@@ -99,7 +99,7 @@ public function build(): Hydrator
             $metadataFactory = new Psr16MetadataFactory($metadataFactory, $this->cache);
         }
 
-        return new MetadataHydrator(
+        return new StackHydrator(
             $metadataFactory,
             array_merge(...$this->middlewares),
             $this->defaultLazy,
diff --git a/tests/Benchmark/HydratorBench.php b/tests/Benchmark/HydratorBench.php
@@ -6,7 +6,7 @@
 
 use Patchlevel\Hydrator\CoreExtension;
 use Patchlevel\Hydrator\Hydrator;
-use Patchlevel\Hydrator\HydratorBuilder;
+use Patchlevel\Hydrator\StackHydratorBuilder;
 use Patchlevel\Hydrator\Tests\Benchmark\Fixture\ProfileCreated;
 use Patchlevel\Hydrator\Tests\Benchmark\Fixture\ProfileId;
 use Patchlevel\Hydrator\Tests\Benchmark\Fixture\Skill;
@@ -19,7 +19,7 @@ final class HydratorBench
 
     public function __construct()
     {
-        $this->hydrator = (new HydratorBuilder())
+        $this->hydrator = (new StackHydratorBuilder())
             ->useExtension(new CoreExtension())
             ->build();
     }
diff --git a/tests/Benchmark/HydratorWithCryptographyBench.php b/tests/Benchmark/HydratorWithCryptographyBench.php
@@ -9,7 +9,7 @@
 use Patchlevel\Hydrator\Extension\Cryptography\CryptographyExtension;
 use Patchlevel\Hydrator\Extension\Cryptography\Store\InMemoryCipherKeyStore;
 use Patchlevel\Hydrator\Hydrator;
-use Patchlevel\Hydrator\HydratorBuilder;
+use Patchlevel\Hydrator\StackHydratorBuilder;
 use Patchlevel\Hydrator\Tests\Benchmark\Fixture\ProfileCreated;
 use Patchlevel\Hydrator\Tests\Benchmark\Fixture\ProfileId;
 use Patchlevel\Hydrator\Tests\Benchmark\Fixture\Skill;
@@ -26,7 +26,7 @@ public function __construct()
     {
         $this->store = new InMemoryCipherKeyStore();
 
-        $this->hydrator = (new HydratorBuilder())
+        $this->hydrator = (new StackHydratorBuilder())
             ->useExtension(new CoreExtension())
             ->useExtension(new CryptographyExtension(BaseCryptographer::createWithOpenssl($this->store)))
             ->build();
diff --git a/tests/Benchmark/HydratorWithLazyBench.php b/tests/Benchmark/HydratorWithLazyBench.php
@@ -6,7 +6,7 @@
 
 use Patchlevel\Hydrator\CoreExtension;
 use Patchlevel\Hydrator\Hydrator;
-use Patchlevel\Hydrator\HydratorBuilder;
+use Patchlevel\Hydrator\StackHydratorBuilder;
 use Patchlevel\Hydrator\Tests\Benchmark\Fixture\ProfileCreated;
 use PhpBench\Attributes as Bench;
 
@@ -17,7 +17,7 @@ final class HydratorWithLazyBench
 
     public function __construct()
     {
-        $this->hydrator = (new HydratorBuilder())
+        $this->hydrator = (new StackHydratorBuilder())
             ->useExtension(new CoreExtension())
             ->enableDefaultLazy()
             ->build();
diff --git a/tests/Unit/Extension/Lifecycle/LifecycleExtensionTest.php b/tests/Unit/Extension/Lifecycle/LifecycleExtensionTest.php
@@ -6,7 +6,7 @@
 
 use Patchlevel\Hydrator\CoreExtension;
 use Patchlevel\Hydrator\Extension\Lifecycle\LifecycleExtension;
-use Patchlevel\Hydrator\HydratorBuilder;
+use Patchlevel\Hydrator\StackHydratorBuilder;
 use Patchlevel\Hydrator\Tests\Unit\Fixture\LifecycleFixture;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\TestCase;
@@ -16,7 +16,7 @@ final class LifecycleExtensionTest extends TestCase
 {
     public function testIntegration(): void
     {
-        $hydrator = (new HydratorBuilder())
+        $hydrator = (new StackHydratorBuilder())
             ->useExtension(new CoreExtension())
             ->useExtension(new LifecycleExtension())
             ->build();
diff --git a/tests/Unit/StackHydratorBuilderTest.php b/tests/Unit/StackHydratorBuilderTest.php
@@ -7,42 +7,35 @@
 use Patchlevel\Hydrator\Extension;
 use Patchlevel\Hydrator\Guesser\ChainGuesser;
 use Patchlevel\Hydrator\Guesser\Guesser;
-use Patchlevel\Hydrator\HydratorBuilder;
 use Patchlevel\Hydrator\Metadata\AttributeMetadataFactory;
 use Patchlevel\Hydrator\Metadata\EnrichingMetadataFactory;
 use Patchlevel\Hydrator\Metadata\MetadataEnricher;
 use Patchlevel\Hydrator\Metadata\Psr16MetadataFactory;
 use Patchlevel\Hydrator\Metadata\Psr6MetadataFactory;
-use Patchlevel\Hydrator\MetadataHydrator;
 use Patchlevel\Hydrator\Middleware\Middleware;
+use Patchlevel\Hydrator\StackHydrator;
+use Patchlevel\Hydrator\StackHydratorBuilder;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\TestCase;
 use Psr\Cache\CacheItemPoolInterface;
 use Psr\SimpleCache\CacheInterface;
 use ReflectionProperty;
 
-#[CoversClass(HydratorBuilder::class)]
-final class HydratorBuilderTest extends TestCase
+#[CoversClass(StackHydratorBuilder::class)]
+final class StackHydratorBuilderTest extends TestCase
 {
-    public function testBuild(): void
-    {
-        $hydrator = (new HydratorBuilder())->build();
-
-        self::assertInstanceOf(MetadataHydrator::class, $hydrator);
-    }
-
     public function testAddMiddlewareWithPriority(): void
     {
         $middleware1 = $this->createMock(Middleware::class);
         $middleware2 = $this->createMock(Middleware::class);
 
-        $builder = new HydratorBuilder();
+        $builder = new StackHydratorBuilder();
         $builder->addMiddleware($middleware1, 10);
         $builder->addMiddleware($middleware2, 20);
 
         $hydrator = $builder->build();
 
-        $reflection = new ReflectionProperty(MetadataHydrator::class, 'middlewares');
+        $reflection = new ReflectionProperty(StackHydrator::class, 'middlewares');
         $middlewares = $reflection->getValue($hydrator);
 
         self::assertSame([$middleware2, $middleware1], $middlewares);
@@ -53,13 +46,13 @@ public function testAddMetadataEnricherWithPriority(): void
         $enricher1 = $this->createMock(MetadataEnricher::class);
         $enricher2 = $this->createMock(MetadataEnricher::class);
 
-        $builder = new HydratorBuilder();
+        $builder = new StackHydratorBuilder();
         $builder->addMetadataEnricher($enricher1, 10);
         $builder->addMetadataEnricher($enricher2, 20);
 
         $hydrator = $builder->build();
 
-        $reflection = new ReflectionProperty(MetadataHydrator::class, 'metadataFactory');
+        $reflection = new ReflectionProperty(StackHydrator::class, 'metadataFactory');
         $enrichingMetadataFactory = $reflection->getValue($hydrator);
 
         self::assertInstanceOf(EnrichingMetadataFactory::class, $enrichingMetadataFactory);
@@ -75,13 +68,13 @@ public function testAddGuesserWithPriority(): void
         $guesser1 = $this->createMock(Guesser::class);
         $guesser2 = $this->createMock(Guesser::class);
 
-        $builder = new HydratorBuilder();
+        $builder = new StackHydratorBuilder();
         $builder->addGuesser($guesser1, 10);
         $builder->addGuesser($guesser2, 20);
 
         $hydrator = $builder->build();
 
-        $reflection = new ReflectionProperty(MetadataHydrator::class, 'metadataFactory');
+        $reflection = new ReflectionProperty(StackHydrator::class, 'metadataFactory');
         $enrichingMetadataFactory = $reflection->getValue($hydrator);
 
         self::assertInstanceOf(EnrichingMetadataFactory::class, $enrichingMetadataFactory);
@@ -104,19 +97,19 @@ public function testAddGuesserWithPriority(): void
 
     public function testEnableDefaultLazy(): void
     {
-        $builder = new HydratorBuilder();
+        $builder = new StackHydratorBuilder();
         $builder->enableDefaultLazy();
 
         $hydrator = $builder->build();
 
-        $reflection = new ReflectionProperty(MetadataHydrator::class, 'defaultLazy');
+        $reflection = new ReflectionProperty(StackHydrator::class, 'defaultLazy');
         self::assertTrue($reflection->getValue($hydrator));
     }
 
     public function testUseExtension(): void
     {
         $extension = $this->createMock(Extension::class);
-        $builder = new HydratorBuilder();
+        $builder = new StackHydratorBuilder();
 
         $extension->expects(self::once())
             ->method('configure')
@@ -129,12 +122,12 @@ public function testCachePsr6(): void
     {
         $cache = $this->createMock(CacheItemPoolInterface::class);
 
-        $builder = new HydratorBuilder();
+        $builder = new StackHydratorBuilder();
         $builder->setCache($cache);
 
         $hydrator = $builder->build();
 
-        $reflection = new ReflectionProperty(MetadataHydrator::class, 'metadataFactory');
+        $reflection = new ReflectionProperty(StackHydrator::class, 'metadataFactory');
         $factory = $reflection->getValue($hydrator);
 
         self::assertInstanceOf(Psr6MetadataFactory::class, $factory);
@@ -144,12 +137,12 @@ public function testCachePsr16(): void
     {
         $cache = $this->createMock(CacheInterface::class);
 
-        $builder = new HydratorBuilder();
+        $builder = new StackHydratorBuilder();
         $builder->setCache($cache);
 
         $hydrator = $builder->build();
 
-        $reflection = new ReflectionProperty(MetadataHydrator::class, 'metadataFactory');
+        $reflection = new ReflectionProperty(StackHydrator::class, 'metadataFactory');
         $factory = $reflection->getValue($hydrator);
 
         self::assertInstanceOf(Psr16MetadataFactory::class, $factory);
diff --git a/tests/Unit/StackHydratorTest.php b/tests/Unit/StackHydratorTest.php

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`
`10`	`10`	`final class CoreExtension implements Extension`
`11`	`11`	`{`
`12`		`- public function configure(HydratorBuilder $builder): void`
	`12`	`+ public function configure(StackHydratorBuilder $builder): void`
`13`	`13`	`{`
`14`	`14`	`$builder->addMiddleware(new TransformMiddleware(), -64);`
`15`	`15`	`$builder->addGuesser(new BuiltInGuesser(), -64);`
Original file line number	Diff line number	Diff line change
`@@ -6,5 +6,5 @@`
`6`	`6`
`7`	`7`	`interface Extension`
`8`	`8`	`{`
`9`		`- public function configure(HydratorBuilder $builder): void;`
	`9`	`+ public function configure(StackHydratorBuilder $builder): void;`
`10`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`namespace Patchlevel\Hydrator\Extension\Cryptography;`
`6`	`6`
`7`	`7`	`use Patchlevel\Hydrator\Extension;`
`8`		`-use Patchlevel\Hydrator\HydratorBuilder;`
	`8`	`+use Patchlevel\Hydrator\StackHydratorBuilder;`
`9`	`9`
`10`	`10`	`final class CryptographyExtension implements Extension`
`11`	`11`	`{`
`@@ -14,7 +14,7 @@ public function __construct(`
`14`	`14`	`) {`
`15`	`15`	`}`
`16`	`16`
`17`		`- public function configure(HydratorBuilder $builder): void`
	`17`	`+ public function configure(StackHydratorBuilder $builder): void`
`18`	`18`	`{`
`19`	`19`	`$builder->addMetadataEnricher(new CryptographyMetadataEnricher(), 64);`
`20`	`20`	`$builder->addMiddleware(new CryptographyMiddleware($this->cryptography), 64);`
Original file line number	Diff line number	Diff line change
`@@ -5,11 +5,11 @@`
`5`	`5`	`namespace Patchlevel\Hydrator\Extension\Lifecycle;`
`6`	`6`
`7`	`7`	`use Patchlevel\Hydrator\Extension;`
`8`		`-use Patchlevel\Hydrator\HydratorBuilder;`
	`8`	`+use Patchlevel\Hydrator\StackHydratorBuilder;`
`9`	`9`
`10`	`10`	`final readonly class LifecycleExtension implements Extension`
`11`	`11`	`{`
`12`		`- public function configure(HydratorBuilder $builder): void`
	`12`	`+ public function configure(StackHydratorBuilder $builder): void`
`13`	`13`	`{`
`14`	`14`	`$builder->addMiddleware(new LifecycleMiddleware());`
`15`	`15`	`$builder->addMetadataEnricher(new LifecycleMetadataEnricher());`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`
`20`	`20`	`use const PHP_VERSION_ID;`
`21`	`21`
`22`		`-final class MetadataHydrator implements Hydrator`
	`22`	`+final class StackHydrator implements Hydrator`
`23`	`23`	`{`
`24`	`24`	`/** @var array<class-string, ClassMetadata> */`
`25`	`25`	`private array $classMetadata = [];`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`	`use function array_merge;`
`19`	`19`	`use function krsort;`
`20`	`20`
`21`		`-final class HydratorBuilder`
	`21`	`+final class StackHydratorBuilder`
`22`	`22`	`{`
`23`	`23`	`private bool $defaultLazy = false;`
`24`	`24`
`@@ -78,7 +78,7 @@ public function setCache(CacheItemPoolInterface\|CacheInterface\|null $cache): sta`
`78`	`78`	`return $this;`
`79`	`79`	`}`
`80`	`80`
`81`		`- public function build(): Hydrator`
	`81`	`+ public function build(): StackHydrator`
`82`	`82`	`{`
`83`	`83`	`krsort($this->guessers);`
`84`	`84`	`krsort($this->metadataEnrichers);`
`@@ -99,7 +99,7 @@ public function build(): Hydrator`
`99`	`99`	`$metadataFactory = new Psr16MetadataFactory($metadataFactory, $this->cache);`
`100`	`100`	`}`
`101`	`101`
`102`		`- return new MetadataHydrator(`
	`102`	`+ return new StackHydrator(`
`103`	`103`	`$metadataFactory,`
`104`	`104`	`array_merge(...$this->middlewares),`
`105`	`105`	`$this->defaultLazy,`