spryker / spryker-core

Bundles/DocumentationGeneratorRestApi/src/Spryker/Zed/DocumentationGeneratorRestApi/Business/Generator/OpenApiSpecificationPathGenerator.php

<?php

/**
 * Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
 * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
 */

namespace Spryker\Zed\DocumentationGeneratorRestApi\Business\Generator;

use ArrayObject;
use Generated\Shared\Transfer\PathMethodDataTransfer;
use Generated\Shared\Transfer\PathSchemaDataTransfer;
use Spryker\Zed\DocumentationGeneratorRestApi\Business\Renderer\PathMethodRendererInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

class OpenApiSpecificationPathGenerator implements PathGeneratorInterface
{
    /**
     * @var string
     */
    protected const DESCRIPTION_DEFAULT_REQUEST = 'Expected request body.';

    /**
     * @var string
     */
    protected const DESCRIPTION_DEFAULT_RESPONSE = 'Expected response to a bad request.';

    /**
     * @var string
     */
    protected const DESCRIPTION_SUCCESSFUL_RESPONSE = 'Expected response to a valid request.';

    /**
     * @var string
     */
    protected const KEY_DEFAULT = 'default';

    /**
     * @var array
     */
    protected $paths = [];

    /**
     * @var \Spryker\Zed\DocumentationGeneratorRestApi\Business\Renderer\PathMethodRendererInterface
     */
    protected $pathMethodRenderer;

    /**
     * @param \Spryker\Zed\DocumentationGeneratorRestApi\Business\Renderer\PathMethodRendererInterface $pathMethodRenderer
     */
    public function __construct(PathMethodRendererInterface $pathMethodRenderer)
    {
        $this->pathMethodRenderer = $pathMethodRenderer;
    }

    /**
     * @return array
     */
    public function getPaths(): array
    {
        return $this->paths;
    }

    /**
     * @param \Generated\Shared\Transfer\PathMethodDataTransfer $pathMethodDataTransfer
     * @param \Generated\Shared\Transfer\PathSchemaDataTransfer $errorSchemaDataTransfer
     * @param \Generated\Shared\Transfer\PathSchemaDataTransfer|null $responseSchemaDataTransfer
     *
     * @return void
     */
    public function addGetPath(
        PathMethodDataTransfer $pathMethodDataTransfer,
        PathSchemaDataTransfer $errorSchemaDataTransfer,
        ?PathSchemaDataTransfer $responseSchemaDataTransfer
    ): void {
        if (!$responseSchemaDataTransfer) {
            $responseSchemaDataTransfer = new PathSchemaDataTransfer();
        }

        $responseSchemaDataTransfer = $this->addDefaultSuccessResponseToResponseSchemaDataTransfer(
            $pathMethodDataTransfer,
            $responseSchemaDataTransfer,
            (string)Response::HTTP_OK,
        );
        if ($responseSchemaDataTransfer) {

$responseSchemaDataTransfer is of type Generated\Shared\Transfer\PathSchemaDataTransfer, thus it always evaluated to true.

            $pathMethodDataTransfer->addResponseSchema($responseSchemaDataTransfer);
        }

        $errorSchemaDataTransfer = $this->addDefaultErrorToErrorSchemaDataTransfer($errorSchemaDataTransfer);
        $pathMethodDataTransfer->addResponseSchema($errorSchemaDataTransfer);

        $pathMethodDataTransfer->setMethod(strtolower(Request::METHOD_GET));

        $this->addPath($pathMethodDataTransfer);
    }

