💥

Author: Th3Mouk

.editorconfig

@@ -0,0 +1,17 @@
+root = true
+
+[*]
+end_of_line = lf
+indent_style = space
+charset = utf-8
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{php}]
+indent_size = 4
+
+[*.{json,yaml}]
+indent_size = 2
+
+[{Makefile,**.mk}]
+indent_style = tab

.gitignore

@@ -0,0 +1,3 @@
+vendor
+composer.lock
+.php_cs.cache

.php_cs.dist

@@ -0,0 +1,33 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->in([
+        __DIR__,
+    ])
+    ->exclude([
+        __DIR__.'/vendor',
+    ])
+;
+
+return PhpCsFixer\Config::create()
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@PSR2' => true,
+        'array_syntax' => ['syntax' => 'short'],
+        'ordered_imports' => true,
+        'no_alternative_syntax' => true,
+        'no_binary_string' => true,
+        'no_extra_blank_lines' => ['tokens' => ['break', 'continue', 'extra', 'return', 'throw', 'use', 'parenthesis_brace_block', 'square_brace_block', 'curly_brace_block']],
+        'no_null_property_initialization' => true,
+        'no_short_echo_tag' => true,
+        'no_superfluous_elseif' => true,
+        'no_unneeded_curly_braces' => true,
+        'no_unneeded_final_method' => true,
+        'no_unreachable_default_argument_value' => true,
+        'no_unset_on_property' => true,
+        'no_useless_else' => true,
+        'no_useless_return' => true,
+        'native_function_invocation' => ['include' => ['@compiler_optimized'], 'scope' => 'namespaced'],
+    ])
+    ->setFinder($finder)
+;

Command/GenerateCommand.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace Th3Mouk\OpenAPIGenerator\Command;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Finder\Finder;
+use Symfony\Component\Yaml\Yaml;
+use Th3Mouk\OpenAPIGenerator\PathHelper;
+
+final class GenerateCommand extends Command
+{
+    protected function configure()
+    {
+        $this
+            ->setName('generate')
+            ->setDescription('Generate the swagger.json')
+        ;
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $this->generateJson();
+        echo 'generated'.PHP_EOL;
+    }
+
+    private function generateJson()
+    {
+        $templateFile = (new Finder())
+            ->in(getRootPath().PathHelper::ROOT)
+            ->files()
+            ->name('swagger.yaml')
+        ;
+
+        if (empty($templateFile)) {
+            echo 'no swagger.yaml file found'.PHP_EOL;
+            return;
+        }
+
+        foreach ($templateFile as $current) {
+            $template = $current;
+            break;
+        }
+
+        $template = Yaml::parse($template->getContents());
+        $definitions = $template['definitions'] ?? [];
+        $paths = $template['paths'] ?? [];
+
+        foreach ($this->getContentGenerator(PathHelper::DEFINITIONS) as $definition) {
+            $definitions[] = $definition;
+        }
+
+        foreach ($this->getContentGenerator(PathHelper::PATHS) as $path) {
+            $paths[key($path)] = $path[key($path)];
+        }
+
+        $template['definitions'] = (object) $definitions;
+        $template['paths'] = (object) $paths;
+
+        if (!$file = fopen(getRootPath().PathHelper::ROOT.'/swagger.json', 'w')) {
+            echo 'error generating json file'.PHP_EOL;
+            return;
+        }
+
+        fwrite($file, json_encode($template, JSON_UNESCAPED_SLASHES));
+        fclose($file);
+    }
+
+    private function getContentGenerator($path): \Generator
+    {
+        foreach ((new Finder())->files()->in(getRootPath().$path)->name('*.yaml') as $file) {
+            yield Yaml::parse($file->getContents());
+        }
+    }
+}

Command/ScaffoldCommand.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Th3Mouk\OpenAPIGenerator\Command;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Th3Mouk\OpenAPIGenerator\PathHelper;
+
+final class ScaffoldCommand extends Command
+{
+    protected function configure()
+    {
+        $this
+            ->setName('scaffold')
+            ->setDescription('Scaffold all directories')
+        ;
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $basePath = getRootPath();
+        mkdir($basePath.PathHelper::PATHS, 0777, true);
+        mkdir($basePath.PathHelper::DEFINITIONS);
+        echo 'scaffolded'.PHP_EOL;
+    }
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Jérémy Marodon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,8 @@
+cs:
+	vendor/bin/php-cs-fixer fix --config=.php_cs.dist -v
+
+cs_dry_run:
+	vendor/bin/php-cs-fixer fix --config=.php_cs.dist -v --dry-run
+
+analyse:
+	vendor/bin/phpstan analyse -l 7 .

PathHelper.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Th3Mouk\OpenAPIGenerator;
+
+class PathHelper
+{
+    const ROOT = '/specs';
+    const PATHS = self::ROOT.'/paths';
+    const DEFINITIONS = self::ROOT.'/definitions';
+}

bin/openapi

@@ -0,0 +1,20 @@
+#!/usr/bin/env php
+<?php
+
+use Symfony\Component\Console\Application;
+use Symfony\Component\Console\Input\ArgvInput;
+use Th3Mouk\OpenAPIGenerator\Command\GenerateCommand;
+use Th3Mouk\OpenAPIGenerator\Command\ScaffoldCommand;
+
+set_time_limit(0);
+
+require __DIR__.'/../vendor/autoload.php';
+
+$input = new ArgvInput();
+
+$application = new Application();
+
+$application->add(new GenerateCommand());
+$application->add(new ScaffoldCommand());
+
+$application->run($input);

composer.json

@@ -0,0 +1,29 @@
+{
+    "name": "th3mouk/openapi-generator",
+    "description": "PHP library which provide a scaffolding and generate an OpenAPI file",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Jérémy Marodon",
+            "email": "marodon.jeremy@gmail.com"
+        }
+    ],
+    "require": {
+        "symfony/yaml": "^4.1",
+        "symfony/console": "^4.1",
+        "symfony/finder": "^4.1"
+    },
+    "require-dev": {
+      "phpstan/phpstan": "^0.10",
+      "friendsofphp/php-cs-fixer": "^2.12"
+    },
+    "bin": ["bin/openapi"],
+    "autoload": {
+        "psr-4": {
+            "Th3Mouk\\OpenAPIGenerator\\": ""
+        },
+        "files": [
+            "functions.php"
+        ]
+    }
+}

functions.php

@@ -0,0 +1,13 @@
+<?php
+
+if (!function_exists('getRootPath')) {
+    function getRootPath(): string
+    {
+        $dir = $rootDir = __DIR__;
+        while (!file_exists($dir.'/composer.lock')) {
+            $dir = \dirname($dir);
+        }
+
+        return $dir;
+    }
+}

phpstan.neon

@@ -0,0 +1,3 @@
+parameters:
+	excludes_analyse:
+		- %rootDir%/../../../vendor