[TASK] Validate guides.xml files against scheme

composer.json

@@ -54,6 +54,8 @@
         "webmozart/assert": "^1.10"
     },
     "require-dev": {
+        "ext-dom": "*",
+        "ext-libxml": "*",
         "dealerdirect/phpcodesniffer-composer-installer": "^1.0",
         "doctrine/coding-standard": "^12.0",
         "fakerphp/faker": "^1.23",

packages/guides-cli/resources/schema/guides.xsd

@@ -2,19 +2,20 @@
 <xsd:schema
     targetNamespace="https://www.phpdoc.org/guides"
     xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+    xmlns="https://www.phpdoc.org/guides"
     version="3.0"
+    elementFormDefault="qualified"
 >
     <xsd:element name="guides" type="guides"/>
 
     <xsd:complexType name="guides">
-        <xsd:choice maxOccurs="unbounded">
+        <xsd:choice minOccurs="0" maxOccurs="unbounded">
             <xsd:element name="project" type="project" minOccurs="0" maxOccurs="1"/>
             <xsd:element name="base-template-path" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
-            <xsd:element name="theme" type="theme" minOccurs="0" maxOccurs="unbounded"/>
             <xsd:element name="extension" type="extension" minOccurs="0" maxOccurs="unbounded"/>
             <xsd:element name="output-format" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
-            <xsd:element name="inventory" type="inventory" minOccurs="1" maxOccurs="unbounded"/>
-            <xsd:element name="template" type="template" minOccurs="1" maxOccurs="unbounded"/>
+            <xsd:element name="inventory" type="inventory" minOccurs="0" maxOccurs="unbounded"/>
+            <xsd:element name="template" type="template" minOccurs="0" maxOccurs="unbounded"/>
         </xsd:choice>
 
         <xsd:attribute name="input" type="xsd:string"/>
@@ -26,6 +27,7 @@
         <xsd:attribute name="show-progress" type="xsd:string"/>
         <xsd:attribute name="theme" type="xsd:string"/>
         <xsd:attribute name="default-code-language" type="xsd:string"/>
+        <xsd:attribute name="links-are-relative" type="xsd:string"/>
 
     </xsd:complexType>
 

tests/Integration/IntegrationTest.php

@@ -4,6 +4,7 @@
 
 namespace phpDocumentor\Guides\Integration;
 
+use DOMDocument;
 use phpDocumentor\Guides\ApplicationTestCase;
 use phpDocumentor\Guides\Cli\Command\Run;
 use PHPUnit\Framework\Attributes\DataProvider;
@@ -21,7 +22,11 @@
 use function file_exists;
 use function file_get_contents;
 use function implode;
+use function libxml_clear_errors;
+use function libxml_get_errors;
+use function libxml_use_internal_errors;
 use function setlocale;
+use function sprintf;
 use function str_ends_with;
 use function str_replace;
 use function system;
@@ -167,6 +172,65 @@ public static function getTestsForLatex(): array
         return self::getTestsForDirectory(__DIR__ . '/tests-latex');
     }
 
