[FEATURE] Add fractor for yaml files

Author: sabbelasichon

.github/workflows/lint_test_pull_requests.yaml

@@ -21,7 +21,7 @@ jobs:
             command: test:php
           - name: Rector
             command: 'rector --dry-run'
-        directory: [ 'extension-installer', 'fractor', 'fractor-xml', 'typo3-fractor', 'fractor-doc-generator' ]
+        directory: [ 'extension-installer', 'fractor', 'fractor-xml', 'typo3-fractor', 'fractor-doc-generator', 'fractor-yaml']
         exclude:
           - directory: extension-installer
             composer-command: {name: 'PHPUnit', command: 'test:php'}

fractor-yaml/.gitignore

@@ -0,0 +1,3 @@
+/vendor/
+/composer.lock
+.phpunit.cache

fractor-yaml/composer.json

@@ -0,0 +1,57 @@
+{
+    "name": "a9f/fractor-yaml",
+    "description": "YAML extension for the File Read-Analyse-Change TOol. Allows modifying YAML files",
+    "license": "MIT",
+    "type": "fractor-extension",
+    "authors": [
+        {
+            "name": "Andreas Wolf",
+            "email": "[email protected]",
+            "role": "Lead Developer"
+        }
+    ],
+    "require": {
+        "php": "^8.2",
+        "a9f/fractor": "@dev",
+        "a9f/fractor-extension-installer": "@dev",
+        "symfony/yaml": "^6.0",
+        "webmozart/assert": "^1.11"
+    },
+    "require-dev": {
+        "ergebnis/composer-normalize": "^2.42",
+        "phpstan/phpstan": "^1.10",
+        "phpunit/phpunit": "^10.5",
+        "rector/rector": "^1.0",
+        "symplify/easy-coding-standard": "^12.1"
+    },
+    "repositories": {
+        "fractor": {
+            "type": "path",
+            "url": "../*"
+        }
+    },
+    "autoload": {
+        "psr-4": {
+            "a9f\\FractorYaml\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "a9f\\FractorYaml\\Tests\\": "tests/"
+        }
+    },
+    "config": {
+        "allow-plugins": {
+            "a9f/fractor-extension-installer": true,
+            "ergebnis/composer-normalize": true
+        },
+        "sort-packages": true
+    },
+    "scripts": {
+        "analyze:php": "phpstan analyze",
+        "rector": "rector",
+        "style:php:check": "ecs",
+        "style:php:fix": "ecs --fix",
+        "test:php": "phpunit"
+    }
+}

fractor-yaml/config/application.php

@@ -0,0 +1,27 @@
+<?php
+
+use a9f\FractorYaml\Contract\YamlDumper;
+use a9f\FractorYaml\Contract\YamlFractorRule;
+use a9f\FractorYaml\Contract\YamlParser;
+use a9f\FractorYaml\SymfonyYamlDumper;
+use a9f\FractorYaml\SymfonyYamlParser;
+use a9f\FractorYaml\YamlFileProcessor;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+use function Symfony\Component\DependencyInjection\Loader\Configurator\tagged_iterator;
+
+return static function (ContainerConfigurator $containerConfigurator, ContainerBuilder $containerBuilder): void {
+    $services = $containerConfigurator->services();
+    $services->defaults()
+        ->autowire()
+        ->autoconfigure();
+
+    $services->load('a9f\\FractorYaml\\', __DIR__ . '/../src/');
+
+    $services->alias(YamlParser::class, SymfonyYamlParser::class);
+    $services->alias(YamlDumper::class, SymfonyYamlDumper::class);
+
+    $services->set(YamlFileProcessor::class)->arg('$rules', tagged_iterator('fractor.yaml_rule'));
+
+    $containerBuilder->registerForAutoconfiguration(YamlFractorRule::class)->addTag('fractor.yaml_rule');
+};

fractor-yaml/ecs.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+return (include __DIR__ . '/../.build/ecs.php')
+    ->withPaths([
+        __DIR__ . '/config',
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ])
+     ;

fractor-yaml/phpstan.neon

@@ -0,0 +1,6 @@
+parameters:
+    level: 8
+
+    paths:
+        - src/
+        - tests/

