YamlStandards\Model\YamlAlphabetical\YamlAlphabeticalChecker

Complexity

Total Complexity

12

Size/Duplication

Total Lines	80
Duplicated Lines	0 %

Test Coverage

Coverage

90.91%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	sortArray()	0	15	5
A	check()	0	16	2
A	sortArrayKeyWithUnderscoresAsFirst()	0	9	1
A	recursiveKsort()	0	14	4

<?php

declare(strict_types=1);

namespace YamlStandards\Model\YamlAlphabetical;

use SebastianBergmann\Diff\Differ;
use Symfony\Component\Yaml\Yaml;
use YamlStandards\Command\ProcessOutput;
use YamlStandards\Model\CheckerInterface;
use YamlStandards\Model\Component\YamlService;
use YamlStandards\Model\Config\StandardParametersData;
use YamlStandards\Result\Result;

/**
 * Check yaml file is alphabetical sorted
 */
class YamlAlphabeticalChecker implements CheckerInterface
{
    /**
     * @inheritDoc
     */
    public function check(string $pathToYamlFile, StandardParametersData $standardParametersData): Result
    {
        $yamlArrayData = YamlService::getYamlData($pathToYamlFile);
        $yamlArrayDataSorted = $this->sortArray($yamlArrayData, $standardParametersData->getDepth());

It seems like $standardParametersData->getDepth() can also be of type null; however, parameter $depth of YamlStandards\Model\YamlAlphabetical\YamlAlphabeticalChecker::sortArray() does only seem to accept integer, maybe add an additional type check?

        $yamlStringData = Yaml::dump($yamlArrayData, PHP_INT_MAX);
        $yamlStringDataSorted = Yaml::dump($yamlArrayDataSorted, PHP_INT_MAX);

        if ($yamlStringData === $yamlStringDataSorted) {
            return new Result($pathToYamlFile, Result::RESULT_CODE_OK, ProcessOutput::STATUS_CODE_OK);
        }

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

        return new Result($pathToYamlFile, Result::RESULT_CODE_INVALID_FILE_SYNTAX, ProcessOutput::STATUS_CODE_INVALID_FILE_SYNTAX, $diffBetweenStrings);
    }

    /**
     * @param string[] $yamlArrayData
     * @param int $depth
     * @return string[]
     */
    private function sortArray(array $yamlArrayData, int $depth): array
    {
        if ($depth > 0) {
            $yamlArrayData = $this->sortArrayKeyWithUnderscoresAsFirst($yamlArrayData);

            if ($depth > 1) {
                foreach ($yamlArrayData as $key => $value) {
                    if (is_array($value)) {
                        $yamlArrayData[$key] = $this->recursiveKsort($value, $depth);
                    }
                }
            }
        }

        return $yamlArrayData;
    }

    /**
     * @param string[] $yamlArrayData
     * @param int $depth
     * @param int $currentDepth
     * @return string[]
     */
    private function recursiveKsort(array $yamlArrayData, int $depth, int $currentDepth = 1): array
    {
        $yamlArrayData = $this->sortArrayKeyWithUnderscoresAsFirst($yamlArrayData);
        foreach ($yamlArrayData as $key => $value) {
            if (is_array($value)) {
                $currentDepth++;
                if ($currentDepth < $depth) {
                    $yamlArrayData[$key] = $this->recursiveKsort($value, $depth, $currentDepth);
                }
                continue;
            }
        }

        return $yamlArrayData;
    }

    /**
     * @param string[] $yamlArrayData
     * @return string[]|string[][]
     */
    private function sortArrayKeyWithUnderscoresAsFirst(array $yamlArrayData): array
    {
        $arrayWithUnderscoreKeys = array_filter($yamlArrayData, [YamlService::class, 'hasArrayKeyUnderscoreAsFirstCharacter'], ARRAY_FILTER_USE_KEY);
        $arrayWithOtherKeys = array_filter($yamlArrayData, [YamlService::class, 'hasNotArrayKeyUnderscoreAsFirstCharacter'], ARRAY_FILTER_USE_KEY);

        ksort($arrayWithUnderscoreKeys);
        ksort($arrayWithOtherKeys);

        return array_merge($arrayWithUnderscoreKeys, $arrayWithOtherKeys);
    }
}