Fix several Psalm-issues

Author: tvdijen

psalm.xml

@@ -9,7 +9,6 @@
 >
     <projectFiles>
         <directory name="src" />
-        <directory name="tests" />
 
         <!-- Ignore certain directories -->
         <ignoreFiles>

src/DOMDocumentFactory.php

@@ -36,7 +36,7 @@ private function __construct()
 
 
     /**
-     * @param string $xml
+     * @param non-empty-string $xml
      *
      * @return \DOMDocument
      */
@@ -98,6 +98,7 @@ public static function fromFile(string $file): DOMDocument
         }
 
         Assert::notWhitespaceOnly($xml, sprintf('File "%s" does not have content', $file), RuntimeException::class);
+        /** @psalm-var non-empty-string $xml */
         return static::fromString($xml);
     }
 

src/ElementInterface.php

@@ -21,14 +21,6 @@ interface ElementInterface
     public function getQualifiedName(): string;
 
 
-    /**
-     * Test if an object, at the state it's in, would produce an empty XML-element
-     *
-     * @return bool
-     */
-    public function isEmptyElement(): bool;
-
-
     /**
      * Get the value of an attribute from a given element.
      *

src/Exception/UnparseableXMLException.php

@@ -12,7 +12,7 @@
  */
 final class UnparseableXMLException extends RuntimeException
 {
-    /** @var array */
+    /** @var string[] */
     private const LEVELMAP = [
         LIBXML_ERR_WARNING => 'WARNING',
         LIBXML_ERR_ERROR   => 'ERROR',

src/ExtendableElementTrait.php

@@ -34,7 +34,7 @@ trait ExtendableElementTrait
     /**
      * Set an array with all elements present.
      *
-     * @param array \SimpleSAML\XML\ElementInterface[]
+     * @param \SimpleSAML\XML\ElementInterface[] $elements
      * @return void
      */
     protected function setElements(array $elements): void
@@ -59,7 +59,8 @@ protected function setElements(array $elements): void
              * @param \SimpleSAML\XML\ElementInterface $elt
              * @return string|null
              */
-            function ($elt) {
+            function (ElementInterface $elt) {
+                /** @psalm-var \SimpleSAML\XML\Chunk|\SimpleSAML\XML\AbstractElement $elt */
                 return ($elt instanceof Chunk) ? $elt->getNamespaceURI() : $elt::getNamespaceURI();
             },
             $elements

src/SerializableElementInterface.php

@@ -21,6 +21,14 @@ interface SerializableElementInterface
     public function __toString(): string;
 
 
+    /**
+     * Test if an object, at the state it's in, would produce an empty XML-element
+     *
+     * @return bool
+     */
+    public function isEmptyElement(): bool;
+
+
     /**
      * Create a class from XML
      *

src/SerializableElementTrait.php

@@ -85,6 +85,7 @@ public function __unserialize(array $serialized): void
      * @codeCoverageIgnore
      * @param array $data
      * @return static
+     * @psalm-suppress MethodSignatureMismatch
      */
     public static function fromArray(/** @scrutinizer ignore-unused */array $data): static
     {

src/Utils.php

@@ -61,7 +61,9 @@ public static function copyElement(DOMElement $element, DOMElement $parent = nul
         $parent->appendChild($newElement);
 
         foreach ($namespaces as $prefix => $uri) {
+            /** @psalm-suppress PossiblyNullArgument  */
             $newElement->setAttributeNS($uri, $prefix . ':__ns_workaround__', 'tmp');
+            /** @psalm-suppress PossiblyNullArgument  */
             $newElement->removeAttributeNS($uri, '__ns_workaround__');
         }
 
@@ -201,6 +203,8 @@ public static function xsDateTimeToTimestamp(string $time): int
         $dateTime2 = DateTimeImmutable::createFromFormat(DateTimeImmutable::RFC3339_EXTENDED, $time);
 
         $dateTime = $dateTime1 ?: $dateTime2;
+        Assert::isInstanceOf($dateTime, DateTimeImmutable::class);
+        /** @psalm-var \DateTimeImmutable $dateTime */
         return $dateTime->getTimestamp();
     }
 }

tests/PHPUnit/SchemaValidationTestTrait.php

@@ -6,6 +6,7 @@
 
 use DOMDocument;
 use libXMLError;
+use SimpleSAML\Assert\Assert;
 use SimpleSAML\XML\Exception\SchemaViolationException;
 use XMLReader;
 
@@ -55,14 +56,18 @@ public function testSchemaValidation(): void
             );
         } else {
             $predoc = XMLReader::XML($this->xmlRepresentation->saveXML());
+            Assert::notFalse($predoc);
 
+            /** @psalm-var \XMLReader $predoc */
             $pre = $this->validateDocument($predoc);
             $this->assertTrue($pre);
 
             $class = $this->testedClass::fromXML($this->xmlRepresentation->documentElement);
             $serializedClass = $class->toXML();
 
             $postdoc = XMLReader::XML($serializedClass->ownerDocument->saveXML());
+            Assert::notFalse($postdoc);
+            /** @psalm-var \XMLReader $postdoc */
             $post = $this->validateDocument($postdoc);
             $this->assertTrue($post);
         }

tests/Utils/ExtendableElement.php

@@ -100,6 +100,7 @@ public function toXML(DOMElement $parent = null): DOMElement
     {
         $e = $this->instantiateParentElement();
 
+        /** @psalm-var \SimpleSAML\XML\SerializableElementInterface $elt */
         foreach ($this->getElements() as $elt) {
             if (!$elt->isEmptyElement()) {
                 $elt->toXML($e);