Yaml::parse() - Code Metrics - Inspection of "Minor fixes and code improvements" - xeriab/konfig - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 33953d...4a13d7 )

by Xeriab

created 2016-10-19 09:52 UTC

Yaml::parse() A

↳ Parent: Yaml

Complexity

Conditions	2
Paths	2

Size

Total Lines	19
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	2

Importance

Changes	3
Bugs	2	Features	0

Metric	Value
c	3
b	2
f	0
dl	0
loc	19
ccs	11
cts	11
cp	1
rs	9.4285
cc	2
eloc	11
nc	2
nop	1
crap	2

<?php

/**
 * Konfig.
 *
 * Yet another simple configuration loader library.
 *
 * PHP version 5
 *
 * @category Library
 * @package  Konfig
 * @author   Xeriab Nabil (aka KodeBurner) <[email protected]>
 * @license  https://raw.github.com/xeriab/konfig/master/LICENSE MIT
 * @link     https://xeriab.github.io/projects/konfig
 */

namespace Exen\Konfig\FileParser;

use Exception;
use Exen\Konfig\Exception\ParseException;
use Exen\Konfig\Utils;
use Symfony\Component\Yaml\Yaml as YamlParser;

/**
 * Yaml
 * Konfig's YAML parser class.
 *
 * @category FileParser
 * @package  Konfig
 * @author   Xeriab Nabil (aka KodeBurner) <[email protected]>
 * @license  https://raw.github.com/xeriab/konfig/master/LICENSE MIT
 * @link     https://xeriab.github.io/projects/konfig
 *
 * @implements Exen\Konfig\FileParser\AbstractFileParser
 */
class Yaml extends AbstractFileParser
{
    /**
     * Loads a YAML/YML file as an array.
     *
     * @param string $path File path
     *
     * @throws ParseException If there is an error parsing YAML/YML file
     *
     * @return array The parsed data
     *
     * @since 0.1.0
     */
    public function parse($path)
    {
        $data = null;

        try {
            $data = $this->loadFile($path);
        } catch (Exception $ex) {
            throw new ParseException(
                [
                'message' => 'Error parsing YAML file',
                'file' => realpath($path),
                'line' => $ex->getParsedLine(),
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                'exception' => $ex,
                ]
            );
        }

        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());
}
    }

    /**
     * {@inheritdoc}
     *
     * @return array Supported extensions
     *
     * @since 0.1.0
     */
    public function getSupportedFileExtensions()
    {
        return ['yaml', 'yml'];
    }

    /**
     * Loads in the given file and parses it.
     *
     * @param string $file File to load
     *
     * @return string|array|stdClass The parsed file data
     *
     * @since              0.2.4
     * @codeCoverageIgnore
     */
    protected function loadFile($file = null)
    {
        $this->file = $file;
        $contents = $this->parseVars(Utils::getContent($file));

        return YamlParser::parse($contents);
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());
}
    }

    /**
     * Returns the formatted configuration file contents.
     *
     * @param array $contents configuration array
     *
     * @return string formatted configuration file contents
     *
     * @since              0.2.4
     * @codeCoverageIgnore
     */
    protected function exportFormat($contents = null)
    {
        $this->prepVars($contents);


        return YamlParser::dump($contents);
    }

    /**
     * __toString.
     *
     * @return             string
     * @since              0.1.2
     * @codeCoverageIgnore
     */
    public function __toString()
    {
        return 'Exen\Konfig\FileParser\Yaml' . PHP_EOL;
    }
}

// END OF ./src/FileParser/Yaml.php FILE


