Builder::buildItem() - Code Metrics - Inspection of "improved versions of Node:add Node::define and Bui..." - dallgoot/yaml - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 2b7f2d...31c8a2 )

by stéphane
created 2018-08-20 09:27 UTC
Builder::buildItem() A

↳ Parent: Builder
Complexity

Conditions	6
Paths	3
Size

Total Lines	10
Code Lines	7
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	6
eloc	7
nc	3
nop	2
dl	0
loc	10
rs	9.2222
c	0
b	0
f	0
<?php


namespace Dallgoot\Yaml;

use Dallgoot\Yaml\Yaml as Y;

/**
 * Constructs the result (YamlObject or array) according to every Node and respecting value
 * @category tag in class comment

 * @package tag in class comment

 * @author tag in class comment

 * @license tag in class comment

 */

final class Builder
{
    private static $_root;
    private static $_debug;

    const ERROR_NO_KEYNAME = self::class.": key has NO IDENTIFIER on line %d";
    const INVALID_DOCUMENT = self::class.": DOCUMENT %d can NOT be a mapping AND a sequence";


    private static function build(object $node, &$parent = null)

    {
        if ($node instanceof NodeList) return self::buildNodeList($node, $parent);
        return self::buildNode($node, $parent);
    }

    private static function buildNodeList(NodeList $node, &$parent)

    {
        if ($node->type & (Y::RAW | Y::LITTERALS)) {
            return self::buildLitteral($node, $node->type);
            return self::buildLitteral($node, /** @scrutinizer ignore-type */ $node->type);
        }
        $p = $parent;
        switch ($node->type) {
            case Y::MAPPING: //fall through
            case Y::SET:      $p = new \StdClass; break;

            case Y::SEQUENCE: $p = []; break;

            // case Y::KEY: $p = $parent;break;
        }
        $out = null;
        foreach ($node as $child) {
            $result = self::build($child, $p);
            if (!is_null($result)) {
                if (is_string($result)) {
                    $out .= $result.' ';
                } else {
                    return $result;
                }
            }
        }
        return is_null($out) ? $p : rtrim($out);
    }

    private static function buildNode(Node $node, &$parent)

    {
        extract((array) $node, EXTR_REFS);
        if ($type & (Y::REF_DEF | Y::REF_CALL)) {
            if (is_object($value)) {
                $tmp = self::build($value, $parent) ?? $parent;
            } else {
                $tmp = $node->getPhpValue();
            }
            if ($type === Y::REF_DEF) self::$_root->addReference($identifier, $tmp);
            return self::$_root->getReference($identifier);
        }
        $typesActions = [Y::COMMENT   => 'buildComment',
                         Y::DIRECTIVE => 'buildDirective',
                         Y::ITEM      => 'buildItem',
                         Y::KEY       => 'buildKey',
                         Y::SET_KEY   => 'buildSetKey',
                         Y::SET_VALUE => 'buildSetValue',
                         Y::TAG       => 'buildTag',
        ];
        if (isset($typesActions[$type])) {
            return self::{$typesActions[$type]}($node, $parent);
        }
        return is_object($value) ? self::build($value, $parent) : $node->getPhpValue();
    }

    /**
     * Builds a key and set the property + value to the given parent
     *
     * @param Node $node       The node

     * @param object|array $parent       The parent

     *
     * @throws \ParseError if Key has no name(identifier)
     * @return null
     */
    private static function buildKey(Node $node, &$parent):void

    {
        extract((array) $node, EXTR_REFS);
        if (is_null($identifier)) {
            throw new \ParseError(sprintf(self::ERROR_NO_KEYNAME, $line));
        } else {
            if ($value instanceof Node && ($value->type & (Y::KEY|Y::ITEM))) {
                $parent->{$identifier} = $value->type & Y::KEY ? new \StdClass : [];
                self::build($value, $parent->{$identifier});
            } elseif (is_object($value)) {
                $parent->{$identifier} = self::build($value, $parent->{$identifier});
            } else {
                $parent->{$identifier} = $node->getPhpValue();
            }
        }
    }

    private static function buildItem(Node $node, &$parent):void

    {
        if (!is_array($parent) && !($parent instanceof \ArrayIterator)) {
            throw new \Exception("parent must be an Iterable not ".(is_object($parent) ? get_class($parent) : gettype($parent)), 1);
        }
        if ($value instanceof Node && $value->type === Y::KEY) {

            $parent[$node->value->identifier] = self::build($node->value->value, $parent[$node->value->identifier]);
            $parent[$node->value->identifier] = self::build(/** @scrutinizer ignore-type */ $node->value->value, $parent[$node->value->identifier]);
        } else {
            $index = count($parent);
            $parent[$index] = self::build($node->value, $parent[$index]);
        }
    }

