ECS-427 Added WithSetPkTrait [2]

README.md

@@ -130,7 +130,7 @@ $this->faker->modelId() // return unsigned bit integer value
 
 If your model has unique index consisting of multiple fields, WithSetPkTrait trait should be used to ensure generated values for these fields are unique.
 
-In order for trait to work, you have to define methods `state`, `sequence` and `generatePk` and include `generatePk` call in `definition`.
+In order for trait to work, you have to define methods `state`, `setPk`, `sequence` and `generatePk` and include `generatePk` call in `definition`.
 Following is the example of a factory ('client_id' and 'location_id' are fields forming unique index):
 
 ```php
@@ -147,6 +147,13 @@ Following is the example of a factory ('client_id' and 'location_id' are fields
         ]);
     }
 
+    public function setPk(?int $clientId = null, ?string $locationId = null): self // Use in tests to define values
+    {
+        return $this->state(function () use ($clientId, $locationId) {
+            return $this->generatePk($clientId, $locationId);
+        });
+    }
+
     public function state(mixed $state): static // Override of Laravel Eloquent Factory method
     {
         return $this->stateSetPk($state, ['client_id', 'location_id']);
@@ -174,6 +181,8 @@ Following is the example of a factory ('client_id' and 'location_id' are fields
 }
 ```
 
+*Important note* - fields must be declared in the same order in all methods.
+
 ## Parent classes
 
 ### BaseApiFactory

src/WithSetPkTrait.php

@@ -30,10 +30,7 @@ protected function stateSetPk(mixed $state, array $keys, bool $isSequence = fals
             $variables = $this->getVariables($state, $keys);
 
             if ($this->hasValue) {
-                return $this->state(function () use ($variables) {
-                    return $this->generatePk(...$variables);
-                })
-                    ->state($state);
+                return $this->setPk(...$variables)->state($state);
             }
         }
 

tests/Stubs/TestObjectWithSetPkTraitFactory.php

@@ -18,6 +18,13 @@ public function definition(): array
         ]);
     }
 
+    public function setPk(?int $clientId = null, ?string $locationId = null): self
+    {
+        return $this->state(function () use ($clientId, $locationId) {
+            return $this->generatePk($clientId, $locationId);
+        });
+    }
+
     public function state(mixed $state): static
     {
         return $this->stateSetPk($state, ['client_id', 'location_id']);

tests/WithSetPkTraitTest.php

@@ -5,7 +5,14 @@
 
 test('TestObjectWithSetPkTraitFactory create', function () {
     /** @var TestObjectModel $result */
-    $result = TestObjectWithSetPkTraitFactory::new()->make(['client_id' => 1]);
+    $result = TestObjectWithSetPkTraitFactory::new()->make(['amount' => 100]);
+
+    expect($result->amount)->toEqual(100);
+});
+
+test('TestObjectWithSetPkTraitFactory create with setPk', function () {
+    /** @var TestObjectModel $result */
+    $result = TestObjectWithSetPkTraitFactory::new()->setPk(1)->make();
 
     expect($result->client_id)->toEqual(1);
 });