Merge pull request #3 from negreanucalin/dev

Dev

Author: negreanucalin

.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - dev
+      - master
+  pull_request:
+    branches:
+      - dev
+      - master
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: php-actions/composer@v5
+      - name: PHPUnit tests
+        uses: php-actions/phpunit@v3
+        with:
+          configuration: phpunit.xml

composer.json

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

composer.lock

@@ -0,0 +1,19 @@
+<?xml version="1.0"?>
+<phpunit
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        colors="true"
+        xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+        bootstrap="vendor/autoload.php"
+>
+    <coverage>
+        <include>
+            <directory suffix=".php">src</directory>
+        </include>
+    </coverage>
+    <testsuites>
+        <testsuite name="feature">
+            <directory prefix="Feature">.</directory>
+        </testsuite>
+    </testsuites>
+    <logging/>
+</phpunit>

phpunit.xml

@@ -12,14 +12,14 @@
  * @property string $logo
  * @property string $definitionFile
  * @property CategoryDto[] $categories
- * @property EnvironmentDto[] $environments
+ * @property VariableDto[] $variables
  */
 class ProjectDto extends DataTransferObject
 {
     protected $casts = [
-        'environments' => EnvironmentDto::class,
         'categories' => CategoryDto::class,
-        'version'=>'string'
+        'version' => 'string',
+        'variables*' => VariableDto::class
     ];
 
     protected $hidden = [
@@ -35,13 +35,13 @@ public function __construct($arguments)
     public function jsonSerialize()
     {
         $return = [
-            'name'=>$this->name,
-            'version'=>$this->version,
-            'description'=>$this->description,
-            'buildDate'=>$this->buildDate,
+            'name' => $this->name,
+            'version' => $this->version,
+            'description' => $this->description,
+            'buildDate' => $this->buildDate,
         ];
-        if ($this->environments) {
-            $return['environments'] = $this->environments;
+        if ($this->variables) {
+            $return['variables'] = $this->variables;
         }
         if ($this->logo) {
             $return['logo'] = $this->logo;

src/DTO/EnvironmentDto.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace MultidocParser\DTO;
+
+use SparkleDto\DataTransferObject;
+
+/**
+ * @property string $default
+ * @property string $description
+ */
+class VariableDto extends DataTransferObject
+{
+
+}

src/DTO/ProjectDto.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace MultidocParser\Exceptions;
+
+class DefinitionFileException extends \Exception
+{
+
+}

src/DTO/VariableDto.php

@@ -5,6 +5,7 @@
 use MultidocParser\DTO\ProjectDto;
 use MultidocParser\DTO\RouteDto;
 use MultidocParser\Exceptions\CategoriesNotFoundException;
+use MultidocParser\Exceptions\DefinitionFileException;
 use MultidocParser\Exceptions\MultipleProjectsException;
 use MultidocParser\Exceptions\ProjectNotDefinedException;
 use MultidocParser\Exceptions\RoutesNotDefinedException;
@@ -27,6 +28,9 @@ class FileContentParserService
     public const PARAMETER_TYPE_FILE = 'file';
     public const TEMPLATES_KEY = 'templates';
     public const PROJECT_KEY = 'project';
+    public const VARIABLES_KEY = 'variables';
+    // Protected because it composes routed in the ui
+    public const ENVIRONMENT_KEY = 'environment';
 
     private DataNormalizer $dataNormalizer;
     private CategoryNormalizer $categoryNormalizer;
@@ -112,6 +116,7 @@ private function readFiles($fileList)
      * @throws ProjectNotDefinedException
      * @throws RoutesNotDefinedException
      * @throws CategoriesNotFoundException
+     * @throws DefinitionFileException
      */
     private function validateParsedData(array $data)
     {

src/Exceptions/DefinitionFileException.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace MultidocParser\Tests\Feature;
+
+use MultidocParser\Tests\MultidocParserTestFeature;
+
+class VariablesFeatureTest extends MultidocParserTestFeature
+{
+    protected string $dataPath = __DIR__.'/../data_in/variables';
+    protected string $outPath = __DIR__.'/../data_out/variables';
+
+    public function test_basic_template_exist()
+    {
+         $this->assertRouteHasParameterName('userId','User retrieval', $this->project);
+         $this->assertRouteHasHeaders(['Accept'=>'application/json'], 'User deletion', $this->project);
+         $this->assertRouteHasHeaders(['Authorization'=>'Bearer APPLICATION_TOKEN'], 'User deletion', $this->project);
+         $this->assertHasVariables($this->project);
+         $this->assertHasVariable('OTHER_TOKEN', $this->project);
+    }
+}