SchemaBuilder::buildSchemaName() - Code Metrics - Inspection of "[OpenAPI] Extract the JSON Schema builder" - api-platform/core - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#2983)

by Kévin
created 2019-08-13 08:49 UTC
SchemaBuilder::buildSchemaName() A

↳ Parent: SchemaBuilder
Complexity

Conditions	6
Paths	7
Size

Total Lines	24
Code Lines	12
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	6
eloc	12
c	1
b	0
f	0
nc	7
nop	7
dl	0
loc	24
rs	9.2222
<?php

declare(strict_types=1);

namespace ApiPlatform\Core\Swagger;

use ApiPlatform\Core\Exception\ResourceClassNotFoundException;
use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
use ApiPlatform\Core\Swagger\Serializer\DocumentationNormalizer;
use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;

/**
 * Builds an OpenAPI Schema, an extended subset of the JSON Schema Specification.
 *
 * @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schema-object
 * @see https://tools.ietf.org/html/draft-wright-json-schema-01
 *
 * @author Kévin Dunglas <[email protected]>
 */
final class SchemaBuilder
{
    use TypeResolverTrait;

    private $resourceMetadataFactory;
    private $propertyNameCollectionFactory;
    private $propertyMetadataFactory;
    private $nameConverter;

    public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, NameConverterInterface $nameConverter = null)
    {
        $this->resourceMetadataFactory = $resourceMetadataFactory;
        $this->propertyNameCollectionFactory = $propertyNameCollectionFactory;
        $this->propertyMetadataFactory = $propertyMetadataFactory;
        $this->nameConverter = $nameConverter;
    }

    public function buildSchemaName(string $resourceClass, bool $output = true, ?string $operationType = null, ?string $operationName = null, ?string $format = null, ?array $serializerContext = null, string $version = DocumentationNormalizer::OPENAPI_VERSION): ?string
    public function buildSchemaName(string $resourceClass, bool $output = true, ?string $operationType = null, ?string $operationName = null, /** @scrutinizer ignore-unused */ ?string $format = null, ?array $serializerContext = null, string $version = DocumentationNormalizer::OPENAPI_VERSION): ?string
    {
        if (null === $metadata = $this->getMetadata($resourceClass, $output, $operationType, $operationName, $serializerContext)) {
            return null;
        }
        [$resourceMetadata, $serializerContext, $inputOrOutputClass] = $metadata;

        $prefix = $resourceMetadata->getShortName();
        if (null !== $inputOrOutputClass && $resourceClass !== $inputOrOutputClass) {
            $prefix .= ':'.md5($inputOrOutputClass);
        }

        /*if (null !== $format) {

            $prefix .= ':'.$format;
        }*/

        if (isset($serializerContext[DocumentationNormalizer::SWAGGER_DEFINITION_NAME])) {
            $name = sprintf('%s-%s', $prefix, $serializerContext[DocumentationNormalizer::SWAGGER_DEFINITION_NAME]);
        } else {
            $groups = (array) ($serializerContext[AbstractNormalizer::GROUPS] ?? []);
            $name = $groups ? sprintf('%s-%s', $prefix, implode('_', $groups)) : $prefix;

        }

        return $name;
    }

    /**
     * @throws ResourceClassNotFoundException
     */
    public function buildSchema(string $resourceClass, bool $output = true, ?string $operationType = null, ?string $operationName = null, ?string $format = null, ?array $serializerContext = null, string $version = DocumentationNormalizer::OPENAPI_VERSION): ?\ArrayObject
    {
        if (null === $metadata = $this->getMetadata($resourceClass, $output, $operationType, $operationName, $serializerContext)) {
            return null;
        }
        [$resourceMetadata, $serializerContext, $inputOrOutputClass] = $metadata;

        $schema = ['type' => 'object'];
        if (null !== $description = $resourceMetadata->getDescription()) {
            $schema['description'] = $description;
        }
        if (null !== $iri = $resourceMetadata->getIri()) {
            $schema['externalDocs'] = ['url' => $iri];
        }

        $options = isset($serializerContext[AbstractNormalizer::GROUPS]) ? ['serializer_groups' => $serializerContext[AbstractNormalizer::GROUPS]] : [];
        foreach ($this->propertyNameCollectionFactory->create($inputOrOutputClass, $options) as $propertyName) {
            $propertyMetadata = $this->propertyMetadataFactory->create($inputOrOutputClass, $propertyName);
            if (!$propertyMetadata->isReadable() && !$propertyMetadata->isWritable()) {
$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
                continue;
            }

            $normalizedPropertyName = $this->nameConverter ? $this->nameConverter->normalize($propertyName, $inputOrOutputClass, $format, $serializerContext) : $propertyName;
            $normalizedPropertyName = $this->nameConverter ? $this->nameConverter->/** @scrutinizer ignore-call */ normalize($propertyName, $inputOrOutputClass, $format, $serializerContext) : $propertyName;
            if ($propertyMetadata->isRequired()) {
                $schema['required'][] = $normalizedPropertyName;
            }

            $schema['properties'][$normalizedPropertyName] = $this->buildPropertySchema($propertyMetadata, $serializerContext, $version);
        }

        return new \ArrayObject($schema);
    }

    private function getMetadata(string $resourceClass, bool $output, ?string $operationType, ?string $operationName, ?array $serializerContext): ?array
    {
        $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
        $attribute = $output ? 'output' : 'input';
        if (null === $operationType || null === $operationName) {
            $inputOrOutput = $resourceMetadata->getAttribute($attribute, ['class' => $resourceClass]);
        } else {
            $inputOrOutput = $resourceMetadata->getTypedOperationAttribute($operationType, $operationName, $attribute, ['class' => $resourceClass], true);
        }

        if (null === ($inputOrOutput['class'] ?? null)) {
            // input or output disabled
            return null;
        }

        return [
            $resourceMetadata,
            $serializerContext ?? $this->getSerializerContext($resourceMetadata, $output, $operationType, $operationName),
            $inputOrOutput['class']
        ];
    }

    private function buildPropertySchema(PropertyMetadata $propertyMetadata, array $serializerContext, string $version): \ArrayObject
    {
        $propertySchema = $propertyMetadata->getAttributes()[$version === DocumentationNormalizer::OPENAPI_VERSION ? 'openapi_context' : 'swagger_context'] ?? [];

        if (false === $propertyMetadata->isWritable() && !$propertyMetadata->isInitializable()) {
$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
            $propertySchema['readOnly'] = true;
        }

        if (null !== $description = $propertyMetadata->getDescription()) {
            $propertySchema['description'] = $description;
        }

        if (null !== $iri = $propertyMetadata->getIri()) {
            $schema['externalDocs'] = ['url' => $iri];

        }

        if (null === $type = $propertyMetadata->getType()) {
            return $propertySchema;

        }

        $isCollection = $type->isCollection();
        if (null === $valueType = $isCollection ? $type->getCollectionValueType() : $type) {
            $builtinType = 'string';
            $className = null;
        } else {
            $builtinType = $valueType->getBuiltinType();
            $className = $valueType->getClassName();
        }

        $valueSchema = $this->getType($builtinType, $isCollection, $className, $propertyMetadata->isReadableLink(), $serializerContext, $version);

        return new \ArrayObject($propertySchema + $valueSchema);
    }

    private function getSerializerContext(ResourceMetadata $resourceMetadata, bool $output, ?string $operationType, ?string $operationName): array
    {
        $attribute = $output ? 'normalization_context' : 'denormalization_context';

        if (null === $operationType || null === $operationName) {
            return $resourceMetadata->getAttribute($attribute, []);
        }

        return $resourceMetadata->getTypedOperationAttribute($operationType, $operationName, $attribute, [], true);
    }
}

api-platform / core

Pull Request — master (#2983)

SchemaBuilder::buildSchemaName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
