v0.1.0

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,7 @@ 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'
+            PHPCS_DISABLE_WARNING: "true"
         php:
             version: "7.1"
         timezone: UTC

.travis.yml

@@ -1,9 +1,9 @@
 language: php
 
 php:
-  - '7.0'
   - '7.1'
   - '7.2'
+  - '7.3'
 
 env:
   global:
@@ -19,7 +19,7 @@ matrix:
 
 before_install:
   # remove xdebug to speed up build
-  - phpenv config-rm xdebug.ini
+  - phpenv config-rm xdebug.ini || true
 
 install:
   - make build
@@ -31,3 +31,7 @@ cache:
   directories:
     - $HOME/.composer
     - vendor
+
+branches:
+  except:
+  - /.*\-dev$/

Makefile

@@ -6,13 +6,15 @@ COVERAGE_OUTPUT_STYLE ?= html
 BUILD_DIRECTORY ?= build
 REPORTS_DIRECTORY ?= ${BUILD_DIRECTORY}/reports
 COVERAGE_DIRECTORY ?= ${BUILD_DIRECTORY}/coverage
+BEHAT_COVERAGE_DIRECTORY ?= ${BUILD_DIRECTORY}/behat-coverage
 COVERAGE_CLOVER_FILE_PATH ?= ${COVERAGE_DIRECTORY}/clover.xml
 
 ## Commands options
 ### Composer
 #COMPOSER_OPTIONS=
 ### Phpcs
 PHPCS_REPORT_STYLE ?= full
+PHPCS_DISABLE_WARNING ?= "false"
 #PHPCS_REPORT_FILE=
 #PHPCS_REPORT_FILE_OPTION=
 
@@ -51,6 +53,12 @@ ifneq ("${PHPCS_REPORT_FILE}","")
 	PHPCS_REPORT_FILE_OPTION ?= --report-file=${PHPCS_REPORT_FILE}
 endif
 
+ifneq ("${PHPCS_DISABLE_WARNING}","true")
+	PHPCS_DISABLE_WARNING_OPTION=
+else
+	PHPCS_DISABLE_WARNING_OPTION=-n
+endif
+
 
 ## Project build (install and configure)
 build: install configure
@@ -76,20 +84,26 @@ test-functional:
 	./vendor/bin/behat ${BEHAT_COLOR_OPTION} ${BEHAT_OUTPUT_STYLE_OPTION} --no-snippets
 
 codestyle: create-reports-directory
-	./vendor/bin/phpcs --standard=phpcs.xml.dist ${PHPCS_COLOR_OPTION} ${PHPCS_REPORT_FILE_OPTION} --report=${PHPCS_REPORT_STYLE}
+	./vendor/bin/phpcs ${PHPCS_DISABLE_WARNING_OPTION} --standard=phpcs.xml.dist ${PHPCS_COLOR_OPTION} ${PHPCS_REPORT_FILE_OPTION} --report=${PHPCS_REPORT_STYLE}
 
 coverage: create-coverage-directory
 	./vendor/bin/phpunit ${PHPUNIT_COLOR_OPTION} ${PHPUNIT_OUTPUT_STYLE_OPTION} ${PHPUNIT_COVERAGE_OPTION}
 
+behat-coverage: create-behat-coverage-directory
+	composer required leanphp/behat-code-coverage
+	./vendor/bin/behat ${BEHAT_COLOR_OPTION} ${BEHAT_OUTPUT_STYLE_OPTION} --no-snippets --profile coverage
 
 
 # Internal commands
 create-coverage-directory:
 	mkdir -p ${COVERAGE_DIRECTORY}
 
+create-behat-coverage-directory:
+	mkdir -p ${BEHAT_COVERAGE_DIRECTORY}
+
 create-reports-directory:
 	mkdir -p ${REPORTS_DIRECTORY}
 
 
-.PHONY: build install configure test test-technical test-functional codestyle coverage create-coverage-directory create-reports-directory
+.PHONY: build install configure test test-technical test-functional codestyle coverage behat-coverage create-coverage-directory create-behat-coverage-directory create-reports-directory
 .DEFAULT: build

README.md

