chore: stop rendering empty fields (#18)

Ferror · Jan 29, 2024 · a1b28e8 · a1b28e8
1 parent d29a77f
commit a1b28e8
Show file tree

Hide file tree

Showing 5 changed files with 66 additions and 56 deletions.
diff --git a/src/Schema/V2/MessageRenderer.php b/src/Schema/V2/MessageRenderer.php
@@ -16,19 +16,19 @@ public function render(array $document): array
         foreach ($document['properties'] as $property) {
             $properties[$property['name']]['type'] = PropertyTypeTranslator::translate($property['type']);
 
-            if (isset($property['description'])) {
+            if (!empty($property['description'])) {
                 $properties[$property['name']]['description'] = $property['description'];
             }
 
-            if (isset($property['format'])) {
+            if (!empty($property['format'])) {
                 $properties[$property['name']]['format'] = $property['format'];
             }
 
-            if (isset($property['example'])) {
+            if (!empty($property['example'])) {
                 $properties[$property['name']]['example'] = $property['example'];
             }
 
-            if (isset($property['required'])) {
+            if (isset($property['required']) && $property['required']) {
                 $required[] = $property['name'];
             }
         }

diff --git a/tests/Integration/DumpSpecificationConsoleTest.php b/tests/Integration/DumpSpecificationConsoleTest.php
@@ -157,32 +157,23 @@ public function testExecuteYaml(): void
         properties:
           id:
             type: integer
-            description: ''
           amount:
             type: number
-            description: ''
           currency:
             type: string
-            description: ''
           isPaid:
             type: boolean
-            description: ''
           createdAt:
             type: string
-            description: ''
             format: date-time
           week:
             type: integer
-            description: ''
           payment:
             type: string
-            description: ''
           products:
             type: string
-            description: ''
           tags:
             type: string
-            description: ''
         required:
           - id
           - amount
@@ -329,41 +320,32 @@ public function testExecuteJson(): void
           "type": "object",
           "properties": {
             "id": {
-              "type": "integer",
-              "description": ""
+              "type": "integer"
             },
             "amount": {
-              "type": "number",
-              "description": ""
+              "type": "number"
             },
             "currency": {
-              "type": "string",
-              "description": ""
+              "type": "string"
             },
             "isPaid": {
-              "type": "boolean",
-              "description": ""
+              "type": "boolean"
             },
             "createdAt": {
               "type": "string",
-              "description": "",
               "format": "date-time"
             },
             "week": {
-              "type": "integer",
-              "description": ""
+              "type": "integer"
             },
             "payment": {
-              "type": "string",
-              "description": ""
+              "type": "string"
             },
             "products": {
-              "type": "string",
-              "description": ""
+              "type": "string"
             },
             "tags": {
-              "type": "string",
-              "description": ""
+              "type": "string"
             }
           },
             "required": [

diff --git a/tests/Unit/Schema/V2/MessageRendererTest.php b/tests/Unit/Schema/V2/MessageRendererTest.php
@@ -145,4 +145,50 @@ public function testAttributes(): void
 
         $this->assertEquals($expectedSpecification, Yaml::dump($specification, 10, 2));
     }
+
+    public function testDoesNotRenderEmptyData(): void
+    {
+        $document = [
+            'name' => 'UserSignedUp',
+            'properties' => [
+                [
+                    'name' => 'firstName',
+                    'type' => 'string',
+                    'description' => '',
+                    'example' => '',
+                    'format' => null,
+                ],
+                [
+                    'name' => 'secondName',
+                    'type' => 'string',
+                    'description' => '',
+                    'example' => '',
+                    'format' => '',
+                ],
+            ],
+        ];
+
+        $schema = new MessageRenderer();
+
+        $actual = $schema->render($document);
+
+        $expected = [
+            'UserSignedUp' => [
+                'payload' => [
+                    'type' => 'object',
+                    'properties' => [
+                        'firstName' => [
+                            'type' => 'string',
+                        ],
+                        'secondName' => [
+                            'type' => 'string',
+                        ],
+                    ],
+                    'required' => [],
+                ],
+            ],
+        ];
+
+        $this->assertEquals($expected, $actual);
+    }
 }
diff --git a/tests/Unit/Symfony/Controller/JsonSpecificationControllerTest.php b/tests/Unit/Symfony/Controller/JsonSpecificationControllerTest.php
@@ -139,41 +139,32 @@ public function test(): void
           "type": "object",
           "properties": {
             "id": {
-              "type": "integer",
-              "description": ""
+              "type": "integer"
             },
             "amount": {
-              "type": "number",
-              "description": ""
+              "type": "number"
             },
             "currency": {
-              "type": "string",
-              "description": ""
+              "type": "string"
             },
             "isPaid": {
-              "type": "boolean",
-              "description": ""
+              "type": "boolean"
             },
             "createdAt": {
               "type": "string",
-              "description": "",
               "format": "date-time"
             },
             "week": {
-              "type": "integer",
-              "description": ""
+              "type": "integer"
             },
             "payment": {
-              "type": "string",
-              "description": ""
+              "type": "string"
             },
             "products": {
-              "type": "string",
-              "description": ""
+              "type": "string"
             },
             "tags": {
-              "type": "string",
-              "description": ""
+              "type": "string"
             }
           },
             "required": [

diff --git a/tests/Unit/Symfony/Controller/YamlSpecificationControllerTest.php b/tests/Unit/Symfony/Controller/YamlSpecificationControllerTest.php
@@ -114,32 +114,23 @@ public function test(): void
         properties:
           id:
             type: integer
-            description: ''
           amount:
             type: number
-            description: ''
           currency:
             type: string
-            description: ''
           isPaid:
             type: boolean
-            description: ''
           createdAt:
             type: string
-            description: ''
             format: date-time
           week:
             type: integer
-            description: ''
           payment:
             type: string
-            description: ''
           products:
             type: string
-            description: ''
           tags:
             type: string
-            description: ''
         required:
           - id
           - amount