feat: add new option to always fake optionals

Author: canvural

src/OpenAPIFaker.php

@@ -145,7 +145,7 @@ public function mockComponentSchema(string $schemaName)
     }
 
     /**
-     * @param array{minItems?:?int, maxItems?:?int} $options
+     * @param array{minItems?:?int, maxItems?:?int, alwaysFakeOptionals?:bool} $options
      */
     public function setOptions(array $options): self
     {

src/Options.php

@@ -8,6 +8,7 @@ final class Options
 {
     private ?int $minItems = null;
     private ?int $maxItems = null;
+    private bool $alwaysFakeOptionals = false;
 
     public function setMinItems(int $minItems): Options
     {
@@ -23,6 +24,13 @@ public function setMaxItems(int $maxItems): Options
         return $this;
     }
 
+    public function setAlwaysFakeOptionals(bool $alwaysFakeOptionals): self
+    {
+        $this->alwaysFakeOptionals = $alwaysFakeOptionals;
+
+        return $this;
+    }
+
     public function getMinItems(): ?int
     {
         return $this->minItems;
@@ -32,4 +40,9 @@ public function getMaxItems(): ?int
     {
         return $this->maxItems;
     }
+
+    public function getAlwaysFakeOptionals(): bool
+    {
+        return $this->alwaysFakeOptionals;
+    }
 }

src/SchemaFaker/ObjectFaker.php

@@ -33,7 +33,7 @@ public static function generate(Schema $schema, Options $options): array
         $allPropertyKeys = array_merge($requiredKeys, $selectedOptionalKeys);
 
         foreach ($schema->properties as $key => $property) {
-            if (! in_array($key, $allPropertyKeys, true)) {
+            if (! $options->getAlwaysFakeOptionals() && ! in_array($key, $allPropertyKeys, true)) {
                 continue;
             }
 

tests/Unit/SchemaFaker/ObjectFakerTest.php

@@ -15,6 +15,7 @@
  * @uses \Vural\OpenAPIFaker\SchemaFaker\NumberFaker
  *
  * @covers \Vural\OpenAPIFaker\SchemaFaker\ObjectFaker
+ * @covers \Vural\OpenAPIFaker\Options
  */
 class ObjectFakerTest extends UnitTestCase
 {
@@ -100,4 +101,38 @@ function it_includes_required_properties_all_the_time()
         self::assertArrayHasKey('username', $fakeData);
         $this->assertMatchesJsonSnapshot($fakeData);
     }
+
+    /** @test */
+    function it_can_fake_all_properties_if_always_fake_optionals_option_is_set()
+    {
+        $options = (new Options())->setAlwaysFakeOptionals(true);
+
+        $yaml = <<<YAML
+type: object
+properties:
+  id:
+    type: integer
+  username:
+    type: string
+  name:
+    type: string
+  age:
+    type: integer
+  birthdate:
+    type: date
+  email:
+    type: string
+    format: email
+required:
+  - id
+  - username
+YAML;
+
+        $fakeData = ObjectFaker::generate(SchemaFactory::fromYaml($yaml), $options);
+
+        self::assertIsArray($fakeData);
+        self::assertCount(6, $fakeData);
+
+        $this->assertMatchesJsonSnapshot($fakeData);
+    }
 }

tests/Unit/SchemaFaker/SchemaFakerTest.php

@@ -17,6 +17,7 @@
  * @uses \Vural\OpenAPIFaker\SchemaFaker\StringFaker
  * @uses \Vural\OpenAPIFaker\SchemaFaker\NumberFaker
  * @uses \Vural\OpenAPIFaker\SchemaFaker\ObjectFaker
+ * @uses \Vural\OpenAPIFaker\Options
  *
  * @covers \Vural\OpenAPIFaker\SchemaFaker\SchemaFaker
  */

tests/Unit/SchemaFaker/__snapshots__/ObjectFakerTest__it_can_fake_all_properties_if_always_fake_optionals_option_is_set__1.json

@@ -0,0 +1,8 @@
+{
+    "id": 321051476,
+    "username": "eaque",
+    "name": "harum",
+    "age": -933357512,
+    "birthdate": [],
+    "email": "[email protected]"
+}