Create assertion and type-class for xs:byte

Author: tvdijen

src/Assert/Assert.php

@@ -12,6 +12,7 @@
  * @method static void validAnyURI(mixed $value, string $message = '', string $exception = '')
  * @method static void validBase64Binary(mixed $value, string $message = '', string $exception = '')
  * @method static void validBoolean(mixed $value, string $message = '', string $exception = '')
+ * @method static void validByte(mixed $value, string $message = '', string $exception = '')
  * @method static void validDate(mixed $value, string $message = '', string $exception = '')
  * @method static void validDateTime(mixed $value, string $message = '', string $exception = '')
  * @method static void validDay(mixed $value, string $message = '', string $exception = '')
@@ -46,6 +47,7 @@
  * @method static void nullOrValidAnyURI(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidBase64Binary(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidBoolean(mixed $value, string $message = '', string $exception = '')
+ * @method static void nullOrValidByte(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidDate(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidDateTime(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidDay(mixed $value, string $message = '', string $exception = '')
@@ -80,6 +82,7 @@
  * @method static void allValidAnyURI(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidBase64Binary(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidBoolean(mixed $value, string $message = '', string $exception = '')
+ * @method static void allValidByte(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidDate(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidDateTime(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidDay(mixed $value, string $message = '', string $exception = '')
@@ -117,6 +120,7 @@ class Assert extends BaseAssert
     use AnyURITrait;
     use Base64BinaryTrait;
     use BooleanTrait;
+    use ByteTrait;
     use DateTrait;
     use DateTimeTrait;
     use DayTrait;

src/Assert/ByteTrait.php

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

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

tests/Assert/ByteTest.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\ByteTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(Assert::class)]
+final class ByteTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $byte
+     */
+    #[DataProvider('provideByte')]
+    public function testValidByte(bool $shouldPass, string $byte): void
+    {
+        try {
+            Assert::validByte($byte);
+            $this->assertTrue($shouldPass);
+        } catch (AssertionFailedException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideByte(): array
+    {
+        return [
+            'empty' => [false, ''],
+            'valid positive signed' => [true, '+127'],
+            'valid negative signed' => [true, '-128'],
+            'valid non-signed' => [true, '123'],
+            'valid leading zeros' => [true, '-0001'],
+            'valid zero' => [true, '0'],
+            'invalid positive signed out-of-bounds' => [false, '+128'],
+            'invalid negative signed out-of-bounds' => [false, '-129'],
+            'invalid with space' => [false, '1 23'],
+            'invalid with fractional' => [false, '123.'],
+        ];
+    }
+}

tests/Type/ByteValueTest.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\ByteValue;
+
+/**
+ * Class \SimpleSAML\Test\Type\ByteValueTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(ByteValue::class)]
+final class ByteValueTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $byte
+     */
+    #[DataProvider('provideByte')]
+    public function testByte(bool $shouldPass, string $byte): void
+    {
+        try {
+            ByteValue::fromString($byte);
+            $this->assertTrue($shouldPass);
+        } catch (SchemaViolationException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideByte(): array
+    {
+        return [
+            'empty' => [false, ''],
+            'valid positive signed' => [true, '+127'],
+            'valid negative signed' => [true, '-128'],
+            'valid non-signed' => [true, '123'],
+            'valid leading zeros' => [true, '-0001'],
+            'valid zero' => [true, '0'],
+            'invalid positive signed out-of-bounds' => [false, '+128'],
+            'invalid negative signed out-of-bounds' => [false, '-129'],
+            'valid with whitespace collapse' => [true, " 1 23 \n"],
+            'invalid with fractional' => [false, '123.'],
+        ];
+    }
+}