    /**
     * @param \Generated\Shared\Transfer\PathMethodDataTransfer $pathMethodDataTransfer
     * @param \Generated\Shared\Transfer\PathSchemaDataTransfer $requestSchemaDataTransfer
     * @param \Generated\Shared\Transfer\PathSchemaDataTransfer $errorSchemaDataTransfer
     * @param \Generated\Shared\Transfer\PathSchemaDataTransfer|null $responseSchemaDataTransfer
     *
     * @return void
     */
    public function addPostPath(
        PathMethodDataTransfer $pathMethodDataTransfer,
        PathSchemaDataTransfer $requestSchemaDataTransfer,
        PathSchemaDataTransfer $errorSchemaDataTransfer,
        ?PathSchemaDataTransfer $responseSchemaDataTransfer
    ): void {
        if (!$responseSchemaDataTransfer) {
            $responseSchemaDataTransfer = new PathSchemaDataTransfer();
        }
        $responseSchemaDataTransfer = $this->addDefaultSuccessResponseToResponseSchemaDataTransfer(
            $pathMethodDataTransfer,
            $responseSchemaDataTransfer,
            (string)Response::HTTP_CREATED,
        );
        if ($responseSchemaDataTransfer) {

$responseSchemaDataTransfer is of type Generated\Shared\Transfer\PathSchemaDataTransfer, thus it always evaluated to true.

            $pathMethodDataTransfer->addResponseSchema($responseSchemaDataTransfer);
        }

        $errorSchemaDataTransfer = $this->addDefaultErrorToErrorSchemaDataTransfer($errorSchemaDataTransfer);
        $pathMethodDataTransfer->addResponseSchema($errorSchemaDataTransfer);

        $pathMethodDataTransfer->setMethod(strtolower(Request::METHOD_POST));

        if ($requestSchemaDataTransfer->getSchemaReference()) {
            $requestSchemaDataTransfer->setDescription(static::DESCRIPTION_DEFAULT_REQUEST);
            $pathMethodDataTransfer->setRequestSchema($requestSchemaDataTransfer);
        }

        $this->addPath($pathMethodDataTransfer);
    }

    /**
     * @param \Generated\Shared\Transfer\PathMethodDataTransfer $pathMethodDataTransfer
     * @param \Generated\Shared\Transfer\PathSchemaDataTransfer $requestSchemaDataTransfer
     * @param \Generated\Shared\Transfer\PathSchemaDataTransfer $errorSchemaDataTransfer
     * @param \Generated\Shared\Transfer\PathSchemaDataTransfer|null $responseSchemaDataTransfer
     *
     * @return void
     */
    public function addPatchPath(
        PathMethodDataTransfer $pathMethodDataTransfer,
        PathSchemaDataTransfer $requestSchemaDataTransfer,
        PathSchemaDataTransfer $errorSchemaDataTransfer,
        ?PathSchemaDataTransfer $responseSchemaDataTransfer
    ): void {
        if (!$responseSchemaDataTransfer) {
            $responseSchemaDataTransfer = new PathSchemaDataTransfer();
        }

        $responseSchemaDataTransfer = $this->addDefaultSuccessResponseToResponseSchemaDataTransfer(
            $pathMethodDataTransfer,
            $responseSchemaDataTransfer,
            (string)Response::HTTP_OK,
        );
        if ($responseSchemaDataTransfer) {

$responseSchemaDataTransfer is of type Generated\Shared\Transfer\PathSchemaDataTransfer, thus it always evaluated to true.

            $pathMethodDataTransfer->addResponseSchema($responseSchemaDataTransfer);
        }

        $errorSchemaDataTransfer = $this->addDefaultErrorToErrorSchemaDataTransfer($errorSchemaDataTransfer);
        $pathMethodDataTransfer->addResponseSchema($errorSchemaDataTransfer);

        $pathMethodDataTransfer->setMethod(strtolower(Request::METHOD_PATCH));

        if ($requestSchemaDataTransfer->getSchemaReference()) {
            $requestSchemaDataTransfer->setDescription(static::DESCRIPTION_DEFAULT_REQUEST);
            $pathMethodDataTransfer->setRequestSchema($requestSchemaDataTransfer);
        }

        $this->addPath($pathMethodDataTransfer);
    }

    /**
     * @param \Generated\Shared\Transfer\PathMethodDataTransfer $pathMethodDataTransfer
     * @param \Generated\Shared\Transfer\PathSchemaDataTransfer $errorSchemaDataTransfer
     *
     * @return void
     */
    public function addDeletePath(
        PathMethodDataTransfer $pathMethodDataTransfer,
        PathSchemaDataTransfer $errorSchemaDataTransfer
    ): void {
        $responseSchemaDataTransfer = $this->addDefaultSuccessResponseToResponseSchemaDataTransfer(
            $pathMethodDataTransfer,
            new PathSchemaDataTransfer(),
            (string)Response::HTTP_NO_CONTENT,
        );
        if ($responseSchemaDataTransfer) {

$responseSchemaDataTransfer is of type Generated\Shared\Transfer\PathSchemaDataTransfer, thus it always evaluated to true.

            $pathMethodDataTransfer->addResponseSchema($responseSchemaDataTransfer);
        }

        $errorSchemaDataTransfer = $this->addDefaultErrorToErrorSchemaDataTransfer($errorSchemaDataTransfer);
        $pathMethodDataTransfer->addResponseSchema($errorSchemaDataTransfer);

        $pathMethodDataTransfer->setMethod(strtolower(Request::METHOD_DELETE));

        $this->addPath($pathMethodDataTransfer);
    }

