Preserve multiline formatting in Swagger export

antograssiot · antograssiot · commit effbaace8d7d · 2019-01-18T15:16:20.000+01:00
diff --git a/features/hydra/docs.feature b/features/hydra/docs.feature
@@ -32,7 +32,8 @@ Feature: Documentation support
     # Root properties
     And the JSON node "@id" should be equal to "/docs.jsonld"
     And the JSON node "hydra:title" should be equal to "My Dummy API"
-    And the JSON node "hydra:description" should be equal to "This is a test API."
+    And the JSON node "hydra:description" should contain "This is a test API."
+    And the JSON node "hydra:description" should contain "Made with love"
     And the JSON node "hydra:entrypoint" should be equal to "/"
     # Supported classes
     And the Hydra class "The API entrypoint" exists
diff --git a/features/swagger/docs.feature b/features/swagger/docs.feature
@@ -13,7 +13,8 @@ Feature: Documentation support
     And the JSON node "swagger" should be equal to "2.0"
     # Root properties
     And the JSON node "info.title" should be equal to "My Dummy API"
-    And the JSON node "info.description" should be equal to "This is a test API."
+    And the JSON node "info.description" should contain "This is a test API."
+    And the JSON node "info.description" should contain "Made with love"
     # Supported classes
     And the Swagger class "AbstractDummy" exists
     And the Swagger class "CircularReference" exists
diff --git a/src/Bridge/Symfony/Bundle/Command/SwaggerCommand.php b/src/Bridge/Symfony/Bundle/Command/SwaggerCommand.php
@@ -67,7 +67,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
     {
         $documentation = new Documentation($this->resourceNameCollectionFactory->create(), $this->apiTitle, $this->apiDescription, $this->apiVersion, $this->apiFormats);
         $data = $this->documentationNormalizer->normalize($documentation);
-        $content = $input->getOption('yaml') ? Yaml::dump($data, 6, 4, Yaml::DUMP_OBJECT_AS_MAP | Yaml::DUMP_EMPTY_ARRAY_AS_SEQUENCE) : (json_encode($data, JSON_PRETTY_PRINT) ?: '');
+        $content = $input->getOption('yaml') ? Yaml::dump($data, 6, 4, Yaml::DUMP_OBJECT_AS_MAP | Yaml::DUMP_EMPTY_ARRAY_AS_SEQUENCE | Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK) : (json_encode($data, JSON_PRETTY_PRINT) ?: '');
         if (!empty($filename = $input->getOption('output')) && \is_string($filename)) {
             file_put_contents($filename, $content);
             $output->writeln(
diff --git a/tests/Bridge/Symfony/Bundle/Command/SwaggerCommandTest.php b/tests/Bridge/Symfony/Bundle/Command/SwaggerCommandTest.php
@@ -72,6 +72,17 @@ public function testExecuteWithYaml()
 YAML;
 
         $this->assertContains($expected, $result, 'arrays should be correctly formatted.');
+
+        $expected = <<<YAML
+info:
+    title: 'My Dummy API'
+    version: 0.0.0
+    description: |
+        This is a test API.
+        Made with love
+YAML;
+
+        $this->assertContains($expected, $result, 'multiline formatting must be preserved (using literal style).');
     }
 
     public function testWriteToFile()
diff --git a/tests/Fixtures/app/config/config_test.yml b/tests/Fixtures/app/config/config_test.yml
@@ -28,7 +28,9 @@ twig:
 
 api_platform:
     title:                             'My Dummy API'
-    description:                       'This is a test API.'
+    description: |
+        This is a test API.
+        Made with love
     allow_plain_identifiers:           true
     formats:
         jsonld:                        ['application/ld+json']

Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ protected function execute(InputInterface $input, OutputInterface $output)`
`67`	`67`	`{`
`68`	`68`	`$documentation = new Documentation($this->resourceNameCollectionFactory->create(), $this->apiTitle, $this->apiDescription, $this->apiVersion, $this->apiFormats);`
`69`	`69`	`$data = $this->documentationNormalizer->normalize($documentation);`
`70`		`- $content = $input->getOption('yaml') ? Yaml::dump($data, 6, 4, Yaml::DUMP_OBJECT_AS_MAP \| Yaml::DUMP_EMPTY_ARRAY_AS_SEQUENCE) : (json_encode($data, JSON_PRETTY_PRINT) ?: '');`
	`70`	`+ $content = $input->getOption('yaml') ? Yaml::dump($data, 6, 4, Yaml::DUMP_OBJECT_AS_MAP \| Yaml::DUMP_EMPTY_ARRAY_AS_SEQUENCE \| Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK) : (json_encode($data, JSON_PRETTY_PRINT) ?: '');`
`71`	`71`	`if (!empty($filename = $input->getOption('output')) && \is_string($filename)) {`
`72`	`72`	`file_put_contents($filename, $content);`
`73`	`73`	`$output->writeln(`