Merge branch 'feature/sf5' of github.com:yoanm/symfony-jsonrpc-http-server-doc into release/1.0.0

yoanm · yoanm · commit 221626d04c03 · 2020-03-28T11:27:16.000+01:00
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1 @@
+*       @yoanm
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,6 @@ build
 composer.lock
 
 features/demo_app/var/
+
+#Phpunit
+.phpunit.result.cache
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
@@ -11,18 +11,28 @@ build_failure_conditions:
 build:
     dependencies:
         override:
-            - make build
+            -
+                command: make build
+                title: Build deps
     tests:
         stop_on_failure: true
         override:
             -
                 command: make coverage
+                title: Coverage
                 idle_timeout: 1200
                 coverage:
                     file: 'build/coverage/clover.xml'
                     format: 'php-clover'
-            - php-scrutinizer-run --enable-security-analysis
-            - make codestyle
+            -
+              command: make codestyle
+              title: Code style
+            -
+              command: composer global require maglnet/composer-require-checker && composer-require-checker check composer.json
+              title: Composer-require-checker
+            -
+              command: php-scrutinizer-run --enable-security-analysis
+              title: Scrutinizer checks
     cache:
         directories:
             - ~/.composer
@@ -36,7 +46,7 @@ build:
             COVERAGE_OUTPUT_STYLE: 'clover'
             COVERAGE_CLOVER_FILE_PATH: 'build/coverage/clover.xml'
         php:
-            version: "7.1"
+            version: "7.3"
         timezone: UTC
         postgresql: false
         redis: false
diff --git a/.travis.yml b/.travis.yml
@@ -1,24 +1,21 @@
 language: php
 
 php:
-  - '7.1'
   - '7.2'
   - '7.3'
   - '7.4'
 
 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
-
-matrix:
+    - CI: 'true'
+    - TEST_OUTPUT_STYLE: 'pretty'
+    - PHPCS_REPORT_STYLE: 'full'
+    - COMPOSER_OPTIONS: '--optimize-autoloader'
+  jobs:
+    - SYMFONY_VERSION: '~4.0'
+    - SYMFONY_VERSION: '~5.0'
+
+jobs:
   fast_finish: true
 
 before_install:
@@ -41,3 +38,4 @@ branches:
   except:
   - /.*\-dev$/
   - /.*\-patch(\-\d+)?$/
