Improve (#2)

Author: yoanm

.scrutinizer.yml

@@ -15,18 +15,14 @@ build:
     tests:
         stop_on_failure: true
         override:
-            - php-scrutinizer-run --enable-security-analysis
-            -
-                command: make codestyle
-                analysis:
-                      file: 'build/reports/cs-data'
-                      format: 'php-cs-checkstyle'
             -
                 command: make coverage
                 idle_timeout: 1200
                 coverage:
                     file: 'build/coverage/clover.xml'
                     format: 'php-clover'
+            - php-scrutinizer-run --enable-security-analysis
+            - make codestyle
     cache:
         directories:
             - ~/.composer
@@ -39,8 +35,6 @@ build:
             COMPOSER_OPTIONS: '--optimize-autoloader'
             COVERAGE_OUTPUT_STYLE: 'clover'
             COVERAGE_CLOVER_FILE_PATH: 'build/coverage/clover.xml'
-            PHPCS_REPORT_STYLE: 'checkstyle'
-            PHPCS_REPORT_FILE: 'build/reports/cs-data'
         php:
             version: "7.1"
         timezone: UTC

.travis.yml

@@ -1,16 +1,19 @@
 language: php
 
 php:
-  - '7.0'
   - '7.1'
   - '7.2'
+  - '7.3'
 
 env:
   global:
     CI: 'true'
     TEST_OUTPUT_STYLE: 'pretty'
     PHPCS_REPORT_STYLE: 'full'
     COMPOSER_OPTIONS: '--optimize-autoloader'
+  matrix:
+  - SYMFONY_VERSION: '~3.0'
+  - SYMFONY_VERSION: '~4.0'
 
 sudo: false
 
@@ -19,9 +22,10 @@ matrix:
 
 before_install:
   # remove xdebug to speed up build
-  - phpenv config-rm xdebug.ini
+  - phpenv config-rm xdebug.ini || true
 
 install:
+  - composer require symfony/http-foundation:$SYMFONY_VERSION symfony/http-kernel:$SYMFONY_VERSION symfony/config:$SYMFONY_VERSION symfony/dependency-injection:$SYMFONY_VERSION
   - make build
 script:
   - make test-technical

composer.json

@@ -2,6 +2,7 @@
     "name": "yoanm/symfony-jsonrpc-http-server-swagger-doc",
     "description": "Symfony bundle for easy JSON-RPC server Swagger 2.0 documentation",
     "license": "MIT",
+    "minimum-stability": "dev",
     "type": "library",
     "support": {
         "issues": "https://github.com/yoanm/symfony-jsonrpc-http-server-swagger-doc/issues"
@@ -25,10 +26,10 @@
         }
     },
     "require": {
-        "php": ">=5.5",
-        "yoanm/jsonrpc-server-doc-sdk": "dev-feature/improve",
-        "yoanm/jsonrpc-http-server-swagger-doc-sdk": "dev-feature/improve",
-        "yoanm/symfony-jsonrpc-http-server-doc": "dev-feature/improve",
+        "php": ">=7.1",
+        "yoanm/jsonrpc-server-doc-sdk": "dev-release/1.0.0",
+        "yoanm/jsonrpc-http-server-swagger-doc-sdk": "dev-release/1.0.0",
+        "yoanm/symfony-jsonrpc-http-server-doc": "dev-release/0.1.0",
         "symfony/http-foundation": "^3.0 || ^4.0",
         "symfony/http-kernel": "^3.0 || ^4.0",
         "symfony/config": "^3.0 || ^4.0",

src/DependencyInjection/JsonRpcHttpServerSwaggerDocExtension.php

@@ -0,0 +1,53 @@
+<?php
+namespace Yoanm\SymfonyJsonRpcHttpServerSwaggerDoc\DependencyInjection;
+
+use Symfony\Component\Config\FileLocator;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
+use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
+
+/**
+ * Class JsonRpcHttpServerSwaggerDocExtension
+ */
+class JsonRpcHttpServerSwaggerDocExtension implements ExtensionInterface
+{
+    // Extension identifier (used in configuration for instance)
+    const EXTENSION_IDENTIFIER = 'json_rpc_http_server_swagger_doc';
+
+    /**
+     * {@inheritdoc}
+     */
+    public function load(array $configs, ContainerBuilder $container)
+    {
+        $loader = new YamlFileLoader(
+            $container,
+            new FileLocator(__DIR__.'/../Resources/config')
+        );
+        $loader->load('services.sdk.yaml');
+        $loader->load('services.public.yaml');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getNamespace()
+    {
+        return 'http://example.org/schema/dic/'.$this->getAlias();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getXsdValidationBasePath()
+    {
+        return '';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getAlias()
+    {
+        return self::EXTENSION_IDENTIFIER;
+    }
+}

src/Event/SwaggerDocCreatedEvent.php

@@ -0,0 +1,58 @@
+<?php
+namespace Yoanm\SymfonyJsonRpcHttpServerSwaggerDoc\Event;
+
+use Yoanm\JsonRpcServerDoc\Domain\Model\HttpServerDoc;
+use Yoanm\SymfonyJsonRpcHttpServerDoc\Event\DocEvent;
+
+/**
+ * Class SwaggerDocCreatedEvent
+ */
+class SwaggerDocCreatedEvent extends DocEvent
+{
+    const EVENT_NAME = 'json_rpc_http_server_swagger_doc.array_created';
+
+    /** @var array */
+    private $swaggerDoc;
+    /** @var HttpServerDoc|null */
+    private $serverDoc;
+
+    /**
+     * @param array              $swaggerDoc
+     * @param HttpServerDoc|null $serverDoc
+     */
+    public function __construct(
+        array $swaggerDoc,
+        HttpServerDoc $serverDoc = null
+    ) {
+        $this->swaggerDoc = $swaggerDoc;
+        $this->serverDoc = $serverDoc;
+    }
+
+    /**
+     * @return HttpServerDoc
+     */
+    public function getSwaggerDoc()
+    {
+        return $this->swaggerDoc;
+    }
+
+    /**
+     * @return HttpServerDoc|null
+     */
+    public function getServerDoc()
+    {
+        return $this->serverDoc;
+    }
+
+    /**
+     * @param array $swaggerDoc
+     *
+     * @return SwaggerDocCreatedEvent
+     */
+    public function setSwaggerDoc(array $swaggerDoc)
+    {
+        $this->swaggerDoc = $swaggerDoc;
+
+        return $this;
+    }
+}

src/JsonRpcHttpServerSwaggerDocBundle.php

@@ -0,0 +1,11 @@
+<?php
+namespace Yoanm\SymfonyJsonRpcHttpServerSwaggerDoc;
+
+use Symfony\Component\HttpKernel\Bundle\Bundle;
+
+/**
+ * Class JsonRpcHttpServerSwaggerDocBundle
+ */
+class JsonRpcHttpServerSwaggerDocBundle extends Bundle
+{
+}

src/Provider/DocProvider.php

@@ -0,0 +1,60 @@
+<?php
+namespace Yoanm\SymfonyJsonRpcHttpServerSwaggerDoc\Provider;
+
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use Yoanm\JsonRpcHttpServerSwaggerDoc\Infra\Normalizer\DocNormalizer;
+use Yoanm\SymfonyJsonRpcHttpServerDoc\Creator\HttpServerDocCreator;
+use Yoanm\SymfonyJsonRpcHttpServerDoc\Provider\DocProviderInterface;
+use Yoanm\SymfonyJsonRpcHttpServerSwaggerDoc\Event\SwaggerDocCreatedEvent;
+
+/**
+ * Class DocProvider
+ */
+class DocProvider implements DocProviderInterface
+{
+    /** @var EventDispatcherInterface */
+    private $dispatcher;
+    /** @var HttpServerDocCreator */
+    private $serverDocCreator;
+    /** @var DocNormalizer */
+    private $docNormalizer;
+
+    /**
+     * @param EventDispatcherInterface $dispatcher
+     * @param HttpServerDocCreator     $serverDocCreator
+     * @param DocNormalizer            $docNormalizer
+     */
+    public function __construct(
+        EventDispatcherInterface $dispatcher,
+        HttpServerDocCreator $serverDocCreator,
+        DocNormalizer $docNormalizer
+    ) {
+        $this->dispatcher = $dispatcher;
+        $this->serverDocCreator = $serverDocCreator;
+        $this->docNormalizer = $docNormalizer;
+    }
+
+    /**
+     * @param string|null $host
+     *
+     * @return array
+     */
+    public function getDoc($host = null)
+    {
+        $rawDoc = $this->serverDocCreator->create($host);
+        $swaggerDoc = $this->docNormalizer->normalize($rawDoc);
+
+        $event = new SwaggerDocCreatedEvent($swaggerDoc, $rawDoc);
+        $this->dispatcher->dispatch($event::EVENT_NAME, $event);
+
+        return $event->getSwaggerDoc();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function supports($filename, $host = null)
+    {
+        return 'swagger.json' === $filename;
+    }
+}

src/Resources/config/services.public.yaml

@@ -0,0 +1,11 @@
+services:
+  _defaults:
+    public: true
+
+  json_rpc_http_server_swagger_doc.provider:
+    class: Yoanm\SymfonyJsonRpcHttpServerSwaggerDoc\Provider\DocProvider
+    arguments:
+      - '@event_dispatcher'
+      - '@json_rpc_http_server_doc.creator.http_server'
+      - '@json_rpc_http_server_swagger_doc_sdk.normalizer.doc'
+    tags: ['json_rpc_server_doc.doc_provider']

src/Resources/config/services.sdk.yaml

@@ -0,0 +1,58 @@
+services:
+  _defaults:
+    public: true
+
+
+  # Def resolver
+  json_rpc_http_server_swagger_doc_sdk.resolver.definition_ref:
+    class: Yoanm\JsonRpcHttpServerSwaggerDoc\App\Resolver\DefinitionRefResolver
+
+
+  # Normalizer
+  json_rpc_http_server_swagger_doc_sdk.normalizer.doc:
+    class: Yoanm\JsonRpcHttpServerSwaggerDoc\Infra\Normalizer\DocNormalizer
+    arguments:
+     - '@json_rpc_http_server_swagger_doc_sdk.normalizer.component.external_schema_list'
+     - '@json_rpc_http_server_swagger_doc_sdk.normalizer.component.operation'
+
+  ## Components
+  json_rpc_http_server_swagger_doc_sdk.normalizer.component.shape:
+      class: Yoanm\JsonRpcHttpServerSwaggerDoc\App\Normalizer\Component\ShapeNormalizer
+  json_rpc_http_server_swagger_doc_sdk.normalizer.component.schema_type:
+    class: Yoanm\JsonRpcHttpServerSwaggerDoc\App\Normalizer\Component\SchemaTypeNormalizer
+  json_rpc_http_server_swagger_doc_sdk.normalizer.component.result_doc:
+    class: Yoanm\JsonRpcHttpServerSwaggerDoc\App\Normalizer\Component\ResultDocNormalizer
+    arguments:
+     - '@json_rpc_http_server_swagger_doc_sdk.resolver.definition_ref'
+  json_rpc_http_server_swagger_doc_sdk.normalizer.component.type:
+    class: Yoanm\JsonRpcHttpServerSwaggerDoc\App\Normalizer\Component\TypeDocNormalizer
+    arguments:
+     - '@json_rpc_http_server_swagger_doc_sdk.normalizer.component.schema_type'
+  json_rpc_http_server_swagger_doc_sdk.normalizer.component.error:
+    class: Yoanm\JsonRpcHttpServerSwaggerDoc\App\Normalizer\Component\ErrorDocNormalizer
+    arguments:
+     - '@json_rpc_http_server_swagger_doc_sdk.normalizer.component.type'
+     - '@json_rpc_http_server_swagger_doc_sdk.normalizer.component.shape'
+  json_rpc_http_server_swagger_doc_sdk.normalizer.component.external_schema_list:
+    class: Yoanm\JsonRpcHttpServerSwaggerDoc\App\Normalizer\Component\ExternalSchemaListDocNormalizer
+    arguments:
+     - '@json_rpc_http_server_swagger_doc_sdk.resolver.definition_ref'
+     - '@json_rpc_http_server_swagger_doc_sdk.normalizer.component.type'
+     - '@json_rpc_http_server_swagger_doc_sdk.normalizer.component.error'
+     - '@json_rpc_http_server_swagger_doc_sdk.normalizer.component.shape'
+  json_rpc_http_server_swagger_doc_sdk.normalizer.component.request:
+    class: Yoanm\JsonRpcHttpServerSwaggerDoc\App\Normalizer\Component\RequestDocNormalizer
+    arguments:
+     - '@json_rpc_http_server_swagger_doc_sdk.resolver.definition_ref'
+     - '@json_rpc_http_server_swagger_doc_sdk.normalizer.component.shape'
+  json_rpc_http_server_swagger_doc_sdk.normalizer.component.response:
+    class: Yoanm\JsonRpcHttpServerSwaggerDoc\App\Normalizer\Component\ResponseDocNormalizer
+    arguments:
+     - '@json_rpc_http_server_swagger_doc_sdk.resolver.definition_ref'
+     - '@json_rpc_http_server_swagger_doc_sdk.normalizer.component.shape'
+  json_rpc_http_server_swagger_doc_sdk.normalizer.component.operation:
+    class: Yoanm\JsonRpcHttpServerSwaggerDoc\App\Normalizer\Component\OperationDocNormalizer
+    arguments:
+     - '@json_rpc_http_server_swagger_doc_sdk.resolver.definition_ref'
+     - '@json_rpc_http_server_swagger_doc_sdk.normalizer.component.request'
+     - '@json_rpc_http_server_swagger_doc_sdk.normalizer.component.response'