Improve (#6)

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

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": {
@@ -25,7 +25,7 @@
         }
     },
     "require": {
-        "php": ">=7.0",
+        "php": ">=7.1",
         "yoanm/jsonrpc-server-doc-sdk": "dev-release/1.0.0",
         "symfony/validator": "^3.0 || ^4.0"
     },

phpunit.xml.dist

@@ -8,9 +8,6 @@
          processIsolation="false"
 
          stopOnRisky="true"
-         processUncoveredFilesFromWhitelist="true"
-         addUncoveredFilesFromWhitelist="true"
-         checkForUnintentionallyCoveredCode="true"
 
          stopOnError="true"
          stopOnFailure="true"

src/App/Helper/ConstraintPayloadDocHelper.php

@@ -57,7 +57,10 @@ public function appendPayloadDoc(TypeDoc $doc, Constraint $constraint)
      */
     public function getTypeIfExist(Constraint $constraint)
     {
-        return $this->getPayloadDocValue($constraint, self::PAYLOAD_DOCUMENTATION_TYPE_KEY);
+        return $this->hasPayloadDoc($constraint)
+            ? $this->getPayloadDocValue($constraint, self::PAYLOAD_DOCUMENTATION_TYPE_KEY)
+            : null
+        ;
     }
 
     /**

src/Infra/Transformer/ConstraintToParamsDocTransformer.php

@@ -46,24 +46,10 @@ public function __construct(
      *
      * @return TypeDoc
      */
-    public function transform(Constraint $constraint)
-    {
-        return $this->docFromConstraint($constraint);
-    }
-
-    /**
-     * @param Constraint      $constraintOrConstraintList
-     * @param string|int|null $paramNameOrIndex
-     *
-     * @return TypeDoc
-     */
-    private function docFromConstraint(Constraint $constraint, $paramNameOrIndex = null)
+    public function transform(Constraint $constraint) : TypeDoc
     {
         $constraintList = [$constraint];
         $constraintDoc = $this->docTypeHelper->guess($constraintList);
-        if (null !== $paramNameOrIndex) {
-            $constraintDoc->setName($paramNameOrIndex);
-        }
 
         foreach ($constraintList as $constraint) {
             $this->appendToDoc($constraintDoc, $constraint);
@@ -76,7 +62,7 @@ private function docFromConstraint(Constraint $constraint, $paramNameOrIndex = n
      * @param TypeDoc $doc
      * @param Constraint   $constraint
      */
-    private function appendToDoc(TypeDoc $doc, Constraint $constraint)
+    private function appendToDoc(TypeDoc $doc, Constraint $constraint) : void
     {
         if ($doc instanceof ArrayDoc && $constraint instanceof Assert\All) {
             $this->appendAllConstraintToDoc($doc, $constraint);
@@ -105,7 +91,7 @@ private function appendToDoc(TypeDoc $doc, Constraint $constraint)
      * @param TypeDoc $doc
      * @param Constraint $constraint
      */
-    private function appendCollectionDoc(TypeDoc $doc, Constraint $constraint)
+    private function appendCollectionDoc(TypeDoc $doc, Constraint $constraint) : void
     {
         // If not a collection => give up
         if (!$doc instanceof CollectionDoc) {
@@ -115,7 +101,8 @@ private function appendCollectionDoc(TypeDoc $doc, Constraint $constraint)
         if ($constraint instanceof Assert\Collection) {
             foreach ($constraint->fields as $fieldName => $constraintOrConstrainList) {
                 $doc->addSibling(
-                    $this->docFromConstraint($constraintOrConstrainList, $fieldName)
+                    $this->transform($constraintOrConstrainList)
+                        ->setName($fieldName)
                 );
             }
 
@@ -128,7 +115,7 @@ private function appendCollectionDoc(TypeDoc $doc, Constraint $constraint)
      * @param TypeDoc $doc
      * @param Constraint $constraint
      */
-    private function appendValidItemListDoc(TypeDoc $doc, Constraint $constraint)
+    private function appendValidItemListDoc(TypeDoc $doc, Constraint $constraint) : void
     {
         if ($constraint instanceof Assert\Choice) {
             if ($constraint->callback && is_callable($constraint->callback)) {
@@ -146,7 +133,7 @@ private function appendValidItemListDoc(TypeDoc $doc, Constraint $constraint)
      * @param ArrayDoc   $doc
      * @param Assert\All $constraint
      */
-    private function appendAllConstraintToDoc(ArrayDoc $doc, Assert\All $constraint)
+    private function appendAllConstraintToDoc(ArrayDoc $doc, Assert\All $constraint) : void
     {
         $itemDoc = $this->docTypeHelper->guess($constraint->constraints);
         foreach ($constraint->constraints as $subConstraint) {

tests/Functional/App/Helper/ConstraintPayloadDocHelper/getTypeIfExistTest.php

@@ -22,7 +22,14 @@ public function setUp()
         $this->helper = new ConstraintPayloadDocHelper();
     }
 
-    public function testShouldReturnNullIfNotDefined()
+    public function testShouldReturnNullIfNoPayload()
+    {
+        $constraint = new Assert\Valid();
+
+        $this->assertNull($this->helper->getTypeIfExist($constraint));
+    }
+
+    public function testShouldReturnNullIfTypeIsNotDefined()
     {
         $constraint = new Assert\Valid();