Yoanm\JsonRpcHttpServerSwaggerDoc\App\Normalizer\Component\OperationDocNormalizer

Complexity

Total Complexity

12

Size/Duplication

Total Lines	138
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	formatErrorForDescription()	0	8	1
A	normalize()	0	29	2
A	getResponseDescription()	0	26	2
A	getDescriptionDoc()	0	21	6

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

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

/**
 * Class OperationDocNormalizer
 */
class OperationDocNormalizer
{
    /** @var RequestDocNormalizer */
    private $requestDocTransformer;
    /** @var ResponseDocNormalizer */
    private $responseDocNormalizer;
    /** @var DefinitionRefResolver */
    private $definitionRefResolver;

    /**
     * @param DefinitionRefResolver $definitionRefResolver
     * @param RequestDocNormalizer  $requestDocTransformer
     * @param ResponseDocNormalizer $responseDocNormalizer
     */
    public function __construct(
        DefinitionRefResolver $definitionRefResolver,
        RequestDocNormalizer $requestDocTransformer,
        ResponseDocNormalizer $responseDocNormalizer
    ) {
        $this->requestDocTransformer = $requestDocTransformer;
        $this->responseDocNormalizer = $responseDocNormalizer;
        $this->definitionRefResolver = $definitionRefResolver;
    }

    /**
     * @param MethodDoc $method
     *
     * @return array
     */
    public function normalize(MethodDoc $method) : array
    {
        $docTags = [];

        if (count($method->getTagList())) {
            $docTags['tags'] = $method->getTagList();
        }

        return [
                'summary' => sprintf('"%s" json-rpc method', $method->getMethodName()),
            ]
            + $this->getDescriptionDoc($method)
            + $docTags
            + [
                'operationId' => $method->getIdentifier(),
                'consumes' => ['application/json'],
                'produces' => ['application/json'],
                'parameters' => [
                    [
                        'in' => 'body',
                        'name' => 'JsonRpc request',
                        'required' => true,
                        'schema' => $this->requestDocTransformer->normalize($method)
                    ]
                ],
                'responses' => [
                    '200' => [
                        'description' => 'JSON-RPC response',
                        'schema' => $this->responseDocNormalizer->normalize($method),
                    ]
                ]
            ]
        ;
    }

    /**
     * @param MethodDoc $method
     *
     * @return array
     */
    protected function getDescriptionDoc(MethodDoc $method) : array
    {
        $docDescription = [];
        if (null !== $method->getDescription()) {
            $docDescription['description'] = $method->getDescription();
        }

        $responseDescription = $this->getResponseDescription($method);
        if (null !== $responseDescription) {
            $hasInitialDescription = isset($docDescription['description'])
                && strlen($docDescription['description']) > 0
            ;
            $docDescription['description'] = sprintf(
                '%s%s%s',
                ($hasInitialDescription ? $docDescription['description'] : ''),
                ($hasInitialDescription ? "\n" : ''),
                $responseDescription
            );
        }

        return $docDescription;
    }

    /**
     * @param MethodDoc $method
     *
     * @return string|null
     */
    private function getResponseDescription(MethodDoc $method) : ?string
    {
        if (count($method->getCustomErrorList())) {
            $self = $this;
            // Better to use raw string instead of \t
            $indentString = <<<STRING

    -
STRING;

            return sprintf(
                "Could throw custom errors : %s%s",
                $indentString,
                implode(
                    $indentString,
                    array_map(
                        function (ErrorDoc $errorDoc) use ($self) {
                            return $self->formatErrorForDescription($errorDoc);
                        },
                        $method->getCustomErrorList()
                    )
                )
            );
        }

        return null;
    }

    /**
     * @param ErrorDoc $errorDoc
     *
     * @return string
     */
    private function formatErrorForDescription(ErrorDoc $errorDoc) : string
    {
        return sprintf(
            '*%s* (**Definitions->%s**)',
            $errorDoc->getTitle(),
            $this->definitionRefResolver->getErrorDefinitionId(
                $errorDoc,
                DefinitionRefResolver::CUSTOM_ERROR_DEFINITION_TYPE
            )
        );
    }
}