    /**
     * Builds a file.  check multiple documents & split if more than one documents
     *
     * @param   Node   $_root      The root node

     * @param   int   $_debug      the level of debugging requested

     *
     * @return array|YamlObject      list of documents or juste one.
     */
    public static function buildContent(Node $_root, int $_debug)
    {
        self::$_debug = $_debug;
        $totalDocStart = 0;
        $documents = [];
        if ($_root->value instanceof Node) {
            $q = new NodeList;
            $q->push($_root->value);
            return self::buildDocument($q, 0);
        }
        $_root->value->setIteratorMode(NodeList::IT_MODE_DELETE);
                       setIteratorMode(NodeList::IT_MODE_DELETE);
        foreach ($_root->value as $child) {
            if ($child->type & Y::DOC_START) $totalDocStart++;
            //if 0 or 1 DOC_START = we are still in first document
            $currentDoc = $totalDocStart > 1 ? $totalDocStart - 1 : 0;
            if (!isset($documents[$currentDoc])) $documents[$currentDoc] = new NodeList();
            $documents[$currentDoc]->push($child);
        }
        $content = array_map([self::class, 'buildDocument'], $documents, array_keys($documents));
        return count($content) === 1 ? $content[0] : $content;
    }

    private static function buildDocument(NodeList $list, int $key):YamlObject

    {
        self::$_root = new YamlObject();
        $childTypes = $list->getTypes();
        $isaMapping  = (bool) (Y::KEY | Y::MAPPING) & $childTypes;
        $isaSequence = (bool) Y::ITEM & $childTypes;
        $isaSet      = (bool) Y::SET_VALUE & $childTypes;
        if ($isaMapping && $isaSequence) {
            throw new \ParseError(sprintf(self::INVALID_DOCUMENT, $key));
        } else {
            switch (true) {

                case $isaSequence: $list->type = Y::SEQUENCE;break;

                case $isaSet:      $list->type = Y::SET;break;

                default:           $list->type = Y::MAPPING;
            }
        }
        $string = '';
        foreach ($list as $child) {
            $result = self::build($child, self::$_root);
            if (is_string($result)) {
                $string .= $result.' ';
            }
        }
        if (!empty($string)) {
            self::$_root->setText(rtrim($string));
        }
        return self::$_root;
    }

    private static function buildLitteral(NodeList $children, int $type):string

    {
        $lines = [];
        $children->rewind();
        $refIndent = $children->current()->indent;
        foreach ($children as $child) {
            if ($child->value instanceof NodeList) {
                $lines[] = self::buildLitteral($child->value, $type);
            } else {
                $prefix = '';
                if ($type & Y::LITT_FOLDED && ($child->indent > $refIndent || ($child->type & Y::BLANK))) {
                    $prefix = "\n";
                }
                $lines[] = $prefix.$child->value;
            }
        }
        if ($type & Y::RAW)         return implode('',   $lines);
        if ($type & Y::LITT)        return implode("\n", $lines);
        if ($type & Y::LITT_FOLDED) return implode(' ',  $lines);
interface ReturnsInt {
    public function returnsIntHinted(): int;
}

class MyClass implements ReturnsInt {
    public function returnsIntHinted(): int
    {
        if (foo()) {
            return 123;
        }
        // here: null is implicitly returned
    }
}
    }

    private function buildSetKey(Node $node, $parent):void

    {
        $key = json_encode(self::build($node->value, $parent), JSON_PARTIAL_OUTPUT_ON_ERROR|JSON_UNESCAPED_SLASHES);
        $key = json_encode(self::build(/** @scrutinizer ignore-type */ $node->value, $parent), JSON_PARTIAL_OUTPUT_ON_ERROR|JSON_UNESCAPED_SLASHES);
        if (empty($key))
        throw new \Exception("Cant serialize complex key: ".var_export($node->value, true), 1);
        $parent->{$key} = null;
    }

    private function buildSetValue(Node $node, $parent):void

    {
        $prop = array_keys(get_object_vars($parent));
        $key = end($prop);
        if ($node->value->type & (Y::ITEM|Y::MAPPING)) {
            $p = $node->value->type === Y::ITEM ? [] : new \StdClass;
            self::build($node->value, $p);
            self::build(/** @scrutinizer ignore-type */ $node->value, $p);
        } else {
            $p = self::build($node->value, $parent->{$key});
        }
        $parent->{$key} = $p;
    }

    private function buildTag(Node $node, $parent)

    {
        if ($parent === self::$_root) {
            $parent->addTag($node->identifier);
            return;
        }
        //TODO: have somewhere a list of common tags and their treatment
        if (in_array($node->identifier, ['!binary', '!str'])) {
            if ($node->value->value instanceof NodeList) $node->value->value->type = Y::RAW;

            else $node->value->type = Y::RAW;
        }
        $val = is_null($node->value) ? null : self::build(/** @scrutinizer ignore-type */ $node->value, $node);

        return new Tag($node->identifier, $val);
    }

    private function buildComment(Node $node, $parent):void

    {
        self::$_root->addComment($node->line, $node->value);
    }

    private function buildDirective($node, $parent)

    {
        # TODO : implement

    }
}

dallgoot / yaml

Push — master ( 2b7f2d...31c8a2 )

Builder::buildItem() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
