Create assertion and type-class for xs:float

Author: tvdijen

src/Assert/Assert.php

@@ -20,6 +20,7 @@
  * @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 = '')
+ * @method static void validFloat(mixed $value, string $message = '', string $exception = '')
  * @method static void validHexBinary(mixed $value, string $message = '', string $exception = '')
  * @method static void validID(mixed $value, string $message = '', string $exception = '')
  * @method static void validIDRef(mixed $value, string $message = '', string $exception = '')
@@ -55,6 +56,7 @@
  * @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 = '')
+ * @method static void nullOrValidFloat(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidHexBinary(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidID(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidIDRef(mixed $value, string $message = '', string $exception = '')
@@ -90,6 +92,7 @@
  * @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 = '')
+ * @method static void allValidFloat(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidHexBinary(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidID(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidIDRef(mixed $value, string $message = '', string $exception = '')
@@ -129,6 +132,7 @@ class Assert extends BaseAssert
     use HexBinaryTrait;
     use EntitiesTrait;
     use EntityTrait;
+    use FloatTrait;
     use IDTrait;
     use IDRefTrait;
     use IDRefsTrait;

src/Assert/FloatTrait.php

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

src/Type/FloatValue.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Type;
+
+use SimpleSAML\XML\Assert\Assert;
+use SimpleSAML\XML\Exception\SchemaViolationException;
+
+/**
+ * @package simplesaml/xml-common
+ */
+class FloatValue 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
+    {
+        Assert::validFloat($this->sanitizeValue($value), SchemaViolationException::class);
+    }
+}

tests/Assert/FloatTest.php

@@ -0,0 +1,58 @@
+<?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\FloatTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(Assert::class)]
+final class FloatTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $float
+     */
+    #[DataProvider('provideFloat')]
+    public function testValidFloat(bool $shouldPass, string $float): void
+    {
+        try {
+            Assert::validFloat($float);
+            $this->assertTrue($shouldPass);
+        } catch (AssertionFailedException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideFloat(): array
+    {
+        return [
+            'empty' => [false, ''],
+            'valid positive signed' => [true, '+123.456'],
+            'valid negative signed' => [true, '-123.456'],
+            'valid non-signed' => [true, '123.456'],
+            'valid leading zeros' => [true, '-0123.456'],
+            'valid zero' => [true, '0.0'],
+            'valid NaN' => [true, 'NaN'],
+            'case-sensitive NaN' => [false, 'NAN'],
+            'valid negative FIN' => [true, '-FIN'],
+            'valid FIN' => [true, 'FIN'],
+            'invalid +FIN' => [false, '+FIN'],
+            'invalid with space' => [false, '1 23.0'],
+            'invalid without fractional' => [false, '123'],
+        ];
+    }
+}

tests/Type/FloatValueTest.php

@@ -0,0 +1,58 @@
+<?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\FloatValue;
+
+/**
+ * Class \SimpleSAML\Test\Type\FloatValueTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(FloatValue::class)]
+final class FloatValueTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $float
+     */
+    #[DataProvider('provideFloat')]
+    public function testFloat(bool $shouldPass, string $float): void
+    {
+        try {
+            FloatValue::fromString($float);
+            $this->assertTrue($shouldPass);
+        } catch (SchemaViolationException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideFloat(): array
+    {
+        return [
+            'empty' => [false, ''],
+            'valid positive signed' => [true, '+123.456'],
+            'valid negative signed' => [true, '-123.456'],
+            'valid non-signed' => [true, '123.456'],
+            'valid leading zeros' => [true, '-0123.456'],
+            'valid zero' => [true, '0.0'],
+            'valid NaN' => [true, 'NaN'],
+            'case-sensitive NaN' => [false, 'NAN'],
+            'valid negative FIN' => [true, '-FIN'],
+            'valid FIN' => [true, 'FIN'],
+            'invalid +FIN' => [false, '+FIN'],
+            'valid with whitespace collapse' => [true, ' 1 234.456 '],
+            'invalid without fractional' => [false, '123'],
+        ];
+    }
+}