Create assertion and type-class for xs:token

Author: tvdijen

src/Assert/Assert.php

@@ -28,6 +28,7 @@
  * @method static void validNMTokens(mixed $value, string $message = '', string $exception = '')
  * @method static void validQName(mixed $value, string $message = '', string $exception = '')
  * @method static void validTime(mixed $value, string $message = '', string $exception = '')
+ * @method static void validToken(mixed $value, string $message = '', string $exception = '')
  * @method static void validYearMonth(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidAnyURI(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidDate(mixed $value, string $message = '', string $exception = '')
@@ -48,6 +49,7 @@
  * @method static void nullOrValidNMTokens(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidQName(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidTime(mixed $value, string $message = '', string $exception = '')
+ * @method static void nullOrValidToken(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidYearMonth(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidAnyURI(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidDate(mixed $value, string $message = '', string $exception = '')
@@ -68,6 +70,7 @@
  * @method static void allValidNMTokens(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidQName(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidTime(mixed $value, string $message = '', string $exception = '')
+ * @method static void allValidToken(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidYearMonth(mixed $value, string $message = '', string $exception = '')
  */
 class Assert extends BaseAssert
@@ -91,5 +94,6 @@ class Assert extends BaseAssert
     use NMTokensTrait;
     use QNameTrait;
     use TimeTrait;
+    use TokenTrait;
     use YearMonthTrait;
 }

src/Assert/TokenTrait.php

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

src/Type/TokenValue.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Type;
+
+use function preg_replace;
+use function trim;
+
+/**
+ * @package simplesaml/xml-common
+ */
+class TokenValue extends NormalizedStringValue
+{
+    /**
+     * Sanitize the value.
+     *
+     * @param string $value  The unsanitized value
+     * @return string
+     */
+    protected function sanitizeValue(string $value): string
+    {
+        $content = parent::sanitizeValue($value);
+        return trim(preg_replace('/\s+/', ' ', $value));
+    }
+}

tests/Assert/TokenTest.php

@@ -0,0 +1,54 @@
+<?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\TokenTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(Assert::class)]
+final class TokenTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $token
+     */
+    #[DataProvider('provideToken')]
+    public function testValidToken(bool $shouldPass, string $token): void
+    {
+        try {
+            Assert::validToken($token);
+            $this->assertTrue($shouldPass);
+        } catch (AssertionFailedException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<int, array{0: bool, 1: string}>
+     */
+    public static function provideToken(): array
+    {
+        return [
+            [true, 'Snoopy'],
+            [true, ':CMS'],
+            [true, 'fööbár'],
+            [true, '-1950-10-04'],
+            [true, ''],
+            [true, '0836217462'],
+            [true, 'foo bar'],
+            [true, 'foo,bar'],
+            [true, "foobar\n"],
+        ];
+    }
+}

tests/Type/TokenValueTest.php

@@ -0,0 +1,45 @@
+<?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\TokenValue;
+
+/**
+ * Class \SimpleSAML\Test\Type\TokenValueTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(TokenValue::class)]
+final class TokenValueTest extends TestCase
+{
+    /**
+     * @param string $str
+     * @param string $normalizedString
+     */
+    #[DataProvider('provideString')]
+    public function testToken(string $str, string $normalizedString): void
+    {
+        $value = TokenValue::fromString($str);
+        $this->assertEquals($normalizedString, $value->getValue());
+        $this->assertEquals($str, $value->getRawValue());
+    }
+
+
+    /**
+     * @return array<string, array{0: string, 1: string}>
+     */
+    public static function provideString(): array
+    {
+        return [
+            'empty string' => ['', ''],
+            'trim' => ['  Snoopy  ', 'Snoopy'],
+            'replace whitespace' => ["Snoopy\trulez", 'Snoopy rulez'],
+            'collapse' => ["Snoopy\t\n\rrulez", 'Snoopy rulez'],
+        ];
+    }
+}