SwaggerDocument::getBasePath() - Code Metrics - Inspection of "Updated README for #42" - kleijnweb/swagger-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6ebd1c...df9bae )

by John

created 2016-02-08 05:07 UTC

SwaggerDocument::getBasePath() A

↳ Parent: SwaggerDocument

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php
/*
 * This file is part of the KleijnWeb\SwaggerBundle package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace KleijnWeb\SwaggerBundle\Document;

use JsonSchema\RefResolver;
use JsonSchema\Uri\UriRetriever;
use Symfony\Component\Yaml\Yaml;

/**
 * @author John Kleijn <[email protected]>
 */
class SwaggerDocument
{
    /**
     * @var string
     */
    private $pathFileName;

    /**
     * @var \ArrayObject
     */
    private $definition;

    /**
     * @param $pathFileName
     */
    public function __construct($pathFileName)
    {
        if (!is_file($pathFileName)) {
            throw new \InvalidArgumentException(
                "Document file '$pathFileName' does not exist'"
            );
        }

        $data = Yaml::parse(file_get_contents($pathFileName));
        $data = self::resolveSelfReferences($data, $data);

        $this->pathFileName = $pathFileName;
        $this->definition = new \ArrayObject($data, \ArrayObject::ARRAY_AS_PROPS | \ArrayObject::STD_PROP_LIST);
    }

    /**
     * @return array
     */
    public function getDefinition()
    {
        return $this->definition;
    }

    /**
     * @return array
     */
    public function getPathDefinitions()
    {
        return $this->definition->paths;

    }

    /**
     * @return array
     */
    public function getResourceSchemas()
    {
        return $this->definition->definitions;

    }

    /**
     * @return string
     */
    public function getBasePath()
    {
        return $this->definition->basePath;

    }

    /**
     * @param string $path
     * @param string $method
     *
     * @return array
     */
    public function getOperationDefinition($path, $method)
    {
        $paths = $this->getPathDefinitions();
        if (!isset($paths[$path])) {
            throw new \InvalidArgumentException("Path '$path' not in Swagger document");
        }
        $method = strtolower($method);
        if (!isset($paths[$path][$method])) {
            throw new \InvalidArgumentException("Method '$method' not supported for path '$path'");
        }

        return $paths[$path][$method];
    }

    /**
     * @return array
     */
    public function getArrayCopy()
    {
        return $this->definition->getArrayCopy();
    }

    /**
     * @param null $targetPath
     *
     * @return void
     */
    public function write($targetPath = null)
    {
        $data = $this->getArrayCopy();
        $data = self::unresolveSelfReferences($data, $data);
        $yaml = Yaml::dump($data, 10, 2);
        $yaml = str_replace(': {  }', ': []', $yaml);
        file_put_contents($targetPath ?: $this->pathFileName, $yaml);
    }

    /**
     * Cloning will break things
     */
    private function __clone()
    {
    }

    /**
     * @param array $segments
     * @param array $context
     *
     * @return mixed
     */
    private static function lookupUsingSegments(array $segments, array $context)
    {
        $segment = array_shift($segments);
        if (isset($context[$segment])) {
            if (!count($segments)) {
                return $context[$segment];
            }

            return self::lookupUsingSegments($segments, $context[$segment]);
        }

        return null;
    }

    /**
     * @param array $doc
     * @param array $data
     *
     * @return array
     */
    private function resolveSelfReferences(array $doc, array &$data)
    {
        foreach ($data as $key => &$value) {
            if (is_array($value)) {
                $value = self::resolveSelfReferences($doc, $value);
            }
            if ($key === '$ref' && '#' === $value[0]) {
                $data = self::lookupUsingSegments(
                    explode('/', trim(substr($value, 1), '/')),
                    $doc
                );
                $data['id'] = $value;
                // Use something a little less generic for more reliable qnd restoring of original
                $data['x-swagger-id'] = $value;
            }
        }

        return $data;
    }

    /**
     * @param array $doc
     * @param array $data
     *
     * @return array
     */
    private function unresolveSelfReferences(array $doc, array &$data)
    {
        foreach ($data as $key => &$value) {
            if (is_array($value)) {
                $value = self::unresolveSelfReferences($doc, $value);
            }
            if ($key === 'x-swagger-id') {
                $data = ['$ref' => $value];
            }
        }

        return $data;
    }
}


