OpenApi::generateDocumentation() - Code Metrics - Inspection of "WIP! v2.0.0" - sunrise-php/http-router - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#34)

by Anatoly

created 2019-12-09 10:57 UTC

OpenApi::generateDocumentation() A

↳ Parent: OpenApi

Complexity

Conditions	3
Paths	3

Size

Total Lines	19
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	11
c	1
b	0
f	0
dl	0
loc	19
ccs	0
cts	15
cp	0
rs	9.9
cc	3
nc	3
nop	0
crap	12

<?php declare(strict_types=1);

/**
 * It's free open-source software released under the MIT License.
 *
 * @author Anatoly Fenric <[email protected]>
 * @copyright Copyright (c) 2018, Anatoly Fenric
 * @license https://github.com/sunrise-php/http-router/blob/master/LICENSE
 * @link https://github.com/sunrise-php/http-router
 */

namespace Sunrise\Http\Router;

/**
 * Import classes
 */
use Doctrine\Common\Annotations\SimpleAnnotationReader;
use Sunrise\Http\Router\Annotation\OpenApi\AbstractReference;
use Sunrise\Http\Router\Annotation\OpenApi\Operation;
use Sunrise\Http\Router\Annotation\OpenApi\Parameter;
use Sunrise\Http\Router\Annotation\OpenApi\Schema;
use ReflectionClass;

/**
 * Import functions
 */
use function array_walk_recursive;
use function strtolower;

/**
 * OpenApi
 */
class OpenApi
{

    /**
     * Version of OpenAPI specification
     *
     * @var string
     */
    public const VERSION = '3.0.2';

    /**
     * @var SimpleAnnotationReader
     */
    private $annotationReader;

    /**
     * @var RouteInterface[]
     */
    private $routes = [];

    /**
     * @var string
     */
    private $title = 'REST API';

    /**
     * @var string
     */
    private $version = '0.0.1';

    /**
     * @var array
     */
    private $documentation = [];

    /**
     * Constructor of the class
     */
    public function __construct()
    {
        $this->annotationReader = new SimpleAnnotationReader();
        $this->annotationReader->addNamespace('Sunrise\Http\Router\Annotation');
    }

    /**
     * @param RouteInterface ...$routes
     *
     * @return void
     */
    public function addRoute(RouteInterface ...$routes) : void
    {
        foreach ($routes as $route) {
            $this->routes[] = $route;
        }
    }

    /**
     * @param string $title
     *
     * @return void
     */
    public function setTitle(string $title) : void
    {
        $this->title = $title;
    }

    /**
     * @param string $version
     *
     * @return void
     */
    public function setVersion(string $version) : void
    {
        $this->version = $version;
    }

    /**
     * @return void
     */
    public function generateDocumentation() : void
    {
        $this->documentation['openapi'] = self::VERSION;
        $this->documentation['info']['title'] = $this->title;
        $this->documentation['info']['version'] = $this->version;

        foreach ($this->routes as $route) {
            $path = path_plain($route->getPath());
            $path = /** @scrutinizer ignore-call */ path_plain($route->getPath());
            $operation = $this->createOperation($route);

            foreach ($route->getMethods() as $method) {
                $method = strtolower($method);

                $this->documentation['paths'][$path][$method]['operationId'] = $route->getName();
                $this->documentation['paths'][$path][$method] += $operation->toArray();
            }
        }

        $this->handleReferences();
    }

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

    /**
     * @return string
     */
    public function toJson() : string
    {
        return json_encode($this->documentation);
    }

    /**
     * @return string
     */
    public function toYaml() : string
    {
        return yaml_emit($this->documentation);
    }

    /**
     * @param RouteInterface $route
     *
     * @return Operation
     */
    private function createOperation(RouteInterface $route) : Operation
    {
        $target = new ReflectionClass($route->getRequestHandler());
        $operation = $this->annotationReader->getClassAnnotation($target, Operation::class) ?? new Operation();
        $attributes = path_parse($route->getPath());
        $attributes = /** @scrutinizer ignore-call */ path_parse($route->getPath());

        foreach ($attributes as $attribute) {
            $parameter = new Parameter();
            $parameter->in = 'path';
            $parameter->name = $attribute['name'];
            $parameter->required = !$attribute['isOptional'];

            if (isset($attribute['pattern'])) {
                $parameter->schema = new Schema();
                $parameter->schema->type = 'string';
                $parameter->schema->pattern = $attribute['pattern'];
            }

            $operation->parameters[] = $parameter;
        }

        return $operation;
    }

    /**
     * @return void
     */
    private function handleReferences() : void
    {
        array_walk_recursive($this->documentation, function (&$value) {
            if (!($value instanceof AbstractReference)) {
                return;
            }

            $ref = $value;
            $value = $ref->getComponentPath();

            $component =& $this->documentation['components'][$ref->getComponentName()];
            if (isset($component[$ref->name])) {
                return;
            }

            $annotation = $ref->getAnnotation($this->annotationReader);
            if (!isset($annotation)) {
                return;
            }

            $component[$ref->name] = $annotation->toArray();
        });
    }
}


sunrise-php / http-router

Pull Request — master (#34)

OpenApi::generateDocumentation() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like