* DtdValidator can be instantiated with custom dtds

* DtdValidator can be instantiated for a directory with DTDs `::forDtdDirectory()`
FriendsOfCXML · Jan 28, 2025 · 93e0f5f · 93e0f5f
1 parent b99c7d6
commit 93e0f5f
Show file tree

Hide file tree

Showing 11 changed files with 25 additions and 22 deletions.
diff --git a/src/CXml/Validation/DtdValidator.php b/src/CXml/Validation/DtdValidator.php
@@ -15,12 +15,20 @@
 
 readonly class DtdValidator
 {
-    public function __construct(private string $pathToCxmlDtds)
+    public function __construct(
+        private array $pathToDtds
+    )
     {
-        Assertion::directory($pathToCxmlDtds);
-        Assertion::file($pathToCxmlDtds . '/cXML.dtd');
-        Assertion::file($pathToCxmlDtds . '/Fulfill.dtd');
-        Assertion::file($pathToCxmlDtds . '/Quote.dtd');
+        Assertion::notEmpty($pathToDtds);
+    }
+
+    public static function forDtdDirectory(string $directory): self
+    {
+        Assertion::directory($directory);
+
+        $pathToDtds = glob($directory . '/*.dtd');
+
+        return new self($pathToDtds);
     }
 
     /**
@@ -38,12 +46,7 @@ public function validateAgainstDtd(string $xml): void
         $old = new DOMDocument();
         $old->loadXML($xml);
 
-        $validateFiles = ['cXML.dtd', 'Fulfill.dtd', 'Quote.dtd'];
-        if (file_exists($this->pathToCxmlDtds . '/Custom.dtd')) {
-            $validateFiles[] = 'Custom.dtd';
-        }
-
-        $this->validateAgainstMultipleDtd($validateFiles, $old);
+        $this->validateAgainstMultipleDtd($this->pathToDtds, $old);
 
         // reset throwing of php errors for libxml
         libxml_use_internal_errors($internalErrors);
@@ -57,7 +60,7 @@ private function injectDtd(DOMDocument $originalDomDocument, string $dtdFilename
         $creator = new DOMImplementation();
 
         try {
-            $doctype = $creator->createDocumentType('cXML', '', $this->pathToCxmlDtds . '/' . $dtdFilename);
+            $doctype = $creator->createDocumentType('cXML', '', $dtdFilename);
             $new = $creator->createDocument('', '', $doctype);
         } catch (DOMException $domException) {
             throw new CXmlInvalidException($domException->getMessage(), (string)$originalDomDocument->saveXML(), $domException);

diff --git a/tests/CXmlTest/Handling/HandlerTest.php b/tests/CXmlTest/Handling/HandlerTest.php
@@ -52,7 +52,7 @@ private static function loadFixture(string $filename): ?string
     public function testEndpoint(string $requestCxml, string $expectedHandlerCalled): void
     {
         $serializer = Serializer::create();
-        $messageValidator = new DtdValidator(__DIR__ . '/../../metadata/cxml/dtd/1.2.050');
+        $messageValidator = DtdValidator::forDtdDirectory(__DIR__ . '/../../metadata/cxml/dtd/1.2.050');
 
         $credentialRepository = new Registry();
         $credentialRepository->registerCredential(

diff --git a/tests/CXmlTest/Model/OrderRequestTest.php b/tests/CXmlTest/Model/OrderRequestTest.php
@@ -43,7 +43,7 @@ final class OrderRequestTest extends TestCase implements PayloadIdentityFactoryI
 
     protected function setUp(): void
     {
-        $this->dtdValidator = new DtdValidator(__DIR__ . '/../../metadata/cxml/dtd/1.2.050/');
+        $this->dtdValidator = DtdValidator::forDtdDirectory(__DIR__ . '/../../metadata/cxml/dtd/1.2.050/');
     }
 
     public function testMinimumExample(): void

diff --git a/tests/CXmlTest/Model/ProductActivityMessageTest.php b/tests/CXmlTest/Model/ProductActivityMessageTest.php
@@ -31,7 +31,7 @@ final class ProductActivityMessageTest extends TestCase implements PayloadIdenti
 
     protected function setUp(): void
     {
-        $this->dtdValidator = new DtdValidator(__DIR__ . '/../../metadata/cxml/dtd/1.2.050/');
+        $this->dtdValidator = DtdValidator::forDtdDirectory(__DIR__ . '/../../metadata/cxml/dtd/1.2.050/');
     }
 
     public function testMinimumExample(): void

diff --git a/tests/CXmlTest/Model/PunchOutSetupRequestTest.php b/tests/CXmlTest/Model/PunchOutSetupRequestTest.php
@@ -41,7 +41,7 @@ final class PunchOutSetupRequestTest extends TestCase implements PayloadIdentity
 
     protected function setUp(): void
     {
-        $this->dtdValidator = new DtdValidator(__DIR__ . '/../../metadata/cxml/dtd/1.2.050/');
+        $this->dtdValidator = DtdValidator::forDtdDirectory(__DIR__ . '/../../metadata/cxml/dtd/1.2.050/');
     }
 
     public function testMinimumExample(): void

diff --git a/tests/CXmlTest/Model/PunchoutOrderMessageAdvancedPricingTest.php b/tests/CXmlTest/Model/PunchoutOrderMessageAdvancedPricingTest.php
@@ -32,7 +32,7 @@ final class PunchoutOrderMessageAdvancedPricingTest extends TestCase implements
 
     protected function setUp(): void
     {
-        $this->dtdValidator = new DtdValidator(__DIR__ . '/../../metadata/cxml/dtd/1.2.050/');
+        $this->dtdValidator = DtdValidator::forDtdDirectory(__DIR__ . '/../../metadata/cxml/dtd/1.2.050/');
     }
 
     public function testMinimumExampleAdvPricing(): void

diff --git a/tests/CXmlTest/Model/PunchoutOrderMessageTest.php b/tests/CXmlTest/Model/PunchoutOrderMessageTest.php
@@ -32,7 +32,7 @@ final class PunchoutOrderMessageTest extends TestCase implements PayloadIdentity
 
     protected function setUp(): void
     {
-        $this->dtdValidator = new DtdValidator(__DIR__ . '/../../metadata/cxml/dtd/1.2.050/');
+        $this->dtdValidator = DtdValidator::forDtdDirectory(__DIR__ . '/../../metadata/cxml/dtd/1.2.050/');
     }
 
     public function testMinimumExample(): void

diff --git a/tests/CXmlTest/Model/QuoteMessageTest.php b/tests/CXmlTest/Model/QuoteMessageTest.php
@@ -37,7 +37,7 @@ final class QuoteMessageTest extends TestCase implements PayloadIdentityFactoryI
 
     protected function setUp(): void
     {
-        $this->dtdValidator = new DtdValidator(__DIR__ . '/../../metadata/cxml/dtd/1.2.050/');
+        $this->dtdValidator = DtdValidator::forDtdDirectory(__DIR__ . '/../../metadata/cxml/dtd/1.2.050/');
     }
 
     public function testMinimumExample(): void

diff --git a/tests/CXmlTest/Model/ShipNoticeRequestTest.php b/tests/CXmlTest/Model/ShipNoticeRequestTest.php
@@ -30,7 +30,7 @@ final class ShipNoticeRequestTest extends TestCase implements PayloadIdentityFac
 
     protected function setUp(): void
     {
-        $this->dtdValidator = new DtdValidator(__DIR__ . '/../../metadata/cxml/dtd/1.2.050/');
+        $this->dtdValidator = DtdValidator::forDtdDirectory(__DIR__ . '/../../metadata/cxml/dtd/1.2.050/');
     }
 
     public function testMinimumExample(): void

diff --git a/tests/CXmlTest/Model/StatusUpdateRequestTest.php b/tests/CXmlTest/Model/StatusUpdateRequestTest.php
@@ -26,7 +26,7 @@ final class StatusUpdateRequestTest extends TestCase implements PayloadIdentityF
 
     protected function setUp(): void
     {
-        $this->dtdValidator = new DtdValidator(__DIR__ . '/../../metadata/cxml/dtd/1.2.050/');
+        $this->dtdValidator = DtdValidator::forDtdDirectory(__DIR__ . '/../../metadata/cxml/dtd/1.2.050/');
     }
 
     public function testMinimumExample(): void

diff --git a/tests/CXmlTest/Validation/MessageValidatorTest.php b/tests/CXmlTest/Validation/MessageValidatorTest.php
@@ -21,7 +21,7 @@ final class MessageValidatorTest extends TestCase
 
     protected function setUp(): void
     {
-        $this->dtdValidator = new DtdValidator(__DIR__ . '/../../metadata/cxml/dtd/1.2.063');
+        $this->dtdValidator = DtdValidator::forDtdDirectory(__DIR__ . '/../../metadata/cxml/dtd/1.2.063');
     }
 
     public function testValidateProfileRequestSuccess(): void