Loader::onDeepestType() - Code Metrics - Inspection of "add NodeList , fixes and simplifications on Loader..." - dallgoot/yaml - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 7a981c...2773c2 )

by stéphane

created 2018-07-30 16:31 UTC

Loader::onDeepestType() A

↳ Parent: Loader

Complexity

Conditions	2
Paths	2

Size

Total Lines	26
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

declare(strict_types=1);

Coding Style introduced 2018-07-24 18:09 UTC by

Missing file doc comment

namespace Dallgoot\Yaml;

use Dallgoot\Yaml as Y;

final class Loader

Coding Style introduced 2018-07-29 23:13 UTC by

Missing class doc comment

    //public

    public $errors = [];

    public const EXCLUDE_DIRECTIVES = 1;//DONT include_directive

    public const IGNORE_COMMENTS    = 2;//DONT include_comments

    public const NO_PARSING_EXCEPTIONS = 4;//THROW Exception on parsing Errors

    public const NO_OBJECT_FOR_DATE = 8;//DONT import date strings as dateTime Object

    //privates

    private $content;/* @var null|string */

Coding Style introduced 2018-07-29 23:13 UTC by

Private member variable "content" must be prefixed with an underscore

    private $filePath;/* @var null|string */

Coding Style introduced 2018-07-29 23:13 UTC by

Private member variable "filePath" must be prefixed with an underscore

    private $debug = 0;//TODO: determine levels

Coding Style introduced 2018-07-24 18:09 UTC by

Private member variable "debug" must be prefixed with an underscore

    private $options = 0;/* @var int */

Coding Style introduced 2018-07-29 23:13 UTC by

Private member variable "options" must be prefixed with an underscore

    //Exceptions messages

    private const INVALID_VALUE        = self::class.": at line %d";

    private const EXCEPTION_NO_FILE    = self::class.": file '%s' does not exists (or path is incorrect?)";

    private const EXCEPTION_READ_ERROR = self::class.": file '%s' failed to be loaded (permission denied ?)";

    private const EXCEPTION_LINE_SPLIT = self::class.": content is not a string(maybe a file error?)";

    public function __construct($absolutePath = null, $options = null, $debug = 0)

Coding Style introduced 2018-07-24 18:09 UTC by

