Merge pull request #58 from barnabaskecskes/feature/useFactoriesWhenC…

…reatingRelations

Using factories when creating relations

README.md

@@ -131,6 +131,14 @@ Here were are getting a user instance that has three related recipes attached. T
 
 > :warning: **Note**: For this to work, you need to have a new RecipeFactory already created.
 
+You can also define extras for the related models when using related model factories directly.
+
+```php
+$user = UserFactory::new()
+    ->withFactory(RecipeFactory::new()->withCustomName(), 'recipes', 3)
+    ->create();
+```
+
 You can create many related models instances by chaining `with`s.
 
 ```php

src/BaseFactory.php

@@ -40,7 +40,7 @@ protected function build(array $extra = [], string $creationType = 'create')
         $modelData = $this->transformModelFields(
             array_merge($this->getDefaults($this->faker), $this->overwriteDefaults, $extra)
         );
-        $model = $this->unguardedIfNeeded(fn () => $this->modelClass::$creationType($modelData));
+        $model = $this->unguardedIfNeeded(fn() => $this->modelClass::$creationType($modelData));
 
         if ($this->relatedModelFactories->isEmpty()) {
             return $model;
@@ -51,7 +51,7 @@ protected function build(array $extra = [], string $creationType = 'create')
 
     protected function unguardedIfNeeded(\Closure $closure)
     {
-        if (! config('factories-reloaded.unguard_models')) {
+        if (!config('factories-reloaded.unguard_models')) {
             return $closure();
         }
 
@@ -67,13 +67,19 @@ public function times(int $times = 1): MultiFactoryCollection
 
     /** @return static */
     public function with(string $relatedModelClass, string $relationshipName, int $times = 1): self
+    {
+        return $this->withFactory($this->getFactoryFromClassName($relatedModelClass), $relationshipName, $times);
+    }
+
+    /** @return static */
+    public function withFactory(FactoryInterface $relatedFactory, string $relationshipName, int $times = 1): self
     {
         $clone = clone $this;
 
         $clone->relatedModelFactories = clone $clone->relatedModelFactories;
         $clone->relatedModelFactories[$relationshipName] ??= collect();
         $clone->relatedModelFactories[$relationshipName] = $clone->relatedModelFactories[$relationshipName]->merge(
-            collect()->times($times, fn () => $this->getFactoryFromClassName($relatedModelClass))
+            collect()->times($times, fn() => $relatedFactory)
         );
 
         return $clone;
@@ -97,7 +103,7 @@ public function overwriteDefaults($attributes): self
     protected function getFactoryFromClassName(string $className): FactoryInterface
     {
         $baseClassName = (new ReflectionClass($className))->getShortName();
-        $factoryClass = config('factories-reloaded.factories_namespace').'\\'.$baseClassName.'Factory';
+        $factoryClass = config('factories-reloaded.factories_namespace') . '\\' . $baseClassName . 'Factory';
 
         return new $factoryClass($this->faker);
     }
@@ -120,7 +126,7 @@ private function buildRelationsForModel(Model $model, string $creationType): Mod
 
             if (method_exists($relation, 'associate')) {
                 $relatedModels = $factories->map->$creationType();
-                $relatedModels->each(fn ($related) => $relation->associate($related));
+                $relatedModels->each(fn($related) => $relation->associate($related));
 
                 if ($creationType === 'create') {
                     $model->save();
@@ -129,7 +135,7 @@ private function buildRelationsForModel(Model $model, string $creationType): Mod
                 continue;
             }
 
-            throw new InvalidArgumentException('Unsupported relation `'.$relationshipName.'` of ` type `'.get_class($relation).'`.');
+            throw new InvalidArgumentException('Unsupported relation `' . $relationshipName . '` of ` type `' . get_class($relation) . '`.');
         }
 
         return $model;

tests/FactoryTest.php

@@ -134,8 +134,8 @@ public function it_lets_you_overwrite_default_data_through_factory_methods(): vo
     public function it_lets_you_overwrite_default_data_when_creating_multiple_instances(): void
     {
         $pancakes = RecipeFactory::new()
-           ->times(5)
-           ->create(['name' => 'Pancakes']);
+            ->times(5)
+            ->create(['name' => 'Pancakes']);
 
         $this->assertEquals('Pancakes', $pancakes->first()->name);
     }
