Dallgoot\Yaml\Node

Complexity

Total Complexity

67

Size/Duplication

Total Lines	327
Duplicated Lines	0 %

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	getParent()	0	8	4
A	setParent()	0	4	1
A	__construct()	0	7	2
A	onHyphen()	0	17	6
A	getDeepestNode()	0	7	2
A	getNumber()	0	5	4
A	parse()	0	17	5
A	getCompact()	0	18	5
A	getScalar()	0	15	4
A	onObject()	0	7	4
A	onNodeAction()	0	9	3
A	add()	0	16	6
A	onKey()	0	19	5
B	define()	0	23	9
A	getPhpValue()	0	14	5
A	__debugInfo()	0	6	2

<?php

Missing file doc comment

namespace Dallgoot\Yaml;

use Dallgoot\Yaml\Yaml as Y;
use Dallgoot\Yaml\Regex as R;

/**
 * TODO
 * @category tag in class comment

There must be exactly one blank line before the tags in a doc comment

Category name "tag in class comment" is not valid; consider "Tag_In_Class_Comment" instead

 * @package tag in class comment

Package name "tag in class comment" is not valid; consider "Tag_In_Class_Comment" instead

Tag value indented incorrectly; expected 2 spaces but found 1

 * @author tag in class comment

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value indented incorrectly; expected 3 spaces but found 1

 * @license tag in class comment

Tag value indented incorrectly; expected 2 spaces but found 1

 */

Missing @link tag in class comment

final class Node
{
    /** @var int */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

    public $indent = -1;
    /** @var int */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

    public $line;
    /** @var int */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

    public $type;
    /** @var null|string|boolean */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

    public $identifier;
    /** @var Node|NodeList|null|string */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

    public $value;

    /** @var null|Node */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

    private $parent;

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

    public function __construct($nodeString = null, $line = null)

Missing function doc comment

    {
        $this->line = $line;
        if (is_null($nodeString)) {
            $this->type = Y::ROOT;
        } else {
            $this->parse($nodeString);
        }
    }

    /**
     * Sets the parent of the current Node
     * @param      Node       $node   The node

There must be exactly one blank line before the tags in a doc comment

Expected 1 spaces after parameter type; 7 found

Expected 1 spaces after parameter name; 3 found

Tag value indented incorrectly; expected 1 spaces but found 6

     *
     * @return     Node|self  The currentNode

Tag value indented incorrectly; expected 1 spaces but found 5

     */
    public function setParent(Node $node):Node
    {
        $this->parent = $node;
        return $this;
    }

    /**
     * Gets the ancestor with specified $indent or the direct $parent OR the current Node itself
     *
     * @param int|null    $indent        The indent

Expected 1 spaces after parameter type; 4 found

Expected 1 spaces after parameter name; 8 found

     *
     * @return Node|self        The parent.
     */
    public function getParent(int $indent = null):Node
    {
        if (!is_int($indent)) return $this->parent ?? $this;
        $cursor = $this;
        while ($cursor instanceof Node && $cursor->indent >= $indent) {
            $cursor = $cursor->parent;
        }
        return $cursor;

The expression return $cursor could return the type null which is incompatible with the type-hinted return Dallgoot\Yaml\Node. Consider adding an additional type-check to rule them out.

    }

    /**
     * Set the value for the current Node :
     * - if value is null , then value = $child (Node)
     * - if value is Node, then value is a NodeList with (previous value AND $child)
     * - if value is a NodeList, simply push $child into
     *
     * @param      Node  $child  The child

Expected 1 spaces after parameter type; 2 found

Expected 1 spaces after parameter name; 2 found

Tag value indented incorrectly; expected 1 spaces but found 6

     */

Missing @return tag in function comment

    public function add(Node $child):void
    {
        $child->setParent($this);
        $current = $this->value;
        if (is_null($current)) {
            $this->value = $child;
        } else {
            if ($current instanceof Node) {
                $this->value = new NodeList();
                $this->value->push($current);
            }
            $this->value->push($child);

The method push() does not exist on Dallgoot\Yaml\Node.

The method push() does not exist on null.

            //modify type according to child
            if ($child->type & (Y::COMMENT | Y::KEY)) $this->value->type = Y::MAPPING;
            if ($child->type & Y::ITEM)               $this->value->type = Y::SEQUENCE;
            if ($this->type & Y::LITTERALS)  $this->value->type = $this->type;
        }
    }