1			<?php
2			/*
3			* This file is part of the KleijnWeb\SwaggerBundle package.
4			*
5			* For the full copyright and license information, please view the LICENSE
6			* file that was distributed with this source code.
7			*/
8
9			namespace KleijnWeb\SwaggerBundle\Document;
10
11			use JsonSchema\RefResolver;
12			use JsonSchema\Uri\UriRetriever;
13			use Symfony\Component\Yaml\Yaml;
14
15			/**
16			* @author John Kleijn <[email protected]>
17			*/
18			class SwaggerDocument
19			{
20			/**
21			* @var string
22			*/
23			private $pathFileName;
24
25			/**
26			* @var \ArrayObject
27			*/
28			private $definition;
29
30			/**
31			* @param $pathFileName
32			*/
33			public function __construct($pathFileName)
34			{
35			if (!is_file($pathFileName)) {
36			throw new \InvalidArgumentException(
37			"Document file '$pathFileName' does not exist'"
38			);
39			}
40
41			$data = Yaml::parse(file_get_contents($pathFileName));
42			$data = self::resolveSelfReferences($data, $data);
43
44			$this->pathFileName = $pathFileName;
45			$this->definition = new \ArrayObject($data, \ArrayObject::ARRAY_AS_PROPS \| \ArrayObject::STD_PROP_LIST);
46			}
47
48			/**
49			* @return array
50			*/
51			public function getDefinition()
52			{
53			return $this->definition;
54			}
55
56			/**
57			* @return array
58			*/
59			public function getPathDefinitions()
60			{
61			return $this->definition->paths;
			0 ignored issues – show Bug introduced 2016-02-04 19:12 UTC by Report Bug Copy Issue Report The property `paths` does not seem to exist in `ArrayObject`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
62			}
63
64			/**
65			* @return array
66			*/
67			public function getResourceSchemas()
68			{
69			return $this->definition->definitions;
			0 ignored issues – show Bug introduced 2016-02-04 19:12 UTC by Report Bug Copy Issue Report The property `definitions` does not seem to exist in `ArrayObject`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
70			}
71
72			/**
73			* @return string
74			*/
75			public function getBasePath()
76			{
77			return $this->definition->basePath;
			0 ignored issues – show Bug introduced 2016-02-04 19:12 UTC by Report Bug Copy Issue Report The property `basePath` does not seem to exist in `ArrayObject`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
78			}
79
80			/**
81			* @param string $path
82			* @param string $method
83			*
84			* @return array
85			*/
86			public function getOperationDefinition($path, $method)
87			{
88			$paths = $this->getPathDefinitions();
89			if (!isset($paths[$path])) {
90			throw new \InvalidArgumentException("Path '$path' not in Swagger document");
91			}
92			$method = strtolower($method);
93			if (!isset($paths[$path][$method])) {
94			throw new \InvalidArgumentException("Method '$method' not supported for path '$path'");
95			}
96
97			return $paths[$path][$method];
98			}
99
100			/**
101			* @return array
102			*/
103			public function getArrayCopy()
104			{
105			return $this->definition->getArrayCopy();
106			}
107
108			/**
109			* @param null $targetPath
110			*
111			* @return void
112			*/
113			public function write($targetPath = null)
114			{
115			$data = $this->getArrayCopy();
116			$data = self::unresolveSelfReferences($data, $data);
117			$yaml = Yaml::dump($data, 10, 2);
118			$yaml = str_replace(': { }', ': []', $yaml);
119			file_put_contents($targetPath ?: $this->pathFileName, $yaml);
120			}
121
122			/**
123			* Cloning will break things
124			*/
125			private function __clone()
126			{
127			}
128
129			/**
130			* @param array $segments
131			* @param array $context
132			*
133			* @return mixed
134			*/
135			private static function lookupUsingSegments(array $segments, array $context)
136			{
137			$segment = array_shift($segments);
138			if (isset($context[$segment])) {
139			if (!count($segments)) {
140			return $context[$segment];
141			}
142
143			return self::lookupUsingSegments($segments, $context[$segment]);
144			}
145
146			return null;
147			}
148
149			/**
150			* @param array $doc
151			* @param array $data
152			*
153			* @return array
154			*/
155			private function resolveSelfReferences(array $doc, array &$data)
156			{
157			foreach ($data as $key => &$value) {
158			if (is_array($value)) {
159			$value = self::resolveSelfReferences($doc, $value);
160			}
161			if ($key === '$ref' && '#' === $value[0]) {
162			$data = self::lookupUsingSegments(
163			explode('/', trim(substr($value, 1), '/')),
164			$doc
165			);
166			$data['id'] = $value;
167			// Use something a little less generic for more reliable qnd restoring of original
168			$data['x-swagger-id'] = $value;
169			}
170			}
171
172			return $data;
173			}
174
175			/**
176			* @param array $doc
177			* @param array $data
178			*
179			* @return array
180			*/
181			private function unresolveSelfReferences(array $doc, array &$data)
182			{
183			foreach ($data as $key => &$value) {
184			if (is_array($value)) {
185			$value = self::unresolveSelfReferences($doc, $value);
186			}
187			if ($key === 'x-swagger-id') {
188			$data = ['$ref' => $value];
189			}
190			}
191
192			return $data;
193			}
194			}
195

kleijnweb / swagger-bundle

Push — master ( 6ebd1c...df9bae )

SwaggerDocument::getBasePath() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like