Code cleanup

Author: theseer

src/Id.php

@@ -9,6 +9,8 @@
  */
 namespace Templado\Engine;
 
+use function implode;
+use function preg_match;
 use InvalidArgumentException;
 
 final readonly class Id {

src/StaticNodeList.php

@@ -9,6 +9,8 @@
  */
 namespace Templado\Engine;
 
+use function array_values;
+use function count;
 use function iterator_to_array;
 use ArrayIterator;
 use Countable;

src/csrfprotection/CSRFProtection.php

@@ -9,14 +9,11 @@
  */
 namespace Templado\Engine;
 
-class CSRFProtection {
-    private readonly string $fieldName;
-
-    private readonly string $tokenValue;
-
-    public function __construct(string $fieldName, string $tokenValue) {
-        $this->fieldName  = $fieldName;
-        $this->tokenValue = $tokenValue;
+final readonly class CSRFProtection {
+    public function __construct(
+        private string $fieldName,
+        private string $tokenValue
+    ) {
     }
 
     public function fieldName(): string {

src/csrfprotection/CSRFProtectionRenderer.php

@@ -9,6 +9,7 @@
  */
 namespace Templado\Engine;
 
+use function assert;
 use function sprintf;
 use DOMDocument;
 use DOMElement;
@@ -19,7 +20,8 @@ final class CSRFProtectionRenderer {
     private CSRFProtection $protection;
 
     private DOMDocument $dom;
-    private DOMXPath$xp;
+
+    private DOMXPath $xp;
 
     public function render(DOMElement $context, CSRFProtection $protection): void {
         $this->protection = $protection;

src/document/DocumentCollection.php

@@ -9,6 +9,8 @@
  */
 namespace Templado\Engine;
 
+use function array_push;
+use function count;
 use ArrayIterator;
 use Countable;
 use IteratorAggregate;

src/formdata/FormData.php

@@ -17,7 +17,6 @@
 
 class FormData {
     private readonly string $identifier;
-
     private readonly array $values;
 
     /**

src/merger/MergeList.php

@@ -9,6 +9,8 @@
  */
 namespace Templado\Engine;
 
+use function count;
+use function sprintf;
 use ArrayIterator;
 use DOMDocument;
 

src/merger/Merger.php

@@ -9,6 +9,8 @@
  */
 namespace Templado\Engine;
 
+use function assert;
+use function sprintf;
 use DOMDocument;
 use DOMElement;
 use DOMXPath;
@@ -90,7 +92,7 @@ private function isConnected(DOMElement $context, DOMElement $contextChild): boo
         return false;
     }
 
-    private function mergeIn(DOMElement $contextChild, DOMElement $import): DOMElement {
+    private function mergeIn(DOMElement $contextChild, DOMElement $import): void {
         $workContext = [$import];
 
         if ($import->namespaceURI === Document::XMLNS) {
@@ -101,12 +103,10 @@ private function mergeIn(DOMElement $contextChild, DOMElement $import): DOMEleme
             $contextChild->after(...$workContext);
             $contextChild->remove();
 
-            return $import;
+            return;
         }
 
         $contextChild->append(...$workContext);
-
-        return $import;
     }
 
     private function shouldReplaceCurrent(DOMElement $import, DOMElement $contextChild): bool {

src/selectors/XPathSelector.php

@@ -20,14 +20,12 @@
 use DOMXPath;
 
 class XPathSelector implements Selector {
-    /** @var string */
-    private $queryString;
+    /** @psalm-var array<string, string> */
+    private array $prefixMap = [];
 
-    /** @var array<string, string> */
-    private $prefixMap = [];
-
-    public function __construct(string $query) {
-        $this->queryString = $query;
+    public function __construct(
+        private string $queryString
+    ) {
     }
 
     public function registerPrefix(string $prefix, string $uri): void {

src/serializer/EmptyElementsFilter.php

@@ -14,7 +14,7 @@
 
 class EmptyElementsFilter implements Filter {
     public function apply(string $content): string {
-        $tagList = [
+        static $tagList = [
             'base', 'br', 'meta', 'link', 'img', 'input', 'button', 'hr', 'embed',
             'param', 'source', 'track', 'area', 'keygen',
         ];

src/serializer/HTMLSerializer.php

@@ -12,10 +12,13 @@
 use DOMDocument;
 
 class HTMLSerializer implements Serializer {
-    private bool $stripRDFaFlag         = false;
-    private bool $keepXMLHeaderFlag     = false;
+    private bool $stripRDFaFlag = false;
+
+    private bool $keepXMLHeaderFlag = false;
+
     private bool $namespaceCleaningFlag = true;
-    private bool $withDoctypeFlag       = true;
+
+    private bool $withDoctypeFlag = true;
 
     private array $filters = [];
 

src/serializer/XMLHeaderFilter.php

@@ -9,6 +9,8 @@
  */
 namespace Templado\Engine;
 
+use function preg_replace;
+
 class XMLHeaderFilter implements Filter {
     public function apply(string $content): string {
         return preg_replace('#^(<\?xml.*\?>\s{0,})#', '', $content);

src/transformation/NamespaceCleaningTransformation.php

@@ -9,6 +9,7 @@
  */
 namespace Templado\Engine;
 
+use function assert;
 use DOMAttr;
 use DOMDocument;
 use DOMElement;
@@ -31,6 +32,7 @@ public function apply(DOMNode $context): void {
             $this->enforceProperNamespace($context);
         }
     }
+
     private function enforceProperNamespace(DOMElement $context): void {
         assert($context->ownerDocument instanceof DOMDocument);
 

src/transformation/TransformationProcessor.php

@@ -9,6 +9,7 @@
  */
 namespace Templado\Engine;
 
+use function assert;
 use DOMElement;
 use DOMNode;
 

src/viewmodel/ViewModelRenderer.php

@@ -11,13 +11,17 @@
 
 use function array_key_exists;
 use function array_reverse;
+use function assert;
+use function explode;
 use function gettype;
+use function implode;
 use function is_iterable;
 use function is_object;
 use function is_string;
 use function lcfirst;
 use function method_exists;
 use function property_exists;
+use function sprintf;
 use function str_contains;
 use DOMDocument;
 use DOMElement;
@@ -27,12 +31,16 @@
 final class ViewModelRenderer {
     /**  @psalm-suppress PropertyNotSetInConstructor */
     private object $rootModel;
+
     /**  @psalm-suppress PropertyNotSetInConstructor */
     private DOMNode $pointer;
+
     /**  @psalm-suppress PropertyNotSetInConstructor */
     private bool $supported;
+
     /**  @psalm-suppress PropertyNotSetInConstructor */
     private DOMXPath $xp;
+
     private array $prefixModels = [];
 
     public function render(DOMNode $context, object $model): void {
@@ -581,7 +589,7 @@ private function objectApply(DOMElement $context, object $model): void {
                     $context,
                     $model,
                     $name,
-                    \sprintf('Unsupported type "%s" for attribute', gettype($result)),
+                    sprintf('Unsupported type "%s" for attribute', gettype($result)),
                 ),
                 ViewModelRendererException::WrongTypeForAttribute
             );
@@ -643,7 +651,7 @@ private function getModelPath(DOMElement $context): string {
     }
 
     private function buildExceptionMessage(?DOMElement $context, object $model, string $method, string $message): string {
-        return \sprintf(
+        return sprintf(
             '%s: %s (%s)',
             $model::class . '::' . $method,
             $message,

tests/csrfprotection/CSRFProtectionRendererTest.php

@@ -3,11 +3,12 @@
 
 use DOMDocument;
 use DOMElement;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\UsesClass;
 use PHPUnit\Framework\TestCase;
 
-/**
- * @covers \Templado\Engine\CSRFProtectionRenderer
- */
+#[CoversClass(CSRFProtectionRenderer::class)]
+#[UsesClass(CSRFProtection::class)]
 class CSRFProtectionRendererTest extends TestCase {
     use DomDocumentsEqualTrait;
 
@@ -21,11 +22,7 @@ class CSRFProtectionRendererTest extends TestCase {
     private $expected;
 
     protected function setUp(): void {
-        $protection = $this->createMock(CSRFProtection::class);
-        $protection->method('fieldName')->willReturn('csrf');
-        $protection->method('tokenValue')->willReturn('secure');
-
-        $this->protection = $protection;
+        $this->protection = new CSRFProtection('csrf', 'secure');
         $this->renderer   = new CSRFProtectionRenderer();
 
         $this->expected = new DOMDocument();
@@ -39,7 +36,7 @@ public function testUsingContextElementWithoutOwnerDocumentThrowsException(): vo
         $this->expectException(CSRFProtectionRendererException::class);
         (new CSRFProtectionRenderer())->render(
             new DOMElement('dummmy'),
-            $this->createMock(CSRFProtection::class)
+            $this->protection
         );
     }
 

tests/document/DocumentTest.php

@@ -34,6 +34,7 @@
 #[UsesClass(Signal::class)]
 #[UsesClass(StaticNodeList::class)]
 #[UsesClass(TransformationProcessor::class)]
+#[UsesClass(CSRFProtection::class)]
 #[Small]
 class DocumentTest extends TestCase {
     use DomDocumentsEqualTrait;
@@ -222,9 +223,7 @@ public function testCSRFProtectionCanBeApplied(): void {
         $dom = new DOMDocument();
         $dom->loadXML('<?xml version="1.0" ?><html><body><form></form></body></html>');
 
-        $protection = $this->createMock(CSRFProtection::class);
-        $protection->method('fieldName')->willReturn('csrf');
-        $protection->method('tokenValue')->willReturn('secure');
+        $protection = new CSRFProtection('csrf', 'secure');
 
         $expected = new DOMDocument();
         $expected->loadXML(