fractor-yaml/phpunit.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd" bootstrap="vendor/autoload.php" colors="true" cacheDirectory=".phpunit.cache">
+  <testsuites>
+    <testsuite name="fractor-yaml">
+      <directory>tests</directory>
+    </testsuite>
+  </testsuites>
+  <source>
+    <include>
+      <directory>./src</directory>
+    </include>
+  </source>
+</phpunit>

fractor-yaml/rector.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+return (include __DIR__ . '/../.build/rector.php')
+    ->withPaths([
+        __DIR__ . '/config',
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ]);

fractor-yaml/src/Contract/YamlDumper.php

@@ -0,0 +1,11 @@
+<?php
+declare(strict_types=1);
+
+namespace a9f\FractorYaml\Contract;
+
+use a9f\Fractor\ValueObject\Indent;
+
+interface YamlDumper
+{
+    public function dump(array $input, Indent $indent): string;
+}

fractor-yaml/src/Contract/YamlFractorRule.php

@@ -0,0 +1,15 @@
+<?php
+declare(strict_types=1);
+
+namespace a9f\FractorYaml\Contract;
+
+use a9f\Fractor\Application\Contract\FractorRule;
+
+interface YamlFractorRule extends FractorRule
+{
+    /**
+     * @param mixed[] $yaml
+     * @return mixed[]
+     */
+    public function refactor(array $yaml): array;
+}

fractor-yaml/src/Contract/YamlParser.php

@@ -0,0 +1,15 @@
+<?php
+declare(strict_types=1);
+
+namespace a9f\FractorYaml\Contract;
+
+use a9f\Fractor\Application\ValueObject\File;
+use a9f\FractorYaml\Exception\ParseException;
+
+interface YamlParser
+{
+    /**
+     * @throws ParseException
+     */
+    public function parse(File $file): array;
+}

fractor-yaml/src/Exception/ParseException.php

@@ -0,0 +1,9 @@
+<?php
+declare(strict_types=1);
+
+namespace a9f\FractorYaml\Exception;
+
+final class ParseException extends \RuntimeException
+{
+
+}

fractor-yaml/src/SymfonyYamlDumper.php

@@ -0,0 +1,17 @@
+<?php
+declare(strict_types=1);
+
+namespace a9f\FractorYaml;
+
+use a9f\Fractor\ValueObject\Indent;
+use a9f\FractorYaml\Contract\YamlDumper;
+use Symfony\Component\Yaml\Yaml;
+
+final class SymfonyYamlDumper implements YamlDumper
+{
+
+    public function dump(array $input, Indent $indent): string
+    {
+        return Yaml::dump($input, 99, $indent->length());
+    }
+}

fractor-yaml/src/SymfonyYamlParser.php

@@ -0,0 +1,25 @@
+<?php
+declare(strict_types=1);
+
+namespace a9f\FractorYaml;
+
+use a9f\Fractor\Application\ValueObject\File;
+use a9f\FractorYaml\Contract\YamlParser;
+use a9f\FractorYaml\Exception\ParseException;
+use Symfony\Component\Yaml\Exception\ParseException as YamlParseException;
+use Symfony\Component\Yaml\Yaml;
+
+final class SymfonyYamlParser implements YamlParser
+{
+
+    public function parse(File $file): array
+    {
+        try {
+            return Yaml::parse($file->getContent(), Yaml::PARSE_CUSTOM_TAGS) ?? [];
+        } catch (YamlParseException $parseException) {
+            $parseException->setParsedFile($file->getFilePath());
+
+            throw new ParseException($parseException->getMessage());
+        }
+    }
+}

fractor-yaml/src/YamlFileProcessor.php

