Create assertion and type-class for xs:nonNegativeInteger

Author: tvdijen

src/Assert/Assert.php

@@ -31,6 +31,7 @@
  * @method static void validNMToken(mixed $value, string $message = '', string $exception = '')
  * @method static void validNMTokens(mixed $value, string $message = '', string $exception = '')
  * @method static void validNegativeInteger(mixed $value, string $message = '', string $exception = '')
+ * @method static void validNonNegativeInteger(mixed $value, string $message = '', string $exception = '')
  * @method static void validNonPositiveInteger(mixed $value, string $message = '', string $exception = '')
  * @method static void validNormalizedString(mixed $value, string $message = '', string $exception = '')
  * @method static void validQName(mixed $value, string $message = '', string $exception = '')
@@ -60,6 +61,7 @@
  * @method static void nullOrValidNMToken(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidNMTokens(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidNegativeInteger(mixed $value, string $message = '', string $exception = '')
+ * @method static void nullOrValidNonNegativeInteger(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidNonPositiveInteger(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidNormalizedString(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidQName(mixed $value, string $message = '', string $exception = '')
@@ -89,6 +91,7 @@
  * @method static void allValidNMToken(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidNMTokens(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidNegativeInteger(mixed $value, string $message = '', string $exception = '')
+ * @method static void allValidNonNegativeInteger(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidNonPositiveInteger(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidNormalizedString(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidQName(mixed $value, string $message = '', string $exception = '')
@@ -121,6 +124,7 @@ class Assert extends BaseAssert
     use NMTokenTrait;
     use NMTokensTrait;
     use NegativeIntegerTrait;
+    use NonNegativeIntegerTrait;
     use NonPositiveIntegerTrait;
     use NormalizedStringTrait;
     use QNameTrait;

src/Assert/NonNegativeIntegerTrait.php

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

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

tests/Assert/NonNegativeIntegerTest.php

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

tests/Type/NonNegativeIntegerValueTest.php

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