[TASK] Add Formatter interface for xml

Author: sabbelasichon

packages/fractor-xml/config/application.php

@@ -2,7 +2,9 @@
 
 declare(strict_types=1);
 
+use a9f\FractorXml\Contract\Formatter;
 use a9f\FractorXml\Contract\XmlFractor;
+use a9f\FractorXml\PrettyXmlFormatter;
 use a9f\FractorXml\XmlFileProcessor;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
@@ -19,5 +21,8 @@
     $services->set(XmlFileProcessor::class)
         ->arg('$rules', tagged_iterator('fractor.xml_rule'));
 
+    $services->set(\PrettyXml\Formatter::class);
+    $services->alias(Formatter::class, PrettyXmlFormatter::class);
+
     $containerBuilder->registerForAutoconfiguration(XmlFractor::class)->addTag('fractor.xml_rule');
 };

packages/fractor-xml/src/Contract/Formatter.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\FractorXml\Contract;
+
+use a9f\Fractor\ValueObject\Indent;
+
+interface Formatter
+{
+    public function format(Indent $indent, string $content): string;
+}

packages/fractor-xml/src/PrettyXmlFormatter.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\FractorXml;
+
+use a9f\Fractor\ValueObject\Indent;
+use a9f\FractorXml\Contract\Formatter;
+
+final readonly class PrettyXmlFormatter implements Formatter
+{
+    public function __construct(
+        private \PrettyXml\Formatter $prettyXmlFormatter
+    ) {
+    }
+
+    public function format(Indent $indent, string $content): string
+    {
+        $indentCharacter = $indent->isSpace() ? Indent::CHARACTERS[Indent::STYLE_SPACE] : Indent::CHARACTERS[Indent::STYLE_TAB];
+        $this->prettyXmlFormatter->setIndentCharacter($indentCharacter);
+        $this->prettyXmlFormatter->setIndentSize($indent->length());
+
+        return $this->prettyXmlFormatter->format($content);
+    }
+}

packages/fractor-xml/src/XmlFileProcessor.php

@@ -7,9 +7,10 @@
 use a9f\Fractor\Application\Contract\FileProcessor;
 use a9f\Fractor\Application\ValueObject\File;
 use a9f\Fractor\Exception\ShouldNotHappenException;
+use a9f\Fractor\ValueObject\Indent;
+use a9f\FractorXml\Contract\Formatter;
 use a9f\FractorXml\Contract\XmlFractor;
 use a9f\FractorXml\ValueObjectFactory\DomDocumentFactory;
-use PrettyXml\Formatter as PrettyXMLFormatter;
 
 /**
  * @implements FileProcessor<XmlFractor>
@@ -21,7 +22,7 @@
      */
     public function __construct(
         private DomDocumentFactory $domDocumentFactory,
-        private PrettyXMLFormatter $formatter,
+        private Formatter $formatter,
         private iterable $rules
     ) {
     }
@@ -44,8 +45,9 @@ public function handle(File $file, iterable $appliedRules): void
         $iterator->traverseDocument($file, $document);
 
         $newXml = $this->saveXml($document);
+
         // TODO make the indentation configurable in fractor config
-        $newXml = $this->formatter->format($newXml);
+        $newXml = $this->formatter->format(Indent::fromSizeAndStyle(4, Indent::STYLE_SPACE), $newXml);
 
         if ($newXml === $originalXml) {
             return;

packages/fractor/src/ValueObject/Indent.php

@@ -12,14 +12,19 @@
  */
 final readonly class Indent
 {
+    public const STYLE_SPACE = 'space';
+
+    public const STYLE_TAB = 'tab';
+
     /**
      * @var array<string, string>
      */
     public const CHARACTERS = [
-        'space' => ' ',
-        'tab' => "\t",
+        self::STYLE_SPACE => ' ',
+        self::STYLE_TAB => "\t",
     ];
 
+
     private function __construct(
         private string $value
     ) {
@@ -49,7 +54,10 @@ public function length(): int
         return strlen($this->value);
     }
 
-    private static function fromSizeAndStyle(int $size, string $style): self
+    /**
+     * @phpstan-param self::STYLE_* $style
+     */
+    public static function fromSizeAndStyle(int $size, string $style): self
     {
         Assert::greaterThanEq($size, 1);
         Assert::keyExists(self::CHARACTERS, $style);