Merge pull request #548 from nikophil/fix/deprecation-layerr

fix(bc-layer): few improvments

src/Factory.php

@@ -204,8 +204,6 @@ final public function many(int $min, ?int $max = null): FactoryCollection
     final public function sequence(iterable|callable $sequence): FactoryCollection
     {
         if (\is_callable($sequence)) {
-            trigger_deprecation('zenstruck\foundry', '1.37.0', 'Passing a callable to method "%s()" is deprecated and will be removed in 2.0.', __METHOD__);
-
             $sequence = $sequence();
         }
 

src/Persistence/Proxy.php

@@ -89,7 +89,7 @@ public function forceSetAll(array $properties): static;
     /**
      * @deprecated Use method "_get()" instead
      */
-    public function get(string $property): mixed;
+    public function forceGet(string $property): mixed;
 
     /**
      * @deprecated Use method "_repository()" instead

src/Proxy.php

@@ -280,7 +280,7 @@ public function forceSetAll(array $properties): static
     /**
      * @deprecated Use method "_get()" instead
      */
-    public function get(string $property): mixed
+    public function forceGet(string $property): mixed
     {
         trigger_deprecation('zenstruck\foundry', '1.37.0', 'Method "%s()" is deprecated and will be removed in 2.0. Use "%s::_get()" instead.', __METHOD__, self::class);
 

tests/Functional/ModelFactoryTest.php

@@ -326,7 +326,6 @@ public function can_create_sequence(): void
 
     /**
      * @dataProvider sequenceProvider
-     * @group legacy
      */
     public function can_create_sequence_with_callable(callable $sequence): void
     {

utils/rector/src/ChangeFactoryBaseClass.php

@@ -6,6 +6,7 @@
 
 use PhpParser\Node;
 use PhpParser\Node\Stmt\Class_;
+use PHPStan\Analyser\MutatingScope;
 use PHPStan\PhpDocParser\Ast\PhpDoc\ExtendsTagValueNode;
 use PHPStan\PhpDocParser\Ast\PhpDoc\MethodTagValueNode;
 use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
@@ -191,7 +192,16 @@ public function refactor(Node $node): ?Node
 
     private function changeBaseClass(Node\Stmt\Class_ $node): Node\Stmt\Class_|null
     {
-        if ($this->persistenceResolver->shouldTransformFactoryIntoObjectFactory($this->getName($node))) {
+        /** @var MutatingScope $mutatingScope */
+        $mutatingScope = $node->getAttribute('scope');
+        $classReflection = $mutatingScope->getClassReflection();
+
+        if (
+            !str_starts_with($classReflection->getParentClass()->getName(), 'Zenstruck\Foundry')
+            || str_starts_with($classReflection->getParentClass()->getName(), 'Zenstruck\Foundry\Utils\Rector')
+        ) {
+            $newFactoryClass = $classReflection->getParentClass()->getName();
+        } elseif ($this->persistenceResolver->shouldTransformFactoryIntoObjectFactory($this->getName($node))) {
             $newFactoryClass = '\\' . ObjectFactory::class;
             $node->extends = new Node\Name($newFactoryClass);
         } else {

utils/rector/src/ChangeFactoryMethodCalls.php

@@ -5,6 +5,8 @@
 namespace Zenstruck\Foundry\Utils\Rector;
 
 use PhpParser\Node;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Expr\StaticCall;
 use PHPStan\Type\ObjectType;
 use Rector\Core\Rector\AbstractRector;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
@@ -24,7 +26,7 @@ public function __construct(
      */
     public function getNodeTypes(): array
     {
-        return [Node\Expr\MethodCall::class];
+        return [Node\Expr\MethodCall::class, Node\Expr\StaticCall::class];
     }
 
     public function getRuleDefinition(): RuleDefinition
@@ -74,10 +76,16 @@ public function published(): static
         );
     }
 
-    /**
-     * @param Node\Expr\MethodCall $node
-     */
     public function refactor(Node $node): Node|int|null
+    {
+        return match($node::class) {
+            Node\Expr\MethodCall::class => $this->changeMethodCall($node),
+            Node\Expr\StaticCall::class => $this->changeStaticCall($node),
+            default => null,
+        };
+    }
+
+    public function changeMethodCall(MethodCall $node): Node|int|null
     {
         if (!$this->isObjectType($node->var, new ObjectType(Factory::class))) {
             return null;
@@ -101,4 +109,19 @@ public function refactor(Node $node): Node|int|null
 
         return null;
     }
+
+    private function changeStaticCall(StaticCall $node): Node|null
+    {
+        if (!$this->isObjectType($node->class, new ObjectType(Factory::class))) {
+            return null;
+        }
+
+        if ((string)$node->name === 'getDefaults') {
+            $node->name = new Node\Identifier('defaults');
+
+            return $node;
+        }
+
+        return null;
+    }
 }

utils/rector/src/ChangeProxyMethodCalls.php

@@ -27,7 +27,7 @@ public function getRuleDefinition(): RuleDefinition
                     $proxy->remove();
                     $proxy->refresh();
                     $proxy->forceSet();
-                    $proxy->get();
+                    $proxy->forceGet();
                     $proxy->repository();
                     $proxy->enableAutoRefresh();
                     $proxy->disableAutoRefresh();
@@ -83,7 +83,7 @@ public function refactor(Node $node): ?Node
             case 'forceSet':
                 $node->name = new Node\Identifier('_set');
                 return $node;
-            case 'get':
+            case 'forceGet':
                 $node->name = new Node\Identifier('_get');
                 return $node;
             case 'repository':

utils/rector/src/RemoveProxyRealObjectMethodCallsForNotProxifiedObjects.php

@@ -100,7 +100,7 @@ private function isProxyOfFutureObjectFactory(Node\Expr $var): bool
             return false;
         }
 
-        /** @var MutatingScope */
+        /** @var MutatingScope $mutatingScope */
         $mutatingScope = $var->getAttribute('scope');
 
         $type = $mutatingScope->getType($var);

utils/rector/tests/ChangeFactoryBaseClass/Fixtures/change-factory-extending-user-defined-factory.php.inc

@@ -0,0 +1,53 @@
+<?php
+
+namespace Zenstruck\Foundry\Utils\Rector\Tests\Fixtures;
+
+use Zenstruck\Foundry\Utils\Rector\Tests\Fixtures\DummyObject;
+use Zenstruck\Foundry\ModelFactory;
+use Zenstruck\Foundry\Proxy;
+
+final class DummyModelFactoryExtendingUserFactory extends DummyObjectModelFactory
+{
+    protected function getDefaults(): array
+    {
+        return [];
+    }
+
+    protected function initialize(): self
+    {
+        return $this;
+    }
+
+    protected static function getClass(): string
+    {
+        return DummyObject::class;
+    }
+}
+?>
+-----
+<?php
+
+namespace Zenstruck\Foundry\Utils\Rector\Tests\Fixtures;
+
+use Zenstruck\Foundry\Utils\Rector\Tests\Fixtures\DummyObject;
+use Zenstruck\Foundry\ModelFactory;
+use Zenstruck\Foundry\Proxy;
+
+final class DummyModelFactoryExtendingUserFactory extends DummyObjectModelFactory
+{
+    protected function defaults(): array
+    {
+        return [];
+    }
+
+    protected function initialize(): static
+    {
+        return $this;
+    }
+
+    public static function class(): string
+    {
+        return DummyObject::class;
+    }
+}
+?>

utils/rector/tests/ChangeFactoryMethodCalls/Fixtures/change-factory-extending-user-defined-factory.php.inc

@@ -0,0 +1,53 @@
+<?php
+
+namespace Zenstruck\Foundry\Utils\Rector\Tests\Fixtures;
+
+use Zenstruck\Foundry\Utils\Rector\Tests\Fixtures\DummyObject;
+use Zenstruck\Foundry\ModelFactory;
+use Zenstruck\Foundry\Proxy;
+
+final class DummyModelFactoryExtendingUserFactory extends DummyObjectModelFactory
+{
+    protected function getDefaults(): array
+    {
+        return self::getDefaults();
+    }
+
+    protected function initialize(): self
+    {
+        return $this;
+    }
+
+    protected static function getClass(): string
+    {
+        return DummyObject::class;
+    }
+}
+?>
+-----
+<?php
+
+namespace Zenstruck\Foundry\Utils\Rector\Tests\Fixtures;
+
+use Zenstruck\Foundry\Utils\Rector\Tests\Fixtures\DummyObject;
+use Zenstruck\Foundry\ModelFactory;
+use Zenstruck\Foundry\Proxy;
+
+final class DummyModelFactoryExtendingUserFactory extends DummyObjectModelFactory
+{
+    protected function getDefaults(): array
+    {
+        return self::defaults();
+    }
+
+    protected function initialize(): self
+    {
+        return $this;
+    }
+
+    protected static function getClass(): string
+    {
+        return DummyObject::class;
+    }
+}
+?>

utils/rector/tests/ChangeProxyMethhodCalls/Fixtures/change-legacy-proxy-methods.php.inc

@@ -8,7 +8,7 @@ function legacyProxy(\Zenstruck\Foundry\Proxy $proxy): void
     $proxy->remove();
     $proxy->refresh();
     $proxy->forceSet();
-    $proxy->get();
+    $proxy->forceGet();
     $proxy->repository();
     $proxy->enableAutoRefresh();
     $proxy->disableAutoRefresh();
@@ -23,7 +23,7 @@ function newProxy(\Zenstruck\Foundry\Persistence\Proxy $proxy): void
     $proxy->remove();
     $proxy->refresh();
     $proxy->forceSet();
-    $proxy->get();
+    $proxy->forceGet();
     $proxy->repository();
     $proxy->enableAutoRefresh();
     $proxy->disableAutoRefresh();

utils/rector/tests/Fixtures/DummyModelFactoryExtendingUserFactory.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Zenstruck\Foundry\Utils\Rector\Tests\Fixtures;
+
+final class DummyModelFactoryExtendingUserFactory extends DummyObjectModelFactory
+{
+    protected function getDefaults(): array
+    {
+        return [];
+    }
+
+    protected static function getClass(): string
+    {
+        return DummyObject::class;
+    }
+}

utils/rector/tests/Fixtures/DummyObjectModelFactory.php

@@ -6,7 +6,7 @@
 
 use Zenstruck\Foundry\ModelFactory;
 
-final class DummyObjectModelFactory extends ModelFactory
+class DummyObjectModelFactory extends ModelFactory
 {
     protected function getDefaults(): array
     {