Create assertion and type-class for xs:string

Author: tvdijen

src/Assert/Assert.php

@@ -27,6 +27,7 @@
  * @method static void validNMToken(mixed $value, string $message = '', string $exception = '')
  * @method static void validNMTokens(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 = '')
  * @method static void validToken(mixed $value, string $message = '', string $exception = '')
  * @method static void validYearMonth(mixed $value, string $message = '', string $exception = '')
@@ -48,6 +49,7 @@
  * @method static void nullOrValidNMToken(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidNMTokens(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 = '')
  * @method static void nullOrValidToken(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidYearMonth(mixed $value, string $message = '', string $exception = '')
@@ -69,6 +71,7 @@
  * @method static void allValidNMToken(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidNMTokens(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 = '')
  * @method static void allValidToken(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidYearMonth(mixed $value, string $message = '', string $exception = '')
@@ -93,6 +96,7 @@ class Assert extends BaseAssert
     use NMTokenTrait;
     use NMTokensTrait;
     use QNameTrait;
+    use StringTrait;
     use TimeTrait;
     use TokenTrait;
     use YearMonthTrait;

src/Assert/StringTrait.php

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

src/Type/StringValue.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Type;
+
+/**
+ * @package simplesaml/xml-common
+ */
+class StringValue extends AbstractValueType
+{
+}

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

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