[FEATURE] Add manipulation of composer.json

.github/workflows/docs.yaml

@@ -13,7 +13,7 @@ jobs:
         composer-command:
           - name: Generate docs
             command: 'docs:generate'
-        directory: ['typo3-fractor']
+        directory: ['typo3-fractor', 'fractor-composer-json']
 
     name: ${{ matrix.composer-command.name }}/${{ matrix.directory }}
 

.github/workflows/lint_test_pull_requests.yaml

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

fractor-composer-json/.gitattributes

@@ -0,0 +1,8 @@
+tests export-ignore
+.gitattributes export-ignore
+.gitignore export-ignore
+ecs.php export-ignore
+phpstan.neon export-ignore
+phpunit.xml export-ignore
+README.md export-ignore
+rector.php export-ignore

fractor-composer-json/.gitignore

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

fractor-composer-json/composer.json

@@ -0,0 +1,63 @@
+{
+    "name": "a9f/fractor-composer-json",
+    "description": "ComposerJson extension for the File Read-Analyse-Change TOol. Allows modifying composer.json 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",
+        "ergebnis/json-printer": "^3.5",
+        "eta-orionis/composer-json-manipulator": "^1.0",
+        "nette/utils": "^4.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\\FractorComposerJson\\": [
+                "src",
+                "rules"
+            ]
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "a9f\\FractorComposerJson\\Tests\\": "tests/"
+        }
+    },
+    "config": {
+        "allow-plugins": {
+            "a9f/fractor-extension-installer": true,
+            "ergebnis/composer-normalize": true
+        },
+        "sort-packages": true
+    },
+    "scripts": {
+        "analyze:php": "phpstan analyze",
+        "docs:generate": "fractor-doc-generator generate rules --output-file docs/composer-json-fractor-rules.md",
+        "rector": "rector",
+        "style:php:check": "ecs",
+        "style:php:fix": "ecs --fix",
+        "test:php": "phpunit"
+    }
+}

fractor-composer-json/config/application.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+use a9f\FractorComposerJson\ComposerJsonFileProcessor;
+use a9f\FractorComposerJson\Contract\ComposerJsonFractorRule;
+use a9f\FractorComposerJson\Contract\ComposerJsonPrinter;
+use a9f\FractorComposerJson\ErgebnisComposerJsonPrinter;
+use Ergebnis\Json\Printer\Printer;
+use Ergebnis\Json\Printer\PrinterInterface;
+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\\FractorComposerJson\\', __DIR__ . '/../src/');
+
+    $services->set(ComposerJsonFileProcessor::class)
+        ->arg('$rules', tagged_iterator('fractor.composer_json_rule'));
+
+    $services->set(Printer::class);
+    $services->alias(ComposerJsonPrinter::class, ErgebnisComposerJsonPrinter::class);
+    $services->alias(PrinterInterface::class, Printer::class);
+    $containerBuilder->registerForAutoconfiguration(ComposerJsonFractorRule::class)->addTag(
+        'fractor.composer_json_rule'
+    );
+};

fractor-composer-json/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-composer-json/phpstan.neon

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

fractor-composer-json/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-composer-json">
+      <directory>tests</directory>
+    </testsuite>
+  </testsuites>
+  <source>
+    <include>
+      <directory>./src</directory>
+    </include>
+  </source>
+</phpunit>

fractor-composer-json/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-composer-json/rules/AddPackageToRequireComposerJsonFractorRule.php

@@ -0,0 +1,54 @@
+<?php
+declare(strict_types=1);
+
+namespace a9f\FractorComposerJson;
+
+use a9f\FractorComposerJson\Contract\ComposerJson;
+use a9f\FractorComposerJson\Contract\ComposerJsonFractorRule;
+use a9f\FractorComposerJson\ValueObject\PackageAndVersion;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+use Webmozart\Assert\Assert;
+
+final class AddPackageToRequireComposerJsonFractorRule implements ComposerJsonFractorRule
+{
+    /**
+     * @var PackageAndVersion[]
+     */
+    private array $packagesAndVersions = [];
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Add package to "require" in `composer.json`', [new ConfiguredCodeSample(
+            <<<'CODE_SAMPLE'
+{
+}
+CODE_SAMPLE
+            ,
+            <<<'CODE_SAMPLE'
+{
+    "require": {
+        "symfony/console": "^3.4"
+    }
+}
+CODE_SAMPLE
+            ,
+            [new PackageAndVersion('symfony/console', '^3.4')]
+        ),
+        ]);
+    }
+
+    public function refactor(ComposerJson $composerJson): void
+    {
+        foreach ($this->packagesAndVersions as $packageAndVersion) {
+            $composerJson->addRequiredPackage($packageAndVersion);
+        }
+    }
+
+    public function configure(array $configuration): void
+    {
+        Assert::allIsAOf($configuration, PackageAndVersion::class);
+
+        $this->packagesAndVersions = $configuration;
+    }
+}

