Add CI pipeline

.build/ecs.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+use PhpCsFixer\Fixer\ArrayNotation\ArraySyntaxFixer;
+use PhpCsFixer\Fixer\Import\NoUnusedImportsFixer;
+use Symplify\EasyCodingStandard\Config\ECSConfig;
+
+return ECSConfig::configure()
+    // add a single rule
+    ->withRules([
+        NoUnusedImportsFixer::class,
+        ArraySyntaxFixer::class,
+    ])
+    ->withPreparedSets(psr12: true)
+    ;

.github/workflows/lint_test_pull_requests.yaml

@@ -0,0 +1,48 @@
+name: "Code style & tests"
+on:
+  pull_request:
+    # Run this workflow for all PRs against main
+    branches:
+      - main
+
+jobs:
+  php-check:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        composer-command:
+          - name: PHP Code Style
+            command: 'style:php'
+          - name: Composer normalize
+            command: 'normalize --dry-run'
+          - name: PHPStan
+            command: analyze:php
+          - name: PHPUnit
+            command: test:php
+        directory: ['extension-installer', 'fractor', 'fractor-xml', 'typo3-fractor']
+        exclude:
+          - directory: extension-installer
+            composer-command: {name: 'PHPUnit', command: 'test:php'}
+
+    name: ${{ matrix.composer-command.name }}/${{ matrix.directory }}
+
+    defaults:
+      run:
+        working-directory: ${{ matrix.directory }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - name: Install composer dependencies
+        uses: php-actions/composer@v6
+        with:
+          container_workdir: /app/${{ matrix.directory }}
+          memory_limit: 512M
+
+      - name: 'Run check "${{ matrix.composer-command.name }}"'
+        uses: php-actions/composer@v6
+        with:
+          container_workdir: /app/${{ matrix.directory }}
+          command: ${{ matrix.composer-command.command }}
+          memory_limit: 512M

extension-installer/composer.json

@@ -16,7 +16,9 @@
   },
   "require-dev": {
     "composer/composer": "^2.7",
-    "ergebnis/composer-normalize": "^2.42"
+    "ergebnis/composer-normalize": "^2.42",
+    "phpstan/phpstan": "^1.10",
+    "symplify/easy-coding-standard": "^12.1"
   },
   "autoload": {
     "psr-4": {
@@ -31,5 +33,9 @@
   },
   "extra": {
     "class": "a9f\\FractorExtensionInstaller\\InstallerPlugin"
+  },
+  "scripts": {
+    "analyze:php": "phpstan analyze",
+    "style:php": "ecs"
   }
 }

extension-installer/ecs.php

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

extension-installer/phpstan.neon

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

extension-installer/src/InstallerPlugin.php

@@ -52,4 +52,4 @@ public static function getSubscribedEvents(): array
             ScriptEvents::POST_UPDATE_CMD => 'processEvent',
         ];
     }
-}
+}

extension-installer/src/PackagesFileGenerator.php

@@ -23,8 +23,7 @@ public function __construct(
         private readonly InstalledRepositoryInterface $repository,
         private readonly InstallationManager $installationManager,
         private readonly string $fileToGenerate
-    )
-    {
+    ) {
     }
 
     public function generate(): void
@@ -49,4 +48,4 @@ public function generate(): void
             sprintf(self::FILE_TEMPLATE, $installedPackagesCode)
         );
     }
-}
+}

fractor-xml/composer.json

@@ -20,7 +20,14 @@
     "require-dev": {
         "ergebnis/composer-normalize": "^2.42",
         "phpstan/phpstan": "^1.10",
-        "phpunit/phpunit": "^10.5"
+        "phpunit/phpunit": "^10.5",
+        "symplify/easy-coding-standard": "^12.1"
+    },
+    "repositories": {
+        "fractor": {
+            "type": "path",
+            "url": "../*"
+        }
     },
     "autoload": {
         "psr-4": {
@@ -32,16 +39,16 @@
             "a9f\\FractorXml\\Tests\\": "tests/"
         }
     },