    public function getDeepestNode():Node

Missing function doc comment

    {
        $cursor = $this;
        while ($cursor->value instanceof Node) {
            $cursor = $cursor->value;
        }
        return $cursor;
    }

    /**
     * Parses the string (assumed to be a line from a valid YAML)
     *
     * @param      string     $nodeString  The node string

Expected 1 spaces after parameter type; 5 found

Expected 1 spaces after parameter name; 2 found

Tag value indented incorrectly; expected 1 spaces but found 6

     *
     * @return     Node|self  ( description_of_the_return_value )

Tag value indented incorrectly; expected 1 spaces but found 5

     */
    public function parse(string $nodeString):Node
    {
        $nodeValue = preg_replace("/^\t+/m", " ", $nodeString); //permissive to tabs but replacement
        $this->indent = strspn($nodeValue, ' ');
        $nodeValue = ltrim($nodeValue);
        if ($nodeValue === '') {
            $this->type = Y::BLANK;
            // $this->indent = 0; // remove if no bugs
        } elseif (substr($nodeValue, 0, 3) === '...') {//TODO: can have something on same line ?
            $this->type = Y::DOC_END;
        } elseif (preg_match(R::KEY, $nodeValue, $matches)) {
            $this->onKey($matches);
        } else {//NOTE: can be of another type according to parent
            list($this->type, $value) = $this->define($nodeValue);
            is_object($value) ? $this->add($value) : $this->value = $value;
        }
        return $this;
    }

    /**
     *  Set the type and value according to first character
     *
     * @param      string  $nodeValue  The node value

Expected 1 spaces after parameter type; 2 found

Expected 1 spaces after parameter name; 2 found

Tag value indented incorrectly; expected 2 spaces but found 6

     * @return     array   contains [node->type, node->value]

Tag cannot be grouped with parameter tags in a doc comment

Tag value indented incorrectly; expected 1 spaces but found 5

     */
    private function define($nodeValue):array

Private method name "Node::define" must be prefixed with an underscore

    {
        $v = substr($nodeValue, 1);
        $first = $nodeValue[0];
        if (in_array($first, ['"', "'"])) {
            $type = R::isProperlyQuoted($nodeValue) ? Y::QUOTED : Y::PARTIAL;
            return [$type, $nodeValue];
        }
        if (in_array($first, ['{', '[']))      return $this->onObject($nodeValue);
        if (in_array($first, ['!', '&', '*'])) return $this->onNodeAction($nodeValue);
        // Note : php don't like '?' as an array key -_-
        if($first === '?') return [Y::SET_KEY, empty($v) ? null : new Node(ltrim($v), $this->line)];
        $characters = [ '#' =>  [Y::COMMENT, ltrim($v)],
                        "-" =>  $this->onHyphen($nodeValue),
                        '%' =>  [Y::DIRECTIVE, ltrim($v)],
                        ':' =>  [Y::SET_VALUE, empty($v) ? null : new Node(ltrim($v), $this->line)],
                        '>' =>  [Y::LITT_FOLDED, null],
                        '|' =>  [Y::LITT, null]
        ];
        if (array_key_exists($first, $characters)) {
            return $characters[$first];
        }
        return [Y::SCALAR, $nodeValue];
    }

    /**
     * Process when a "key: value" syntax is found in the parsed string
     * Note : key is match 1, value is match 2 as per regex from R::KEY
     * @param      array  $matches  The matches provided by 'preg_match' function

There must be exactly one blank line before the tags in a doc comment

Expected 1 spaces after parameter type; 2 found

Expected 1 spaces after parameter name; 2 found

Tag value indented incorrectly; expected 1 spaces but found 6

     */

Missing @return tag in function comment

    private function onKey(array $matches):void

Private method name "Node::onKey" must be prefixed with an underscore

    {
        $this->type = Y::KEY;
        $this->identifier = trim($matches[1]);
        $value = isset($matches[2]) ? trim($matches[2]) : null;
        if (!empty($value)) {
            $n = new Node($value, $this->line);
            $hasComment = strpos($value, ' #');
            if (!is_bool($hasComment)) {

The condition is_bool($hasComment) is always false.

                $tmpNode = new Node(trim(substr($value, 0, $hasComment)), $this->line);
                if ($tmpNode->type !== Y::PARTIAL) {
                    $comment = new Node(trim(substr($value, $hasComment + 1)), $this->line);
                    $comment->identifier = true; //to specify it is NOT a fullline comment
                    $this->add($comment);
                    $n = $tmpNode;
                }
            }
            $n->indent = $this->indent + strlen($this->identifier);
            $this->add($n);
        }
    }

