Yaml::parseFile() - Code Metrics - Inspection of "Fix #113" - hassankhan/config - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#114)

by Filip

created 2018-10-09 14:24 UTC

Yaml::parseFile() A

↳ Parent: Yaml

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	15
ccs	8
cts	8
cp	1
rs	9.7666
c	0
b	0
f	0
cc	2
nc	2
nop	1
crap	2

<?php

namespace Noodlehaus\Parser;

use Exception;
use Symfony\Component\Yaml\Yaml as YamlParser;
use Noodlehaus\Exception\ParseException;

/**
 * YAML parser
 *
 * @package    Config
 * @author     Jesus A. Domingo <[email protected]>
 * @author     Hassan Khan <[email protected]>
 * @author     Filip Š <[email protected]>
 * @link       https://github.com/noodlehaus/config
 * @license    MIT
 */
class Yaml implements ParserInterface
{
    /**
     * {@inheritDoc}
     * Loads a YAML/YML file as an array
     *
     * @throws ParseException If If there is an error parsing the YAML file
     */
    public function parseFile($filename)
    {
        try {
            $data = YamlParser::parseFile($filename, YamlParser::PARSE_CONSTANT);
        } catch (Exception $exception) {
            throw new ParseException(
                [
                    'message'   => 'Error parsing YAML file',
                    'exception' => $exception,
                ]
            );
        }

        return $this->parse($data, $filename);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * {@inheritDoc}
     * Loads a YAML/YML string as an array
     *
     * @throws ParseException If If there is an error parsing the YAML string
     */
    public function parseString($config)
    {
        try {
            $data = YamlParser::parse($config, YamlParser::PARSE_CONSTANT);
        } catch (Exception $exception) {
            throw new ParseException(
                [
                    'message'   => 'Error parsing YAML string',
                    'exception' => $exception,
                ]
            );
        }

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

    /**
     * Completes parsing of YAML/YML data
     *
     * @param  array   $data
     * @param  strring $filename
     *
     * @throws ParseException If there is an error parsing the YAML data
     */
    protected function parse($data = null, $filename = null)

    {
        return $data;
    }

    /**
     * {@inheritDoc}
     */
    public static function getSupportedExtensions()
    {
        return ['yaml', 'yml'];
    }
}


1		<?php
2
3		namespace Noodlehaus\Parser;
4
5		use Exception;
6		use Symfony\Component\Yaml\Yaml as YamlParser;
7		use Noodlehaus\Exception\ParseException;
8
9		/**
10		* YAML parser
11		*
12		* @package Config
13		* @author Jesus A. Domingo <[email protected]>
14		* @author Hassan Khan <[email protected]>
15		* @author Filip Š <[email protected]>
16		* @link https://github.com/noodlehaus/config
17		* @license MIT
18		*/
19		class Yaml implements ParserInterface
20		{
21		/**
22		* {@inheritDoc}
23		* Loads a YAML/YML file as an array
24		*
25		* @throws ParseException If If there is an error parsing the YAML file
26		*/
27	9	public function parseFile($filename)
28		{
29		try {
30	9	$data = YamlParser::parseFile($filename, YamlParser::PARSE_CONSTANT);
31	5	} catch (Exception $exception) {
32	3	throw new ParseException(
33		[
34	3	'message' => 'Error parsing YAML file',
35	3	'exception' => $exception,
36		]
37	1	);
38		}
39
40	6	return $this->parse($data, $filename);
		0 ignored issues – show Documentation introduced 2018-10-09 14:38 UTC by Report Bug Copy Issue Report `$filename` is of type `string`, but the function expects a `object<Noodlehaus\Parser\strring>\|null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
41		}
42
43		/**
44		* {@inheritDoc}
45		* Loads a YAML/YML string as an array
46	3	*
47		* @throws ParseException If If there is an error parsing the YAML string
48	3	*/
49		public function parseString($config)
50		{
51		try {
52		$data = YamlParser::parse($config, YamlParser::PARSE_CONSTANT);
53		} catch (Exception $exception) {
54		throw new ParseException(
55		[
56		'message' => 'Error parsing YAML string',
57		'exception' => $exception,
58		]
59		);
60		}
61
62		return $this->parse($data);
63		}
64
65		/**
66		* Completes parsing of YAML/YML data
67		*
68		* @param array $data
69		* @param strring $filename
70		*
71		* @throws ParseException If there is an error parsing the YAML data
72		*/
73		protected function parse($data = null, $filename = null)
		0 ignored issues – show Unused Code introduced 2018-10-09 14:38 UTC by Report Bug Copy Issue Report The parameter `$filename` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
74		{
75		return $data;
76		}
77
78		/**
79		* {@inheritDoc}
80		*/
81		public static function getSupportedExtensions()
82		{
83		return ['yaml', 'yml'];
84		}
85		}
86

hassankhan / config

Pull Request — develop (#114)

Yaml::parseFile() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like