-    "repositories": {
-        "fractor": {
-            "type": "path",
-            "url": "../*"
-        }
-    },
     "config": {
         "allow-plugins": {
+            "a9f/fractor-extension-installer": true,
             "ergebnis/composer-normalize": true
         },
         "sort-packages": true
+    },
+    "scripts": {
+        "analyze:php": "phpstan analyze",
+        "style:php": "ecs",
+        "test:php": "phpunit tests/"
     }
 }

fractor-xml/config/application.php

@@ -9,4 +9,4 @@
         ->autoconfigure();
 
     $services->load('a9f\\FractorXml\\', __DIR__ . '/../src/');
-};
+};

fractor-xml/config/fractor.php

@@ -3,6 +3,6 @@
 use a9f\Fractor\Configuration\FractorConfig;
 use a9f\FractorXml\DependencyInjection\XmlFractorCompilerPass;
 
-return static function(FractorConfig $config) {
+return static function (FractorConfig $config) {
     $config->addCompilerPass(new XmlFractorCompilerPass());
-};
+};

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

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

fractor-xml/src/AbstractXmlFractor.php

@@ -29,4 +29,4 @@ public function afterTraversal(\DOMNode $rootNode): void
     {
         // no-op for now
     }
-}
+}

fractor-xml/src/DependencyInjection/XmlFractorCompilerPass.php

@@ -31,4 +31,4 @@ public function process(ContainerBuilder $container): void
         $definition = $container->findDefinition(XmlFileProcessor::class);
         $definition->setArgument('$rules', $references);
     }
-}
+}

fractor-xml/src/DomDocumentIterator.php

@@ -20,7 +20,9 @@ public function traverseDocument(\DOMDocument $document): void
             $visitor->beforeTraversal($document);
         }
 
-        $this->traverseNode($document->firstChild);
+        if ($document->firstChild instanceof \DOMNode) {
+            $this->traverseNode($document->firstChild);
+        }
 
         foreach ($this->visitors as $visitor) {
             $visitor->afterTraversal($document);
@@ -33,6 +35,11 @@ private function traverseNode(\DOMNode $node): void
         foreach ($this->visitors as $visitor) {
             $result = $visitor->enterNode($node);
 
+            if ($node->parentNode === null) {
+                // TODO convert into a custom ShouldNotHappenException
+                throw new \RuntimeException('Node has no parent node');
+            }
+
             if ($result === DomDocumentIterator::REMOVE_NODE) {
                 $node->parentNode->removeChild($node);
                 $nodeRemoved = true;

fractor-xml/src/DomNodeVisitor.php

@@ -17,4 +17,4 @@ public function enterNode(\DOMNode $node): \DOMNode|int;
     public function leaveNode(\DOMNode $node): void;
 
     public function afterTraversal(\DOMNode $rootNode): void;
-}
+}

fractor-xml/src/XmlFileProcessor.php

@@ -32,4 +32,4 @@ public function handle(\SplFileInfo $file): void
         // TODO only update file if changed
         file_put_contents($file->getPathname(), $doc->saveXML());
     }
-}
+}

fractor-xml/src/XmlFractor.php

@@ -2,9 +2,12 @@
 
 namespace a9f\FractorXml;
 
-interface XmlFractor
+interface XmlFractor extends DomNodeVisitor
 {
     public function canHandle(\DOMNode $node): bool;
 
+    /**
+     * @return \DOMNode|DomDocumentIterator::*|null
+     */
     public function refactor(\DOMNode $node): \DOMNode|int|null;
-}
+}

fractor-xml/tests/DomDocumentIteratorTest.php

@@ -141,7 +141,7 @@ public function traversalEntersAndLeavesGrandChildrenBeforeLeavingChildren(): vo
     #[Test]
     public function nodeIsRemovedFromDomIfVisitorReturnsRemoveNode(): void
     {
-        $nodeRemovingVisitor = new class extends CollectingDomNodeVisitor {
+        $nodeRemovingVisitor = new class() extends CollectingDomNodeVisitor {
             public function enterNode(\DOMNode $node): \DOMNode|int
             {
                 parent::enterNode($node);
@@ -150,7 +150,6 @@ public function enterNode(\DOMNode $node): \DOMNode|int
                 }
                 return $node;
             }
-
         };
         $document = new \DOMDocument();
         $document->loadXML(<<<XML
@@ -169,22 +168,25 @@ public function enterNode(\DOMNode $node): \DOMNode|int
             'afterTraversal:#document',
         ], $nodeRemovingVisitor->calls);
 
