refactor: add #[\ReturnTypeWillChange] to PersistentProxyObjectFactor…

…y::initialize()

phpstan.neon

@@ -37,4 +37,4 @@ parameters:
     ignoreErrors:
         -
             message: '#Unsafe usage of new static\(\).*#'
-            path: ./src/ModelFactory.php
+            path: ./src/Persistence/PersistentProxyObjectFactory.php

src/Bundle/Resources/skeleton/Factory.tpl.php

@@ -60,7 +60,7 @@ protected function defaults(): array|callable
     /**
      * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization
      */
-    protected function initialize(): self
+    protected function initialize(): static
     {
         return $this
 <?php if (!$makeFactoryData->isPersisted()): ?>

src/Factory.php

@@ -24,9 +24,6 @@
  * @abstract
  *
  * @author Kevin Bond <kevinbond@gmail.com>
- *
- * @phpstan-type Parameters = array<string,mixed>
- * @phpstan-type Attributes = Parameters|callable(int):Parameters
  */
 class Factory
 {
@@ -226,7 +223,7 @@ final public function withAttributes($attributes = []): self
     }
 
     /**
-     * @param Attributes $attributes
+     * @param array|callable $attributes
      */
     final public function with(array|callable $attributes = []): static
     {

src/ModelFactory.php

@@ -21,6 +21,8 @@
  * @phpstan-method static list<Proxy<TModel>> createMany(int $number, array|callable $attributes = [])
  *
  * @author Kevin Bond <kevinbond@gmail.com>
+ *
+ * @deprecated use PersistentProxyObjectFactory instead
  */
 abstract class ModelFactory extends PersistentProxyObjectFactory
 {

src/Persistence/PersistentProxyObjectFactory.php

@@ -56,7 +56,7 @@ final public static function new(array|callable|string $defaultAttributes = [],
         }
 
         $factory = $factory
-            ->with(static fn(): array => $factory->defaults())
+            ->with(static fn(): array|callable => $factory->defaults())
             ->with($defaultAttributes);
 
         try {
@@ -286,6 +286,7 @@ abstract public static function class(): string;
      *
      * @return static
      */
+    #[\ReturnTypeWillChange]
     protected function initialize()
     {
         return $this;

tests/Fixtures/Factories/CategoryFactory.php

@@ -21,7 +21,7 @@ protected function defaults(): array|callable
         return ['name' => self::faker()->sentence()];
     }
 
-    protected function initialize()
+    protected function initialize(): static
     {
         return $this
             ->instantiateWith(

tests/Fixtures/Factories/PostFactory.php

@@ -34,7 +34,7 @@ protected function defaults(): array|callable
         ];
     }
 
-    protected function initialize()
+    protected function initialize(): static
     {
         return $this
             ->instantiateWith(

tests/Fixtures/Factories/PostFactoryWithInvalidInitialize.php

@@ -5,7 +5,7 @@
 /**
  * @author Kevin Bond <kevinbond@gmail.com>
  */
-final class PostFactoryWithInvalidInitialize extends PostFactory
+final class PostFactoryWithInvalidInitialize extends LegacyPostFactory
 {
     protected function initialize()
     {

tests/Fixtures/Factories/PostFactoryWithNullInitialize.php

@@ -5,7 +5,7 @@
 /**
  * @author Kevin Bond <kevinbond@gmail.com>
  */
-final class PostFactoryWithNullInitialize extends PostFactory
+final class PostFactoryWithNullInitialize extends LegacyPostFactory
 {
     protected function initialize()
     {

tests/Fixtures/Factories/PostFactoryWithValidInitialize.php

@@ -7,7 +7,7 @@
  */
 final class PostFactoryWithValidInitialize extends PostFactory
 {
-    protected function initialize(): self
+    protected function initialize(): static
     {
         return $this->published();
     }

tests/Fixtures/Maker/expected/can_create_factory.php

@@ -67,7 +67,7 @@ protected function defaults(): array|callable
     /**
      * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization
      */
-    protected function initialize(): self
+    protected function initialize(): static
     {
         return $this
             // ->afterInstantiate(function(Category $category): void {})

tests/Fixtures/Maker/expected/can_create_factory_for_entity_with_repository_with_data_set_phpstan.php

@@ -86,7 +86,7 @@ protected function defaults(): array|callable
     /**
      * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization
      */
-    protected function initialize(): self
+    protected function initialize(): static
     {
         return $this
             // ->afterInstantiate(function(Post $post): void {})

tests/Fixtures/Maker/expected/can_create_factory_for_entity_with_repository_with_data_set_psalm.php

@@ -86,7 +86,7 @@ protected function defaults(): array|callable
     /**
      * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization
      */
-    protected function initialize(): self
+    protected function initialize(): static
     {
         return $this
             // ->afterInstantiate(function(Post $post): void {})

tests/Fixtures/Maker/expected/can_create_factory_for_not_persisted_class.php

@@ -64,7 +64,7 @@ protected function defaults(): array|callable
     /**
      * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization
      */
-    protected function initialize(): self
+    protected function initialize(): static
     {
         return $this
             ->withoutPersisting()

tests/Fixtures/Maker/expected/can_create_factory_for_not_persisted_class_interactively.php

@@ -62,7 +62,7 @@ protected function defaults(): array|callable
     /**
      * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization
      */
-    protected function initialize(): self
+    protected function initialize(): static
     {
         return $this
             ->withoutPersisting()

tests/Fixtures/Maker/expected/can_create_factory_for_odm_with_data_set_document.php

@@ -70,7 +70,7 @@ protected function defaults(): array|callable
     /**
      * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization
      */
-    protected function initialize(): self
+    protected function initialize(): static
     {
         return $this
             // ->afterInstantiate(function(ODMPost $oDMPost): void {})

tests/Fixtures/Maker/expected/can_create_factory_for_odm_with_data_set_embedded_document.php

@@ -56,7 +56,7 @@ protected function defaults(): array|callable
     /**
      * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization
      */
-    protected function initialize(): self
+    protected function initialize(): static
     {
         return $this
             ->withoutPersisting()

tests/Fixtures/Maker/expected/can_create_factory_for_orm_embedded_class.php

@@ -54,7 +54,7 @@ protected function defaults(): array|callable
     /**
      * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization
      */
-    protected function initialize(): self
+    protected function initialize(): static
     {
         return $this
             ->withoutPersisting()

tests/Fixtures/Maker/expected/can_create_factory_in_test_dir.php

@@ -67,7 +67,7 @@ protected function defaults(): array|callable
     /**
      * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization
      */
-    protected function initialize(): self
+    protected function initialize(): static
     {
         return $this
             // ->afterInstantiate(function(Category $category): void {})

tests/Fixtures/Maker/expected/can_create_factory_in_test_dir_interactively.php

@@ -67,7 +67,7 @@ protected function defaults(): array|callable
     /**
      * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization
      */
-    protected function initialize(): self
+    protected function initialize(): static
     {
         return $this
             // ->afterInstantiate(function(Tag $tag): void {})

tests/Fixtures/Maker/expected/can_create_factory_interactively.php

@@ -71,7 +71,7 @@ protected function defaults(): array|callable
     /**
      * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization
      */
-    protected function initialize(): self
+    protected function initialize(): static
     {
         return $this
             // ->afterInstantiate(function(Comment $comment): void {})

tests/Fixtures/Maker/expected/can_create_factory_with_auto_activated_not_persisted_option.php

@@ -55,7 +55,7 @@ protected function defaults(): array|callable
     /**
      * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization
      */
-    protected function initialize(): self
+    protected function initialize(): static
     {
         return $this
             ->withoutPersisting()

tests/Fixtures/Maker/expected/can_create_factory_with_default_enum_with_data_set_odm.php

@@ -68,7 +68,7 @@ protected function defaults(): array|callable
     /**
      * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization
      */
-    protected function initialize(): self
+    protected function initialize(): static
     {
         return $this
             // ->afterInstantiate(function(DocumentWithEnum $documentWithEnum): void {})

tests/Fixtures/Maker/expected/can_create_factory_with_default_enum_with_data_set_orm.php

@@ -68,7 +68,7 @@ protected function defaults(): array|callable
     /**
      * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization
      */
-    protected function initialize(): self
+    protected function initialize(): static
     {
         return $this
             // ->afterInstantiate(function(EntityWithEnum $entityWithEnum): void {})

tests/Fixtures/Maker/expected/can_create_factory_with_default_enum_with_data_set_without_persistence.php

@@ -55,7 +55,7 @@ protected function defaults(): array|callable
     /**
      * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization
      */
-    protected function initialize(): self
+    protected function initialize(): static
     {
         return $this
             ->withoutPersisting()

tests/Fixtures/Maker/expected/can_create_factory_with_embeddable_with_data_set_odm.php

@@ -73,7 +73,7 @@ protected function defaults(): array|callable
     /**
      * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization
      */
-    protected function initialize(): self
+    protected function initialize(): static
     {
         return $this
             // ->afterInstantiate(function(ODMPost $oDMPost): void {})

tests/Fixtures/Maker/expected/can_create_factory_with_embeddable_with_data_set_orm.php

@@ -68,7 +68,7 @@ protected function defaults(): array|callable
     /**
      * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization
      */
-    protected function initialize(): self
+    protected function initialize(): static
     {
         return $this
             // ->afterInstantiate(function(Contact $contact): void {})

tests/Fixtures/Maker/expected/can_create_factory_with_relation_defaults.php

@@ -71,7 +71,7 @@ protected function defaults(): array|callable
     /**
      * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization
      */
-    protected function initialize(): self
+    protected function initialize(): static
     {
         return $this
             // ->afterInstantiate(function(EntityWithRelations $entityWithRelations): void {})

tests/Fixtures/Maker/expected/can_create_factory_with_relation_for_all_fields.php

@@ -71,7 +71,7 @@ protected function defaults(): array|callable
     /**
      * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization
      */
-    protected function initialize(): self
+    protected function initialize(): static
     {
         return $this
             // ->afterInstantiate(function(EntityWithRelations $entityWithRelations): void {})

tests/Fixtures/Maker/expected/can_create_factory_with_static_analysis_annotations_with_data_set_phpstan.php

@@ -83,7 +83,7 @@ protected function defaults(): array|callable
     /**
      * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization
      */
-    protected function initialize(): self
+    protected function initialize(): static
     {
         return $this
             // ->afterInstantiate(function(Category $category): void {})

tests/Fixtures/Maker/expected/can_create_factory_with_static_analysis_annotations_with_data_set_psalm.php

@@ -83,7 +83,7 @@ protected function defaults(): array|callable
     /**
      * @see https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#initialization
      */
-    protected function initialize(): self
+    protected function initialize(): static
     {
         return $this
             // ->afterInstantiate(function(Category $category): void {})

tests/Functional/ORMModelFactoryTest.php

@@ -53,6 +53,7 @@ public function can_override_initialize(): void
 
     /**
      * @test
+     * @group legacy
      */
     public function initialize_must_return_an_instance_of_the_current_factory(): void
     {
@@ -64,6 +65,7 @@ public function initialize_must_return_an_instance_of_the_current_factory(): voi
 
     /**
      * @test
+     * @group legacy
      */
     public function initialize_must_return_a_value(): void
     {