Create assertion and type-class for xs:decimal

Author: tvdijen

src/Assert/Assert.php

@@ -15,6 +15,7 @@
  * @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 = '')
+ * @method static void validDecimal(mixed $value, string $message = '', string $exception = '')
  * @method static void validDuration(mixed $value, string $message = '', string $exception = '')
  * @method static void validEntity(mixed $value, string $message = '', string $exception = '')
  * @method static void validEntities(mixed $value, string $message = '', string $exception = '')
@@ -40,6 +41,7 @@
  * @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 = '')
+ * @method static void nullOrValidDecimal(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidDuration(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidEntity(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidEntities(mixed $value, string $message = '', string $exception = '')
@@ -65,6 +67,7 @@
  * @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 = '')
+ * @method static void allValidDecimal(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidDuration(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidEntity(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidEntities(mixed $value, string $message = '', string $exception = '')
@@ -93,6 +96,7 @@ class Assert extends BaseAssert
     use DateTrait;
     use DateTimeTrait;
     use DayTrait;
+    use DecimalTrait;
     use DurationTrait;
     use HexBinaryTrait;
     use EntitiesTrait;

src/Assert/DecimalTrait.php

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

src/Type/DecimalValue.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Type;
+
+use SimpleSAML\XML\Assert\Assert;
+use SimpleSAML\XML\Exception\SchemaViolationException;
+
+/**
+ * @package simplesaml/xml-common
+ */
+class DecimalValue extends AbstractValueType
+{
+    /**
+     * Sanitize the value.
+     *
+     * @param string $value  The unsanitized value
+     * @return string
+     */
+    protected function sanitizeValue(string $value): string
+    {
+        return str_replace(["\f", "\r", "\n", "\t", "\v", ' '], '', $value);
+    }
+
+
+    /**
+     * Validate the value.
+     *
+     * @param string $value
+     * @throws \SimpleSAML\XML\Exception\SchemaViolationException on failure
+     * @return void
+     */
+    protected function validateValue(string $value): void
+    {
+        // Note: value must already be sanitized before validating
+        Assert::validDecimal($this->sanitizeValue($value), SchemaViolationException::class);
+    }
+}

tests/Assert/DecimalTest.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\DecimalTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(Assert::class)]
+final class DecimalTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $decimal
+     */
+    #[DataProvider('provideDecimal')]
+    public function testValidDecimal(bool $shouldPass, string $decimal): void
+    {
+        try {
+            Assert::validDecimal($decimal);
+            $this->assertTrue($shouldPass);
+        } catch (AssertionFailedException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideDecimal(): array
+    {
+        return [
+            'empty' => [false, ''],
+            'valid decimal' => [true, '123.456'],
+            'valid positive signed' => [true, '+123.456'],
+            'valid negative signed' => [true, '-123.456'],
+            'valid fractional only' => [true, '-.456'],
+            'valid without fraction' => [true, '-456'],
+            'invalid with space' => [false, '1 234.456'],
+            'invalid scientific notation' => [false, '1234.456E+2'],
+            'invalid signed with space' => [false, '+ 1234.456'],
+            'invalid with thousands-delimiter' => [false, '+1,234.456'],
+        ];
+    }
+}

tests/Type/DecimalValueTest.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\DecimalValue;
+
+/**
+ * Class \SimpleSAML\Test\Type\DecimalValueTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(DecimalValue::class)]
+final class DecimalValueTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $decimal
+     */
+    #[DataProvider('provideDecimal')]
+    public function testDecimal(bool $shouldPass, string $decimal): void
+    {
+        try {
+            DecimalValue::fromString($decimal);
+            $this->assertTrue($shouldPass);
+        } catch (SchemaViolationException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideDecimal(): array
+    {
+        return [
+            'empty' => [false, ''],
+            'valid decimal' => [true, '123.456'],
+            'valid positive signed' => [true, '+123.456'],
+            'valid negative signed' => [true, '-123.456'],
+            'valid fractional only' => [true, '-.456'],
+            'valid without fraction' => [true, '-456'],
+            'valid with whitespace collapse' => [true, ' 1 234.456 '],
+            'invalid scientific notation' => [false, '1234.456E+2'],
+            'invalid with thousands-delimiter' => [false, '+1,234.456'],
+        ];
+    }
+}