Merge pull request #10 from veewee/configurable-wsdl-tools

Make WSDL tools configurable by other packages

Author: veewee

.github/workflows/analyzers.yaml

@@ -22,4 +22,4 @@ jobs:
             - name: Install dependencies
               run: composer update --prefer-dist --no-progress --no-suggest ${{ matrix.composer-options }}
             - name: Run the tests
-              run: ./tools/psalm.phar
+              run: ./vendor/bin/psalm

.phive/phars.xml

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

README.md

@@ -131,6 +131,12 @@ The final result is stored in a single WSDL file.
 This command performs some basic validations on the provided WSDL file.
 If your WSDL contains any imports, you'll have to flatten the WSDL into a single file first.
 
+### Extensions
+
+By installing additional packages from `php-soap`, additional commands will be added to the WSDL tools:
+
+* [wsdl-reader](https://github.com/php-soap/wsdl-reader): Will install inspect commands that will give you a human-readable version of all information inside your WSDL. 
+
 ### Custom WSDL Loader
 
 By default, all CLI tools use the StreamWrapperLoader.

composer.json

@@ -37,6 +37,7 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",
-        "psalm/plugin-symfony": "^4.0"
+        "psalm/plugin-symfony": "^5.0",
+        "vimeo/psalm": "^5.9.0"
     }
 }

src/Console/AppFactory.php

@@ -8,6 +8,14 @@
 
 final class AppFactory
 {
+    /**
+     * @psalm-suppress UndefinedClass
+     * @var list<class-string>
+     */
+    private static array $configurators = [
+        \Soap\WsdlReader\Console\WsdlReaderConfigurator::class
+    ];
+
     /**
      * @throws LogicException
      */
@@ -19,6 +27,19 @@ public static function create(): Application
             new Command\ValidateCommand(),
         ]);
 
+        self::configure($app);
+
         return $app;
     }
+
+    private static function configure(Application $app): void
+    {
+        foreach (self::$configurators as $configurator) {
+            if (!class_exists($configurator) || !is_a($configurator, Configurator::class, true)) {
+                continue;
+            }
+
+            $configurator::configure($app);
+        }
+    }
 }

src/Console/Configurator.php

@@ -0,0 +1,11 @@
+<?php
+declare(strict_types=1);
+
+namespace Soap\Wsdl\Console;
+
+use Symfony\Component\Console\Application;
+
+interface Configurator
+{
+    public static function configure(Application $application): void;
+}

src/Xml/Configurator/FlattenWsdlImports.php

@@ -42,7 +42,7 @@ public function __invoke(DOMDocument $document): DOMDocument
         $xml = Document::fromUnsafeDocument($document);
         $xpath = $xml->xpath(new WsdlPreset($xml));
 
-        $imports = $xpath->query('wsdl:import');
+        $imports = $xpath->query('wsdl:import')->expectAllOfType(DOMElement::class);
         $imports->forEach(fn (DOMElement $import) => $this->importWsdlImportElement($import));
 
         return $document;

src/Xml/Validator/SchemaSyntaxValidator.php

@@ -30,12 +30,15 @@ public function __invoke(DOMDocument $document): IssueCollection
         $xml = Document::fromUnsafeDocument($document);
         $xpath = $xml->xpath(new WsdlPreset($xml));
 
-        return $xpath->query('//schema:schema')->reduce(
-            fn (IssueCollection $issues, DOMElement $schema) => new IssueCollection(
-                ...$issues,
-                ...Document::fromXmlNode($schema)->validate(xsd_validator($this->xsd))
-            ),
-            new IssueCollection()
-        );
+        return $xpath
+            ->query('//schema:schema')
+            ->expectAllOfType(DOMElement::class)
+            ->reduce(
+                fn (IssueCollection $issues, DOMElement $schema) => new IssueCollection(
+                    ...$issues,
+                    ...Document::fromXmlNode($schema)->validate(xsd_validator($this->xsd))
+                ),
+                new IssueCollection()
+            );
     }
 }