RestYamlCollectionLoader::addParentNamePrefix() - Code Metrics - Inspection of "Add deprecated error when using 'pattern' option...." - FriendsOfSymfony/FOSRestBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 048dbb...8f0fa7 )

by Guilh

created 2016-09-05 16:10 UTC

RestYamlCollectionLoader::addParentNamePrefix() A

↳ Parent: RestYamlCollectionLoader

Complexity

Conditions	4
Paths	3

Size

Total Lines	15
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	4

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	15
ccs	9
cts	9
cp	1
rs	9.2
cc	4
eloc	8
nc	3
nop	2
crap	4

<?php

/*
 * This file is part of the FOSRestBundle package.
 *
 * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace FOS\RestBundle\Routing\Loader;

use FOS\RestBundle\Routing\RestRouteCollection;
use Symfony\Component\Config\FileLocatorInterface;
use Symfony\Component\Config\Resource\FileResource;
use Symfony\Component\Routing\Loader\YamlFileLoader;
use Symfony\Component\Routing\RouteCollection;
use Symfony\Component\Yaml\Yaml;

/**
 * RestYamlCollectionLoader YAML file collections loader.
 */
class RestYamlCollectionLoader extends YamlFileLoader
{
    protected $collectionParents = [];
    private $processor;
    private $includeFormat;
    private $formats;
    private $defaultFormat;

    /**
     * Initializes yaml loader.
     *
     * @param FileLocatorInterface $locator
     * @param RestRouteProcessor   $processor
     * @param bool                 $includeFormat
     * @param string[]             $formats
     * @param string               $defaultFormat
     */
    public function __construct(
        FileLocatorInterface $locator,
        RestRouteProcessor $processor,
        $includeFormat = true,
        array $formats = [],
        $defaultFormat = null
    ) {
        parent::__construct($locator);

        $this->processor = $processor;
        $this->includeFormat = $includeFormat;
        $this->formats = $formats;
        $this->defaultFormat = $defaultFormat;
    }

    /**
     * {@inheritdoc}
     */
    public function load($file, $type = null)
    {
        $path = $this->locator->locate($file);

        $config = Yaml::parse(file_get_contents($path));

        $collection = new RouteCollection();
        $collection->addResource(new FileResource($path));
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

        // process routes and imports
        foreach ($config as $name => $config) {
            if (isset($config['resource'])) {
                $resource = $config['resource'];
                $prefix = isset($config['prefix']) ? $config['prefix'] : null;
                $namePrefix = isset($config['name_prefix']) ? $config['name_prefix'] : null;
                $parent = isset($config['parent']) ? $config['parent'] : null;
                $type = isset($config['type']) ? $config['type'] : null;
                $requirements = isset($config['requirements']) ? $config['requirements'] : [];
                $defaults = isset($config['defaults']) ? $config['defaults'] : [];
                $options = isset($config['options']) ? $config['options'] : [];
                $currentDir = dirname($path);

                $parents = [];
                if (!empty($parent)) {

                    if (!isset($this->collectionParents[$parent])) {
                        throw new \InvalidArgumentException(sprintf('Cannot find parent resource with name %s', $parent));
                    }

                    $parents = $this->collectionParents[$parent];
                }

                $imported = $this->processor->importResource($this, $resource, $parents, $prefix, $namePrefix, $type, $currentDir);

                if ($imported instanceof RestRouteCollection) {
                    $parents[] = ($prefix ? $prefix.'/' : '').$imported->getSingularName();
                    $prefix = null;
                    $namePrefix = null;

                    $this->collectionParents[$name] = $parents;
                }

                $imported->addRequirements($requirements);
                $imported->addDefaults($defaults);
                $imported->addOptions($options);

                $imported->addPrefix($prefix);

                // Add name prefix from parent config files
                $imported = $this->addParentNamePrefix($imported, $namePrefix);

                $collection->addCollection($imported);
            } elseif (isset($config['pattern']) || isset($config['path'])) {
                // the YamlFileLoader of the Routing component only checks for
                // the path option
                if (!isset($config['path'])) {
                    $config['path'] = $config['pattern'];

                    @trigger_error(sprintf('The "pattern" option at "%s" in file "%s" is deprecated. Use the "path" option instead.', $name, $path), E_USER_DEPRECATED);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
                }

                if ($this->includeFormat) {
                    // append format placeholder if not present
                    if (false === strpos($config['path'], '{_format}')) {
                        $config['path'] .= '.{_format}';
                    }

                    // set format requirement if configured globally
                    if (!isset($config['requirements']['_format']) && !empty($this->formats)) {

                        $config['requirements']['_format'] = implode('|', array_keys($this->formats));
                    }
                }

                // set the default format if configured
                if (null !== $this->defaultFormat) {
                    $config['defaults']['_format'] = $this->defaultFormat;
                }

                $this->parseRoute($collection, $name, $config, $path);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            } else {
                throw new \InvalidArgumentException(sprintf('Unable to parse the "%s" route.', $name));
            }
        }

        return $collection;
    }