+    #[DataProvider('getTestsWithGuidesXmlForDirectoryTest')]
+    public function testXmlValidation(string $xmlFile): void
+    {
+        $xsdFile = 'packages/guides-cli/resources/schema/guides.xsd';
+        libxml_use_internal_errors(true);
+        // Create a DOMDocument for XML validation
+        $dom = new DOMDocument();
+        $dom->load($xmlFile);
+
+        // Validate against XSD schema
+        $isValid = $dom->schemaValidate($xsdFile);
+        $errorString = '';
+
+        if (!$isValid) {
+            $errors = libxml_get_errors();
+
+            foreach ($errors as $error) {
+                $errorString .= sprintf("Validation Error at line %s: %s\n", $error->line, $error->message);
+            }
+
+            libxml_clear_errors();
+        }
+
+        self::assertTrue($isValid, 'XML of ' . $xmlFile . ' does not validate against the schema: ' . $errorString);
+    }
+
+    /** @return mixed[] */
+    public static function getTestsWithGuidesXmlForDirectoryTest(): array
+    {
+        return self::getTestsWithGuidesXmlForSubDirectoryTest('tests/Integration/tests');
+    }
+
+    /** @return mixed[] */
+    private static function getTestsWithGuidesXmlForSubDirectoryTest(string $directory = 'tests'): array
+    {
+        $finder = new SymfonyFinder();
+        $finder
+            ->directories()
+            ->in($directory)
+            ->depth('== 0');
+
+        $tests = [];
+
+        foreach ($finder as $dir) {
+            if (!file_exists($dir->getPathname() . '/input')) {
+                $tests = array_merge($tests, self::getTestsWithGuidesXmlForSubDirectoryTest($dir->getPathname()));
+                continue;
+            }
+
+            if (!file_exists($dir->getPathname() . '/input/guides.xml')) {
+                continue;
+            }
+
+            $tests[$dir->getRelativePathname()] = [$dir->getPathname() . '/input/guides.xml'];
+        }
+
+        return $tests;
+    }
+
     /** @return mixed[] */
     private static function getTestsForDirectory(string $directory): array
     {

tests/Integration/tests/bootstrap/bootstrap-admonition/input/guides.xml

@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <guides xmlns="https://www.phpdoc.org/guides"
-    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:schemaLocation="https://www.phpdoc.org/guides packages/guides-cli/resources/schema/guides.xsd">
-    <theme>bootstrap</theme>
-
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="https://www.phpdoc.org/guides packages/guides-cli/resources/schema/guides.xsd"
+        theme="bootstrap"
+>
     <extension class="phpDocumentor\Guides\Bootstrap"/>
 </guides>

tests/Integration/tests/bootstrap/bootstrap-default-menu-several/input/guides.xml

@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <guides xmlns="https://www.phpdoc.org/guides"
-    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:schemaLocation="https://www.phpdoc.org/guides packages/guides-cli/resources/schema/guides.xsd">
-    <theme>bootstrap</theme>
-
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="https://www.phpdoc.org/guides packages/guides-cli/resources/schema/guides.xsd"
+        theme="bootstrap"
+>
     <extension class="phpDocumentor\Guides\Bootstrap"/>
 </guides>

tests/Integration/tests/bootstrap/bootstrap-default-menu/input/guides.xml

@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <guides xmlns="https://www.phpdoc.org/guides"
-    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:schemaLocation="https://www.phpdoc.org/guides packages/guides-cli/resources/schema/guides.xsd">
-    <theme>bootstrap</theme>
-
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="https://www.phpdoc.org/guides packages/guides-cli/resources/schema/guides.xsd"
+        theme="bootstrap"
+>
     <extension class="phpDocumentor\Guides\Bootstrap"/>
 </guides>

tests/Integration/tests/bootstrap/bootstrap-index/input/guides.xml

@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <guides xmlns="https://www.phpdoc.org/guides"
-    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:schemaLocation="https://www.phpdoc.org/guides packages/guides-cli/resources/schema/guides.xsd">
-    <theme>bootstrap</theme>
-
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="https://www.phpdoc.org/guides packages/guides-cli/resources/schema/guides.xsd"
+        theme="bootstrap"
+>
     <extension class="phpDocumentor\Guides\Bootstrap"/>
 </guides>

tests/Integration/tests/bootstrap/bootstrap-tabs/input/guides.xml

@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <guides xmlns="https://www.phpdoc.org/guides"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:schemaLocation="https://www.phpdoc.org/guides packages/guides-cli/resources/schema/guides.xsd">
-    <theme>bootstrap</theme>
-
+    xsi:schemaLocation="https://www.phpdoc.org/guides packages/guides-cli/resources/schema/guides.xsd"
+        theme="bootstrap"
+>
     <extension class="phpDocumentor\Guides\Bootstrap"/>
 </guides>

tests/Integration/tests/configuration/config-project/expected/index.html

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title>Document Title - Title</title>
+
+</head>
+<body>
+    <div class="section" id="document-title">
+    <h1>Document Title</h1>
+
+            <p>Lorem Ipsum Dolor.</p>
+    </div>
+
+</body>
+</html>

tests/Integration/tests/configuration/config-project/input/guides.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<guides xmlns="https://www.phpdoc.org/guides"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="https://www.phpdoc.org/guides packages/guides-cli/resources/schema/guides.xsd"
+>
+    <project title="Title"/>
+</guides>

tests/Integration/tests/configuration/config-project/input/index.rst

@@ -0,0 +1,5 @@
+==============
+Document Title
+==============
+
+Lorem Ipsum Dolor.

tests/Integration/tests/configuration/config-simple/expected/index.html

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title>Document Title</title>
+
+</head>
+<body>
+    <div class="section" id="document-title">
+    <h1>Document Title</h1>
+
+            <p>Lorem Ipsum Dolor.</p>
+            <pre><code class="language-php">$some = &#039;PHP code&#039;;</code></pre>
+    </div>
+
+</body>
+</html>

tests/Integration/tests/configuration/config-simple/input/guides.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<guides xmlns="https://www.phpdoc.org/guides"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="https://www.phpdoc.org/guides packages/guides-cli/resources/schema/guides.xsd"
+        default-code-language="php"
+>
+</guides>

tests/Integration/tests/configuration/config-simple/input/index.rst

@@ -0,0 +1,9 @@
+==============
+Document Title
+==============
+
+Lorem Ipsum Dolor.
+
+::
+
+    $some = 'PHP code';

tests/Integration/tests/input-file/input/guides.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<guides
+<guides xmlns="https://www.phpdoc.org/guides"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="https://www.phpdoc.org/guides packages/guides-cli/resources/schema/guides.xsd"
         input-file="README.rst"

tests/Integration/tests/markdown/blockquote-md/input/guides.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<guides
+<guides xmlns="https://www.phpdoc.org/guides"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="https://www.phpdoc.org/guides packages/guides-cli/resources/schema/guides.xsd"
         input-format="md"

tests/Integration/tests/markdown/code-md/input/guides.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<guides
+<guides xmlns="https://www.phpdoc.org/guides"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="https://www.phpdoc.org/guides packages/guides-cli/resources/schema/guides.xsd"
         input-format="md"

tests/Integration/tests/markdown/emphasis-md/input/guides.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<guides
+<guides xmlns="https://www.phpdoc.org/guides"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="https://www.phpdoc.org/guides packages/guides-cli/resources/schema/guides.xsd"
         input-format="md"

tests/Integration/tests/markdown/html-inline-md/input/guides.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<guides
+<guides xmlns="https://www.phpdoc.org/guides"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="https://www.phpdoc.org/guides packages/guides-cli/resources/schema/guides.xsd"
         input-format="md"

tests/Integration/tests/markdown/html-md/input/guides.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<guides
+<guides xmlns="https://www.phpdoc.org/guides"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="https://www.phpdoc.org/guides packages/guides-cli/resources/schema/guides.xsd"
         input-format="md"

tests/Integration/tests/markdown/image-empty-alt-md/input/guides.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<guides
+<guides xmlns="https://www.phpdoc.org/guides"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="https://www.phpdoc.org/guides packages/guides-cli/resources/schema/guides.xsd"
         input-format="md"

tests/Integration/tests/markdown/image-md/input/guides.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<guides
+<guides xmlns="https://www.phpdoc.org/guides"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="https://www.phpdoc.org/guides packages/guides-cli/resources/schema/guides.xsd"
         input-format="md"