Change

Author: negreanucalinadrian

composer.json

@@ -27,7 +27,7 @@
     "symfony/dependency-injection": "5.*",
     "symfony/filesystem": "5.*",
     "symfony/config": "5.*",
-    "negreanucalin/sparkle-dto": "~1.1",
+    "negreanucalin/sparkle-dto": "~0.1",
     "ext-json": "*"
   }
 }

composer.lock

@@ -10,24 +10,25 @@ Just manual-functional testing for now  provided in folder `demo_files` by runni
 
 * Define mandatory and optional parameters by adding demo files
 * Validate route params
-	1. If FILE and JSON or named POST variables present throw error (only 1 of them)
-	2. Parameter type validation (from list:uri,post, get)
-	3. GET cannot have JSON and FILE
-	4. Route validation:
-		I. If parameter present in route check if it exists in list
-		II. If parameter present check if uri
+    1. If FILE and JSON or named POST variables present throw error (only 1 of them)
+    2. Parameter type validation (from list:uri,post, get)
+    3. GET cannot have JSON and FILE
+    4. Route validation:
+        I. If parameter present in route check if it exists in list
+        II. If parameter present check if uri
 * Parses `*.yaml` files and generates a flat document containing the application's documentation
-* Notes
-	* No filename convention required
-	* You can organize however you want
-	* A sugestion would be to have multiple files:
-		* `_project.yaml` - Project description
-		* `_categories.yaml` - Menu items and sub-items
-		* `user_route.yaml` - Route example
-		* `another_route.yaml` - Route example
+* 
+### Notes
+* No filename convention required
+* You can organize however you want
+* A sugestion would be to have multiple files:
+	* `_project.yaml` - Project description
+	* `_categories.yaml` - Menu items and sub-items
+	* `user_route.yaml` - Route example
+	* `another_route.yaml` - Route example
 		
 * Project
