v0.1.0

Author: yoanm

.scrutinizer.yml

@@ -15,14 +15,14 @@ build:
     tests:
         stop_on_failure: true
         override:
-            - php-scrutinizer-run --enable-security-analysis
-            - make codestyle
             -
                 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

.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/validator:$SYMFONY_VERSION
   - make build
 script:
   - make test-technical
@@ -31,3 +35,7 @@ cache:
   directories:
     - $HOME/.composer
     - vendor
+
+branches:
+  except:
+  - /.*\-dev$/

Makefile

@@ -6,6 +6,7 @@ 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
@@ -88,15 +89,21 @@ codestyle: create-reports-directory
 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,16 +1,61 @@
 # JSON-RPC params symfony constraint doc
- [![License](https://img.shields.io/github/license/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk.svg)](https://github.com/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk) [![Code size](https://img.shields.io/github/languages/code-size/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk.svg)](https://github.com/yoanm/php-jsonrpc-params-symfony-constraint-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/)
+[![License](https://img.shields.io/github/license/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk.svg)](https://github.com/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk) [![Code size](https://img.shields.io/github/languages/code-size/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk.svg)](https://github.com/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk) [![Dependencies](https://img.shields.io/librariesio/github/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk.svg)](https://libraries.io/packagist/yoanm%2Fjsonrpc-params-symfony-constraint-doc-sdk)
 
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk/?branch=master) [![Build Status](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk/badges/build.png?b=master)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk/build-status/master) [![Code Coverage](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk/?branch=master)
+[![Scrutinizer Build Status](https://img.shields.io/scrutinizer/build/g/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk.svg?label=Scrutinizer&logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk/build-status/master) [![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk/master.svg?logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk/?branch=master) [![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk/master.svg?logo=scrutinizer)](https://scrutinizer-ci.com/g/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk/?branch=master)
 
-[![Travis Build Status](https://img.shields.io/travis/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk/master.svg?label=travis)](https://travis-ci.org/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk) [![Travis PHP versions](https://img.shields.io/travis/php-v/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk.svg)](https://travis-ci.org/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk)
+[![Travis Build Status](https://img.shields.io/travis/com/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk/master.svg?label=Travis&logo=travis)](https://travis-ci.com/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk) [![Travis PHP versions](https://img.shields.io/travis/php-v/yoanm/php-jsonrpc-params-symfony-constraint-doc-sdk.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/)
 
 [![Latest Stable Version](https://img.shields.io/packagist/v/yoanm/jsonrpc-params-symfony-constraint-doc-sdk.svg)](https://packagist.org/packages/yoanm/jsonrpc-params-symfony-constraint-doc-sdk) [![Packagist PHP version](https://img.shields.io/packagist/php-v/yoanm/jsonrpc-params-symfony-constraint-doc-sdk.svg)](https://packagist.org/packages/yoanm/jsonrpc-params-symfony-constraint-doc-sdk)
 
 PHP SDK to generate JSON-RPC documentation from symfony constraint
 
+See [yoanm/symfony-jsonrpc-params-sf-constraints-doc](https://github.com/yoanm/symfony-jsonrpc-params-sf-constraints-doc) for automatic dependency injection.
+
 ## How to use
 
+Create the transformer : 
+```php
+use Yoanm\JsonRpcParamsSymfonyConstraintDoc\App\Helper\ConstraintPayloadDocHelper;
+use Yoanm\JsonRpcParamsSymfonyConstraintDoc\App\Helper\DocTypeHelper;
+use Yoanm\JsonRpcParamsSymfonyConstraintDoc\App\Helper\MinMaxHelper;
+use Yoanm\JsonRpcParamsSymfonyConstraintDoc\App\Helper\StringDocHelper;
+use Yoanm\JsonRpcParamsSymfonyConstraintDoc\App\Helper\TypeGuesser;
+use Yoanm\JsonRpcParamsSymfonyConstraintDoc\Infra\Transformer\ConstraintToParamsDocTransformer;
+
+$constraintPayloadDocHelper = new ConstraintPayloadDocHelper();
+
+$transformer = new ConstraintToParamsDocTransformer(
+  new DocTypeHelper(
+    $constraintPayloadDocHelper,
+    new TypeGuesser()
+  ),
+  new StringDocHelper(),
+  new MinMaxHelper(),
+  $constraintPayloadDocHelper
+);
+```
+
+Then use it with single constraint or a list of : 
+```php
+use Symfony\Component\Validator\Constraints as ConstraintNS;
+use Yoanm\JsonRpcServerDoc\Domain\Model\Type\ObjectDoc;
+use Yoanm\JsonRpcServerDoc\Domain\Model\Type\StringDoc;
+
+$constraint = new ConstraintNS\Collection([
+  'a' => new ConstraintNS\Type('string'),
+  'b' => new ConstraintNS\Type('integer'),
+  'c' => new ConstraintNS\Type('bool')
+]);
+
+/** @var ObjectDoc $constraintDoc */
+$constraintDoc = $transformer->transform($constraint);
+
+/** @var StringDoc $constraintDoc2 */
+$constraintDoc2 = $transformer->transformList([
+  new ConstraintNS\Type('string'),
+  new ConstraintNS\NotNull()
+]);
+```
 
 ## Contributing
 See [contributing note](./CONTRIBUTING.md)

behat.yml

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

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "yoanm/jsonrpc-params-symfony-constraint-doc-sdk",
-    "description": "Simple JSON-RPC params validator that use Symfony validator component",
+    "description": "SDK to generate JSON-RPC documentation from symfony constraint",
     "license": "MIT",
     "type": "library",
     "support": {
@@ -24,16 +24,20 @@
             "Tests\\Functional\\BehatContext\\": "features/bootstrap"
         }
     },
+    "suggest": {
+        "yoanm/symfony-jsonrpc-params-sf-constraints-doc": "Symfony bundle for easy Symfony constraints to JSON-RPC documentation transformation",
+        "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.0",
-        "yoanm/jsonrpc-server-doc-sdk": "dev-release/1.0.0",
+        "php": ">=7.1",
+        "yoanm/jsonrpc-server-doc-sdk": "v0.1.0",
         "symfony/validator": "^3.0 || ^4.0"
     },
     "require-dev": {
         "behat/behat": "~3.0",
         "squizlabs/php_codesniffer": "3.*",
         "phpunit/phpunit": "^6.0 || ^7.0",
         "yoanm/php-unit-extended": "^1.0"
-    },
-    "minimum-stability": "dev"
+    }
 }

features/01_basic-constraints/blank-constraints.feature

@@ -0,0 +1,98 @@
+Feature: ConstraintToParamsDocTransformer - NotBlank & Blank constraints
+
+  Scenario: Simple NotBlank constraint
+    Given I have the following Constraint:
+    """
+    use Symfony\Component\Validator\Constraints as ConstraintNS;
+    return new ConstraintNS\NotBlank();
+    """
+    When I transform constraint
+    Then I should have a constraint doc of class "Yoanm\JsonRpcServerDoc\Domain\Model\Type\TypeDoc"
+    ## Check others properties
+    And constraint doc "getName" should return null
+    And constraint doc "getDescription" should return null
+    And constraint doc "getDefault" should return null
+    And constraint doc "getExample" should return null
+    And constraint doc "isRequired" should return false
+    And constraint doc "isNullable" should return true
+
+  Scenario: Simple NotBlank constraint with string type specified
+    Given I have the following Constraint:
+    """
+    use Symfony\Component\Validator\Constraints as ConstraintNS;
+    return new ConstraintNS\NotBlank([
+      'payload' => [
+        'documentation' => [
+          'type' => 'string'
+        ]
+      ]
+    ]);
+    """
+    When I transform constraint
+    Then I should have a constraint doc of class "Yoanm\JsonRpcServerDoc\Domain\Model\Type\StringDoc"
+    And constraint doc "getMinLength" should return the number 1
+    ## Check others properties
+    And constraint doc "getName" should return null
+    And constraint doc "getDescription" should return null
+    And constraint doc "getDefault" should return null
+    And constraint doc "getExample" should return null
+    And constraint doc "isRequired" should return false
+    And constraint doc "isNullable" should return true
+    And constraint doc "getAllowedValueList" should return an empty array
+    And constraint doc "getFormat" should return null
+    And constraint doc "getMaxLength" should return null
+
+  Scenario: Simple NotBlank constraint with array type specified
+    Given I have the following Constraint:
+    """
+    use Symfony\Component\Validator\Constraints as ConstraintNS;
+    return new ConstraintNS\NotBlank([
+      'payload' => [
+        'documentation' => [
+          'type' => 'array'
+        ]
+      ]
+    ]);
+    """
+    When I transform constraint
+    Then I should have a constraint doc of class "Yoanm\JsonRpcServerDoc\Domain\Model\Type\ArrayDoc"
+    And constraint doc "getMinItem" should return the number 1
+    ## Check others properties
+    And constraint doc "getName" should return null
+    And constraint doc "getDescription" should return null
+    And constraint doc "getDefault" should return null
+    And constraint doc "getExample" should return null
+    And constraint doc "isRequired" should return false
+    And constraint doc "isNullable" should return true
+    And constraint doc "getAllowedValueList" should return an empty array
+    And constraint doc "getSiblingList" should return an empty array
+    And constraint doc "getMaxItem" should return null
+    And constraint doc "isAllowExtraSibling" should return false
+    And constraint doc "isAllowMissingSibling" should return false
+    And constraint doc "getItemValidation" should return null
+
+  Scenario: Simple Blank constraint with string type specified
+    Given I have the following Constraint:
+    """
+    use Symfony\Component\Validator\Constraints as ConstraintNS;
+    return new ConstraintNS\Blank([
+      'payload' => [
+        'documentation' => [
+          'type' => 'string'
+        ]
+      ]
+    ]);
+    """
+    When I transform constraint
+    Then I should have a constraint doc of class "Yoanm\JsonRpcServerDoc\Domain\Model\Type\StringDoc"
+    And constraint doc "getMaxLength" should return the number 0
+    ## Check others properties
+    And constraint doc "getName" should return null
+    And constraint doc "getDescription" should return null
+    And constraint doc "getDefault" should return null
+    And constraint doc "getExample" should return null
+    And constraint doc "isRequired" should return false
+    And constraint doc "isNullable" should return true
+    And constraint doc "getAllowedValueList" should return an empty array
+    And constraint doc "getFormat" should return null
+    And constraint doc "getMinLength" should return null