Dallgoot\Yaml\Loader

Complexity

Total Complexity

30

Size/Duplication

Total Lines	177
Duplicated Lines	0 %

Test Coverage

Coverage

89.71%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
B	parse()	0	26	8
A	attachBlankLines()	0	8	3
A	getSourceGenerator()	0	7	4
A	__construct()	0	6	4
A	onError()	0	10	3
A	load()	0	16	5
A	needsSpecialProcess()	0	9	3

<?php
declare(strict_types=1);

namespace Dallgoot\Yaml;

/**
 * TODO
 *
 * @author  Stéphane Rebai <stephane.rebai@gmail.com>
 * @license Apache 2.0
 * @link    TODO : url to specific online doc
 */
final class Loader
{
    //public
    /* @var null|string */
    public static $error;
    public const IGNORE_DIRECTIVES     = 1;//DONT include_directive
    public const IGNORE_COMMENTS       = 2;//DONT include_comments
    public const NO_PARSING_EXCEPTIONS = 4;//DONT throw Exception on parsing errors
    public const NO_OBJECT_FOR_DATE    = 8;//DONT import date strings as dateTime Object

    //private
    /* @var null|false|array */
    private $content;
    /* @var null|string */
    private $filePath;
    /* @var integer */
    private $_debug = 0;
    /* @var integer */
    private $_options = 0;
    /* @var array */
    private $_blankBuffer = [];

    //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?)";

    /**
     * Loader constructor
     *
     * @param string|null       $absolutePath The file absolute path
     * @param int|null          $options      The options (bitmask as int value)
     * @param integer|bool|null $debug        The debug level as either boolean (true=1) or any integer
     */
    public function __construct($absolutePath = null, $options = null, $debug = 0)
    {
        $this->_debug   = is_null($debug) ? 0 : min($debug, 3);
        $this->_options = is_int($options) ? $options : $this->_options;
        if (is_string($absolutePath)) {
            $this->load($absolutePath);
        }
    }

    /**
     * Load a file and save its content as $content
     *
     * @param string $absolutePath The absolute path of a file
     *
     * @throws \Exception if file don't exist OR reading failed
     *
     * @return self  ( returns the same Loader  )
     */
    public function load(string $absolutePath):Loader
    {
        if (!file_exists($absolutePath)) {
            throw new \Exception(sprintf(self::EXCEPTION_NO_FILE, $absolutePath));
        }
        $this->filePath = $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;
    }

    /**
     * Gets the source iterator.
     *
     * @param string|null $strContent  The string content
     *
     * @throws \Exception if self::content is empty or splitting on linefeed has failed
     * @return \Generator  The source iterator.
     */
    private function getSourceGenerator($strContent = null):\Generator
    {
        $source = $this->content ?? preg_split("/\n/m", preg_replace('/(\r\n|\r)/', "\n", $strContent), 0, PREG_SPLIT_DELIM_CAPTURE);
        //TODO : be more permissive on $strContent values
        if (!is_array($source) || !count($source)) throw new \Exception(self::EXCEPTION_LINE_SPLIT);
        foreach ($source as $key => $value) {
            yield ++$key => $value;
        }
    }

    /**
     * Parse Yaml lines into a hierarchy of Node
     *
     * @param string $strContent The Yaml string or null to parse loaded content
     *
     * @throws \Exception    if content is not available as $strContent or as $this->content (from file)
     * @throws \ParseError  if any error during parsing or building
     *
     * @return array|YamlObject|null      null on errors if NO_PARSING_EXCEPTIONS is set, otherwise an array of YamlObject or just YamlObject
     */
    public function parse($strContent = null)
    {
        $generator = $this->getSourceGenerator($strContent);
        $previous = $root = new NodeRoot();
        try {
            foreach ($generator as $lineNb => $lineString) {
                $node = NodeFactory::get($lineString, $lineNb);
                if ($this->_debug === 1) echo get_class($node)."\n";
                if ($this->needsSpecialProcess($node, $previous)) continue;
                $this->attachBlankLines($previous);
                switch ($node->indent <=> $previous->indent) {
                    case -1: $target = $previous->getTargetOnLessIndent($node);
                        break;
                    case 0:  $target = $previous->getTargetOnEqualIndent($node);
                        break;
                    default: $target = $previous->getTargetOnMoreIndent($node);
                }
                $previous = $target->add($node);
            }
            $this->attachBlankLines($previous);
            if ($this->_debug === 1){
                return;
            }
            return Builder::buildContent($root, $this->_debug);
        } catch (\Error|\Exception|\ParseError $e) {
            $this->onError($e, $generator);
        }
    }


    /**
     * Attach blank(empty) Nodes savec in $blankBuffer to their parent (it means they are needed)
     *
     * @param array $emptyLines The empty lines
     * @param Node  $previous   The previous
     *
     * @return null
     */
    public function attachBlankLines(Node &$previous)
    {
        foreach ($this->_blankBuffer as $blankNode) {
            if ($blankNode !== $previous) {
                $blankNode->getParent()->add($blankNode);
            }
        }
        $this->_blankBuffer = [];
    }

    /**
     * For certain (special) Nodes types some actions are required BEFORE parent assignment
     *
     * @param Node   $previous   The previous Node
     * @param array  $emptyLines The empty lines
     *
     * @return boolean  if True self::parse skips changing previous and adding to parent
     * @see self::parse
     */
    public function needsSpecialProcess(Node $current, Node &$previous):bool
    {
        $deepest = $previous->getDeepestNode();
        if ($deepest instanceof NodePartial) {
            return $deepest->specialProcess($current,  $this->_blankBuffer);
        } elseif(!($current instanceof NodePartial)) {
            return $current->specialProcess($previous, $this->_blankBuffer);
        }
        return false;
    }

    public function onError(object $e, \Generator $generator)
    {
        $file = $this->filePath ? realpath($this->filePath) : '#YAML STRING#';
        $message = $e->getMessage()."\n ".$e->getFile().":".$e->getLine();
        if ($this->_options & self::NO_PARSING_EXCEPTIONS) {
            self::$error = $message;
            return null;
        }
        $line = $generator->key() ?? 'X';
        throw new \Exception($message." for $file:".$line, 1, $e);
    }
}