Fix cs and static analysis

Author: veewee

.gitignore

@@ -1,3 +1,4 @@
 /vendor/
 .phpunit.result.cache
-composer.lock
+composer.lock
+.php_cs.cache

.phive/phars.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phive xmlns="https://phar.io/phive">
+  <phar name="psalm" version="^4.3.1" installed="4.8.1" location="./tools/psalm.phar" copy="true"/>
+  <phar name="php-cs-fixer" version="^2.18.2" installed="2.19.0" location="./tools/php-cs-fixer.phar" copy="true"/>
+</phive>

.php_cs.dist

@@ -0,0 +1,55 @@
+<?php
+
+return PhpCsFixer\Config::create()
+    ->setFinder(
+        \Symfony\Component\Finder\Finder::create()
+            ->in([
+                __DIR__ . '/src',
+                __DIR__ . '/tests',
+            ])
+            ->name('*.php')
+    )
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@PSR2' => true,
+        'align_multiline_comment' => true,
+        'array_indentation' => true,
+        'declare_strict_types' => true,
+        'final_class' => true,
+        'global_namespace_import' => [
+            'import_classes' => true,
+            'import_constants' => true,
+            'import_functions' => true,
+        ],
+        'list_syntax' => [
+            'syntax' => 'short',
+        ],
+        'lowercase_constants' => true,
+        'multiline_comment_opening_closing' => true,
+        'native_function_casing' => true,
+        'no_empty_phpdoc' => true,
+        'no_leading_import_slash' => true,
+        'no_superfluous_phpdoc_tags' => [
+            'allow_mixed' => true,
+        ],
+        'no_unused_imports' => true,
+        'no_useless_else' => true,
+        'no_useless_return' => true,
+        'ordered_imports' => [
+            'imports_order' => ['class', 'function', 'const'],
+        ],
+        'ordered_interfaces' => true,
+        'php_unit_test_annotation' => true,
+        'php_unit_test_case_static_method_calls' => [
+            'call_type' => 'static',
+        ],
+        'php_unit_method_casing' => [
+            'case' => 'snake_case',
+        ],
+        'single_import_per_statement' => true,
+        'single_trait_insert_per_statement' => true,
+        'static_lambda' => true,
+        'strict_comparison' => true,
+        'strict_param' => true,
+    ])
+;

psalm.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="1"
+    resolveFromConfigFile="true"
+    forbidEcho="true"
+    strictBinaryOperands="true"
+    phpVersion="8.0"
+    allowPhpStormGenerics="true"
+    allowStringToStandInForClass="true"
+    rememberPropertyAssignmentsAfterCall="false"
+    skipChecksOnUnresolvableIncludes="false"
+    checkForThrowsDocblock="true"
+    checkForThrowsInGlobalScope="true"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+>
+    <projectFiles>
+        <directory name="src" />
+        <ignoreFiles>
+            <directory name="vendor" />
+            <directory name="tests" />
+        </ignoreFiles>
+    </projectFiles>
+</psalm>

src/Builder/SoapHeaders.php

@@ -1,32 +1,33 @@
-<?php
+<?php declare(strict_types=1);
 
 namespace Soap\Xml\Builder;
 
 use DOMElement;
 use DOMNode;
-use Soap\Xml\Locator\SoapEnvelopeLocator;
 use VeeWee\Xml\Dom\Builder\Builder;
 use function VeeWee\Xml\Dom\Builder\namespaced_element;
 use function VeeWee\Xml\Dom\Locator\Node\detect_document;
 use function VeeWee\Xml\Dom\Locator\root_namespace_uri;
 