1		<?php
2
3		/**
4		* Konfig.
5		*
6		* Yet another simple configuration loader library.
7		*
8		* PHP version 5
9		*
10		* @category Library
11		* @package Konfig
12		* @author Xeriab Nabil (aka KodeBurner) <[email protected]>
13		* @license https://raw.github.com/xeriab/konfig/master/LICENSE MIT
14		* @link https://xeriab.github.io/projects/konfig
15		*/
16
17		namespace Exen\Konfig\FileParser;
18
19		use Exception;
20		use Exen\Konfig\Exception\ParseException;
21		use Exen\Konfig\Utils;
22		use Symfony\Component\Yaml\Yaml as YamlParser;
23
24		/**
25		* Yaml
26		* Konfig's YAML parser class.
27		*
28		* @category FileParser
29		* @package Konfig
30		* @author Xeriab Nabil (aka KodeBurner) <[email protected]>
31		* @license https://raw.github.com/xeriab/konfig/master/LICENSE MIT
32		* @link https://xeriab.github.io/projects/konfig
33		*
34		* @implements Exen\Konfig\FileParser\AbstractFileParser
35		*/
36		class Yaml extends AbstractFileParser
37		{
38		/**
39		* Loads a YAML/YML file as an array.
40		*
41		* @param string $path File path
42		*
43		* @throws ParseException If there is an error parsing YAML/YML file
44		*
45		* @return array The parsed data
46		*
47		* @since 0.1.0
48		*/
49	6	public function parse($path)
50		{
51	6	$data = null;
52
53		try {
54	6	$data = $this->loadFile($path);
55	5	} catch (Exception $ex) {
56	3	throw new ParseException(
57		[
58	3	'message' => 'Error parsing YAML file',
59	3	'file' => realpath($path),
60	3	'line' => $ex->getParsedLine(),
		0 ignored issues – show Bug introduced 2016-10-16 20:17 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Exception` as the method `getParsedLine()` does only exist in the following sub-classes of `Exception`: `Exen\Konfig\Exception\DumpException`, `Exen\Konfig\Exception\RuntimeException`, `Symfony\Component\Yaml\Exception\ParseException`, `Yosymfony\Toml\Exception\ParseException`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
61	3	'exception' => $ex,
62		]
63	2	);
64		}
65
66	3	return $data;
		0 ignored issues – show Bug Best Practice introduced 2016-10-16 20:17 UTC by Report Bug Copy Issue Report The return type of `return $data;` (`string\|array\|stdClass`) is incompatible with the return type declared by the interface `Exen\Konfig\FileParser::parse` of type `array`. 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...
67		}
68
69		/**
70		* {@inheritdoc}
71		*
72		* @return array Supported extensions
73		*
74		* @since 0.1.0
75		*/
76	3	public function getSupportedFileExtensions()
77		{
78	3	return ['yaml', 'yml'];
79		}
80
81		/**
82		* Loads in the given file and parses it.
83		*
84		* @param string $file File to load
85		*
86		* @return string\|array\|stdClass The parsed file data
87		*
88		* @since 0.2.4
89		* @codeCoverageIgnore
90		*/
91		protected function loadFile($file = null)
92		{
93		$this->file = $file;
94		$contents = $this->parseVars(Utils::getContent($file));
95
96		return YamlParser::parse($contents);
		0 ignored issues – show Bug Best Practice introduced 2016-10-18 08:48 UTC by Report Bug Copy Issue Report The return type of `return \Symfony\Componen...Yaml::parse($contents);` (`string\|array\|stdClass`) is incompatible with the return type declared by the abstract method `Exen\Konfig\FileParser\A...actFileParser::loadFile` of type `array`. 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...
97		}
98
99		/**
100		* Returns the formatted configuration file contents.
101		*
102		* @param array $contents configuration array
103		*
104		* @return string formatted configuration file contents
105		*
106		* @since 0.2.4
107		* @codeCoverageIgnore
108		*/
109		protected function exportFormat($contents = null)
110		{
111		$this->prepVars($contents);
		0 ignored issues – show Bug introduced 2016-10-16 20:17 UTC by Report Bug Copy Issue Report It seems like `$contents` defined by parameter `$contents` on line 109 can also be of type `null`; however, `Exen\Konfig\FileParser\A...tFileParser::prepVars()` does only seem to accept `array`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
112
113		return YamlParser::dump($contents);
114		}
115
116		/**
117		* __toString.
118		*
119		* @return string
120		* @since 0.1.2
121		* @codeCoverageIgnore
122		*/
123		public function __toString()
124		{
125		return 'Exen\Konfig\FileParser\Yaml' . PHP_EOL;
126		}
127		}
128
129		// END OF ./src/FileParser/Yaml.php FILE
130

xeriab / konfig

Push — master ( 33953d...4a13d7 )

Yaml::parse() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like