refactor: deprecate proxy class

zenstruck · Nov 4, 2023 · 307b3de · 307b3de
1 parent dc871b7
commit 307b3de
Show file tree

Hide file tree

Showing 55 changed files with 609 additions and 449 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -21,7 +21,12 @@ parameters:
 			path: src/FactoryCollection.php
 
 		-
-			message: "#^Method Zenstruck\\\\Foundry\\\\RepositoryProxy\\:\\:proxyResult\\(\\) should return array\\<int, Zenstruck\\\\Foundry\\\\Proxy\\<TProxiedObject of object\\>\\>\\|Zenstruck\\\\Foundry\\\\Proxy\\<TProxiedObject of object\\> but returns \\(TProxiedObject of object\\)\\|null\\.$#"
+			message: "#^If condition is always false\\.$#"
+			count: 1
+			path: src/Proxy.php
+
+		-
+			message: "#^Method Zenstruck\\\\Foundry\\\\RepositoryProxy\\:\\:proxyResult\\(\\) should return array\\<int, Zenstruck\\\\Foundry\\\\Persistence\\\\Proxy\\<TProxiedObject of object\\>\\>\\|Zenstruck\\\\Foundry\\\\Persistence\\\\Proxy\\<TProxiedObject of object\\> but returns \\(TProxiedObject of object\\)\\|null\\.$#"
 			count: 1
 			path: src/RepositoryProxy.php
 
@@ -56,6 +61,6 @@ parameters:
 			path: src/ZenstruckFoundryBundle.php
 
 		-
-			message: "#^Function Zenstruck\\\\Foundry\\\\anonymous\\(\\) should return Zenstruck\\\\Foundry\\\\Factory\\<TObject of object\\> but returns class@anonymous/src/functions\\.php\\:45\\.$#"
+			message: "#^Function Zenstruck\\\\Foundry\\\\anonymous\\(\\) should return Zenstruck\\\\Foundry\\\\Factory\\<TObject of object\\> but returns class@anonymous/src/functions\\.php\\:46\\.$#"
 			count: 1
 			path: src/functions.php
diff --git a/src/AnonymousFactory.php b/src/AnonymousFactory.php
@@ -11,6 +11,8 @@
 
 namespace Zenstruck\Foundry;
 
