Adding a (nearly passing) fjson integration test

Author: weaverryan

src/BuildResult.php

@@ -53,7 +53,7 @@ public function getMetas(): Metas
     /**
      * Returns the JSON data generated for each file, keyed by the source filename.
      *
-     * @return string[]
+     * @return array[]
      */
     public function getJsonResults(): array
     {

src/Generator/JsonGenerator.php

@@ -73,7 +73,7 @@ public function generateJson(): array
                 $jsonFilename,
                 json_encode($data, JSON_PRETTY_PRINT)
             );
-            $fJsonFiles[$filename] = json_encode($data, JSON_PRETTY_PRINT);
+            $fJsonFiles[$filename] = $data;
 
             $progressBar->advance();
         }

tests/AbstractIntegrationTest.php

@@ -11,20 +11,14 @@ class AbstractIntegrationTest extends TestCase
 {
     protected function createBuildConfig(string $sourceDir): BuildConfig
     {
+        $filesystem = new Filesystem();
+        $filesystem->remove(__DIR__.'/_output');
+
         return (new BuildConfig())
             ->setSymfonyVersion('4.0')
             ->setContentDir($sourceDir)
             ->disableBuildCache()
             ->setOutputDir(__DIR__.'/_output')
         ;
     }
-
-    /**
-     * @after
-     */
-    public function cleanUpOutput()
-    {
-        $filesystem = new Filesystem();
-        $filesystem->remove(__DIR__.'/_output');
-    }
 }

tests/JsonIntegrationTest.php

@@ -0,0 +1,93 @@
+<?php
+
+/*
+ * This file is part of the Docs Builder package.
+ * (c) Ryan Weaver <ryan@symfonycasts.com>
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace SymfonyDocsBuilder\Tests;
+
+use SymfonyDocsBuilder\DocBuilder;
+
+class JsonIntegrationTest extends AbstractIntegrationTest
+{
+    /**
+     * @dataProvider getJsonTests
+     */
+    public function testJsonGeneration(string $filename, array $expectedData)
+    {
+        $buildConfig = $this->createBuildConfig(__DIR__ . '/fixtures/source/json');
+        $builder = new DocBuilder();
+        $buildResult = $builder->build($buildConfig);
+        $fJsons = $buildResult->getJsonResults();
+
+        $actualFileData = $fJsons[$filename];
+        foreach ($expectedData as $key => $expectedKeyData) {
+            $this->assertArrayHasKey($key, $actualFileData, sprintf('Missing key "%s" in file "%s"', $key, $filename));
+            $this->assertSame($expectedData[$key], $actualFileData[$key], sprintf('Invalid data for key "%s" in file "%s"', $key, $filename));
+        }
+    }
+
+    public function getJsonTests()
+    {
+        yield 'index' => [
+            'file' => 'index',
+            'data' => [
+                //'parents' => [],
+                'prev' => null,
+                'next' => [
+                    'link' => 'dashboards/',
+                    'title' => 'Dashboards'
+                ],
+                'title' => 'JSON Generation Test',
+            ]
+        ];
+
+        yield 'dashboards' => [
+            'file' => 'dashboards',
+            'data' => [
+                //'parents' => [],
+                'prev' => [
+                    'title' => 'JSON Generation Test',
+                    'link' => 'index.html',
+                ],
+                'next' => [
+                    'title' => 'CRUD',
+                    'link' => 'crud.html',
+                ],
+                'title' => 'Dashboards',
+            ]
+        ];
+
+        yield 'crud' => [
+           'file' => 'crud',
+           'data' => [
+               //'parents' => [],
+               'prev' => [
+                   'title' => 'Dashboards',
+                   'link' => 'dashboards.html',
+               ],
+               'next' => [
+                   'title' => 'Design',
+                   'link' => 'design.html',
+               ],
+               'title' => 'CRUD',
+           ]
+       ];
+
+        yield 'design' => [
+           'file' => 'design',
+           'data' => [
+               //'parents' => [],
+               'prev' => [
+                   'title' => 'CRUD',
+                   'link' => 'crud.html',
+               ],
+               'next' => null,
+               'title' => 'Design',
+           ]
+       ];
+    }
+}

tests/fixtures/source/json/crud.rst

@@ -0,0 +1,7 @@
+CRUD
+====
+
+CRUD stands for: "create, read, update, delete".
+
+Or it might be: "Crazy runner's utter delight" (which would
+be, of course, a warm spring morning).

tests/fixtures/source/json/dashboards.rst

@@ -0,0 +1,5 @@
+Dashboards
+==========
+
+A file about dashboards... probably the one in an admin area... but
+maybe also the ones found in a car!

tests/fixtures/source/json/design.rst

@@ -0,0 +1,5 @@
+Design
+======
+
+Something that should not be left to most programmers
+to try to do.

tests/fixtures/source/json/index.rst

@@ -0,0 +1,9 @@
+JSON Generation Test
+====================
+
+.. toctree::
+    :maxdepth: 1
+
+    dashboards
+    crud
+    design