@@ -1,15 +1,89 @@
-# JSON-RPC server symfony plugin
- [![License](https://img.shields.io/github/license/yoanm/php-jsonrpc-server-doc-sdk.svg)](https://github.com/yoanm/php-jsonrpc-server-doc-sdk) [![Code size](https://img.shields.io/github/languages/code-size/yoanm/php-jsonrpc-server-doc-sdk.svg)](https://github.com/yoanm/php-jsonrpc-server-doc-sdk) [![PHP Versions](https://img.shields.io/badge/php-7.0%20%2F%207.1%20%2F%207.2-8892BF.svg)](https://php.net/)
+# JSON-RPC server documentation
+[![License](https://img.shields.io/github/license/yoanm/php-jsonrpc-server-doc-sdk.svg)](https://github.com/yoanm/php-jsonrpc-server-doc-sdk) [![Code size](https://img.shields.io/github/languages/code-size/yoanm/php-jsonrpc-server-doc-sdk.svg)](https://github.com/yoanm/php-jsonrpc-server-doc-sdk) [![Dependencies](https://img.shields.io/librariesio/github/yoanm/php-jsonrpc-server-doc-sdk.svg)](https://libraries.io/packagist/yoanm%jsonrpc-server-doc-sdk)
 
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-server-doc-sdk/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-server-doc-sdk/?branch=master) [![Build Status](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-server-doc-sdk/badges/build.png?b=master)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-server-doc-sdk/build-status/master) [![Code Coverage](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-server-doc-sdk/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-server-doc-sdk/?branch=master)
+[![Scrutinizer Build Status](https://img.shields.io/scrutinizer/build/g/yoanm/php-jsonrpc-server-doc-sdk.svg?label=Scrutinizer&logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-server-doc-sdk/build-status/master) [![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/yoanm/php-jsonrpc-server-doc-sdk/master.svg?logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-server-doc-sdk/?branch=master) [![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/yoanm/php-jsonrpc-server-doc-sdk/master.svg?logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-server-doc-sdk/?branch=master)
 
-[![Travis Build Status](https://img.shields.io/travis/yoanm/php-jsonrpc-server-doc-sdk/master.svg?label=travis)](https://travis-ci.org/yoanm/php-jsonrpc-server-doc-sdk) [![Travis PHP versions](https://img.shields.io/travis/php-v/yoanm/php-jsonrpc-server-doc-sdk.svg)](https://travis-ci.org/yoanm/php-jsonrpc-server-doc-sdk)
+[![Travis Build Status](https://img.shields.io/travis/yoanm/php-jsonrpc-server-doc-sdk/master.svg?label=Travis&logo=travis)](https://travis-ci.org/yoanm/php-jsonrpc-server-doc-sdk) [![Travis PHP versions](https://img.shields.io/travis/php-v/yoanm/php-jsonrpc-server-doc-sdk.svg?logo=travis)](https://travis-ci.org/yoanm/php-jsonrpc-server-doc-sdk)
 
 [![Latest Stable Version](https://img.shields.io/packagist/v/yoanm/jsonrpc-server-doc-sdk.svg)](https://packagist.org/packages/yoanm/jsonrpc-server-doc-sdk) [![Packagist PHP version](https://img.shields.io/packagist/php-v/yoanm/jsonrpc-server-doc-sdk.svg)](https://packagist.org/packages/yoanm/jsonrpc-server-doc-sdk)
 
-Php SDK to generate Http JSON-RPC server documentation
+Php SDK to generate (Http) JSON-RPC server documentation
+
+See [yoanm/symfony-jsonrpc-http-server-doc](https://github.com/yoanm/symfony-jsonrpc-http-server-doc) for automatic dependency injection.
+
+See [yoanm/jsonrpc-params-symfony-constraint-doc-sdk](https://github.com/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk) for params documentation generation.
+
+## Availble formats
+
+ - Raw : Built-in `json` format
+ - Swagger : [yoanm/jsonrpc-http-server-swagger-doc-sdk](https://github.com/yoanm/php-jsonrpc-http-server-swagger-doc-sdk)
+ - OpenApi : [yoanm/jsonrpc-http-server-openapi-doc-sdk](https://github.com/yoanm/php-jsonrpc-http-server-openapi-doc-sdk)
 
 ## How to use
 
+### Php objects
+Available documentation objects:
+ - [`ServerDoc`](./src/Domain/Model/ServerDoc.php) and [`HttpServerDoc`](./src/Domain/Model/HttpServerDoc.php) for HTTP server
+ - [`MethodDoc`](./src/Domain/Model/MethodDoc.php)
+ - [`ErrorDoc`](./src/Domain/Model/ErrorDoc.php)
+ - [`TagDoc`](./src/Domain/Model/TagDoc.php) : Allow to tag methods
+ - Types : 
+   - [`TypeDoc`](./src/Domain/Model/Type/TypeDoc.php) : Basic type
+     - [`BooleanDoc`](./src/Domain/Model/Type/BooleanDoc.php)
+     - [`ScalarDoc`](./src/Domain/Model/Type/ScalarDoc.php)
+       - [`StringDoc`](./src/Domain/Model/Type/StringDoc.php)
+       - [`NumberDoc`](./src/Domain/Model/Type/NumberDoc.php)
+         - [`IntegerDoc`](./src/Domain/Model/Type/IntegerDoc.php)
+         - [`FloatDoc`](./src/Domain/Model/Type/FloatDoc.php)
+     - [`CollectionDoc`](./src/Domain/Model/Type/CollectionDoc.php)
+       - [`ArrayDoc`](./src/Domain/Model/Type/ArrayDoc.php)
+       - [`ObjectDoc`](./src/Domain/Model/Type/ObjectDoc.php)
+
+### Normalizers
+Available normalizers : 
+ - [`TypeDocNormalizer`](./src/Infra/Normalizer/TypeDocNormalizer.php)
+   ```php
+   use Yoanm\JsonRpcServerDoc\Infra\Normalizer\TypeDocNormalizer;
+   
+   $typeDocNormalizer = new TypeDocNormalizer();
+   ```
+ - [`TagDocNormalizer`](./src/Infra/Normalizer/TagDocNormalizer.php)
+   ```php
+   use Yoanm\JsonRpcServerDoc\Infra\Normalizer\TagDocNormalizer;
+   
+   $tagDocNormalizer = new TagDocNormalizer();
+   ```
+ - [`ErrorDocNormalizer`](./src/Infra/Normalizer/ErrorDocNormalizer.php)
+   ```php
+   use Yoanm\JsonRpcServerDoc\Infra\Normalizer\MethodDocNormalizer;
+   
+   $errorDocNormalizer = new ErrorDocNormalizer($typeDocNormalizer);
+   ```
+ - [`MethodDocNormalizer`](./src/Infra/Normalizer/MethodDocNormalizer.php)
+   ```php
+   use Yoanm\JsonRpcServerDoc\Infra\Normalizer\MethodDocNormalizer;
+   
+   $tagDocNormalizer = new MethodDocNormalizer(
+     $typeDocNormalizer,
+     $errorDocNormalizer
+   );
+   ```
+ - [`ServerDocNormalizer`](./src/Infra/Normalizer/ServerDocNormalizer.php) and [`HttpServerDocNormalizer`](./src/Infra/Normalizer/HttpServerDocNormalizer.php) for HTTP server
+   ```php
+   use Yoanm\JsonRpcServerDoc\Infra\Normalizer\ServerDocNormalizer;
+   use Yoanm\JsonRpcServerDoc\Infra\Normalizer\HttpServerDocNormalizer;
+   
+   $normalizer = new ServerDocNormalizer(
+     $methodDocNormalizer,
+     $tagDocNormalizer,
+     $errorDocNormalizer
+   );
+   
+   $httpNormalizer = new HttpServerDocNormalizer($normalizer);
+   ``` 
+
+
+
+
 ## Contributing
 See [contributing note](./CONTRIBUTING.md)

behat.yml

@@ -2,4 +2,18 @@ default:
   suites:
     default:
       contexts:
-        - Tests\Functional\BehatContext\FeatureContext: ~
+        - Tests\Functional\BehatContext\DocNormalizerContext: ~
+coverage:
+  extensions:
+    LeanPHP\Behat\CodeCoverage\Extension:
+      drivers:
+      - local
+      filter:
+        whitelist:
+          include:
+            directories:
+              'src': ~
+      report:
+        format:   html
+        options:
+          target: build/behat-coverage

composer.json

@@ -1,36 +1,45 @@
 {
-    "name": "yoanm/jsonrpc-server-doc-sdk",
-    "description": "SDK to generate Http JSON-RPC server documentation",
-    "license": "MIT",
-    "type": "library",
-    "support": {
-        "issues": "https://github.com/yoanm/php-jsonrpc-server-doc-sdk/issues"
-    },
-    "authors": [
-        {
-            "name": "Yoanm",
-            "email": "yoanm@users.noreply.github.com",
-            "role": "Developer"
-        }
-    ],
-    "autoload": {
-        "psr-4": {
-            "Yoanm\\JsonRpcServerDoc\\": "src"
-        }
-    },
-    "autoload-dev": {
-        "psr-4": {
-            "Tests\\": "tests",
-            "Tests\\Functional\\BehatContext\\": "features/bootstrap"
-        }
-    },
-    "require": {
-        "php": ">=7.0"
-    },
-    "require-dev": {
-        "behat/behat": "~3.0",
-        "squizlabs/php_codesniffer": "3.*",
-        "phpunit/phpunit": "^6.0 || ^7.0",
-        "yoanm/php-unit-extended": "~1.0"
+  "name": "yoanm/jsonrpc-server-doc-sdk",
+  "description": "SDK to generate (Http) JSON-RPC server documentation",
+  "license": "MIT",
+  "type": "library",
+  "support": {
+    "issues": "https://github.com/yoanm/php-jsonrpc-server-doc-sdk/issues"
+  },
+  "authors": [
+    {
+      "name": "Yoanm",
+      "email": "yoanm@users.noreply.github.com",
+      "role": "Developer"
     }
+  ],
+  "autoload": {
+    "psr-4": {
+      "Yoanm\\JsonRpcServerDoc\\": "src"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Tests\\": "tests",
+      "Tests\\Functional\\BehatContext\\": "features/bootstrap"
+    }
+  },
+  "suggest": {
+    "yoanm/jsonrpc-params-symfony-constraint-doc-sdk": "SDK to generate JSON-RPC documentation from symfony constraint",
+    "yoanm/jsonrpc-http-server-swagger-doc-sdk": "SDK to generate Http JSON-RPC server documentation for Swagger v2.0",
+    "yoanm/jsonrpc-http-server-openapi-doc-sdk": "SDK to generate Http JSON-RPC server documentation for OpenAPI v3.0.0",
+    "yoanm/jsonrpc-server-sdk": "Server SDK to convert a json-rpc request string into json-rpc response string",
+    "yoanm/symfony-jsonrpc-http-server-doc": "Symfony bundle for easy JSON-RPC server documentation",
+    "yoanm/symfony-jsonrpc-http-server": "Symfony Bundle to convert an HTTP json-rpc request into HTTP json-rpc response"
+  },
+  "require": {
+    "php": ">=7.1"
+  },
+  "require-dev": {
+    "ext-json": "*",
+    "behat/behat": "~3.0",
+    "squizlabs/php_codesniffer": "3.*",
+    "phpunit/phpunit": "^6.0 || ^7.0",
+    "yoanm/php-unit-extended": "~1.0"
+  }
 }

features/bootstrap/AbstractContext.php

@@ -0,0 +1,35 @@
+<?php
+namespace Tests\Functional\BehatContext;
+
+use Behat\Behat\Context\Context;
+
+class AbstractContext implements Context
+{
+    public function jsonDecode($encodedData)
+    {
+        $decoded = json_decode($encodedData, true);
+
+        if (JSON_ERROR_NONE != json_last_error()) {
+            throw new \Exception(
+                json_last_error_msg(),
+                json_last_error()
+            );
+        }
+
+        return $decoded;
+    }
+
+    /**
+     * @param object $object
+     * @param array  $decodedMethodCalls
+     */
+    protected function callMethods($object, array $decodedMethodCalls)
+    {
+        foreach ($decodedMethodCalls as $decodedMethodCall) {
+            call_user_func_array(
+                [$object, $decodedMethodCall['method']],
+                $decodedMethodCall['arguments'] ?? []
+            );
+        }
+    }
+}