ContextBuilder::getResourceContext() - Code Metrics - Inspection of "[WIP] feat: fix #539 hal support" - api-platform/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#608)

by Amrouche

created 2016-07-12 08:42 UTC

ContextBuilder::getResourceContext() C

↳ Parent: ContextBuilder

Complexity

Conditions	7
Paths	10

Size

Total Lines	31
Code Lines	18

Duplication

Lines	31
Ratio	100 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	31
loc	31
rs	6.7272
cc	7
eloc	18
nc	10
nop	2

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ApiPlatform\Core\Hypermedia;

use ApiPlatform\Core\Api\UrlGeneratorInterface;
use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
use Symfony\Component\Serializer\NameConverter\NameConverterInterface;

/**
 * {@inheritdoc}
 *
 * @author Kévin Dunglas <[email protected]>
 */
final class ContextBuilder implements ContextBuilderInterface
{
    private $resourceNameCollectionFactory;
    private $resourceMetadataFactory;
    private $propertyNameCollectionFactory;
    private $propertyMetadataFactory;
    private $urlGenerator;
    private $docUri;

    /**
     * @var NameConverterInterface
     */
    private $nameConverter;

    public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, UrlGeneratorInterface $urlGenerator, string $docUri = '', NameConverterInterface $nameConverter = null)

    {
        $this->resourceNameCollectionFactory = $resourceNameCollectionFactory;
        $this->resourceMetadataFactory = $resourceMetadataFactory;
        $this->propertyNameCollectionFactory = $propertyNameCollectionFactory;
        $this->propertyMetadataFactory = $propertyMetadataFactory;
        $this->urlGenerator = $urlGenerator;
        $this->nameConverter = $nameConverter;
        $this->docUri = $docUri;
    }

    /**
     * {@inheritdoc}
     */
    public function getBaseContext(int $referenceType = UrlGeneratorInterface::ABS_URL) : array

    {
        return [
            '@vocab' => $this->urlGenerator->generate('api_hydra_doc', [], UrlGeneratorInterface::ABS_URL).'#',
            'hydra' => self::HYDRA_NS,
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function getHalContext(string $selfLink) : array
    {
        return [
            '_links' => ['self' => ['href' => $selfLink],
                 'curies' => [
                     ['name' => 'ap',
                      'href' => $this->urlGenerator->generate('api_hal_entrypoint').$this->docUri.'#section-{rel}',
                      'templated' => true,
                     ],
                 ],
                ],
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function getEntrypointContext(int $referenceType = UrlGeneratorInterface::ABS_PATH) : array

    {
        $context = $this->getBaseContext($referenceType);

        foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {
            $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);

            $resourceName = lcfirst($resourceMetadata->getShortName());

            $context[$resourceName] = [
                '@id' => 'Entrypoint/'.$resourceName,
                '@type' => '@id',
            ];
        }

        return $context;
    }

    /**
     * {@inheritdoc}
     */
    public function getResourceContext(string $resourceClass, int $referenceType = UrlGeneratorInterface::ABS_PATH) : array

    {
        $context = $this->getBaseContext($referenceType, $referenceType);

        $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
        $prefixedShortName = sprintf('#%s', $resourceMetadata->getShortName());

        foreach ($this->propertyNameCollectionFactory->create($resourceClass) as $propertyName) {
            $propertyMetadata = $this->propertyMetadataFactory->create($resourceClass, $propertyName);

            if ($propertyMetadata->isIdentifier() && !$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;
            }

            $convertedName = $this->nameConverter ? $this->nameConverter->normalize($propertyName) : $propertyName;

            if (!$id = $propertyMetadata->getIri()) {
                $id = sprintf('%s/%s', $prefixedShortName, $convertedName);
            }

            if (!$propertyMetadata->isReadableLink()) {
$a = canBeFalseAndNull();

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

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
                $context[$convertedName] = [
                    '@id' => $id,
                    '@type' => '@id',
                ];
            } else {
                $context[$convertedName] = $id;
            }
        }

        return $context;
    }

    public function getResourceContextUri(string $resourceClass, int $referenceType = UrlGeneratorInterface::ABS_PATH) : string
    {
        $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);

        return $this->urlGenerator->generate('api_jsonld_context', ['shortName' => $resourceMetadata->getShortName()]);
    }
}


1		<?php
2
3		/*
4		* This file is part of the API Platform project.
5		*
6		* (c) Kévin Dunglas <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace ApiPlatform\Core\Hypermedia;
13
14		use ApiPlatform\Core\Api\UrlGeneratorInterface;
15		use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
16		use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
17		use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
18		use ApiPlatform\Core\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
19		use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
20
21		/**
22		* {@inheritdoc}
23		*
24		* @author Kévin Dunglas <[email protected]>
25		*/
26		final class ContextBuilder implements ContextBuilderInterface
27		{
28		private $resourceNameCollectionFactory;
29		private $resourceMetadataFactory;
30		private $propertyNameCollectionFactory;
31		private $propertyMetadataFactory;
32		private $urlGenerator;
33		private $docUri;
34
35		/**
36		* @var NameConverterInterface
37		*/
38		private $nameConverter;
39
40	View Code Duplication	public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, UrlGeneratorInterface $urlGenerator, string $docUri = '', NameConverterInterface $nameConverter = null)
		0 ignored issues – show Duplication introduced 2016-07-11 13:36 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
41		{
42		$this->resourceNameCollectionFactory = $resourceNameCollectionFactory;
43		$this->resourceMetadataFactory = $resourceMetadataFactory;
44		$this->propertyNameCollectionFactory = $propertyNameCollectionFactory;
45		$this->propertyMetadataFactory = $propertyMetadataFactory;
46		$this->urlGenerator = $urlGenerator;
47		$this->nameConverter = $nameConverter;
48		$this->docUri = $docUri;
49		}
50
51		/**
52		* {@inheritdoc}
53		*/
54	View Code Duplication	public function getBaseContext(int $referenceType = UrlGeneratorInterface::ABS_URL) : array
		0 ignored issues – show Duplication introduced 2016-07-11 13:36 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
55		{
56		return [
57		'@vocab' => $this->urlGenerator->generate('api_hydra_doc', [], UrlGeneratorInterface::ABS_URL).'#',
58		'hydra' => self::HYDRA_NS,
59		];
60		}
61
62		/**
63		* {@inheritdoc}
64		*/
65		public function getHalContext(string $selfLink) : array
66		{
67		return [
68		'_links' => ['self' => ['href' => $selfLink],
69		'curies' => [
70		['name' => 'ap',
71		'href' => $this->urlGenerator->generate('api_hal_entrypoint').$this->docUri.'#section-{rel}',
72		'templated' => true,
73		],
74		],
75		],
76		];
77		}
78
79		/**
80		* {@inheritdoc}
81		*/
82	View Code Duplication	public function getEntrypointContext(int $referenceType = UrlGeneratorInterface::ABS_PATH) : array
		0 ignored issues – show Duplication introduced 2016-07-11 13:36 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
83		{
84		$context = $this->getBaseContext($referenceType);
85
86		foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {
87		$resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
88
89		$resourceName = lcfirst($resourceMetadata->getShortName());
90
91		$context[$resourceName] = [
92		'@id' => 'Entrypoint/'.$resourceName,
93		'@type' => '@id',
94		];
95		}
96
97		return $context;
98		}
99
100		/**
101		* {@inheritdoc}
102		*/
103	View Code Duplication	public function getResourceContext(string $resourceClass, int $referenceType = UrlGeneratorInterface::ABS_PATH) : array
		0 ignored issues – show Duplication introduced 2016-07-11 13:36 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
104		{
105		$context = $this->getBaseContext($referenceType, $referenceType);
		0 ignored issues – show Unused Code introduced 2016-03-08 19:19 UTC by Report Bug Copy Issue Report The call to `ContextBuilder::getBaseContext()` has too many arguments starting with `$referenceType`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
106		$resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
107		$prefixedShortName = sprintf('#%s', $resourceMetadata->getShortName());
108
109		foreach ($this->propertyNameCollectionFactory->create($resourceClass) as $propertyName) {
110		$propertyMetadata = $this->propertyMetadataFactory->create($resourceClass, $propertyName);
111
112		if ($propertyMetadata->isIdentifier() && !$propertyMetadata->isWritable()) {
		0 ignored issues – show Bug Best Practice introduced 2016-03-08 19:19 UTC by Report Bug Copy Issue Report The expression `$propertyMetadata->isWritable()` of type `null\|boolean` is loosely compared to `false`; this is ambiguous if the boolean can be false. You might want to explicitly use `!== null` instead. If an expression can have both `false`, and `null` as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values. $a = canBeFalseAndNull(); // Instead of if ( ! $a) { } // Better use one of the explicit versions: if ($a !== null) { } if ($a !== false) { } if ($a !== null && $a !== false) { } Loading history...
113		continue;
114		}
115
116		$convertedName = $this->nameConverter ? $this->nameConverter->normalize($propertyName) : $propertyName;
117
118		if (!$id = $propertyMetadata->getIri()) {
119		$id = sprintf('%s/%s', $prefixedShortName, $convertedName);
120		}
121
122		if (!$propertyMetadata->isReadableLink()) {
		0 ignored issues – show Bug Best Practice introduced 2016-03-08 19:19 UTC by Report Bug Copy Issue Report The expression `$propertyMetadata->isReadableLink()` of type `null\|boolean` is loosely compared to `false`; this is ambiguous if the boolean can be false. You might want to explicitly use `!== null` instead. If an expression can have both `false`, and `null` as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values. $a = canBeFalseAndNull(); // Instead of if ( ! $a) { } // Better use one of the explicit versions: if ($a !== null) { } if ($a !== false) { } if ($a !== null && $a !== false) { } Loading history...
123		$context[$convertedName] = [
124		'@id' => $id,
125		'@type' => '@id',
126		];
127		} else {
128		$context[$convertedName] = $id;
129		}
130		}
131
132		return $context;
133		}
134
135		public function getResourceContextUri(string $resourceClass, int $referenceType = UrlGeneratorInterface::ABS_PATH) : string
136		{
137		$resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
138
139		return $this->urlGenerator->generate('api_jsonld_context', ['shortName' => $resourceMetadata->getShortName()]);
140		}
141		}
142

api-platform / core

Pull Request — master (#608)

ContextBuilder::getResourceContext() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like