-class SoapHeaders implements Builder
+final class SoapHeaders implements Builder
 {
     /**
-     * @var callable(DOMNode): DOMElement
+     * @var list<callable(DOMNode): DOMElement>
      */
     private array $configurators;
 
     /**
-     * @param callable(DOMNode): DOMElement ...$configurators
+     * @no-named-arguments
+     * @param list<callable(DOMNode): DOMElement> $configurators
      */
     public function __construct(callable ... $configurators)
     {
         $this->configurators = $configurators;
     }
 
     /**
-     * @param DOMNode $node
+     * @psalm-suppress MissingThrowsDocblock
+     *
      * @param callable(DOMElement): DOMElement ...$configurators
      */
     public function __invoke(DOMNode $node): DOMNode

src/Locator/BodyNamespaceLocator.php

@@ -5,9 +5,17 @@
 namespace Soap\Xml\Locator;
 
 use DOMDocument;
+use VeeWee\Xml\Exception\RuntimeException;
 
 final class BodyNamespaceLocator
 {
+    /**
+     * @psalm-suppress UndefinedPropertyFetch - psalm gets lost
+     * @psalm-suppress MixedReturnStatement - psalm gets lost
+     * @psalm-suppress MixedPropertyFetch - psalm gets lost
+     * @psalm-suppress MixedInferredReturnType - psalm gets lost
+     * @throws RuntimeException
+     */
     public function __invoke(DOMDocument $document): ?string
     {
         return (new SoapBodyLocator())($document)?->firstElementChild?->namespaceURI;

src/Locator/SoapBodyLocator.php

@@ -7,11 +7,15 @@
 use DOMDocument;
 use DOMElement;
 use VeeWee\Xml\Dom\Document;
+use VeeWee\Xml\Exception\RuntimeException;
 use function VeeWee\Xml\Dom\Locator\root_namespace_uri;
 use function VeeWee\Xml\Dom\Xpath\Configurator\namespaces;
 
 final class SoapBodyLocator
 {
+    /**
+     * @throws RuntimeException
+     */
     public function __invoke(DOMDocument $document): ?DOMElement
     {
         $soapNs = root_namespace_uri()($document) ?? '';

src/Locator/SoapHeaderLocator.php

@@ -7,11 +7,15 @@
 use DOMDocument;
 use DOMElement;
 use VeeWee\Xml\Dom\Document;
+use VeeWee\Xml\Exception\RuntimeException;
 use function VeeWee\Xml\Dom\Locator\root_namespace_uri;
 use function VeeWee\Xml\Dom\Xpath\Configurator\namespaces;
 
 final class SoapHeaderLocator
 {
+    /**
+     * @throws RuntimeException
+     */
     public function __invoke(DOMDocument $document): ?DOMElement
     {
         $soapNs = root_namespace_uri()($document) ?? '';

src/Manipulator/PrependSoapHeaders.php

@@ -8,6 +8,7 @@
 use DOMElement;
 use Soap\Xml\Locator\SoapEnvelopeLocator;
 use VeeWee\Xml\Dom\Document;
+use VeeWee\Xml\Exception\RuntimeException;
 
 final class PrependSoapHeaders
 {
@@ -18,6 +19,11 @@ public function __construct(DOMElement $soapHeaders)
         $this->soapHeaders = $soapHeaders;
     }
 
+    /**
+     * @throws RuntimeException
+     * @psalm-suppress LessSpecificReturnStatement
+     * @psalm-suppress MoreSpecificReturnType
+     */
     public function __invoke(DOMDocument $document): DOMElement
     {
         $doc = Document::fromUnsafeDocument($document);

src/Xpath/EnvelopePreset.php

@@ -8,10 +8,11 @@
 use Soap\Xml\Locator\BodyNamespaceLocator;
 use VeeWee\Xml\Dom\Document;
 use VeeWee\Xml\Dom\Xpath\Configurator\Configurator;
+use VeeWee\Xml\Exception\RuntimeException;
 use function VeeWee\Xml\Dom\Locator\root_namespace_uri;
 use function VeeWee\Xml\Dom\Xpath\Configurator\namespaces;
 
-class EnvelopePreset implements Configurator
+final class EnvelopePreset implements Configurator
 {
     private Document $document;
 
@@ -20,6 +21,9 @@ public function __construct(Document $document)
         $this->document = $document;
     }
 
+    /**
+     * @throws RuntimeException
+     */
     public function __invoke(DOMXPath $xpath): DOMXPath
     {
         return namespaces(array_filter([

src/Xpath/WsdlPreset.php

@@ -10,7 +10,7 @@
 use function VeeWee\Xml\Dom\Locator\root_namespace_uri;
 use function VeeWee\Xml\Dom\Xpath\Configurator\namespaces;
 
-class WsdlPreset implements Configurator
+final class WsdlPreset implements Configurator
 {
     private Document $document;
 
@@ -21,8 +21,8 @@ public function __construct(Document $document)
 
     public function __invoke(DOMXPath $xpath): DOMXPath
     {
-        return namespaces([
+        return namespaces(array_filter([
             'wsdl' => $this->document->locate(root_namespace_uri()),
-        ])($xpath);
+        ]))($xpath);
     }
 }

tests/Unit/Builder/SoapHeadersTest.php

@@ -11,10 +11,10 @@
 use function VeeWee\Xml\Dom\Builder\value;
 use function VeeWee\Xml\Dom\Mapper\xml_string;
 
-class SoapHeadersTest extends TestCase
+final class SoapHeadersTest extends TestCase
 {
-    /** @test */
-    public function it_can_create_a_header_element(): void
+    
+    public function test_it_can_create_a_header_element(): void
     {
         $builder = new SoapHeaders(
             children(
@@ -32,7 +32,7 @@ public function it_can_create_a_header_element(): void
         </soap:Header>
         EOXML;
 
-        self::assertXmlStringEqualsXmlString(
+        static::assertXmlStringEqualsXmlString(
             $expected,
             xml_string()($headers[0])
         );

tests/Unit/Locator/BodyNamespaceLocatorTest.php

@@ -5,36 +5,34 @@
 
 use PHPUnit\Framework\TestCase;
 use Soap\Xml\Locator\BodyNamespaceLocator;
-use Soap\Xml\Locator\SoapBodyLocator;
 use VeeWee\Xml\Dom\Document;
-use function VeeWee\Xml\Dom\Predicate\is_element;
 
-class BodyNamespaceLocatorTest extends TestCase
+final class BodyNamespaceLocatorTest extends TestCase
 {
-    /** @test */
-    public function it_detects_nothing_on_empty_envelope(): void
+    
+    public function test_it_detects_nothing_on_empty_envelope(): void
     {
         $doc = Document::fromXmlFile(FIXTURE_DIR.'/empty-envelope.xml');
         $namespace = $doc->locate(new BodyNamespaceLocator());
 
-        self::assertNull($namespace);
+        static::assertNull($namespace);
     }
 
-    /** @test */
-    public function it_detects_nothing_on_empty_body(): void
+    
+    public function test_it_detects_nothing_on_empty_body(): void
     {
         $doc = Document::fromXmlFile(FIXTURE_DIR.'/empty-envelope-with-body.xml');
         $namespace = $doc->locate(new BodyNamespaceLocator());
 
-        self::assertNull($namespace);
+        static::assertNull($namespace);
     }
 
-    /** @test */
-    public function it_detects_ns_on_body(): void
+    
+    public function test_it_detects_ns_on_body(): void
     {
         $doc = Document::fromXmlFile(FIXTURE_DIR.'/envelope-with-body.xml');
         $namespace = $doc->locate(new BodyNamespaceLocator());
 
-        self::assertSame('http://tns.com', $namespace);
+        static::assertSame('http://tns.com', $namespace);
     }
 }

tests/Unit/Locator/SoapBodyLocatorTest.php

@@ -8,24 +8,24 @@
 use VeeWee\Xml\Dom\Document;
 use function VeeWee\Xml\Dom\Predicate\is_element;
 
-class SoapBodyLocatorTest extends TestCase
+final class SoapBodyLocatorTest extends TestCase
 {
-    /** @test */
-    public function it_detects_nothing_on_empty_envelope(): void
+    
+    public function test_it_detects_nothing_on_empty_envelope(): void
     {
         $doc = Document::fromXmlFile(FIXTURE_DIR.'/empty-envelope.xml');
         $body = $doc->locate(new SoapBodyLocator());
 
-        self::assertNull($body);
+        static::assertNull($body);
     }
 
-    /** @test */
-    public function it_detects_body_if_it_exists(): void
+    
+    public function test_it_detects_body_if_it_exists(): void
     {
         $doc = Document::fromXmlFile(FIXTURE_DIR.'/empty-envelope-with-body.xml');
         $body = $doc->locate(new SoapBodyLocator());
 
-        self::assertTrue(is_element($body));
-        self::assertSame('Body', $body->localName);
+        static::assertTrue(is_element($body));
+        static::assertSame('Body', $body->localName);
     }
 }

tests/Unit/Locator/SoapEnvelopeLocatorTest.php

@@ -8,15 +8,15 @@
 use VeeWee\Xml\Dom\Document;
 use function VeeWee\Xml\Dom\Predicate\is_element;
 
-class SoapEnvelopeLocatorTest extends TestCase
+final class SoapEnvelopeLocatorTest extends TestCase
 {
-    /** @test */
-    public function it_detects_envelope(): void
+    
+    public function test_it_detects_envelope(): void
     {
         $doc = Document::fromXmlFile(FIXTURE_DIR.'/empty-envelope.xml');
         $envelope = $doc->locate(new SoapEnvelopeLocator());
 
-        self::assertTrue(is_element($envelope));
-        self::assertSame('Envelope', $envelope->localName);
+        static::assertTrue(is_element($envelope));
+        static::assertSame('Envelope', $envelope->localName);
     }
-}
+}