fractor-composer-json/src/ComposerJsonFactory.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\FractorComposerJson;
+
+use a9f\Fractor\Application\ValueObject\File;
+use a9f\FractorComposerJson\Contract\ComposerJson;
+use a9f\FractorComposerJson\ValueObject\EtaOrionisComposerJson;
+
+final class ComposerJsonFactory
+{
+    public function createFromFile(File $file): ComposerJson
+    {
+        return EtaOrionisComposerJson::fromFile($file);
+    }
+}

fractor-composer-json/src/ComposerJsonFileProcessor.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\FractorComposerJson;
+
+use a9f\Fractor\Application\Contract\FileProcessor;
+use a9f\Fractor\Application\ValueObject\AppliedRule;
+use a9f\Fractor\Application\ValueObject\File;
+use a9f\Fractor\ValueObject\Indent;
+use a9f\FractorComposerJson\Contract\ComposerJsonFractorRule;
+use a9f\FractorComposerJson\Contract\ComposerJsonPrinter;
+
+final readonly class ComposerJsonFileProcessor implements FileProcessor
+{
+    /**
+     * @param iterable<ComposerJsonFractorRule> $rules
+     */
+    public function __construct(
+        private iterable $rules,
+        private ComposerJsonPrinter $composerJsonPrinter,
+        private ComposerJsonFactory $composerJsonFactory
+    ) {
+    }
+
+    public function handle(File $file): void
+    {
+        $composerJson = $this->composerJsonFactory->createFromFile($file);
+        $oldComposerJson = $this->composerJsonFactory->createFromFile($file);
+        $ident = Indent::fromFile($file);
+
+        foreach ($this->rules as $rule) {
+            $rule->refactor($composerJson);
+
+            if ($oldComposerJson->getJsonArray() !== $composerJson->getJsonArray()) {
+                $file->changeFileContent($this->composerJsonPrinter->printToString($ident, $composerJson));
+                $file->addAppliedRule(AppliedRule::fromRule($rule));
+            }
+        }
+    }
+
+    public function canHandle(File $file): bool
+    {
+        return $file->getFileName() === 'composer.json';
+    }
+
+    public function allowedFileExtensions(): array
+    {
+        return ['json'];
+    }
+}

fractor-composer-json/src/Contract/ComposerJson.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\FractorComposerJson\Contract;
+
+use a9f\FractorComposerJson\ValueObject\PackageAndVersion;
+
+interface ComposerJson
+{
+    /**
+     * @return mixed[]
+     */
+    public function getJsonArray(): array;
+
+    public function addRequiredPackage(PackageAndVersion $packageAndVersion): void;
+
+    public function toJsonString(): string;
+}

fractor-composer-json/src/Contract/ComposerJsonFractorRule.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\FractorComposerJson\Contract;
+
+use a9f\Fractor\Application\Contract\ConfigurableFractorRule;
+use a9f\Fractor\Application\Contract\FractorRule;
+
+interface ComposerJsonFractorRule extends FractorRule, ConfigurableFractorRule
+{
+    public function refactor(ComposerJson $composerJson): void;
+}

fractor-composer-json/src/Contract/ComposerJsonPrinter.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\FractorComposerJson\Contract;
+
+use a9f\Fractor\ValueObject\Indent;
+
+interface ComposerJsonPrinter
+{
+    public function printToString(Indent $indent, ComposerJson $composerJson): string;
+}

fractor-composer-json/src/ErgebnisComposerJsonPrinter.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\FractorComposerJson;
+
+use a9f\Fractor\ValueObject\Indent;
+use a9f\FractorComposerJson\Contract\ComposerJson;
+use a9f\FractorComposerJson\Contract\ComposerJsonPrinter;
+use Ergebnis\Json\Printer\PrinterInterface;
+
+final readonly class ErgebnisComposerJsonPrinter implements ComposerJsonPrinter
+{
+    public function __construct(
+        private PrinterInterface $printer
+    ) {
+    }
+
+    public function printToString(Indent $indent, ComposerJson $composerJson): string
+    {
+        return $this->printer->print($composerJson->toJsonString(), $indent->toString());
+    }
+}