YamlStandards\Model\YamlInline\YamlInlineChecker

Complexity

Total Complexity

5

Size/Duplication

Total Lines	49
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	1	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	removeComments()	0	3	1
A	removeCommentLine()	0	3	1
A	check()	0	26	3

<?php

declare(strict_types=1);

namespace YamlStandards\Model\YamlInline;

use SebastianBergmann\Diff\Differ;
use SebastianBergmann\Diff\Output\UnifiedDiffOutputBuilder;
use Symfony\Component\Yaml\Yaml;
use YamlStandards\Model\AbstractChecker;
use YamlStandards\Model\Component\YamlService;
use YamlStandards\Model\Config\StandardParametersData;
use YamlStandards\Result\Result;

/**
 * Check yaml file complies inline standards
 */
class YamlInlineChecker extends AbstractChecker
{
    /**
     * @inheritDoc
     */
    public function check(string $pathToFile, StandardParametersData $standardParametersData): Result
    {
        $yamlArrayData = YamlService::getYamlData($pathToFile);
        $yamlStringData = Yaml::dump($yamlArrayData, 3);

        $yamlContent = file_get_contents($pathToFile);
        $yamlContent = str_replace("\r", '', $yamlContent); // remove carriage returns
        $yamlLines = explode("\n", $yamlContent);
        $lastYamlElement = end($yamlLines);
        $filteredYamlLines = array_filter($yamlLines, [YamlService::class, 'isLineNotBlank']);
        $filteredYamlLines = array_filter($filteredYamlLines, [__CLASS__, 'removeCommentLine']);
        $filteredYamlLines = array_map([__CLASS__, 'removeComments'], $filteredYamlLines);
        if (YamlService::isLineBlank($lastYamlElement)) {
            $filteredYamlLines[] = '';
        }

        $filteredYamlFile = implode("\n", $filteredYamlLines);

        if ($yamlStringData === $filteredYamlFile) {
            return new Result($pathToFile, Result::RESULT_CODE_OK);
        }

        $differ = new Differ(new UnifiedDiffOutputBuilder());
        $diffBetweenStrings = $differ->diff($filteredYamlFile, $yamlStringData);

        return new Result($pathToFile, Result::RESULT_CODE_INVALID_FILE_SYNTAX, $diffBetweenStrings);
    }

    /**
     * @param string $yamlLine
     * @return bool
     */
    private function removeCommentLine(string $yamlLine): bool
    {
        return preg_match('/^\s*#/', $yamlLine) === 0;
    }

    /**
     * @param string $yamlLine
     * @return string
     */
    private function removeComments(string $yamlLine): string
    {
        return preg_replace('/\s#.+/', '', $yamlLine);
    }
}