    /**
     * Determines the correct type and value when a short object/array syntax is found
     *
     * @param      string  $value  The value assumed to start with { or ( or characters

Expected 1 spaces after parameter type; 2 found

Expected 1 spaces after parameter name; 2 found

Tag value indented incorrectly; expected 1 spaces but found 6

     *
     * @return     array   array with the type and $value (unchanged for now)

Tag value indented incorrectly; expected 1 spaces but found 5

     * @see self:define

Tag value indented incorrectly; expected 4 spaces but found 1

     */
    private function onObject($value):array

Private method name "Node::onObject" must be prefixed with an underscore

    {
        json_decode($value, false, 512, JSON_PARTIAL_OUTPUT_ON_ERROR|JSON_UNESCAPED_SLASHES);
        if (json_last_error() === JSON_ERROR_NONE)  return [Y::JSON, $value];
        if (preg_match(R::MAPPING, $value))         return [Y::COMPACT_MAPPING, $value];
        if (preg_match(R::SEQUENCE, $value))        return [Y::COMPACT_SEQUENCE, $value];
        return [Y::PARTIAL, $value];
    }

    /**
     * Determines type and value when an hyphen "-" is found
     *
     * @param      string $nodeValue  The node value

Expected 1 spaces after parameter name; 2 found

Tag value indented incorrectly; expected 1 spaces but found 6

     *
     * @return     array   array with the type and $value

Tag value indented incorrectly; expected 1 spaces but found 5

     */
    private function onHyphen($nodeValue):array

Private method name "Node::onHyphen" must be prefixed with an underscore

    {
        if (substr($nodeValue, 0, 3) === '---') {
            $rest = trim(substr($nodeValue, 3));
            if (empty($rest)) return [Y::DOC_START, null];
            $n = new Node($rest, $this->line);
            $n->indent = $this->indent + 4;
            return [Y::DOC_START, $n->setParent($this)];
        }
        if (preg_match(R::ITEM, $nodeValue, $matches)) {
            if (isset($matches[1]) && !empty(trim($matches[1]))) {
                $n = new Node(trim($matches[1]), $this->line);
                return [Y::ITEM, $n->setParent($this)];
            }
            return [Y::ITEM, null];
        }
        return [Y::SCALAR, $nodeValue];
    }

    /**
     * Determines the type and value according to $nodeValue when one of these characters is found : !,&,*
     *
     * @param      string  $nodeValue  The node value

Expected 1 spaces after parameter type; 2 found

Expected 1 spaces after parameter name; 2 found

Tag value indented incorrectly; expected 1 spaces but found 6

     *
     * @return     array   array with the type and $value

Tag value indented incorrectly; expected 1 spaces but found 5

     * @see self::define

Tag value indented incorrectly; expected 4 spaces but found 1

     */
    private function onNodeAction($nodeValue):array

Private method name "Node::onNodeAction" must be prefixed with an underscore

    {
        // TODO: handle tags like  <tag:clarkevans.com,2002:invoice>
        $v = substr($nodeValue, 1);
        $type = ['!' => Y::TAG, '&' => Y::REF_DEF, '*' => Y::REF_CALL][$nodeValue[0]];
        $pos = strpos($v, ' ');
        $this->identifier = is_bool($pos) ? $v : strstr($v, ' ', true);

The condition is_bool($pos) is always false.

        $n = is_bool($pos) ? null : (new Node(trim(substr($nodeValue, $pos + 1)), $this->line))->setParent($this);

The condition is_bool($pos) is always false.

        return [$type, $n];
    }