-	* File name `_my_awesome_project.yaml`
+    * File name `_my_awesome_project.yaml`
 ```
 project:
   name: My Awesome project

readme.md

@@ -0,0 +1,13 @@
+<?php
+
+namespace MultidocParser\Exceptions;
+
+class NoCategoryRouteException extends \Exception
+{
+    const MESSAGE = 'Missing category for route:';
+
+    public function __construct($name)
+    {
+        parent::__construct(self::MESSAGE.' '. $name);
+    }
+}

src/Exceptions/NoCategoryRouteException.php

@@ -2,6 +2,7 @@
 
 namespace MultidocParser\Normalizers;
 
+use MultidocParser\Exceptions\NoCategoryRouteException;
 use MultidocParser\Exceptions\UndefinedTemplateException;
 use MultidocParser\Services\FileContentParserService;
 use Symfony\Component\Finder\SplFileInfo;
@@ -27,6 +28,7 @@ public function hydrateFilesToRouteDefinitionList(SplFileInfo $file, $routeDefin
     /**
      * @param array[] $routeDefinitionList
      * @return array[]
+     * @throws NoCategoryRouteException
      */
     public function formatTagsAndStatusAndHeaders($routeDefinitionList)
     {
@@ -55,6 +57,9 @@ public function formatTagsAndStatusAndHeaders($routeDefinitionList)
                 }
                 unset($routeDefinitionList[$routeIndex][FileContentParserService::STATUS_PLURAL_LIST]);
             }
+            if (!isset($routeDefinitionList[$routeIndex]['category'])) {
+                throw new NoCategoryRouteException($routeDefinitionList[$routeIndex]['name']);
+            }
             $routeDefinitionList[$routeIndex]['categoryId'] = $routeDefinitionList[$routeIndex]['category'];
             unset($routeDefinitionList[$routeIndex]['category']);
         }

src/Normalizers/DataNormalizer.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace MultidocParser\Services;
 
 use MultidocParser\DTO\CategoryDto;
@@ -22,15 +23,15 @@ class OutputFileService
      */
     private $categoryRenderer;
 
-    private $outputDirectory = __DIR__.'\..\\';
+    private $outputDirectory = __DIR__ . '\..\\';
 
     private $projectFileName = 'project.json';
 
     private $categoryListFileName = 'categories.json';
 
 
     public function __construct(
-        Filesystem $fileService,
+        Filesystem       $fileService,
         CategoryRenderer $categoryRenderer
     )
     {
@@ -40,7 +41,7 @@ public function __construct(
 
     public function prepareOutputFolder($outputPath)
     {
-        if(empty($outputPath)) {
+        if (empty($outputPath)) {
             $outputPath = self::DEFAULT_OUTPUT_PATH;
         }
         $this->outputDirectory = $outputPath;
@@ -56,12 +57,12 @@ public function exportProjectEntityToOutputFolder(ProjectDto $project)
     {
         $this->removeCurrentFilesInOutput();
         $this->fileService->dumpFile(
-            $this->outputDirectory.DIRECTORY_SEPARATOR.$this->projectFileName,
+            $this->outputDirectory . DIRECTORY_SEPARATOR . $this->projectFileName,
             json_encode($project, JSON_PRETTY_PRINT)
         );
 
         $this->fileService->dumpFile(
-            $this->outputDirectory.DIRECTORY_SEPARATOR.$this->categoryListFileName,
+            $this->outputDirectory . DIRECTORY_SEPARATOR . $this->categoryListFileName,
             json_encode(
                 $this->categoryRenderer->renderList($project->categories), JSON_PRETTY_PRINT)
         );
@@ -70,17 +71,17 @@ public function exportProjectEntityToOutputFolder(ProjectDto $project)
     private function removeCurrentFilesInOutput()
     {
         $this->fileService->remove(array(
-            $this->outputDirectory.DIRECTORY_SEPARATOR,
-            $this->outputDirectory.DIRECTORY_SEPARATOR
+            $this->outputDirectory . DIRECTORY_SEPARATOR,
+            $this->outputDirectory . DIRECTORY_SEPARATOR
         ));
     }
 
     public function exportLogo(ProjectDto $project, $outputFolder)
     {
         if ($project->logo) {
             $this->fileService->copy(
-                $project->definitionFile.DIRECTORY_SEPARATOR.$project->logo,
-                $outputFolder.DIRECTORY_SEPARATOR.$project->logo,
+                $project->definitionFile . DIRECTORY_SEPARATOR . $project->logo,
+                $outputFolder . DIRECTORY_SEPARATOR . $project->logo,
                 true
             );
         }
@@ -92,7 +93,7 @@ public function exportLogo(ProjectDto $project, $outputFolder)
      */
     public function exportExampleFiles($categoryList, $outputFolder)
     {
-        foreach($categoryList as $category) {
+        foreach ($categoryList as $category) {
             if ($category->routeList) {
                 foreach ($category->routeList as $route) {
                     $this->moveExampleFilesFromRoute($route, $outputFolder);
@@ -110,7 +111,7 @@ public function exportExampleFiles($categoryList, $outputFolder)
      */
     private function moveExampleFilesFromRoute(RouteDto $route, $outputFolder)
     {
-        if($route->request->method == FileContentParserService::ROUTE_METHOD_POST){
+        if ($route->request->method == FileContentParserService::ROUTE_METHOD_POST) {
             /**
              * @var $paramList ParameterDto[]
              */
@@ -119,11 +120,11 @@ private function moveExampleFilesFromRoute(RouteDto $route, $outputFolder)
             if (empty($paramList)) {
                 return;
             }
-            foreach($paramList as $parameter) {
-                if($parameter->data_type == FileContentParserService::PARAMETER_TYPE_FILE){
+            foreach ($paramList as $parameter) {
+                if ($parameter->data_type == FileContentParserService::PARAMETER_TYPE_FILE) {
                     $this->fileService->copy(
-                        $route->inputPath.DIRECTORY_SEPARATOR.$parameter->example,
-                        $outputFolder.DIRECTORY_SEPARATOR.$parameter->example,
+                        $route->inputPath . DIRECTORY_SEPARATOR . $parameter->example,
+                        $outputFolder . DIRECTORY_SEPARATOR . $parameter->example,
                         true
                     );
                 }