ExternalSchemaListDocNormalizer::getMethodErrorsExternalSchemaList() - Code Metrics - Inspection of "Add ExternalSchemaListDocNormalizer" - yoanm/php-jsonrpc-http-server-swagger-doc-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — release/1.0.0 (#9)

by Yo

created 2018-06-16 17:57 UTC

getMethodErrorsExternalSchemaList() A

↳ Parent: ExternalSchemaListDocNormalizer

Complexity

Conditions	2
Paths	2

Size

Total Lines	14
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
eloc	8
nc	2
nop	1
dl	0
loc	14
ccs	9
cts	9
cp	1
crap	2
rs	9.4285
c	0
b	0
f	0

<?php
namespace Yoanm\JsonRpcHttpServerSwaggerDoc\App\Normalizer\Component;

use Yoanm\JsonRpcHttpServerSwaggerDoc\App\Resolver\DefinitionRefResolver;
use Yoanm\JsonRpcServerDoc\Domain\Model\MethodDoc;
use Yoanm\JsonRpcServerDoc\Domain\Model\ServerDoc;

/**
 * Class ExternalSchemaListDocNormalizer
 */
class ExternalSchemaListDocNormalizer
{
    /** @var DefinitionRefResolver */
    private $definitionRefResolver;
    /** @var TypeDocNormalizer */
    private $typeDocNormalizer;
    /** @var ErrorDocNormalizer */
    private $errorDocNormalizer;
    /** @var ShapeNormalizer */
    private $shapeNormalizer;

    /**
     * @param ExternalSchemaNormalizerHelper $externalSchemaNormalizerHelper
filter:
    dependency_paths: ["lib/*"]
     * @param ShapeNormalizer                $shapeNormalizer
     */
    public function __construct(
        DefinitionRefResolver $definitionRefResolver,
        TypeDocNormalizer $typeDocNormalizer,
        ErrorDocNormalizer $errorDocNormalizer,
        ShapeNormalizer $shapeNormalizer
    ) {
        $this->definitionRefResolver = $definitionRefResolver;
        $this->typeDocNormalizer = $typeDocNormalizer;
        $this->errorDocNormalizer = $errorDocNormalizer;
        $this->shapeNormalizer = $shapeNormalizer;
    }

    /**
     * @param ServerDoc $doc
     * @return array
     */
    public function normalize(ServerDoc $doc)
    {
        return array_merge(
            $this->getMethodsExternalSchemaList($doc),
            $this->getMethodErrorsExternalSchemaList($doc),
            $this->getServerErrorsExtraSchemaList($doc),
            $this->getDefaultSchemaList($doc)
        );
    }

    /**
     * @param ServerDoc $doc
     *
     * @return array
     */
    protected function getMethodsExternalSchemaList(ServerDoc $doc)
    {
        $list = [];
        foreach ($doc->getMethodList() as $method) {
            // Merge extra definitions
            $list = array_merge($list, $this->getMethodExternalSchemaList($method));
        }

        return $list;
    }

    /**
     * @param ServerDoc $doc
     *
     * @return array
     */
    protected function getMethodErrorsExternalSchemaList(ServerDoc $doc)
    {
        $list = [];
        foreach ($doc->getMethodList() as $method) {
            $list = array_merge(
                $list,
                $this->normalizeErrorList(
                    $method->getCustomErrorList(),
                    DefinitionRefResolver::CUSTOM_ERROR_DEFINITION_TYPE
                )
            );
        }

        return $list;
    }


    /**
     * @param ServerDoc $doc
     *
     * @return array
     */
    protected function getServerErrorsExtraSchemaList(ServerDoc $doc)
    {
        return array_merge(
            $this->normalizeErrorList(
                $doc->getGlobalErrorList(),
                DefinitionRefResolver::CUSTOM_ERROR_DEFINITION_TYPE
            ),
            $this->normalizeErrorList(
                $doc->getServerErrorList(),
                DefinitionRefResolver::SERVER_ERROR_DEFINITION_TYPE
            )
        );
    }

    /**
     * @param MethodDoc $method
     *
     * @return array[]
     */
    protected function getMethodExternalSchemaList(MethodDoc $method) : array
    {
        $list = [];
        // Create request params schema if provided
        if (null !== $method->getParamsDoc()) {
            $key = $this->definitionRefResolver->getMethodDefinitionId(
                $method,
                DefinitionRefResolver::METHOD_PARAMS_DEFINITION_TYPE
            );
            $list[$key] = $this->typeDocNormalizer->normalize($method->getParamsDoc());
        }

        // Create custom result schema if provided
        if (null !== $method->getResultDoc()) {
            $key = $this->definitionRefResolver->getMethodDefinitionId(
                $method,
                DefinitionRefResolver::METHOD_RESULT_DEFINITION_TYPE
            );
            $list[$key] = $this->typeDocNormalizer->normalize($method->getResultDoc());
        }

        return $list;
    }

    /**
     * @param ServerDoc $doc
     * @return array
     */
    protected function getDefaultSchemaList(ServerDoc $doc)
    {
        $propertyList = [
            'code' => [
                'type' => 'integer',
            ],
        ];

        $codeList = [];
        foreach ($doc->getServerErrorList() as $errorDoc) {
            $codeList[] = $errorDoc->getCode();
        }
        foreach ($doc->getGlobalErrorList() as $errorDoc) {
            $codeList[] = $errorDoc->getCode();
        }
        foreach ($doc->getMethodList() as $method) {
            foreach ($method->getCustomErrorList() as $errorDoc) {
                $codeList[] = $errorDoc->getCode();
            }
        }

        $codeList = array_unique($codeList);
        if (count($codeList) > 0) {
            $propertyList['code']['enum'] = $codeList;
        }

        return [
            'Default-Error' => [
                'allOf' => [
                    $this->shapeNormalizer->getErrorShapeDefinition(),
                    [
                        'type' => 'object',
                        'properties' => $propertyList,
                    ],
                ],
            ],
        ];
    }

    /**
     * @param array  $errorDocList
     * @param string $definitionType
     *
     * @return array
     */
    private function normalizeErrorList(array $errorDocList, $definitionType)
    {
        $list = [];
        foreach ($errorDocList as $errorDoc) {
            $key = $this->definitionRefResolver->getErrorDefinitionId($errorDoc, $definitionType);

            $list[$key] = $this->errorDocNormalizer->normalize($errorDoc);
        }

        return $list;
    }
}


1		<?php
2		namespace Yoanm\JsonRpcHttpServerSwaggerDoc\App\Normalizer\Component;
3
4		use Yoanm\JsonRpcHttpServerSwaggerDoc\App\Resolver\DefinitionRefResolver;
5		use Yoanm\JsonRpcServerDoc\Domain\Model\MethodDoc;
6		use Yoanm\JsonRpcServerDoc\Domain\Model\ServerDoc;
7
8		/**
9		* Class ExternalSchemaListDocNormalizer
10		*/
11		class ExternalSchemaListDocNormalizer
12		{
13		/** @var DefinitionRefResolver */
14		private $definitionRefResolver;
15		/** @var TypeDocNormalizer */
16		private $typeDocNormalizer;
17		/** @var ErrorDocNormalizer */
18		private $errorDocNormalizer;
19		/** @var ShapeNormalizer */
20		private $shapeNormalizer;
21
22		/**
23		* @param ExternalSchemaNormalizerHelper $externalSchemaNormalizerHelper
		0 ignored issues – show Bug introduced 2018-06-16 17:59 UTC by Report Bug Copy Issue Report The type `Yoanm\JsonRpcHttpServerS...lSchemaNormalizerHelper` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
24		* @param ShapeNormalizer $shapeNormalizer
25		*/
26	7	public function __construct(
27		DefinitionRefResolver $definitionRefResolver,
28		TypeDocNormalizer $typeDocNormalizer,
29		ErrorDocNormalizer $errorDocNormalizer,
30		ShapeNormalizer $shapeNormalizer
31		) {
32	7	$this->definitionRefResolver = $definitionRefResolver;
33	7	$this->typeDocNormalizer = $typeDocNormalizer;
34	7	$this->errorDocNormalizer = $errorDocNormalizer;
35	7	$this->shapeNormalizer = $shapeNormalizer;
36	7	}
37
38		/**
39		* @param ServerDoc $doc
40		* @return array
41		*/
42	7	public function normalize(ServerDoc $doc)
43		{
44	7	return array_merge(
45	7	$this->getMethodsExternalSchemaList($doc),
46	7	$this->getMethodErrorsExternalSchemaList($doc),
47	7	$this->getServerErrorsExtraSchemaList($doc),
48	7	$this->getDefaultSchemaList($doc)
49		);
50		}
51
52		/**
53		* @param ServerDoc $doc
54		*
55		* @return array
56		*/
57	7	protected function getMethodsExternalSchemaList(ServerDoc $doc)
58		{
59	7	$list = [];
60	7	foreach ($doc->getMethodList() as $method) {
61		// Merge extra definitions
62	4	$list = array_merge($list, $this->getMethodExternalSchemaList($method));
63		}
64
65	7	return $list;
66		}
67
68		/**
69		* @param ServerDoc $doc
70		*
71		* @return array
72		*/
73	7	protected function getMethodErrorsExternalSchemaList(ServerDoc $doc)
74		{
75	7	$list = [];
76	7	foreach ($doc->getMethodList() as $method) {
77	4	$list = array_merge(
78	4	$list,
79	4	$this->normalizeErrorList(
80	4	$method->getCustomErrorList(),
81	4	DefinitionRefResolver::CUSTOM_ERROR_DEFINITION_TYPE
82		)
83		);
84		}
85
86	7	return $list;
87		}
88
89
90		/**
91		* @param ServerDoc $doc
92		*
93		* @return array
94		*/
95	7	protected function getServerErrorsExtraSchemaList(ServerDoc $doc)
96		{
97	7	return array_merge(
98	7	$this->normalizeErrorList(
99	7	$doc->getGlobalErrorList(),
100	7	DefinitionRefResolver::CUSTOM_ERROR_DEFINITION_TYPE
101		),
102	7	$this->normalizeErrorList(
103	7	$doc->getServerErrorList(),
104	7	DefinitionRefResolver::SERVER_ERROR_DEFINITION_TYPE
105		)
106		);
107		}
108
109		/**
110		* @param MethodDoc $method
111		*
112		* @return array[]
113		*/
114	4	protected function getMethodExternalSchemaList(MethodDoc $method) : array
115		{
116	4	$list = [];
117		// Create request params schema if provided
118	4	if (null !== $method->getParamsDoc()) {
119	1	$key = $this->definitionRefResolver->getMethodDefinitionId(
120	1	$method,
121	1	DefinitionRefResolver::METHOD_PARAMS_DEFINITION_TYPE
122		);
123	1	$list[$key] = $this->typeDocNormalizer->normalize($method->getParamsDoc());
124		}
125
126		// Create custom result schema if provided
127	4	if (null !== $method->getResultDoc()) {
128	1	$key = $this->definitionRefResolver->getMethodDefinitionId(
129	1	$method,
130	1	DefinitionRefResolver::METHOD_RESULT_DEFINITION_TYPE
131		);
132	1	$list[$key] = $this->typeDocNormalizer->normalize($method->getResultDoc());
133		}
134
135	4	return $list;
136		}
137
138		/**
139		* @param ServerDoc $doc
140		* @return array
141		*/
142	7	protected function getDefaultSchemaList(ServerDoc $doc)
143		{
144		$propertyList = [
145	7	'code' => [
146		'type' => 'integer',
147		],
148		];
149
150	7	$codeList = [];
151	7	foreach ($doc->getServerErrorList() as $errorDoc) {
152	2	$codeList[] = $errorDoc->getCode();
153		}
154	7	foreach ($doc->getGlobalErrorList() as $errorDoc) {
155	2	$codeList[] = $errorDoc->getCode();
156		}
157	7	foreach ($doc->getMethodList() as $method) {
158	4	foreach ($method->getCustomErrorList() as $errorDoc) {
159	4	$codeList[] = $errorDoc->getCode();
160		}
161		}
162
163	7	$codeList = array_unique($codeList);
164	7	if (count($codeList) > 0) {
165	4	$propertyList['code']['enum'] = $codeList;
166		}
167
168		return [
169		'Default-Error' => [
170		'allOf' => [
171	7	$this->shapeNormalizer->getErrorShapeDefinition(),
172		[
173	7	'type' => 'object',
174	7	'properties' => $propertyList,
175		],
176		],
177		],
178		];
179		}
180
181		/**
182		* @param array $errorDocList
183		* @param string $definitionType
184		*
185		* @return array
186		*/
187	7	private function normalizeErrorList(array $errorDocList, $definitionType)
188		{
189	7	$list = [];
190	7	foreach ($errorDocList as $errorDoc) {
191	4	$key = $this->definitionRefResolver->getErrorDefinitionId($errorDoc, $definitionType);
192
193	4	$list[$key] = $this->errorDocNormalizer->normalize($errorDoc);
194		}
195
196	7	return $list;
197		}
198		}
199

yoanm / php-jsonrpc-http-server-swagger-doc-sdk

Pull Request — release/1.0.0 (#9)

getMethodErrorsExternalSchemaList() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like