@@ -208,8 +208,8 @@ public function it_lets_you_use_a_closure_for_defining_default_data(): void
     public function it_lets_you_use_a_closure_for_overriding_default_data(): void
     {
         $ingredient = IngredientFactoryUsingClosure::new()->create([
-            'name' => fn (array $ingredient) => 'Basil',
-            'description' => fn (array $ingredient) => "Super delicious {$ingredient['name']}",
+            'name' => fn(array $ingredient) => 'Basil',
+            'description' => fn(array $ingredient) => "Super delicious {$ingredient['name']}",
         ]);
 
         $this->assertIsString($ingredient->name);
@@ -273,6 +273,91 @@ public function the_factory_is_immutable_when_adding_related_models(): void
         $this->assertEquals(4, $secondGroup->recipes()->count());
     }
 
+    /** @test * */
+    public function it_lets_you_add_a_related_model_using_a_factory(): void
+    {
+        Config::set('factories-reloaded.factories_namespace', 'ExampleAppTests\Factories');
+
+        $group = GroupFactory::new()
+            ->withFactory(RecipeFactory::new(), 'recipes')
+            ->create();
+
+        $this->assertEquals(1, $group->recipes->count());
+        $this->assertInstanceOf(Recipe::class, $group->recipes->first());
+    }
+
+    /** @test * */
+    public function it_lets_you_add_a_related_model_using_a_factory_with_make(): void
+    {
+        Config::set('factories-reloaded.factories_namespace', 'ExampleAppTests\Factories');
+
+        $group = GroupFactory::new()
+            ->withFactory(RecipeFactory::new(), 'recipes')
+            ->make();
+
+        $this->assertEquals(1, $group->recipes->count());
+        $this->assertEquals(0, Recipe::count());
+        $this->assertEquals(0, Group::count());
+    }
+
+    /** @test * */
+    public function it_lets_you_add_multiple_related_models_using_factories(): void
+    {
+        Config::set('factories-reloaded.factories_namespace', 'ExampleAppTests\Factories');
+
+        $group = GroupFactory::new()
+            ->withFactory(RecipeFactory::new(), 'recipes', 4)
+            ->create();
+
+        $this->assertEquals(4, $group->recipes->count());
+        $this->assertInstanceOf(Recipe::class, $group->recipes->first());
+    }
+
+    /** @test * */
+    public function the_factory_is_immutable_when_adding_related_models_using_factories(): void
+    {
+        Config::set('factories-reloaded.factories_namespace', 'ExampleAppTests\Factories');
+
+        $group = GroupFactory::new()
+            ->withFactory(RecipeFactory::new(), 'recipes', 4);
+
+        $firstGroup = $group->withFactory(RecipeFactory::new(), 'recipes')->create();
+        $secondGroup = $group->create();
+
+        $this->assertEquals(5, $firstGroup->recipes()->count());
+        $this->assertEquals(4, $secondGroup->recipes()->count());
+    }
+
+    /** @test */
+    public function it_lets_you_define_extras_for_related_models_using_factories()
+    {
+        Config::set('factories-reloaded.factories_namespace', 'ExampleAppTests\Factories');
+
+        $group = GroupFactory::new()
+            ->withFactory(RecipeFactory::new()
+                ->withCustomName()
+                ->withCustomDescription(), 'recipes')
+            ->create();
+
+        tap($group->recipes()->first(), function ($recipe) {
+            $this->assertEquals('my-name', $recipe->name);
+            $this->assertEquals('my-desc', $recipe->description);
+        });
+    }
+
+    /** @test */
+    public function it_lets_you_define_extras_for_multiple_related_models_at_once_using_factories()
+    {
+        Config::set('factories-reloaded.factories_namespace', 'ExampleAppTests\Factories');
+
+        $group = GroupFactory::new()
+            ->withFactory(RecipeFactory::new()->withCustomName(), 'recipes', 3)
+            ->create();
+
+        $this->assertEquals(3, $group->recipes()->count());
+        $group->recipes->each(fn($recipe) => $this->assertEquals('my-name', $recipe->name));
+    }
+
     /** @test */
     public function it_works_with_factory_as_relationship(): void
     {