Create assertion and type-class for xs:integer

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 validInteger(mixed $value, string $message = '', string $exception = '')
  * @method static void validLang(mixed $value, string $message = '', string $exception = '')
  * @method static void validMonth(mixed $value, string $message = '', string $exception = '')
  * @method static void validName(mixed $value, string $message = '', string $exception = '')
@@ -49,6 +50,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 nullOrValidInteger(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidLang(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidMonth(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidName(mixed $value, string $message = '', string $exception = '')
@@ -75,6 +77,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 allValidInteger(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidLang(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidMonth(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidName(mixed $value, string $message = '', string $exception = '')
@@ -104,6 +107,7 @@ class Assert extends BaseAssert
     use IDTrait;
     use IDRefTrait;
     use IDRefsTrait;
+    use IntegerTrait;
     use LangTrait;
     use MonthTrait;
     use NameTrait;

src/Assert/IntegerTrait.php

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

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

tests/Assert/IntegerTest.php

@@ -0,0 +1,52 @@
+<?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\IntegerTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(Assert::class)]
+final class IntegerTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $integer
+     */
+    #[DataProvider('provideInteger')]
+    public function testValidInteger(bool $shouldPass, string $integer): void
+    {
+        try {
+            Assert::validInteger($integer);
+            $this->assertTrue($shouldPass);
+        } catch (AssertionFailedException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideInteger(): array
+    {
+        return [
+            'empty' => [false, ''],
+            'valid integer' => [true, '123456'],
+            'valid positive signed' => [true, '+00000012'],
+            'valid negative signed' => [true, '-1'],
+            'invalid with space' => [false, '1 234'],
+            'invalid with fractional' => [false, '1234.'],
+            'invalid with thousands-delimiter' => [false, '+1,234'],
+        ];
+    }
+}

tests/Type/IntegerValueTest.php

@@ -0,0 +1,52 @@
+<?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\IntegerValue;
+
+/**
+ * Class \SimpleSAML\Test\Type\IntegerValueTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(IntegerValue::class)]
+final class IntegerValueTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $integer
+     */
+    #[DataProvider('provideInteger')]
+    public function testInteger(bool $shouldPass, string $integer): void
+    {
+        try {
+            IntegerValue::fromString($integer);
+            $this->assertTrue($shouldPass);
+        } catch (SchemaViolationException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideInteger(): array
+    {
+        return [
+            'empty' => [false, ''],
+            'valid integer' => [true, '123456'],
+            'valid positive signed' => [true, '+00000012'],
+            'valid negative signed' => [true, '-1'],
+            'valid with whitespace collapse' => [true, ' 1 234 '],
+            'invalid with fractional' => [false, '1234.'],
+            'invalid with thousands-delimiter' => [false, '+1,234'],
+        ];
+    }
+}