+  - /^dev-.*/
diff --git a/README.md b/README.md
@@ -3,13 +3,13 @@
 
 [![Scrutinizer Build Status](https://img.shields.io/scrutinizer/build/g/yoanm/symfony-jsonrpc-http-server-doc.svg?label=Scrutinizer&logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/symfony-jsonrpc-http-server-doc/build-status/master) [![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/yoanm/symfony-jsonrpc-http-server-doc/master.svg?logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/symfony-jsonrpc-http-server-doc/?branch=master) [![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/yoanm/symfony-jsonrpc-http-server-doc/master.svg?logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/symfony-jsonrpc-http-server-doc/?branch=master)
 
-[![Travis Build Status](https://img.shields.io/travis/com/yoanm/symfony-jsonrpc-http-server-doc/master.svg?label=Travis&logo=travis)](https://travis-ci.com/yoanm/symfony-jsonrpc-http-server-doc) <!-- NOT WORKING WITH travis-ci.com [![Travis PHP versions](https://img.shields.io/travis/php-v/yoanm/symfony-jsonrpc-http-server-doc.svg?logo=travis)](https://php.net/) --> [![Travis Symfony Versions](https://img.shields.io/badge/Symfony-v3%20%2F%20v4-8892BF.svg?logo=travis)](https://symfony.com/)
+[![Travis Build Status](https://img.shields.io/travis/com/yoanm/symfony-jsonrpc-http-server-doc/master.svg?label=Travis&logo=travis)](https://travis-ci.com/yoanm/symfony-jsonrpc-http-server-doc) <!-- NOT WORKING WITH travis-ci.com [![Travis PHP versions](https://img.shields.io/travis/php-v/yoanm/symfony-jsonrpc-http-server-doc.svg?logo=travis)](https://php.net/) --> [![Travis Symfony Versions](https://img.shields.io/badge/Symfony-v4%20%2F%20v5-8892BF.svg?logo=travis)](https://symfony.com/)
 
 [![Latest Stable Version](https://img.shields.io/packagist/v/yoanm/symfony-jsonrpc-http-server-doc.svg)](https://packagist.org/packages/yoanm/symfony-jsonrpc-http-server-doc) [![Packagist PHP version](https://img.shields.io/packagist/php-v/yoanm/symfony-jsonrpc-http-server-doc.svg)](https://packagist.org/packages/yoanm/symfony-jsonrpc-http-server-doc)
 
 Symfony bundle for easy JSON-RPC server documentation
 
-Symfony bundle for [`yoanm/jsonrpc-server-doc-sdk`](https://raw.githubusercontent.com/yoanm/php-jsonrpc-server-doc-sdk)
+Symfony bundle for [`yoanm/jsonrpc-server-doc-sdk`](https://github.com/yoanm/php-jsonrpc-server-doc-sdk)
 
 See [yoanm/symfony-jsonrpc-params-sf-constraints-doc](https://github.com/yoanm/symfony-jsonrpc-params-sf-constraints-doc) for params documentation generation.
 
diff --git a/composer.json b/composer.json
@@ -32,22 +32,25 @@
     "yoanm/symfony-jsonrpc-http-server-swagger-doc": "Symfony bundle for easy JSON-RPC server Swagger 2.0 documentation"
   },
   "require": {
-    "php": ">=7.1",
+    "ext-json": "*",
+    "php": ">=7.2",
     "yoanm/jsonrpc-server-sdk": "^3.0",
     "yoanm/jsonrpc-server-doc-sdk": "^0.2",
-    "yoanm/symfony-jsonrpc-http-server": "^2.0",
-    "symfony/http-kernel": "^3.0 || ^4.0",
-    "symfony/config": "^3.0 || ^4.0",
-    "symfony/dependency-injection": "^3.0 || ^4.0"
+    "yoanm/symfony-jsonrpc-http-server": "^3.0",
+    "symfony/http-foundation": "^4.0 || ^5.0",
+    "symfony/http-kernel": "^4.0 || ^5.0",
+    "symfony/config": "^4.0 || ^5.0",
+    "symfony/dependency-injection": "^4.0 || ^5.0",
+    "symfony/event-dispatcher-contracts": "^1.0 || ^2.0"
   },
   "require-dev": {
     "behat/behat": "~3.0",
     "squizlabs/php_codesniffer": "3.*",
     "phpunit/phpunit": "^7.0 || ^8.0",
     "matthiasnoback/symfony-dependency-injection-test": "^3.0 || ^4.0",
     "matthiasnoback/symfony-config-test": "^3.0 || ^4.0",
-    "symfony/framework-bundle": "^3.0 || ^4.0",
-    "symfony/routing": "^3.0 || ^4.0",
+    "symfony/framework-bundle": "^4.0 || ^5.0",
+    "symfony/routing": "^4.0 || ^5.0",
     "yoanm/php-unit-extended": "~1.0"
   }
 }
diff --git a/src/Creator/HttpServerDocCreator.php b/src/Creator/HttpServerDocCreator.php
@@ -1,7 +1,7 @@
 <?php
 namespace Yoanm\SymfonyJsonRpcHttpServerDoc\Creator;
 
-use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 use Yoanm\JsonRpcServer\Domain\JsonRpcMethodAwareInterface;
 use Yoanm\JsonRpcServer\Domain\JsonRpcMethodInterface;
 use Yoanm\JsonRpcServerDoc\Domain\Model\HttpServerDoc;
@@ -49,7 +49,7 @@ public function create($host = null) : HttpServerDoc
         $this->appendMethodsDoc($serverDoc);
 
         $event = new ServerDocCreatedEvent($serverDoc);
-        $this->dispatcher->dispatch($event::EVENT_NAME, $event);
+        $this->dispatcher->dispatch($event, $event::EVENT_NAME);
 
         return $serverDoc;
     }
@@ -75,7 +75,7 @@ protected function appendMethodsDoc(ServerDoc $serverDoc)
             )
                 ->setMethod($method);
 
-            $this->dispatcher->dispatch($event::EVENT_NAME, $event);
+            $this->dispatcher->dispatch($event, $event::EVENT_NAME);
 
             $serverDoc->addMethod($event->getDoc());
         }
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -15,9 +15,9 @@ class Configuration implements ConfigurationInterface
      */
     public function getConfigTreeBuilder()
     {
-        $treeBuilder = new TreeBuilder();
+        $treeBuilder = new TreeBuilder(JsonRpcHttpServerDocExtension::EXTENSION_IDENTIFIER);
 
-        $rootNode = $treeBuilder->root(JsonRpcHttpServerDocExtension::EXTENSION_IDENTIFIER);
+        $rootNode = $treeBuilder->getRootNode();
 
         $rootNode
             ->addDefaultsIfNotSet()
diff --git a/src/Endpoint/DocumentationEndpoint.php b/src/Endpoint/DocumentationEndpoint.php
@@ -35,8 +35,9 @@ public function httpOptions() : Response
         $response->headers->set('Content-Type', 'application/json');
 
         // Set allowed http methods
-        $response->headers->set('Allow', $this->allowedMethodList);
-        $response->headers->set('Access-Control-Request-Method', $this->allowedMethodList);
+        $allowedMethodListString = implode(', ', $this->allowedMethodList);
+        $response->headers->set('Allow', $allowedMethodListString);
+        $response->headers->set('Access-Control-Request-Method', $allowedMethodListString);
 
         // Set allowed content type
         $response->headers->set('Accept', 'application/json');
diff --git a/src/Event/DocEvent.php b/src/Event/DocEvent.php
@@ -2,7 +2,7 @@
 
 namespace Yoanm\SymfonyJsonRpcHttpServerDoc\Event;
 
-use Symfony\Component\EventDispatcher\Event;
+use Symfony\Contracts\EventDispatcher\Event;
 
 /**
  * Class DocEvent
diff --git a/tests/Functional/Creator/HttpServerDocCreatorTest.php b/tests/Functional/Creator/HttpServerDocCreatorTest.php
@@ -36,6 +36,10 @@ protected function setUp(): void
 
     public function testShouldCreateBasicDocWithoutMethods()
     {
+        $this->dispatcher->dispatch(Argument::type(ServerDocCreatedEvent::class), ServerDocCreatedEvent::EVENT_NAME)
+            ->willReturnArgument(0)
+            ->shouldBeCalled();
+
         $doc = $this->creator->create();
 
         $this->assertSame(
@@ -56,6 +60,10 @@ public function testShouldCreateBasicDocWithoutMethods()
 
     public function testShouldCreateDocWithHost()
     {
+        $this->dispatcher->dispatch(Argument::type(ServerDocCreatedEvent::class), ServerDocCreatedEvent::EVENT_NAME)
+            ->willReturnArgument(0)
+            ->shouldBeCalled();
+
         $host = 'my-host';
         $doc = $this->creator->create($host);
 
@@ -77,6 +85,14 @@ public function testShouldCreateDocWithHost()
 
     public function testShouldCreateDocWithMethodList()
     {
+        $this->dispatcher->dispatch(Argument::type(ServerDocCreatedEvent::class), ServerDocCreatedEvent::EVENT_NAME)
+            ->willReturnArgument(0)
+            ->shouldBeCalled();
+
+        $this->dispatcher->dispatch(Argument::type(MethodDocCreatedEvent::class), MethodDocCreatedEvent::EVENT_NAME)
+            ->willReturnArgument(0)
+            ->shouldBeCalledTimes(2);
+
         $method1Name = 'method-1';
         $method2Name = 'method-2';
         $method1 = $this->prophesize(JsonRpcMethodInterface::class);
@@ -114,9 +130,11 @@ public function testShouldDispatchServerDocCreatedEvent()
     {
         $docInEvent = null;
 
-        $this->dispatcher->dispatch(ServerDocCreatedEvent::EVENT_NAME, Argument::type(ServerDocCreatedEvent::class))
+        $this->dispatcher->dispatch(Argument::type(ServerDocCreatedEvent::class), ServerDocCreatedEvent::EVENT_NAME)
             ->will(function ($args) use (&$docInEvent) {
-                $docInEvent = $args[1]->getDoc();
+                $docInEvent = $args[0]->getDoc();
+
+                return $args[0];
             })
             ->shouldBeCalled();
 
@@ -137,34 +155,39 @@ public function testShouldDispatchMethodDocCreatedEvent()
         $this->creator->addJsonRpcMethod($method1Name, $method1->reveal());
         $this->creator->addJsonRpcMethod($method2Name, $method2->reveal());
 
-        $this->dispatcher->dispatch(ServerDocCreatedEvent::EVENT_NAME, Argument::cetera())
-            ->shouldBeCalled()
-        ;
+
+        $this->dispatcher->dispatch(Argument::type(ServerDocCreatedEvent::class), ServerDocCreatedEvent::EVENT_NAME)
+            ->willReturnArgument(0)
+            ->shouldBeCalled();
 
         $this->dispatcher->dispatch(
-            MethodDocCreatedEvent::EVENT_NAME,
             Argument::allOf(
                 Argument::type(MethodDocCreatedEvent::class),
                 Argument::which('getMethod', $method1->reveal())
-            )
+            ),
+            MethodDocCreatedEvent::EVENT_NAME
         )
             ->will(function ($args) use (&$docInEvent1) {
-                $docInEvent1 = $args[1]->getDoc();
+                $docInEvent1 = $args[0]->getDoc();
+
+                return $args[0];
             })
             ->shouldBeCalled();
-
         $this->dispatcher->dispatch(
-            MethodDocCreatedEvent::EVENT_NAME,
             Argument::allOf(
                 Argument::type(MethodDocCreatedEvent::class),
                 Argument::which('getMethod', $method2->reveal())
-            )
+            ),
+            MethodDocCreatedEvent::EVENT_NAME
         )
             ->will(function ($args) use (&$docInEvent2) {
-                $docInEvent2 = $args[1]->getDoc();
+                $docInEvent2 = $args[0]->getDoc();
+
+                return $args[0];
             })
             ->shouldBeCalled();
 
+
         $doc = $this->creator->create();
 
         [$method1Doc, $method2Doc] = $doc->getMethodList();
diff --git a/tests/Functional/Endpoint/DocumentationEndpointTest.php b/tests/Functional/Endpoint/DocumentationEndpointTest.php
@@ -89,7 +89,7 @@ public function testHttPostShouldHaveUseRawDocIfNoFilenameProvided()
 
     public function testHttOptionsShouldReturnAllowedMethodsAndContentType()
     {
-        $expectedAllowedMethodList = [Request::METHOD_GET, Request::METHOD_OPTIONS];
+        $expectedAllowedMethodList = implode(', ', [Request::METHOD_GET, Request::METHOD_OPTIONS]);
 
         $response = $this->endpoint->httpOptions();
 
