Create assertion and type-class for xs:unsignedByte

Author: tvdijen

src/Assert/Assert.php

@@ -45,6 +45,7 @@
  * @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 validUnsignedByte(mixed $value, string $message = '', string $exception = '')
  * @method static void validUnsignedInt(mixed $value, string $message = '', string $exception = '')
  * @method static void validUnsignedLong(mixed $value, string $message = '', string $exception = '')
  * @method static void validUnsignedShort(mixed $value, string $message = '', string $exception = '')
@@ -85,6 +86,7 @@
  * @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 nullOrValidUnsignedByte(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidUnsignedInt(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidUnsignedLong(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidUnsignedShort(mixed $value, string $message = '', string $exception = '')
@@ -125,6 +127,7 @@
  * @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 allValidUnsignedByte(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidUnsignedInt(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidUnsignedLong(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidUnsignedShort(mixed $value, string $message = '', string $exception = '')
@@ -168,6 +171,7 @@ class Assert extends BaseAssert
     use StringTrait;
     use TimeTrait;
     use TokenTrait;
+    use UnsignedByteTrait;
     use UnsignedIntTrait;
     use UnsignedLongTrait;
     use UnsignedShortTrait;

src/Assert/UnsignedByteTrait.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Assert;
+
+use InvalidArgumentException;
+
+/**
+ * @package simplesamlphp/xml-common
+ */
+trait UnsignedByteTrait
+{
+    /** @var string */
+    private static string $unsignedByte_regex = '/^(([+]?0*)(?:[1-9]|[1-9]\d|1\d{2}|2[0-4]\d|25[0-5])|0)$/D';
+
+
+    /**
+     * @param string $value
+     * @param string $message
+     */
+    protected static function validUnsignedByte(string $value, string $message = ''): void
+    {
+        parent::regex(
+            $value,
+            self::$unsignedByte_regex,
+            $message ?: '%s is not a valid xs:unsignedByte',
+            InvalidArgumentException::class,
+        );
+    }
+}

src/Type/UnsignedByteValue.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 UnsignedByteValue extends IntegerValue
+{
+    /**
+     * Validate the value.
+     *
+     * @param string $value
+     * @throws \SimpleSAML\XML\Exception\SchemaViolationException on failure
+     * @return void
+     */
+    protected function validateValue(string $value): void
+    {
+        Assert::validUnsignedByte($this->sanitizeValue($value), SchemaViolationException::class);
+    }
+}

tests/Assert/UnsignedByteTest.php

@@ -0,0 +1,55 @@
+<?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\UnsignedByteTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(Assert::class)]
+final class UnsignedByteTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $unsignedByte
+     */
+    #[DataProvider('provideUnsignedByte')]
+    public function testValidUnsignedByte(bool $shouldPass, string $unsignedByte): void
+    {
+        try {
+            Assert::validUnsignedByte($unsignedByte);
+            $this->assertTrue($shouldPass);
+        } catch (AssertionFailedException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideUnsignedByte(): array
+    {
+        return [
+            'empty' => [false, ''],
+            'valid positive Byte' => [true, '255'],
+            'invalid positive out-of-bounds' => [false, '256'],
+            'valid signed positive Byte' => [true, '+255'],
+            'valid zero' => [true, '0'],
+            'valid negative leading zeros' => [true, '0000000000000000000005'],
+            'invalid with fractional' => [false, '1.'],
+            'invalid with space' => [false, '12 3'],
+            'invalid negative' => [false, '-1'],
+            'invalid with thousands-delimiter' => [false, '1,23'],
+        ];
+    }
+}

tests/Type/UnsignedByteValueTest.php

@@ -0,0 +1,55 @@
+<?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\UnsignedByteValue;
+
+/**
+ * Class \SimpleSAML\Test\Type\UnsignedByteValueTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(UnsignedByteValue::class)]
+final class UnsignedByteValueTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $unsignedByte
+     */
+    #[DataProvider('provideUnsignedByte')]
+    public function testUnsignedByte(bool $shouldPass, string $unsignedByte): void
+    {
+        try {
+            UnsignedByteValue::fromString($unsignedByte);
+            $this->assertTrue($shouldPass);
+        } catch (SchemaViolationException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideUnsignedByte(): array
+    {
+        return [
+            'empty' => [false, ''],
+            'valid positive Byte' => [true, '255'],
+            'invalid positive out-of-bounds' => [false, '256'],
+            'valid signed positive Byte' => [true, '+255'],
+            'valid zero' => [true, '0'],
+            'valid negative leading zeros' => [true, '0000000000000000000005'],
+            'invalid with fractional' => [false, '1.'],
+            'valid with whitespace collapse' => [true, " 1 24 \n"],
+            'invalid negative' => [false, '-1'],
+            'invalid with thousands-delimiter' => [false, '1,23'],
+        ];
+    }
+}