Create assertion and type-class for xs:int

Author: tvdijen

src/Assert/Assert.php

@@ -23,6 +23,7 @@
  * @method static void validID(mixed $value, string $message = '', string $exception = '')
  * @method static void validIDRef(mixed $value, string $message = '', string $exception = '')
  * @method static void validIDRefs(mixed $value, string $message = '', string $exception = '')
+ * @method static void validInt(mixed $value, string $message = '', string $exception = '')
  * @method static void validInteger(mixed $value, string $message = '', string $exception = '')
  * @method static void validLang(mixed $value, string $message = '', string $exception = '')
  * @method static void validLong(mixed $value, string $message = '', string $exception = '')
@@ -55,6 +56,7 @@
  * @method static void nullOrValidID(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidIDRef(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidIDRefs(mixed $value, string $message = '', string $exception = '')
+ * @method static void nullOrValidInt(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidInteger(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidLang(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidLong(mixed $value, string $message = '', string $exception = '')
@@ -87,6 +89,7 @@
  * @method static void allValidID(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidIDRef(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidIDRefs(mixed $value, string $message = '', string $exception = '')
+ * @method static void allValidInt(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidInteger(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidLang(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidLong(mixed $value, string $message = '', string $exception = '')
@@ -122,6 +125,7 @@ class Assert extends BaseAssert
     use IDTrait;
     use IDRefTrait;
     use IDRefsTrait;
+    use IntTrait;
     use IntegerTrait;
     use LangTrait;
     use LongTrait;

src/Assert/IntTrait.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Assert;
+
+use InvalidArgumentException;
+
+/**
+ * @package simplesamlphp/xml-common
+ */
+trait IntTrait
+{
+    /** @var string */
+    private static string $int_regex = '/^(((-[0]*([0-9]|[1-8][0-9]|9[0-9]|[1-8][0-9]{2}|9[0-8][0-9]|99[0-9]|[1-8][0-9]{3}|9[0-8][0-9]{2}|99[0-8][0-9]|999[0-9]|[1-8][0-9]{4}|9[0-8][0-9]{3}|99[0-8][0-9]{2}|999[0-8][0-9]|9999[0-9]|[1-8][0-9]{5}|9[0-8][0-9]{4}|99[0-8][0-9]{3}|999[0-8][0-9]{2}|9999[0-8][0-9]|99999[0-9]|[1-8][0-9]{6}|9[0-8][0-9]{5}|99[0-8][0-9]{4}|999[0-8][0-9]{3}|9999[0-8][0-9]{2}|99999[0-8][0-9]|999999[0-9]|[1-8][0-9]{7}|9[0-8][0-9]{6}|99[0-8][0-9]{5}|999[0-8][0-9]{4}|9999[0-8][0-9]{3}|99999[0-8][0-9]{2}|999999[0-8][0-9]|9999999[0-9]|[1-8][0-9]{8}|9[0-8][0-9]{7}|99[0-8][0-9]{6}|999[0-8][0-9]{5}|9999[0-8][0-9]{4}|99999[0-8][0-9]{3}|999999[0-8][0-9]{2}|9999999[0-8][0-9]|99999999[0-9]|1[0-9]{9}|20[0-9]{8}|21[0-3][0-9]{7}|214[0-6][0-9]{6}|2147[0-3][0-9]{5}|21474[0-7][0-9]{4}|214748[0-2][0-9]{3}|2147483[0-5][0-9]{2}|21474836[0-3][0-9]|214748364[0-8]))|([+]?[0]*(([0-9]|[1-8][0-9]|9[0-9]|[1-8][0-9]{2}|9[0-8][0-9]|99[0-9]|[1-8][0-9]{3}|9[0-8][0-9]{2}|99[0-8][0-9]|999[0-9]|[1-8][0-9]{4}|9[0-8][0-9]{3}|99[0-8][0-9]{2}|999[0-8][0-9]|9999[0-9]|[1-8][0-9]{5}|9[0-8][0-9]{4}|99[0-8][0-9]{3}|999[0-8][0-9]{2}|9999[0-8][0-9]|99999[0-9]|[1-8][0-9]{6}|9[0-8][0-9]{5}|99[0-8][0-9]{4}|999[0-8][0-9]{3}|9999[0-8][0-9]{2}|99999[0-8][0-9]|999999[0-9]|[1-8][0-9]{7}|9[0-8][0-9]{6}|99[0-8][0-9]{5}|999[0-8][0-9]{4}|9999[0-8][0-9]{3}|99999[0-8][0-9]{2}|999999[0-8][0-9]|9999999[0-9]|[1-8][0-9]{8}|9[0-8][0-9]{7}|99[0-8][0-9]{6}|999[0-8][0-9]{5}|9999[0-8][0-9]{4}|99999[0-8][0-9]{3}|999999[0-8][0-9]{2}|9999999[0-8][0-9]|99999999[0-9]|1[0-9]{9}|20[0-9]{8}|21[0-3][0-9]{7}|214[0-6][0-9]{6}|2147[0-3][0-9]{5}|21474[0-7][0-9]{4}|214748[0-2][0-9]{3}|2147483[0-5][0-9]{2}|21474836[0-3][0-9]|214748364[0-7])))|0))$/D';
+
+
+    /**
+     * @param string $value
+     * @param string $message
+     */
+    protected static function validInt(string $value, string $message = ''): void
+    {
+        parent::regex(
+            $value,
+            self::$int_regex,
+            $message ?: '%s is not a valid xs:int',
+            InvalidArgumentException::class,
+        );
+    }
+}

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

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

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