Create assertion and type-class for xs:short

Author: tvdijen

src/Assert/Assert.php

@@ -38,6 +38,7 @@
  * @method static void validNormalizedString(mixed $value, string $message = '', string $exception = '')
  * @method static void validPositiveInteger(mixed $value, string $message = '', string $exception = '')
  * @method static void validQName(mixed $value, string $message = '', string $exception = '')
+ * @method static void validShort(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 = '')
@@ -71,6 +72,7 @@
  * @method static void nullOrValidNormalizedString(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidPositiveInteger(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidQName(mixed $value, string $message = '', string $exception = '')
+ * @method static void nullOrValidShort(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 = '')
@@ -104,6 +106,7 @@
  * @method static void allValidNormalizedString(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidPositiveInteger(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidQName(mixed $value, string $message = '', string $exception = '')
+ * @method static void allValidShort(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 = '')
@@ -140,6 +143,7 @@ class Assert extends BaseAssert
     use NormalizedStringTrait;
     use PositiveIntegerTrait;
     use QNameTrait;
+    use ShortTrait;
     use StringTrait;
     use TimeTrait;
     use TokenTrait;

src/Assert/ShortTrait.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Assert;
+
+use InvalidArgumentException;
+
+/**
+ * @package simplesamlphp/xml-common
+ */
+trait ShortTrait
+{
+    /** @var string */
+    private static string $short_regex = '/^((([+-]?0*)(?:[1-9]|3276[0-7]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9]|[12][0-9][0-9][0-9][0-9]|3[01][0-9][0-9][0-9]|32[0-6][0-9][0-9]|327[0-5][0-9]|[0-9]|3276[0-7]))|0|((-0*)32768))$/D';
+
+
+    /**
+     * @param string $value
+     * @param string $message
+     */
+    protected static function validShort(string $value, string $message = ''): void
+    {
+        parent::regex(
+            $value,
+            self::$short_regex,
+            $message ?: '%s is not a valid xs:short',
+            InvalidArgumentException::class,
+        );
+    }
+}

src/Type/ShortValue.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Type;
+
+use SimpleSAML\XML\Assert\Assert;
+use SimpleSAML\XML\Exception\SchemaViolationException;
+
+/**
+ * @package simplesaml/xml-common
+ */
+class ShortValue extends IntValue
+{
+    /**
+     * Validate the value.
+     *
+     * @param string $value
+     * @throws \SimpleSAML\XML\Exception\SchemaViolationException on failure
+     * @return void
+     */
+    protected function validateValue(string $value): void
+    {
+        Assert::validShort($this->sanitizeValue($value), SchemaViolationException::class);
+    }
+}

tests/Assert/ShortTest.php

@@ -0,0 +1,56 @@
+<?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\ShortTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(Assert::class)]
+final class ShortTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $short
+     */
+    #[DataProvider('provideShort')]
+    public function testValidShort(bool $shouldPass, string $short): void
+    {
+        try {
+            Assert::validShort($short);
+            $this->assertTrue($shouldPass);
+        } catch (AssertionFailedException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideShort(): array
+    {
+        return [
+            'empty' => [false, ''],
+            'valid positive signed' => [true, '+32767'],
+            'valid negative signed' => [true, '-32768'],
+            'valid non-signed' => [true, '123'],
+            'valid leading zeros' => [true, '-0001'],
+            'valid zero' => [true, '0'],
+            'invalid positive signed out-of-bounds' => [false, '+32768'],
+            'invalid negative signed out-of-bounds' => [false, '-32769'],
+            'invalid with space' => [false, '1 234'],
+            'invalid with fractional' => [false, '1234.'],
+            'invalid with thousands-delimiter' => [false, '+1,234'],
+        ];
+    }
+}

tests/Type/ShortValueTest.php

@@ -0,0 +1,56 @@
+<?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\ShortValue;
+
+/**
+ * Class \SimpleSAML\Test\Type\ShortValueTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(ShortValue::class)]
+final class ShortValueTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $short
+     */
+    #[DataProvider('provideShort')]
+    public function testShort(bool $shouldPass, string $short): void
+    {
+        try {
+            ShortValue::fromString($short);
+            $this->assertTrue($shouldPass);
+        } catch (SchemaViolationException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideShort(): array
+    {
+        return [
+            'empty' => [false, ''],
+            'valid positive signed' => [true, '+32767'],
+            'valid negative signed' => [true, '-32768'],
+            'valid non-signed' => [true, '123'],
+            'valid leading zeros' => [true, '-0001'],
+            'valid zero' => [true, '0'],
+            'invalid positive signed out-of-bounds' => [false, '+32768'],
+            'invalid negative signed out-of-bounds' => [false, '-32769'],
+            'valid with whitespace collapse' => [true, " 1 234 \n"],
+            'invalid with fractional' => [false, '1234.'],
+            'invalid with thousands-delimiter' => [false, '+1,234'],
+        ];
+    }
+}