@@ -0,0 +1,52 @@
+<?php
+declare(strict_types=1);
+
+namespace a9f\FractorYaml;
+
+use a9f\Fractor\Application\Contract\FileProcessor;
+use a9f\Fractor\Application\ValueObject\File;
+use a9f\Fractor\ValueObject\Indent;
+use a9f\FractorYaml\Contract\YamlDumper;
+use a9f\FractorYaml\Contract\YamlFractorRule;
+use a9f\FractorYaml\Contract\YamlParser;
+use Webmozart\Assert\Assert;
+
+final readonly class YamlFileProcessor implements FileProcessor
+{
+    /**
+     * @param iterable<YamlFractorRule> $rules
+     */
+    public function __construct(private iterable $rules, private YamlParser $yamlParser, private YamlDumper $yamlDumper)
+    {
+        Assert::allIsInstanceOf($this->rules, YamlFractorRule::class);
+    }
+
+    public function canHandle(File $file): bool
+    {
+        return in_array($file->getFileExtension(), $this->allowedFileExtensions(), true);
+    }
+
+    public function handle(File $file): void
+    {
+        $yaml = $this->yamlParser->parse($file);
+        $indent = Indent::fromFile($file);
+
+        $newYaml = $yaml;
+
+        foreach ($this->rules as $rule) {
+            $newYaml = $rule->refactor($newYaml);
+        }
+
+        // Nothing has changed.
+        if ($newYaml === $yaml) {
+            return;
+        }
+
+        $file->changeFileContent($this->yamlDumper->dump($newYaml, $indent));
+    }
+
+    public function allowedFileExtensions(): array
+    {
+        return ['yaml', 'yml'];
+    }
+}

fractor-yaml/tests/Fixtures/DummyYamlFractorRule.php

@@ -0,0 +1,66 @@
+<?php
+declare(strict_types=1);
+
+namespace a9f\FractorYaml\Tests\Fixtures;
+
+use a9f\FractorYaml\Contract\YamlFractorRule;
+use Symfony\Component\DependencyInjection\Exception\BadMethodCallException;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+final class DummyYamlFractorRule implements YamlFractorRule
+{
+    /**
+     * @var string
+     */
+    private const TRANSLATION_FILE_KEY = 'translationFile';
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        throw new BadMethodCallException('Not implemented yet');
+    }
+
+    public function refactor(array $yaml): array
+    {
+        return $this->refactorTranslationFile($yaml);
+    }
+
+    /**
+     * @param mixed[] $yaml
+     * @return mixed[]
+     * @see https://github.com/TYPO3/typo3/blob/10.4/typo3/sysext/form/Classes/Controller/FormEditorController.php#L653-L689
+     */
+    private function refactorTranslationFile(array &$yaml): array
+    {
+        foreach ($yaml as &$section) {
+            if (! is_array($section)) {
+                continue;
+            }
+
+            if (array_key_exists(self::TRANSLATION_FILE_KEY, $section)
+                && is_array($section[self::TRANSLATION_FILE_KEY])
+            ) {
+                $section['translationFiles'] = $this->buildNewTranslations($section[self::TRANSLATION_FILE_KEY]);
+                unset($section[self::TRANSLATION_FILE_KEY]);
+            }
+
+            $this->refactorTranslationFile($section);
+        }
+
+        unset($section);
+
+        return $yaml;
+    }
+
+    /**
+     * @param array<int, string> $oldTranslations
+     *
+     * @return array<int, string>
+     */
+    private function buildNewTranslations(array $oldTranslations): array
+    {
+        return array_filter(
+            $oldTranslations,
+            static fn ($oldTranslationFile) => ! \str_starts_with($oldTranslationFile, 'EXT:form')
+        );
+    }
+}

fractor-yaml/tests/YamlFileProcessor/Fixtures/fixture.yaml

@@ -0,0 +1,24 @@
+TYPO3:
+  CMS:
+    Form:
+      prototypes:
+        standard:
+          formElementsDefinition:
+            Form:
+              renderingOptions:
+                translation:
+                  translationFile:
+                    10: 'EXT:form/Resources/Private/Language/locallang.xlf'
+                    20: 'EXT:myextension/Resources/Private/Language/locallang.xlf'
+-----
+TYPO3:
+  CMS:
+    Form:
+      prototypes:
+        standard:
+          formElementsDefinition:
+            Form:
+              renderingOptions:
+                translation:
+                  translationFiles:
+                    20: 'EXT:myextension/Resources/Private/Language/locallang.xlf'