YamlParser - Code Metrics - Inspection of "3.0 Release" - kleijnweb/swagger-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#52)

by John

created 2016-02-14 10:29 UTC

YamlParser A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	55
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	3
Bugs	2	Features	0

Metric	Value
wmc	7
c	3
b	2
f	0
lcom	1
cbo	1
dl	0
loc	55
rs	10

3 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	parse()	7	1
B	fixHashMaps()	19	5

<?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 Symfony\Component\Yaml\Parser;

/**
 * Facade/Adapter for Symfony\Yaml
 *
 * @author John Kleijn <[email protected]>
 */
class YamlParser
{
    /**
     * @var Parser
     */
    private $parser;

    /**
     * Construct the wrapper
     */
    public function __construct()
    {
        $this->parser = new Parser();
    }

    /**
     * @param string $string
     *
     * @return object
     */
    public function parse($string)
    {
        // Hashmap support is broken, so disable it and attempt fix afterwards
        $data = $this->parser->parse($string, true, false, false);

        return $this->fixHashMaps($data);
    }

    /**
     * @see https://github.com/symfony/symfony/pull/17711
     *
     * @param mixed $data
     *
     * @return \stdClass
     */
    private function fixHashMaps(&$data)
    {
        if (is_array($data)) {
            $shouldBeObject = false;
            $object = new \stdClass();
            $index = 0;
            foreach ($data as $key => &$value) {
                $object->$key = $this->fixHashMaps($value);
                if ($index++ !== $key) {
                    $shouldBeObject = true;
                }
            }
            if ($shouldBeObject) {
                $data = $object;
            }
        }

        return $data;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }
}


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 Symfony\Component\Yaml\Parser;
12
13			/**
14			* Facade/Adapter for Symfony\Yaml
15			*
16			* @author John Kleijn <[email protected]>
17			*/
18			class YamlParser
19			{
20			/**
21			* @var Parser
22			*/
23			private $parser;
24
25			/**
26			* Construct the wrapper
27			*/
28			public function __construct()
29			{
30			$this->parser = new Parser();
31			}
32
33			/**
34			* @param string $string
35			*
36			* @return object
37			*/
38			public function parse($string)
39			{
40			// Hashmap support is broken, so disable it and attempt fix afterwards
41			$data = $this->parser->parse($string, true, false, false);
42
43			return $this->fixHashMaps($data);
44			}
45
46			/**
47			* @see https://github.com/symfony/symfony/pull/17711
48			*
49			* @param mixed $data
50			*
51			* @return \stdClass
52			*/
53			private function fixHashMaps(&$data)
54			{
55			if (is_array($data)) {
56			$shouldBeObject = false;
57			$object = new \stdClass();
58			$index = 0;
59			foreach ($data as $key => &$value) {
60			$object->$key = $this->fixHashMaps($value);
61			if ($index++ !== $key) {
62			$shouldBeObject = true;
63			}
64			}
65			if ($shouldBeObject) {
66			$data = $object;
67			}
68			}
69
70			return $data;
			0 ignored issues – show Bug Best Practice introduced 2016-02-06 22:56 UTC by Report Bug Copy Issue Report The return type of `return $data;` (`object\|integer\|double\|string\|null\|boolean\|array`) is incompatible with the return type documented by `KleijnWeb\SwaggerBundle\...YamlParser::fixHashMaps` of type `stdClass\|null`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
71			}
72			}
73

kleijnweb / swagger-bundle

Pull Request — master (#52)

YamlParser A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

Duplication Side-by-Side

Filter issues like