-        self::assertXmlStringEqualsXmlString('<Root></Root>', $document->saveXML());
+        self::assertXmlStringEqualsXmlString('<Root></Root>', $document->saveXML() ?: '');
     }
 
     #[Test]
     public function nodeIsReplacedIfVisitorReturnsNewDomNode(): void
     {
-        $nodeRemovingVisitor = new class extends CollectingDomNodeVisitor {
+        $nodeRemovingVisitor = new class() extends CollectingDomNodeVisitor {
             public function enterNode(\DOMNode $node): \DOMNode|int
             {
                 parent::enterNode($node);
                 if ($node->nodeName === 'Child') {
+                    if ($node->ownerDocument === null) {
+                        throw new \RuntimeException('Node does not have an ownerDocument, cannot create element');
+                    }
+
                     return $node->ownerDocument->createElement('NewChild');
                 }
                 return $node;
             }
-
         };
         $document = new \DOMDocument();
         $document->loadXML(<<<XML
@@ -203,14 +205,17 @@ public function enterNode(\DOMNode $node): \DOMNode|int
             'afterTraversal:#document',
         ], $nodeRemovingVisitor->calls);
 
-        self::assertXmlStringEqualsXmlString('<Root><NewChild></NewChild></Root>', $document->saveXML());
+        self::assertXmlStringEqualsXmlString('<Root><NewChild></NewChild></Root>', $document->saveXML() ?: '');
     }
 
-    private function getCollectingDomNodeVisitor(): DomNodeVisitor
+    private function getCollectingDomNodeVisitor(): CollectingDomNodeVisitor
     {
         return new CollectingDomNodeVisitor();
     }
 
+    /**
+     * @param list<string> $recorder
+     */
     private function getCallRecordingDomNodeVisitor(string $visitorName, array &$recorder): DomNodeVisitor
     {
         return new class($visitorName, $recorder) implements DomNodeVisitor {
@@ -219,7 +224,7 @@ private function getCallRecordingDomNodeVisitor(string $visitorName, array &$rec
              */
             public function __construct(
                 private readonly string $visitorName,
-                private array &$calls
+                public array &$calls // only public to please PHPStan
             ) {
             }
 
@@ -245,4 +250,4 @@ public function afterTraversal(\DOMNode $rootNode): void
             }
         };
     }
-}
+}

fractor-xml/tests/Fixtures/CollectingDomNodeVisitor.php

@@ -4,7 +4,8 @@
 
 use a9f\FractorXml\DomNodeVisitor;
 
-class CollectingDomNodeVisitor implements DomNodeVisitor {
+class CollectingDomNodeVisitor implements DomNodeVisitor
+{
     /** @var list<non-empty-string> */
     public array $calls = [];
 
@@ -28,4 +29,4 @@ public function afterTraversal(\DOMNode $rootNode): void
     {
         $this->calls[] = sprintf('afterTraversal:%s', $rootNode->nodeName);
     }
-}
+}

fractor/composer.json

@@ -20,8 +20,9 @@
     },
     "require-dev": {
         "ergebnis/composer-normalize": "^2.42",
-        "phpstan/phpstan": "1.10",
-        "phpunit/phpunit": "^10.5"
+        "phpstan/phpstan": "^1.10",
+        "phpunit/phpunit": "^10.5",
+        "symplify/easy-coding-standard": "^12.1"
     },
     "autoload": {
         "psr-4": {
@@ -41,5 +42,10 @@
             "ergebnis/composer-normalize": true
         },
         "sort-packages": true
+    },
+    "scripts": {
+        "analyze:php": "phpstan analyze",
+        "style:php": "ecs",
+        "test:php": "phpunit tests/"
     }
 }

fractor/config/application.php

@@ -23,4 +23,4 @@
 
     $services->set(FractorConfig::class)
         ->lazy(true);
-};
+};