    /**
     * Returns the correct PHP datatype for the value of the current Node
     *
     * @return mixed  The value as PHP type : scalar, array or Compact, DateTime
     */
    public function getPhpValue()
    {
        $v = &$this->value;
        if (is_null($v)) return null;
        if ($this->type & (Y::REF_CALL | Y::SCALAR)) return self::getScalar($v);

It seems like $v can also be of type Dallgoot\Yaml\NodeList and Dallgoot\Yaml\Node; however, parameter $v of Dallgoot\Yaml\Node::getScalar() does only seem to accept string, maybe add an additional type check?

        if ($this->type & (Y::COMPACT_MAPPING | Y::COMPACT_SEQUENCE)) return self::getCompact(substr($v, 1, -1), $this->type);

It seems like $v can also be of type Dallgoot\Yaml\NodeList and Dallgoot\Yaml\Node; however, parameter $string of substr() does only seem to accept string, maybe add an additional type check?

        $expected = [Y::JSON   => json_decode($v, false, 512, JSON_PARTIAL_OUTPUT_ON_ERROR),

It seems like $v can also be of type Dallgoot\Yaml\NodeList and Dallgoot\Yaml\Node; however, parameter $json of json_decode() does only seem to accept string, maybe add an additional type check?

                     Y::QUOTED => substr($v, 1, -1),
                     Y::RAW    => strval($v)];
        if (isset($expected[$this->type])) {
            return $expected[$this->type];
        }
        trigger_error("Error can not get PHP type for ".Y::getName($this->type), E_USER_WARNING);
        return null;
    }

    /**
     * Returns the correct PHP type according to the string value
     *
     * @param      string  $v      a string value

Expected 1 spaces after parameter type; 2 found

Expected 1 spaces after parameter name; 6 found

Tag value indented incorrectly; expected 1 spaces but found 6

     *
     * @return     mixed   The value with appropriate PHP type

Tag value indented incorrectly; expected 1 spaces but found 5

     */
    private static function getScalar(string $v)

Private method name "Node::getScalar" must be prefixed with an underscore

    {
        $types = ['yes'   => true,
                    'no'    => false,
                    'true'  => true,
                    'false' => false,
                    'null'  => null,
                    '.inf'  => INF,
                    '-.inf' => -INF,
                    '.nan'  => NAN
        ];
        if (isset($types[strtolower($v)])) return $types[strtolower($v)];
        if (R::isDate($v))   return date_create($v);
        if (R::isNumber($v)) return self::getNumber($v);
        return strval($v);
    }

    /**
     * Returns the correct PHP type according to the string value
     *
     * @param      string  $v      a string value

Expected 1 spaces after parameter type; 2 found

Expected 1 spaces after parameter name; 6 found

Tag value indented incorrectly; expected 1 spaces but found 6

     *
     * @return     int|float   The scalar value with appropriate PHP type

Tag value indented incorrectly; expected 1 spaces but found 5

     */
    private static function getNumber(string $v)

Private method name "Node::getNumber" must be prefixed with an underscore

    {
        if (preg_match("/^(0o\d+)$/i", $v))      return intval(base_convert($v, 8, 10));
        if (preg_match("/^(0x[\da-f]+)$/i", $v)) return intval(base_convert($v, 16, 10));
        return is_bool(strpos($v, '.')) ? intval($v) : floatval($v);

The condition is_bool(strpos($v, '.')) is always false.

    }

    private static function getCompact(string $mappingOrSeqString, int $type):object

Private method name "Node::getCompact" must be prefixed with an underscore

Missing function doc comment

    {
        $out = new Compact();
        if ($type === Y::COMPACT_SEQUENCE) {
            $f = function ($e) { return self::getScalar(trim($e));};

Opening brace must be the last content on the line

Closing brace must be on a line by itself

            //TODO : that's not robust enough, improve it
            foreach (array_map($f, explode(",", $mappingOrSeqString)) as $key => $value) {
                $out[$key] = $value;
            }
        }
        if ($type === Y::COMPACT_MAPPING) {
            //TODO : that's not robust enough, improve it
            foreach (explode(',', $mappingOrSeqString) as $value) {
                list($keyName, $keyValue) = explode(':', $value);
                $out->{trim($keyName)} = self::getScalar(trim($keyValue));
            }
        }
        return $out;
    }

    /**
     * PHP internal function for debugging purpose : simplify output provided by 'var_dump'
     *
     * @return     array  the Node properties and respective values displayed by 'var_dump'

Tag value indented incorrectly; expected 1 spaces but found 5

     */
    public function __debugInfo():array
    {
        return ['line'  => $this->line,
                'indent'=> $this->indent,
                'type'  => Y::getName($this->type).($this->identifier ? "($this->identifier)" : ''),
                'value' => $this->value];
    }
}