    /**
     * {@inheritdoc}
     */
    public function supports($resource, $type = null)
    {
        return is_string($resource) &&
            'yml' === pathinfo($resource, PATHINFO_EXTENSION) &&
            'rest' === $type;
    }

    /**
     * Adds a name prefix to the route name of all collection routes.
     *
     * @param RouteCollection $collection Route collection
     * @param array           $namePrefix NamePrefix to add in each route name of the route collection
     *
     * @return RouteCollection
     */
    public function addParentNamePrefix(RouteCollection $collection, $namePrefix)
    {
        if (!isset($namePrefix) || ($namePrefix = trim($namePrefix)) === '') {
            return $collection;
        }

        $iterator = $collection->getIterator();

        foreach ($iterator as $key1 => $route1) {
            $collection->add($namePrefix.$key1, $route1);
            $collection->remove($key1);
        }

        return $collection;
    }
}


1			<?php
2
3			/*
4			* This file is part of the FOSRestBundle package.
5			*
6			* (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
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 FOS\RestBundle\Routing\Loader;
13
14			use FOS\RestBundle\Routing\RestRouteCollection;
15			use Symfony\Component\Config\FileLocatorInterface;
16			use Symfony\Component\Config\Resource\FileResource;
17			use Symfony\Component\Routing\Loader\YamlFileLoader;
18			use Symfony\Component\Routing\RouteCollection;
19			use Symfony\Component\Yaml\Yaml;
20
21			/**
22			* RestYamlCollectionLoader YAML file collections loader.
23			*/
24			class RestYamlCollectionLoader extends YamlFileLoader
25			{
26			protected $collectionParents = [];
27			private $processor;
28			private $includeFormat;
29			private $formats;
30			private $defaultFormat;
31
32			/**
33			* Initializes yaml loader.
34			*
35			* @param FileLocatorInterface $locator
36			* @param RestRouteProcessor $processor
37			* @param bool $includeFormat
38			* @param string[] $formats
39			* @param string $defaultFormat
40			*/
41	23		public function __construct(
42			FileLocatorInterface $locator,
43			RestRouteProcessor $processor,
44			$includeFormat = true,
45			array $formats = [],
46			$defaultFormat = null
47			) {
48	23		parent::__construct($locator);
49
50	23		$this->processor = $processor;
51	23		$this->includeFormat = $includeFormat;
52	23		$this->formats = $formats;
53	23		$this->defaultFormat = $defaultFormat;
54	23		}
55
56			/**
57			* {@inheritdoc}
58			*/
59	11		public function load($file, $type = null)
60			{
61	11		$path = $this->locator->locate($file);
62
63	11		$config = Yaml::parse(file_get_contents($path));
64
65	11		$collection = new RouteCollection();
66	11		$collection->addResource(new FileResource($path));
			0 ignored issues – show Bug introduced 2016-02-04 16:20 UTC by Report Bug Copy Issue Report It seems like `$path` defined by `$this->locator->locate($file)` on line `61` can also be of type `array`; however, `Symfony\Component\Config...Resource::__construct()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
67
68			// process routes and imports
69	11		foreach ($config as $name => $config) {
70	11		if (isset($config['resource'])) {
71	7		$resource = $config['resource'];
72	7		$prefix = isset($config['prefix']) ? $config['prefix'] : null;
73	7		$namePrefix = isset($config['name_prefix']) ? $config['name_prefix'] : null;
74	7		$parent = isset($config['parent']) ? $config['parent'] : null;
75	7		$type = isset($config['type']) ? $config['type'] : null;
76	7		$requirements = isset($config['requirements']) ? $config['requirements'] : [];
77	7		$defaults = isset($config['defaults']) ? $config['defaults'] : [];
78	7		$options = isset($config['options']) ? $config['options'] : [];
79	7		$currentDir = dirname($path);
80
81	7		$parents = [];
82	7	View Code Duplication	if (!empty($parent)) {
			0 ignored issues – show Duplication introduced 2015-11-21 09:45 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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	3		if (!isset($this->collectionParents[$parent])) {
84			throw new \InvalidArgumentException(sprintf('Cannot find parent resource with name %s', $parent));
85			}
86
87	3		$parents = $this->collectionParents[$parent];
88	3		}
89
90	7		$imported = $this->processor->importResource($this, $resource, $parents, $prefix, $namePrefix, $type, $currentDir);
91
92	7		if ($imported instanceof RestRouteCollection) {
93	7		$parents[] = ($prefix ? $prefix.'/' : '').$imported->getSingularName();
94	7		$prefix = null;
95	7		$namePrefix = null;
96
97	7		$this->collectionParents[$name] = $parents;
98	7		}
99
100	7		$imported->addRequirements($requirements);
101	7		$imported->addDefaults($defaults);
102	7		$imported->addOptions($options);
103
104	7		$imported->addPrefix($prefix);
105
106			// Add name prefix from parent config files
107	7		$imported = $this->addParentNamePrefix($imported, $namePrefix);
108
109	7		$collection->addCollection($imported);
110	11		} elseif (isset($config['pattern']) \|\| isset($config['path'])) {
111			// the YamlFileLoader of the Routing component only checks for
112			// the path option
113	4		if (!isset($config['path'])) {
114			$config['path'] = $config['pattern'];
115
116			@trigger_error(sprintf('The "pattern" option at "%s" in file "%s" is deprecated. Use the "path" option instead.', $name, $path), E_USER_DEPRECATED);
			0 ignored issues – show Security Best Practice introduced 2016-09-01 08:19 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
117			}
118
119	4		if ($this->includeFormat) {
120			// append format placeholder if not present
121	3		if (false === strpos($config['path'], '{_format}')) {
122	3		$config['path'] .= '.{_format}';
123	3		}
124
125			// set format requirement if configured globally
126	3	View Code Duplication	if (!isset($config['requirements']['_format']) && !empty($this->formats)) {
			0 ignored issues – show Duplication introduced 2015-11-21 09:45 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
127	3		$config['requirements']['_format'] = implode('\|', array_keys($this->formats));
128	3		}
129	3		}
130
131			// set the default format if configured
132	4		if (null !== $this->defaultFormat) {
133	1		$config['defaults']['_format'] = $this->defaultFormat;
134	1		}
135
136	4		$this->parseRoute($collection, $name, $config, $path);
			0 ignored issues – show Bug introduced 2016-02-04 16:20 UTC by Report Bug Copy Issue Report It seems like `$path` defined by `$this->locator->locate($file)` on line `61` can also be of type `array`; however, `Symfony\Component\Routin...ileLoader::parseRoute()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
137	4		} else {
138			throw new \InvalidArgumentException(sprintf('Unable to parse the "%s" route.', $name));
139			}
140	11		}
141
142	11		return $collection;
143			}
144
145			/**
146			* {@inheritdoc}
147			*/
148	7		public function supports($resource, $type = null)
149			{
150	7		return is_string($resource) &&
151	7		'yml' === pathinfo($resource, PATHINFO_EXTENSION) &&
152	7		'rest' === $type;
153			}
154
155			/**
156			* Adds a name prefix to the route name of all collection routes.
157			*
158			* @param RouteCollection $collection Route collection
159			* @param array $namePrefix NamePrefix to add in each route name of the route collection
160			*
161			* @return RouteCollection
162			*/
163	7		public function addParentNamePrefix(RouteCollection $collection, $namePrefix)
164			{
165	7		if (!isset($namePrefix) \|\| ($namePrefix = trim($namePrefix)) === '') {
166	7		return $collection;
167			}
168
169	1		$iterator = $collection->getIterator();
170
171	1		foreach ($iterator as $key1 => $route1) {
172	1		$collection->add($namePrefix.$key1, $route1);
173	1		$collection->remove($key1);
174	1		}
175
176	1		return $collection;
177			}
178			}
179

FriendsOfSymfony / FOSRestBundle

Push — master ( 048dbb...8f0fa7 )

RestYamlCollectionLoader::addParentNamePrefix() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like