Add UseValue type and UseEnum

Author: tvdijen

src/Type/UseValue.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XSD\Type;
+
+use SimpleSAML\Assert\Assert;
+use SimpleSAML\XML\Exception\SchemaViolationException;
+use SimpleSAML\XML\Type\NMTokenValue;
+use SimpleSAML\XSD\XML\xsd\UseEnum;
+
+use function array_column;
+
+/**
+ * @package simplesaml/xml-xsd
+ */
+class UseValue extends NMTokenValue
+{
+    /**
+     * Validate the value.
+     *
+     * @param string $value  The value
+     * @throws \Exception on failure
+     * @return void
+     */
+    protected function validateValue(string $value): void
+    {
+        Assert::oneOf(
+            $this->sanitizeValue($value),
+            array_column(UseEnum::cases(), 'value'),
+            SchemaViolationException::class,
+        );
+    }
+
+
+    /**
+     * @param \SimpleSAML\XSD\XML\xsd\UseEnum $value
+     * @return static
+     */
+    public static function fromEnum(UseEnum $value): static
+    {
+        return new static($value->value);
+    }
+
+
+    /**
+     * @return \SimpleSAML\XSD\XML\xsd\UseEnum $value
+     */
+    public function toEnum(): UseEnum
+    {
+        return UseEnum::from($this->getValue());
+    }
+}

src/XML/xsd/AbstractAttribute.php

@@ -8,7 +8,7 @@
 use SimpleSAML\XML\Assert\Assert;
 use SimpleSAML\XML\Exception\SchemaViolationException;
 use SimpleSAML\XML\Type\{BooleanValue, IDValue, NCNameValue, QNameValue};
-use SimpleSAML\XSD\Type\FormChoiceValue;
+use SimpleSAML\XSD\Type\{FormChoiceValue, UseValue};
 
 use function strval;
 
@@ -28,8 +28,8 @@ abstract class AbstractAttribute extends AbstractAnnotated
      *
      * @param \SimpleSAML\XML\Type\NCNameValue $name
      * @param \SimpleSAML\XML\Type\QNameValue $reference
-     * @param string $type
-     * @param string|null $use
+     * @param \SimpleSAML\XML\Type\QNameValue $type
+     * @param \SimpleSAML\XSD\Type\UseValue|null $use
      * @param string|null $default
      * @param \SimpleSAML\XML\Type\BooleanValue|null $fixed
      * @param \SimpleSAML\XSD\Type\FormChoiceValue|null $formChoice
@@ -41,8 +41,8 @@ abstract class AbstractAttribute extends AbstractAnnotated
     public function __construct(
         NCNameValue $name,
         QNameValue $reference,
-        protected string $type,
-        protected ?string $use = null,
+        protected QNameValue $type,
+        protected ?UseValue $use = null,
         protected ?string $default = null,
         protected ?BooleanValue $fixed = null,
         protected ?FormChoiceValue $formChoice = null,
@@ -52,7 +52,6 @@ public function __construct(
         array $namespacedAttributes = [],
     ) {
         Assert::validQName($type, SchemaViolationException::class);
-        Assert::nullOrOneOf($use, ['optional', 'prohibited', 'required'], SchemaViolationException::class);
 
         parent::__construct($annotation, $id, $namespacedAttributes);
 
@@ -76,9 +75,9 @@ public function getSimpleType(): array
     /**
      * Collect the value of the type-property
      *
-     * @return string
+     * @return \SimpleSAML\XML\Type\QNameValue
      */
-    public function getType(): string
+    public function getType(): QNameValue
     {
         return $this->type;
     }
@@ -87,9 +86,9 @@ public function getType(): string
     /**
      * Collect the value of the use-property
      *
-     * @return string|null
+     * @return \SimpleSAML\XSD\Type\UseValue|null
      */
-    public function getUse(): ?string
+    public function getUse(): ?UseValue
     {
         return $this->use;
     }
@@ -129,10 +128,10 @@ public function toXML(?DOMElement $parent = null): DOMElement
 
         $e->setAttribute('name', strval($this->getName()));
         $e->setAttribute('reference', strval($this->getReference()));
-        $e->setAttribute('type', $this->getType());
+        $e->setAttribute('type', strval($this->getType()));
 
         if ($this->getUse() !== null) {
-            $e->setAttribute('use', $this->getUse());
+            $e->setAttribute('use', strval($this->getUse()));
         }
 
         if ($this->getDefault() !== null) {

src/XML/xsd/UseEnum.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XSD\XML\xsd;
+
+enum UseEnum: string
+{
+    case Optional = 'optional';
+    case Prohibited = 'prohibited';
+    case Required = 'required';
+}

tests/Type/UseValueTest.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\Test\XSD\Type;
+
+use PHPUnit\Framework\Attributes\{CoversClass, DataProvider, DependsOnClass};
+use PHPUnit\Framework\TestCase;
+use SimpleSAML\XML\Exception\SchemaViolationException;
+use SimpleSAML\XSD\Type\UseValue;
+use SimpleSAML\XSD\XML\xsd\UseEnum;
+
+/**
+ * Class \SimpleSAML\Test\XSD\Type\UseValueTest
+ *
+ * @package simplesamlphp/xml-xsd
+ */
+#[CoversClass(UseValue::class)]
+final class UseValueTest extends TestCase
+{
+    /**
+     * @param string $use
+     * @param bool $expected
+     */
+    #[DataProvider('provideUse')]
+    public function testUseValue(string $use, bool $shouldPass): void
+    {
+        try {
+            UseValue::fromString($use);
+            $this->assertTrue($shouldPass);
+        } catch (SchemaViolationException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * Test helpers
+     */
+    public function testHelpers(): void
+    {
+        $x = UseValue::fromEnum(UseEnum::Optional);
+        $this->assertEquals(UseEnum::Optional, $x->toEnum());
+
+        $y = UseValue::fromString('optional');
+        $this->assertEquals(UseEnum::Optional, $y->toEnum());
+    }
+
+
+    /**
+     * @return array<string, array{0: string, 1: string}>
+     */
+    public static function provideUse(): array
+    {
+        return [
+            'optional' => ['optional', true],
+            'prohibited' => ['prohibited', true],
+            'required' => ['required', true],
+            'undefined' => ['undefined', false],
+            'empty' => ['', false],
+        ];
+    }
+}