Create assertion and type-class for xs:language

Author: tvdijen

src/Assert/LangTrait.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Assert;
+
+use InvalidArgumentException;
+
+/**
+ * @package simplesamlphp/xml-common
+ */
+trait LangTrait
+{
+    /** @var string */
+    private static string $lang_regex = '/^([a-z]{2}|[i]-[a-z]+|[x]-[a-z]{1,8})(-[a-z]{1,8})*$/Di';
+
+
+    /**
+     * @param string $value
+     * @param string $message
+     */
+    protected static function validLang(string $value, string $message = ''): void
+    {
+        Assert::regex(
+            $value,
+            self::$lang_regex,
+            $message ?: '%s is not a valid xs:language',
+            InvalidArgumentException::class,
+        );
+    }
+}

src/Type/LangValue.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Type;
+
+use SimpleSAML\XML\Assert\Assert;
+use SimpleSAML\XML\Exception\SchemaViolationException;
+
+/**
+ * @package simplesaml/xml-common
+ */
+class LangValue extends TokenValue
+{
+    /**
+     * Validate the value.
+     *
+     * @param string $value
+     * @throws \SimpleSAML\XML\Exception\SchemaViolationException on failure
+     * @return void
+     */
+    protected function validateValue(string $value): void
+    {
+        // Note: content must already be sanitized before validating
+        Assert::validLang($this->sanitizeValue($value), SchemaViolationException::class);
+    }
+}

tests/Assert/LangTest.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\Test\XML\Assert;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+use SimpleSAML\Assert\AssertionFailedException;
+use SimpleSAML\XML\Assert\Assert;
+
+/**
+ * Class \SimpleSAML\Test\XML\Assert\LangTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(Assert::class)]
+final class LangTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $lang
+     */
+    #[DataProvider('provideLang')]
+    public function testValidLang(bool $shouldPass, string $lang): void
+    {
+        try {
+            Assert::validLang($lang);
+            $this->assertTrue($shouldPass);
+        } catch (AssertionFailedException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideLang(): array
+    {
+        return [
+            'empty string' => [false, ''],
+            'one part' => [true, 'es'],
+            'two parts' => [true, 'en-US'],
+            'many parts' => [true, 'es-this-goes-on-forever'],
+            'too long' => [false, 'toolonglanguage'],
+            'x-case' => [true, 'x-klingon'],
+            'i-case' => [true, 'i-sami-no'],
+        ];
+    }
+}

tests/Type/LangValueTest.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\Test\XML\Type;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+use SimpleSAML\XML\Exception\SchemaViolationException;
+use SimpleSAML\XML\Type\LangValue;
+
+/**
+ * Class \SimpleSAML\Test\Type\LangValueTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(LangValue::class)]
+final class LangValueTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $lang
+     */
+    #[DataProvider('provideLang')]
+    public function testLang(bool $shouldPass, string $lang): void
+    {
+        try {
+            LangValue::fromString($lang);
+            $this->assertTrue($shouldPass);
+        } catch (SchemaViolationException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideLang(): array
+    {
+        return [
+            'empty string' => [false, ''],
+            'one part' => [true, 'es'],
+            'two parts' => [true, 'en-US'],
+            'many parts' => [true, 'es-this-goes-on-forever'],
+            'too long' => [false, 'toolonglanguage'],
+            'x-case' => [true, 'x-klingon'],
+            'i-case' => [true, 'i-sami-no'],
+            'normalization' => [true, ' en-US '],
+        ];
+    }
+}