    /**
     * @param \Generated\Shared\Transfer\PathMethodDataTransfer $pathMethodDataTransfer
     *
     * @return void
     */
    protected function addPath(PathMethodDataTransfer $pathMethodDataTransfer): void
    {
        $this->paths = array_replace_recursive($this->paths, $this->pathMethodRenderer->render($pathMethodDataTransfer));
    }

    /**
     * @param \Generated\Shared\Transfer\PathMethodDataTransfer $pathMethodDataTransfer
     * @param string $defaultMethodStatusCode
     *
     * @return string
     */
    protected function getResponseStatusCode(PathMethodDataTransfer $pathMethodDataTransfer, string $defaultMethodStatusCode): string
    {
        return $pathMethodDataTransfer->getIsEmptyResponse() ? (string)Response::HTTP_NO_CONTENT : $defaultMethodStatusCode;
    }

    /**
     * @param \Generated\Shared\Transfer\PathSchemaDataTransfer $errorSchemaDataTransfer
     *
     * @return \Generated\Shared\Transfer\PathSchemaDataTransfer
     */
    protected function addDefaultErrorToErrorSchemaDataTransfer(PathSchemaDataTransfer $errorSchemaDataTransfer): PathSchemaDataTransfer
    {
        $errorSchemaDataTransfer->setCode(static::KEY_DEFAULT);
        $errorSchemaDataTransfer->setDescription(static::DESCRIPTION_DEFAULT_RESPONSE);

        return $errorSchemaDataTransfer;
    }

    /**
     * @param \Generated\Shared\Transfer\PathMethodDataTransfer $pathMethodDataTransfer
     * @param \Generated\Shared\Transfer\PathSchemaDataTransfer $responseSchemaDataTransfer
     * @param string $defaultResponseCode
     *
     * @return \Generated\Shared\Transfer\PathSchemaDataTransfer|null
     */
    protected function addDefaultSuccessResponseToResponseSchemaDataTransfer(
        PathMethodDataTransfer $pathMethodDataTransfer,
        PathSchemaDataTransfer $responseSchemaDataTransfer,
        string $defaultResponseCode
    ): ?PathSchemaDataTransfer {
        $pathSchemaDataTransfer = $this->getSuccessResponseSchema($pathMethodDataTransfer->getResponseSchemas());

        if ($pathSchemaDataTransfer) {
            if ($pathSchemaDataTransfer->getCode() !== Response::HTTP_NO_CONTENT) {
                $pathSchemaDataTransfer->setSchemaReference($responseSchemaDataTransfer->getSchemaReference());
            }

            return null;
        }

        $responseStatusCode = $this->getResponseStatusCode($pathMethodDataTransfer, $defaultResponseCode);
        $responseSchemaDataTransfer->setCode($responseStatusCode);
        $responseSchemaDataTransfer->setDescription(static::DESCRIPTION_SUCCESSFUL_RESPONSE);

        return $responseSchemaDataTransfer;
    }

    /**
     * @param \ArrayObject<int, \Generated\Shared\Transfer\PathSchemaDataTransfer> $responseSchemas
     *
     * @return \Generated\Shared\Transfer\PathSchemaDataTransfer|null
     */
    protected function getSuccessResponseSchema(ArrayObject $responseSchemas): ?PathSchemaDataTransfer
    {
        foreach ($responseSchemas as $responseSchema) {
            $responseSchemaCode = (int)$responseSchema->getCode();
            if ($responseSchemaCode >= 200 && $responseSchemaCode < 300) {
                return $responseSchema;
            }
        }

        return null;
    }
}