Improve support for Factories (#201)

Co-authored-by: Luke Towers <[email protected]>

Author: mjauvin

src/Database/Factories/Factory.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace Winter\Storm\Database\Factories;
+
+use Illuminate\Database\Eloquent\Factories\Factory as BaseFactory;
+use Illuminate\Support\Str;
+
+/**
+ * @template TModel of \Winter\Storm\Database\Model
+ *
+ * @method $this trashed()
+ */
+abstract class Factory extends BaseFactory
+{
+    /**
+     * Get the factory name for the given model name.
+     *
+     * @param  class-string<\Winter\Storm\Database\Model>  $modelName
+     * @return class-string<\Winter\Storm\Database\Factories\Factory>
+     */
+    public static function resolveFactoryName(string $modelName)
+    {
+        if (Str::contains($modelName, 'Models\\')) {
+            $baseNamespace = trim(Str::before($modelName, 'Models'), '\\');
+            $modelClassName = trim(Str::after($modelName, 'Models'), '\\');
+        } else {
+            $baseNamespace = '';
+            $modelClassName = $modelName;
+        }
+
+        return trim(implode('\\', [
+            $baseNamespace,
+            trim(static::$namespace, '\\'),
+            $modelClassName.'Factory'
+        ]), '\\');
+    }
+
+    /**
+     * Get the name of the model that is generated by the factory.
+     *
+     * @return class-string<\Illuminate\Database\Eloquent\Model|TModel>
+     */
+    public function modelName()
+    {
+        // @phpstan-ignore-next-line
+        $resolver = static::$modelNameResolver ?? function (self $factory) {
+            $baseNamespace = join("\\", array_slice(
+                explode("\\", Str::replaceFirst(static::$namespace, '', get_class($factory))),
+                0,
+                -1
+            ));
+            $factoryBasename = Str::replaceLast('Factory', '', class_basename($factory));
+
+            $guessedClass = $baseNamespace . '\\Models\\' . $factoryBasename;
+
+            return class_exists($guessedClass) ? $guessedClass : parent::modelName();
+        };
+
+        // @phpstan-ignore-next-line
+        return $this->model ?? $resolver($this);
+    }
+}

src/Database/Factories/HasFactory.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Winter\Storm\Database\Factories;
+
+trait HasFactory
+{
+    /**
+     * Get a new factory instance for the model.
+     */
+    public static function factory(callable|array|int|null $count = null, callable|array $state = []): Factory
+    {
+        $factory = static::newFactory() ?: Factory::factoryForModel(get_called_class());
+
+        return $factory
+            ->count(is_numeric($count) ? $count : null)
+            ->state(is_callable($count) || is_array($count) ? $count : $state);
+    }
+
+    /**
+     * Create a new factory instance for the model.
+     *
+     * @return \Winter\Storm\Database\Factories\Factory<static>
+     */
+    protected static function newFactory()
+    {
+        //
+    }
+}

tests/Database/Factories/FactoryTest.php

@@ -0,0 +1,21 @@
+<?php
+
+use Winter\Storm\Database\Factories\Factory;
+
+class FactoryTest extends TestCase
+{
+    public function testResolveFactoryName()
+    {
+        $factoryClass = Factory::resolveFactoryName('Module\Models\TestModel');
+        $this->assertEquals($factoryClass, 'Module\Database\Factories\TestModelFactory');
+
+        $factoryClass = Factory::resolveFactoryName('Plugin\Author\Models\TestModel');
+        $this->assertEquals($factoryClass, 'Plugin\Author\Database\Factories\TestModelFactory');
+
+        $factoryClass = Factory::resolveFactoryName('Models\TestModel');
+        $this->assertEquals($factoryClass, 'Database\Factories\TestModelFactory');
+
+        $factoryClass = Factory::resolveFactoryName('TestModel');
+        $this->assertEquals($factoryClass, 'Database\Factories\TestModelFactory');
+    }
+}