Missing function doc comment

        $this->debug   = is_int($debug)   ? min($debug, 3) : 1;

        $this->options = is_int($options) ? $options       : $this->options;

        if (is_string($absolutePath)) {

            $this->load($absolutePath);

/**

     * load a file and save its content as $content

Coding Style introduced 2018-07-29 23:13 UTC by

Doc comment short description must start with a capital letter

     * @param      string       $absolutePath  The absolute path of a file

3 ignored issues

– show

     * @throws     \Exception   if file don't exist OR reading failed

1 ignored issue

– show

     * @return     self  ( returns the same Loader  )

1 ignored issue

– show

*/

    public function load(string $absolutePath):Loader

        $this->debug > 1 && var_dump($absolutePath);

1 ignored issue

– show

        $this->filePath = $absolutePath;

        if (!file_exists($absolutePath)) {

            throw new \Exception(sprintf(self::EXCEPTION_NO_FILE, $absolutePath));

        $adle = "auto_detect_line_endings";

        $prevADLE = ini_get($adle);

        !$prevADLE && ini_set($adle, "true");

        $content = file($absolutePath, FILE_IGNORE_NEW_LINES);

        !$prevADLE && ini_set($adle, "false");

        if (is_bool($content)) {

            throw new \Exception(sprintf(self::EXCEPTION_READ_ERROR, $absolutePath));

        $this->content = $content;

        return $this;

/**

     * Parse Yaml lines into an hierarchy of Node

     * @param      string       $strContent  The Yaml string or null to parse loaded content

3 ignored issues

– show

     * @throws     \Exception    if content is not available as $strContent or as $this->content (from file)

1 ignored issue

– show

Coding Style introduced 2018-07-24 18:09 UTC by

Tag cannot be grouped with parameter tags in a doc comment

     * @throws     \ParseError  if any error during parsing or building

1 ignored issue

– show

Coding Style introduced 2018-07-24 18:09 UTC by

Tag cannot be grouped with parameter tags in a doc comment

     * @return     array|YamlObject      the hierarchy built an array of YamlObject or just YamlObject

1 ignored issue

– show

*/

    public function parse($strContent = null)

        $source = $this->content;

        if (is_null($source)) $source = preg_split("/([^\n\r]+)/um", $strContent, 0, PREG_SPLIT_DELIM_CAPTURE);

1 ignored issue

– show

        //TODO : be more permissive on $strContent values

        if (!is_array($source)) throw new \Exception(self::EXCEPTION_LINE_SPLIT);

1 ignored issue

– show

        $previous = $root = new Node();

        $emptyLines = [];

        $specialTypes = Y\LITTERALS | Y\BLANK;

1 ignored issue

– show

        try {

            foreach ($source as $lineNb => $lineString) {

                $n = new Node($lineString, $lineNb + 1);//TODO: useful???-> $this->debug && var_dump($n);

                $deepest = $previous->getDeepestNode();

                if ($deepest->type & Y\PARTIAL) {

Bug introduced 2018-07-29 23:13 UTC by

The constant Dallgoot\Yaml\Y\PARTIAL was not found. Maybe you did not declare it correctly or list all dependencies?

                    //TODO:verify this edge case

                    // if ($n->type === Y\KEY && $n->indent === $previous->indent) {

                    //     throw new \ParseError(sprintf(self::INVALID_VALUE, $lineNb), 1);

                    // }

                    $deepest->parse($deepest->value.' '.ltrim($lineString));

                } else {

                    if (($n->type & $specialTypes) && $this->onSpecialType($n, $previous, $emptyLines)) {

                        continue;

                    if ($n->type & Y\SCALAR) {

Bug introduced 2018-07-30 16:35 UTC by

The constant Dallgoot\Yaml\Y\SCALAR was not found. Maybe you did not declare it correctly or list all dependencies?

                        foreach ($emptyLines as $blankNode) {

                            $blankNode->getParent()->add($blankNode);

100

101

102

                    $emptyLines = [];

103

                    switch ($n->indent <=> $previous->indent) {

104

                        case -1: $previous->getParent($n->indent)->add($n);break;

1 ignored issue

– show

Coding Style introduced 2018-07-30 16:35 UTC by

Closing brace must be on a line by itself

105

                        case  0: $previous->getParent()->add($n);break;

1 ignored issue

– show

Coding Style introduced 2018-07-30 16:35 UTC by

Closing brace must be on a line by itself

106

                        default:

1 ignored issue

– show

107

                            if ($this->onDeepestType($n, $previous, $lineString)) continue 2;

1 ignored issue

– show

108

                            $previous->add($n);

109

110

                    $previous = $n;

111

112

113

            if ($this->debug === 2) {

introduced 2018-07-29 23:13 UTC by

The condition $this->debug is always false. If $this->debug can have other possible types, add them to yaml/Loader.php:19

114

                var_dump("\033[33mParsed Structure\033[0m\n", $root);

Security Debugging Code introduced 2018-07-19 17:01 UTC by

var_dump('[33mParsed Structure[0m ', $root) looks like debug code. Are you sure you do not want to remove it?

115

                die("Debug of root structure requested (remove debug level to suppress these)");

Best Practice introduced 2018-07-29 23:13 UTC by

Using exit here is not recommended.

116

117

            $out = Builder::buildContent($root, $this->debug);//var_dump($out);exit();

Bug introduced 2018-07-30 16:35 UTC by

$this->debug of type null|string is incompatible with the type integer expected by parameter $_debug of Dallgoot\Yaml\Builder::buildContent(). ( Ignorable by Annotation )

118

            return $out;

119

        } catch (\Error|\Exception|\ParseError $e) {

120

            $file = basename($this->filePath);

121

            $message = basename($e->getFile())."@".$e->getLine().":".$e->getMessage()." in '$file' @".($lineNb+1)."\n";

Comprehensibility Best Practice introduced 2018-07-30 16:35 UTC by

The variable $lineNb seems to be defined by a foreach iteration on line 84. Are you sure the iterator is never empty, otherwise this variable is not defined?

122

            if ($e instanceof \ParseError && ($this->options & self::NO_PARSING_EXCEPTIONS)) {

123

                trigger_error($message, E_USER_WARNING);

124

                $this->errors[] = $message;

125

                var_dump($root);

126

127

            throw new \Exception($message, 3);

128

129

130

131

    private function onSpecialType(&$n, &$previous, &$emptyLines):bool

Coding Style introduced 2018-07-30 16:35 UTC by

Private method name "Loader::onSpecialType" must be prefixed with an underscore

Coding Style introduced 2018-07-30 16:35 UTC by

Missing function doc comment

132

133

        $deepest = $previous->getDeepestNode();

134

        if ($n->type & Y\LITTERALS) {

135

            if ($deepest->type & Y\KEY && is_null($deepest->value)) {

1 ignored issue

– show

136

                $deepest->add($n);

137

                $previous = $n;

138

                return true;

139

140

141

        if ($n->type & Y\BLANK) {

1 ignored issue

– show

142

            if ($previous->type & Y\SCALAR) $emptyLines[] = $n->setParent($previous->getParent());

1 ignored issue

– show

Bug introduced 2018-07-29 23:13 UTC by

The constant Dallgoot\Yaml\Y\SCALAR was not found. Maybe you did not declare it correctly or list all dependencies?

143

            if ($deepest->type & Y\LITTERALS) $emptyLines[] = $n->setParent($deepest);

1 ignored issue

– show

144

            return true;

145

146

        return false;

147

148

149

    private function onDeepestType(&$n, &$previous, $lineString):bool

Unused Code introduced 2018-07-30 16:35 UTC by

The parameter $n is not used and could be removed. ( Ignorable by Annotation )

Unused Code introduced 2018-07-30 16:35 UTC by

The parameter $lineString is not used and could be removed. ( Ignorable by Annotation )

Coding Style introduced 2018-07-30 16:35 UTC by

Private method name "Loader::onDeepestType" must be prefixed with an underscore

Coding Style introduced 2018-07-30 16:35 UTC by

Missing function doc comment

150

151

        $deepest = $previous->getDeepestNode();

152

        // if ($deepest->type & Y\LITTERALS) {

153

        //     $n->value = trim($lineString);//fall through

154

        // }

155

        // if ($deepest->type & (Y\LITTERALS | Y\REF_DEF | Y\SET_VALUE | Y\TAG) && is_null($deepest->value)) {

156

        //     $parent = $deepest;

157

        // }

158

        // // if ($previous->type & Y\ITEM && $n->type & Y\KEY) {

159

        // //     $previous

160

        // // }

161

        if ($deepest->type & (Y\BLANK | Y\SCALAR) ) {//|| ($previous->type & (Y\ITEM | Y\SET_KEY))) {

1 ignored issue

– show

Bug introduced 2018-07-30 16:35 UTC by

The constant Dallgoot\Yaml\Y\SCALAR was not found. Maybe you did not declare it correctly or list all dependencies?

162

                $previous = $deepest->getParent();

163

        //     // if ($n->type === Y\SCALAR && ($deepest->getParent()->type & Y\LITTERALS)) {

Coding Style introduced 2018-07-30 16:35 UTC by

Line indented incorrectly; expected at least 12 spaces, found 8

164

        //     //     // $deepest->type = Y\SCALAR;

Coding Style introduced 2018-07-30 16:35 UTC by

Line indented incorrectly; expected at least 12 spaces, found 8

165

        //     //     // $deepest->value .= "\n".$n->value;

Coding Style introduced 2018-07-30 16:35 UTC by

Line indented incorrectly; expected at least 12 spaces, found 8

166

        //     //     // ->add($n);

Coding Style introduced 2018-07-30 16:35 UTC by

Line indented incorrectly; expected at least 12 spaces, found 8

167

        //     //     // return true;

Coding Style introduced 2018-07-30 16:35 UTC by

Line indented incorrectly; expected at least 12 spaces, found 8

168

        //     // } else {

Coding Style introduced 2018-07-30 16:35 UTC by

Line indented incorrectly; expected at least 12 spaces, found 8

169

        //     //     if ($previous->type & (Y\ITEM | Y\SET_KEY)) {

Coding Style introduced 2018-07-30 16:35 UTC by

Line indented incorrectly; expected at least 12 spaces, found 8

170

        //     //         $parent = $deepest->getParent();

Coding Style introduced 2018-07-30 16:35 UTC by

Line indented incorrectly; expected at least 12 spaces, found 8

171

        //     //     }

Coding Style introduced 2018-07-30 16:35 UTC by

Line indented incorrectly; expected at least 12 spaces, found 8

172

        //     // }

Coding Style introduced 2018-07-30 16:35 UTC by

Line indented incorrectly; expected at least 12 spaces, found 8

173

174

        return false;

175

176

177

dallgoot / yaml

Push — master ( 7a981c...2773c2 )

Loader::onDeepestType() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like