Add type for xml:space attribute

Author: tvdijen

src/XML/Type/SpaceValue.php

@@ -0,0 +1,71 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Type;
+
+use SimpleSAML\XML\Assert\Assert;
+use SimpleSAML\XML\Attribute;
+use SimpleSAML\XML\Constants as C;
+use SimpleSAML\XML\XML\xml\SpaceEnum;
+use SimpleSAML\XMLSchema\Exception\SchemaViolationException;
+use SimpleSAML\XMLSchema\Type\Builtin\NCNameValue;
+use SimpleSAML\XMLSchema\Type\Helper\AttributeTypeInterface;
+
+/**
+ * @package simplesaml/xml-common
+ */
+class SpaceValue extends NCNameValue implements AttributeTypeInterface
+{
+    /**
+     * Validate the value.
+     *
+     * @param string $value
+     * @throws \SimpleSAML\XMLSchema\Exception\SchemaViolationException on failure
+     * @return void
+     */
+    protected function validateValue(string $value): void
+    {
+        $sanitized = $this->sanitizeValue($value);
+        parent::validateValue($sanitized);
+
+        Assert::oneOf(
+            $sanitized,
+            [
+                SpaceEnum::Default->value,
+                SpaceEnum::Preserve->value,
+            ],
+            SchemaViolationException::class,
+        );
+    }
+
+
+    /**
+     * @param \SimpleSAML\XML\XML\xml\SpaceEnum $value
+     * @return static
+     */
+    public static function fromEnum(SpaceEnum $value): static
+    {
+        return new static($value->value);
+    }
+
+
+    /**
+     * @return \SimpleSAML\XML\XML\xml\SpaceEnum $value
+     */
+    public function toEnum(): SpaceEnum
+    {
+        return SpaceEnum::from($this->getValue());
+    }
+
+
+    /**
+     * Convert this value to an attribute
+     *
+     * @return \SimpleSAML\XML\Attribute
+     */
+    public function toAttribute(): Attribute
+    {
+        return new Attribute(C::NS_XML, 'xml', 'space', $this);
+    }
+}

src/XML/XML/xml/SpaceEnum.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\XML\xml;
+
+enum SpaceEnum: string
+{
+    case Default = 'default';
+    case Preserve = 'preserve';
+}

tests/XML/Type/SpaceValueTest.php

@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\Test\XMLSchema\Type;
+
+use PHPUnit\Framework\Attributes\{CoversClass, DataProvider, DependsOnClass};
+use PHPUnit\Framework\TestCase;
+use SimpleSAML\XML\Constants as C;
+use SimpleSAML\XML\Type\SpaceValue;
+use SimpleSAML\XML\XML\xml\SpaceEnum;
+use SimpleSAML\XMLSchema\Exception\SchemaViolationException;
+
+/**
+ * Class \SimpleSAML\Test\XML\Type\SpaceValueTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(SpaceValue::class)]
+final class SpaceValueTest extends TestCase
+{
+    /**
+     * @param string $space
+     * @param bool $shouldPass
+     */
+    #[DataProvider('provideSpace')]
+    public function testSpaceValue(string $space, bool $shouldPass): void
+    {
+        try {
+            SpaceValue::fromString($space);
+            $this->assertTrue($shouldPass);
+        } catch (SchemaViolationException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * Test helpers
+     */
+    public function testHelpers(): void
+    {
+        $lang = SpaceValue::fromString('default');
+        $attr = $lang->toAttribute();
+
+        $this->assertEquals($attr->getNamespaceURI(), C::NS_XML);
+        $this->assertEquals($attr->getNamespacePrefix(), 'xml');
+        $this->assertEquals($attr->getAttrName(), 'space');
+        $this->assertEquals($attr->getAttrValue(), 'default');
+
+        //
+        $x = SpaceValue::fromEnum(SpaceEnum::Default);
+        $this->assertEquals(SpaceEnum::Default, $x->toEnum());
+
+        $y = SpaceValue::fromString('default');
+        $this->assertEquals(SpaceEnum::Default, $y->toEnum());
+    }
+
+
+    /**
+     * @return array<string, array{0: string, 1: bool}>
+     */
+    public static function provideSpace(): array
+    {
+        return [
+            'default' => ['default', true],
+            'preserve' => ['preserve', true],
+            'undefined' => ['undefined', false],
+            'empty' => ['', false],
+        ];
+    }
+}