Improve (#25)

Author: yoanm

composer.json

@@ -31,7 +31,7 @@
   },
   "require": {
     "php": ">=7.1",
-    "yoanm/jsonrpc-server-doc-sdk": "dev-release/0.1.0"
+    "yoanm/jsonrpc-server-doc-sdk": "v0.1.0"
   },
   "require-dev": {
     "ext-json": "*",

src/App/Helper/ArrayAppendHelperTrait.php

@@ -13,7 +13,7 @@ trait ArrayAppendHelperTrait
      *
      * @return array
      */
-    protected function appendIfValueHaveSiblings(string $key, array $value, array $doc = [])
+    protected function appendIfValueHaveSiblings(string $key, array $value, array $doc = []) : array
     {
         return $this->appendIf((count($value) > 0), $key, $value, $doc);
     }
@@ -25,7 +25,7 @@ protected function appendIfValueHaveSiblings(string $key, array $value, array $d
      *
      * @return array
      */
-    protected function appendIfValueNotNull(string $key, $value, array $doc = [])
+    protected function appendIfValueNotNull(string $key, $value, array $doc = []) : array
     {
         return $this->appendIf((null !== $value), $key, $value, $doc);
     }
@@ -38,7 +38,7 @@ protected function appendIfValueNotNull(string $key, $value, array $doc = [])
      *
      * @return array
      */
-    protected function appendIf(bool $doAppend, string $key, $value, array $doc = [])
+    protected function appendIf(bool $doAppend, string $key, $value, array $doc = []) : array
     {
         if (true === $doAppend) {
             $doc[$key] = $value;

src/App/Normalizer/Component/ErrorDocNormalizer.php

@@ -32,7 +32,7 @@ public function __construct(
      *
      * @throws \ReflectionException
      */
-    public function normalize(ErrorDoc $errorDoc)
+    public function normalize(ErrorDoc $errorDoc) : array
     {
         $requiredDoc = ['required' => ['code']];
         $properties = [

src/App/Normalizer/Component/ExternalSchemaListDocNormalizer.php

@@ -46,7 +46,7 @@ public function __construct(
      *
      * @throws \ReflectionException
      */
-    public function normalize(ServerDoc $doc)
+    public function normalize(ServerDoc $doc) : array
     {
         return array_merge(
             $this->getMethodsExternalSchemaList($doc),
@@ -63,7 +63,7 @@ public function normalize(ServerDoc $doc)
      *
      * @throws \ReflectionException
      */
-    protected function getMethodsExternalSchemaList(ServerDoc $doc)
+    protected function getMethodsExternalSchemaList(ServerDoc $doc) : array
     {
         $list = [];
         foreach ($doc->getMethodList() as $method) {
@@ -81,7 +81,7 @@ protected function getMethodsExternalSchemaList(ServerDoc $doc)
      *
      * @throws \ReflectionException
      */
-    protected function getMethodErrorsExternalSchemaList(ServerDoc $doc)
+    protected function getMethodErrorsExternalSchemaList(ServerDoc $doc) : array
     {
         $list = [];
         foreach ($doc->getMethodList() as $method) {
@@ -105,7 +105,7 @@ protected function getMethodErrorsExternalSchemaList(ServerDoc $doc)
      *
      * @throws \ReflectionException
      */
-    protected function getServerErrorsExtraSchemaList(ServerDoc $doc)
+    protected function getServerErrorsExtraSchemaList(ServerDoc $doc) : array
     {
         return array_merge(
             $this->normalizeErrorList(
@@ -154,9 +154,10 @@ protected function getMethodExternalSchemaList(MethodDoc $method) : array
 
     /**
      * @param ServerDoc $doc
+     *
      * @return array
      */
-    protected function getDefaultSchemaList(ServerDoc $doc)
+    protected function getDefaultSchemaList(ServerDoc $doc) : array
     {
         $propertyList = [
             'code' => [
@@ -213,7 +214,7 @@ function (ErrorDoc $errorDoc) {
      *
      * @throws \ReflectionException
      */
-    private function normalizeErrorList(array $errorDocList, $definitionType)
+    private function normalizeErrorList(array $errorDocList, $definitionType) : array
     {
         $list = [];
         foreach ($errorDocList as $errorDoc) {
@@ -234,7 +235,7 @@ private function normalizeErrorList(array $errorDocList, $definitionType)
      *
      * @throws \ReflectionException
      */
-    protected function appendAndNormalizeIfNotNull(string $key, $value, array $list = [])
+    protected function appendAndNormalizeIfNotNull(string $key, $value, array $list = []) : array
     {
         if (null !== $value) {
             $list[$key] = $this->typeDocNormalizer->normalize($value);

src/App/Normalizer/Component/OperationDocNormalizer.php

@@ -74,9 +74,10 @@ public function normalize(MethodDoc $method) : array
 
     /**
      * @param MethodDoc $method
+     *
      * @return array
      */
-    protected function getDescriptionDoc(MethodDoc $method)
+    protected function getDescriptionDoc(MethodDoc $method) : array
     {
         $docDescription = [];
         if (null !== $method->getDescription()) {
@@ -104,7 +105,7 @@ protected function getDescriptionDoc(MethodDoc $method)
      *
      * @return string|null
      */
-    private function getResponseDescription(MethodDoc $method)
+    private function getResponseDescription(MethodDoc $method) : ?string
     {
         if (count($method->getCustomErrorList())) {
             $self = $this;
@@ -132,7 +133,12 @@ function (ErrorDoc $errorDoc) use ($self) {
         return null;
     }
 
-    private function formatErrorForDescription(ErrorDoc $errorDoc)
+    /**
+     * @param ErrorDoc $errorDoc
+     *
+     * @return string
+     */
+    private function formatErrorForDescription(ErrorDoc $errorDoc) : string
     {
         return sprintf(
             '*%s* (**Definitions->%s**)',

src/App/Normalizer/Component/RequestDocNormalizer.php

@@ -27,9 +27,11 @@ public function __construct(
     }
 
     /**
-     * {@inheritdoc}
+     * @param MethodDoc $method
+     *
+     * @return array
      */
-    public function normalize(MethodDoc $method)
+    public function normalize(MethodDoc $method) : array
     {
         $requestSchema = ['allOf' => [$this->shapeNormalizer->getRequestShapeDefinition()]];
         // Append custom if params required

src/App/Normalizer/Component/ResponseDocNormalizer.php

@@ -32,7 +32,7 @@ public function __construct(
      *
      * @return array
      */
-    public function normalize(MethodDoc $method)
+    public function normalize(MethodDoc $method) : array
     {
         return [
             'allOf' => array_merge(
@@ -78,7 +78,7 @@ function ($errorIdentifier) {
      *
      * @return array
      */
-    protected function getMethodResultArrayDoc(MethodDoc $method)
+    protected function getMethodResultArrayDoc(MethodDoc $method) : array
     {
         if (null !== $method->getResultDoc()) {
             return [

src/App/Normalizer/Component/ResultDocNormalizer.php

@@ -25,7 +25,7 @@ public function __construct(DefinitionRefResolver $definitionRefResolver)
      *
      * @return array
      */
-    public function normalize(MethodDoc $method)
+    public function normalize(MethodDoc $method) : array
     {
         if (null !== $method->getResultDoc()) {
             return [

src/App/Normalizer/Component/SchemaTypeNormalizer.php

@@ -33,11 +33,11 @@ class SchemaTypeNormalizer
     /**
      * @param TypeDoc $doc
      *
-     * @return mixed|string
+     * @return string
      *
      * @throws \ReflectionException
      */
-    public function normalize(TypeDoc $doc)
+    public function normalize(TypeDoc $doc) : string
     {
         $type = str_replace('Doc', '', lcfirst((new \ReflectionClass($doc))->getShortName()));
         if (in_array($type, self::MANAGED_TYPE_LIST)) {

src/App/Normalizer/Component/ShapeNormalizer.php

@@ -9,7 +9,7 @@ class ShapeNormalizer
     /**
      * @return array
      */
-    public function getRequestShapeDefinition()
+    public function getRequestShapeDefinition() : array
     {
         return [
             'type' => 'object',
@@ -32,7 +32,7 @@ public function getRequestShapeDefinition()
     /**
      * @return array
      */
-    public function getResponseShapeDefinition()
+    public function getResponseShapeDefinition() : array
     {
         return [
             'type' => 'object',
@@ -55,7 +55,7 @@ public function getResponseShapeDefinition()
     /**
      * @return array
      */
-    public function getErrorShapeDefinition()
+    public function getErrorShapeDefinition() : array
     {
         return [
             'type' => 'object',