+use Zenstruck\Foundry\Persistence\Proxy;
+
 /**
  * @template TModel of object
  * @template-extends Factory<TModel>

diff --git a/src/Bundle/Maker/Factory/MakeFactoryData.php b/src/Bundle/Maker/Factory/MakeFactoryData.php
@@ -14,7 +14,7 @@
 use Symfony\Bundle\MakerBundle\Str;
 use Symfony\Bundle\MakerBundle\Util\ClassNameDetails;
 use Zenstruck\Foundry\Persistence\PersistentProxyObjectFactory;
-use Zenstruck\Foundry\Proxy;
+use Zenstruck\Foundry\Persistence\Proxy;
 use Zenstruck\Foundry\RepositoryProxy;
 
 /**

diff --git a/src/Bundle/Maker/Factory/NoPersistenceObjectsAutoCompleter.php b/src/Bundle/Maker/Factory/NoPersistenceObjectsAutoCompleter.php
@@ -34,6 +34,11 @@ public function getAutocompleteValues(): array
 
                 $class = $this->toPSR4($rootPath, $phpFile, $namespacePrefix);
 
+                if ($class === 'Zenstruck\Foundry\Proxy') {
+                    // do not load legacy Proxy: prevents deprecations in tests.
+                    continue;
+                }
+
                 try {
                     // @phpstan-ignore-next-line $class is not always a class-string
                     $reflection = new \ReflectionClass($class);

diff --git a/src/Configuration.php b/src/Configuration.php
@@ -16,6 +16,7 @@
 use Doctrine\Persistence\ObjectManager;
 use Faker;
 use Zenstruck\Foundry\Exception\FoundryBootException;
+use Zenstruck\Foundry\Persistence\Proxy;
 
 /**
  * @internal
@@ -184,7 +185,7 @@ public function repositoryFor(object|string $objectOrClass): RepositoryProxy
         }
 
         if ($objectOrClass instanceof Proxy) {
-            $objectOrClass = $objectOrClass->object();
+            $objectOrClass = $objectOrClass->_real();
         }
 
         if (!\is_string($objectOrClass)) {

diff --git a/src/Factory.php b/src/Factory.php
@@ -18,6 +18,7 @@
 use Zenstruck\Foundry\Exception\FoundryBootException;
 use Zenstruck\Foundry\Persistence\InversedRelationshipPostPersistCallback;
 use Zenstruck\Foundry\Persistence\PostPersistCallback;
+use Zenstruck\Foundry\Persistence\Proxy;
 
 /**
  * @template TObject of object
@@ -152,8 +153,8 @@ final public function create(array|callable $attributes = []): Proxy
         }
 
         return $proxy
-            ->save()
-            ->withoutAutoRefresh(function(Proxy $proxy) use ($attributes, $postPersistCallbacks): void {
+            ->_save()
+            ->_withoutAutoRefresh(function(Proxy $proxy) use ($attributes, $postPersistCallbacks): void {
                 $callbacks = [...$postPersistCallbacks, ...$this->afterPersist];
 
                 if (!$callbacks) {
@@ -164,7 +165,7 @@ final public function create(array|callable $attributes = []): Proxy
                     $proxy->executeCallback($callback, $attributes);
                 }
 
-                $proxy->save(); // save again as afterPersist events may have modified
+                $proxy->_save(); // save again as afterPersist events may have modified
             })
         ;
     }
@@ -375,7 +376,7 @@ private function normalizeAttributes(array|callable $attributes): array
     private function normalizeAttribute(mixed $value, string $name): mixed
     {
         if ($value instanceof Proxy) {
-            return $value->isPersisted() ? $value->refresh()->object() : $value->object();
+            return $value->isPersisted(calledInternally: true) ? $value->_refresh()->_real() : $value->_real();
         }
 
         if ($value instanceof FactoryCollection) {
@@ -399,25 +400,25 @@ private function normalizeAttribute(mixed $value, string $name): mixed
         }
 
         if (!self::configuration()->hasManagerRegistry()) {
-            return $value->create()->object();
+            return $value->create()->_real();
         }
 
         try {
             $objectManager = self::configuration()->objectManagerFor($this->class);
 
             if (!$objectManager instanceof EntityManagerInterface || $objectManager->getClassMetadata($value->class)->isEmbeddedClass) {
                 // we may deal with ODM document or ORM\Embedded
-                return $value->create()->object();
+                return $value->create()->_real();
             }
         } catch (\Throwable) {
             // not persisted object
-            return $value->create()->object();
+            return $value->create()->_real();
         }
 
         $relationshipMetadata = self::getRelationshipMetadata($objectManager, $this->class, $name);
 
         if (!$relationshipMetadata) {
-            return $value->create()->object();
+            return $value->create()->_real();
         }
 
         if ($relationshipMetadata['isOwningSide']) {
@@ -436,13 +437,13 @@ private function normalizeAttribute(mixed $value, string $name): mixed
             $value = $value->withCascadePersist();
         }
 
-        return $value->create()->object();
+        return $value->create()->_real();
     }
 
     private static function normalizeObject(object $object): object
     {
         try {
-            return Proxy::createFromPersisted($object)->refresh()->object();
+            return Proxy::createFromPersisted($object)->_refresh()->_real();
         } catch (\RuntimeException) {
             return $object;
         }

diff --git a/src/FactoryCollection.php b/src/FactoryCollection.php
@@ -11,6 +11,8 @@
 
 namespace Zenstruck\Foundry;
 
+use Zenstruck\Foundry\Persistence\Proxy;
+
 /**
  * @template TObject of object
  *

diff --git a/src/ModelFactory.php b/src/ModelFactory.php
@@ -12,6 +12,7 @@
 namespace Zenstruck\Foundry;
 
 use Zenstruck\Foundry\Persistence\PersistentProxyObjectFactory;
+use Zenstruck\Foundry\Persistence\Proxy;
 
 /**
  * @template TModel of object

diff --git a/src/Persistence/InversedRelationshipPostPersistCallback.php b/src/Persistence/InversedRelationshipPostPersistCallback.php
@@ -14,7 +14,7 @@
 namespace Zenstruck\Foundry\Persistence;
 
 use Zenstruck\Foundry\Factory;
-use Zenstruck\Foundry\Proxy;
+use Zenstruck\Foundry\Persistence\Proxy;
 
 /**
  * @internal
@@ -34,6 +34,6 @@ public function __invoke(Proxy $proxy): void
             $this->relationshipField => $this->isCollection ? [$proxy] : $proxy,
         ]);
 
-        $proxy->refresh();
+        $proxy->_refresh();
     }
 }
diff --git a/src/Persistence/PersistentProxyObjectFactory.php b/src/Persistence/PersistentProxyObjectFactory.php
@@ -6,7 +6,6 @@
 
 use Zenstruck\Foundry\Exception\FoundryBootException;
 use Zenstruck\Foundry\Factory;
-use Zenstruck\Foundry\Proxy;
 use Zenstruck\Foundry\RepositoryAssertions;
 use Zenstruck\Foundry\RepositoryProxy;
 

diff --git a/src/Persistence/PostPersistCallback.php b/src/Persistence/PostPersistCallback.php
@@ -13,7 +13,7 @@
 
 namespace Zenstruck\Foundry\Persistence;
 
-use Zenstruck\Foundry\Proxy;
+use Zenstruck\Foundry\Persistence\Proxy;
 
 /**
  * @internal
-Original file line number
+Diff line change
@@ Expand Up / @@ -11,6 +11,8 @@ @@
     namespace Zenstruck\Foundry;
+    use Zenstruck\Foundry\Persistence\Proxy;
     /**
      * @template TObject of object
      *
@@ Expand Down @@