Create assertion and type-class for xs:normalizedString

Author: tvdijen

src/Assert/Assert.php

@@ -26,6 +26,7 @@
  * @method static void validNCName(mixed $value, string $message = '', string $exception = '')
  * @method static void validNMToken(mixed $value, string $message = '', string $exception = '')
  * @method static void validNMTokens(mixed $value, string $message = '', string $exception = '')
+ * @method static void validNormalizedString(mixed $value, string $message = '', string $exception = '')
  * @method static void validQName(mixed $value, string $message = '', string $exception = '')
  * @method static void validString(mixed $value, string $message = '', string $exception = '')
  * @method static void validTime(mixed $value, string $message = '', string $exception = '')
@@ -48,6 +49,7 @@
  * @method static void nullOrValidNCName(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidNMToken(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidNMTokens(mixed $value, string $message = '', string $exception = '')
+ * @method static void nullOrValidNormalizedString(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidQName(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidString(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidTime(mixed $value, string $message = '', string $exception = '')
@@ -70,6 +72,7 @@
  * @method static void allValidNCName(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidNMToken(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidNMTokens(mixed $value, string $message = '', string $exception = '')
+ * @method static void allValidNormalizedString(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidQName(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidString(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidTime(mixed $value, string $message = '', string $exception = '')
@@ -95,6 +98,7 @@ class Assert extends BaseAssert
     use NCNameTrait;
     use NMTokenTrait;
     use NMTokensTrait;
+    use NormalizedStringTrait;
     use QNameTrait;
     use StringTrait;
     use TimeTrait;

src/Assert/NormalizedStringTrait.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Assert;
+
+/**
+ * @package simplesamlphp/xml-common
+ */
+trait NormalizedStringTrait
+{
+    /**
+     * @param string $value
+     * @param string $message
+     */
+    protected static function validNormalizedString(string $value, string $message = ''): void
+    {
+    }
+}

src/Type/NormalizedStringValue.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Type;
+
+/**
+ * @package simplesaml/xml-common
+ */
+class NormalizedStringValue extends StringValue
+{
+    /**
+     * Sanitize the value.
+     *
+     * @param string $value  The unsanitized value
+     * @return string
+     */
+    protected function sanitizeValue(string $value): string
+    {
+        return str_replace(["\f", "\r", "\n", "\t", "\v"], ' ', $value);
+    }
+}

tests/Assert/NormalizedStringTest.php

@@ -0,0 +1,47 @@
+<?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\NormalizedStringTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(Assert::class)]
+final class NormalizedStringTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $str
+     */
+    #[DataProvider('provideNormalizedString')]
+    public function testNormalizedString(bool $shouldPass, string $str): void
+    {
+        try {
+            Assert::validNormalizedString($str);
+            $this->assertTrue($shouldPass);
+        } catch (AssertionFailedException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: boolean, 1: string}>
+     */
+    public static function provideNormalizedString(): array
+    {
+        return [
+            'preserve spaces' => [true, '  Snoopy  '],
+            'replace whitespace' => [true, "  Snoopy\t\n\rrulez  "],
+        ];
+    }
+}

tests/Type/NormalizedStringValueTest.php

@@ -0,0 +1,43 @@
+<?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\Type\NormalizedStringValue;
+
+/**
+ * Class \SimpleSAML\Test\Type\NormalizedStringValueValueTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(NormalizedStringValue::class)]
+final class NormalizedStringValueTest extends TestCase
+{
+    /**
+     * @param string $str
+     * @param string $normalizedStringValue
+     */
+    #[DataProvider('provideNormalizedString')]
+    public function testNormalizedString(string $str, string $normalizedStringValue): void
+    {
+        $value = NormalizedStringValue::fromString($str);
+        $this->assertEquals($normalizedStringValue, $value->getValue());
+        $this->assertEquals($str, $value->getRawValue());
+    }
+
+
+    /**
+     * @return array<string, array{0: string, 1: string}>
+     */
+    public static function provideNormalizedString(): array
+    {
+        return [
+            'preserve spaces' => ['  Snoopy  ', '  Snoopy  '],
+            'replace whitespace' => ["  Snoopy\t\n\rrulez  ", '  Snoopy   rulez  '],
+        ];
+    }
+}