Create assertion and type-class for xs:date

Author: tvdijen

src/Assert/DateTrait.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Assert;
+
+use InvalidArgumentException;
+
+/**
+ * @package simplesamlphp/xml-common
+ */
+trait DateTrait
+{
+    /**
+     * The ·lexical space· of date consists of finite-length sequences of characters of the form:
+     * '-'? yyyy '-' mm '-' dd zzzzzz?
+     *
+     * where the date and optional timezone are represented exactly the same way as they are for dateTime.
+     * The first moment of the interval is that represented by:
+     * '-' yyyy '-' mm '-' dd 'T00:00:00' zzzzzz?
+     *
+     * and the least upper bound of the interval is the timeline point represented (noncanonically) by:
+     * '-' yyyy '-' mm '-' dd 'T24:00:00' zzzzzz?.
+     *
+     * @var string
+     */
+    private static string $date_regex  = '/^-?([1-9][0-9]*|[0-9]{4})-(((0(1|3|5|7|8)|1(0|2))-(0[1-9]|(1|2)[0-9]|3[0-1]))|((0(4|6|9)|11)-(0[1-9]|(1|2)[0-9]|30))|(02-(0[1-9]|(1|2)[0-9])))((\+|-)([0-1][0-9]|2[0-4]):(0[0-9]|[1-5][0-9])|Z)?$/Di';
+
+
+    /**
+     * @param string $value
+     * @param string $message
+     */
+    protected static function validDate(string $value, string $message = ''): void
+    {
+        parent::regex(
+            $value,
+            self::$date_regex,
+            $message ?: '%s is not a valid xs:date',
+            InvalidArgumentException::class,
+        );
+    }
+}

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

tests/Assert/DateTest.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\DateTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(Assert::class)]
+final class DateTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $date
+     */
+    #[DataProvider('provideDate')]
+    public function testValidDate(bool $shouldPass, string $date): void
+    {
+        try {
+            Assert::validDate($date);
+            $this->assertTrue($shouldPass);
+        } catch (AssertionFailedException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideDate(): array
+    {
+        return [
+            'valid' => [true, '2001-10-26'],
+            'valid numeric timezone' => [true, '2001-10-26+02:00'],
+            'valid Zulu timezone' => [true, '2001-10-26Z'],
+            'valid 00:00 timezone' => [true, '2001-10-26+00:00'],
+            '2001 BC' => [true, '-2001-10-26'],
+            '2000 BC' => [true, '-20000-04-01'],
+            'missing part' => [false, '2001-10'],
+            'day out of range' => [false, '2001-10-32'],
+            'month out of range' => [false, '2001-13-26+02:00'],
+            'century part missing' => [false, '01-10-26'],
+        ];
+    }
+}

tests/Type/DateValueTest.php

@@ -0,0 +1,55 @@
+<?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\DateValue;
+
+/**
+ * Class \SimpleSAML\Test\Type\DateValueTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(DateValue::class)]
+final class DateValueTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $date
+     */
+    #[DataProvider('provideDate')]
+    public function testDate(bool $shouldPass, string $date): void
+    {
+        try {
+            DateValue::fromString($date);
+            $this->assertTrue($shouldPass);
+        } catch (SchemaViolationException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideDate(): array
+    {
+        return [
+            'valid' => [true, '2001-10-26'],
+            'valid numeric timezone' => [true, '2001-10-26+02:00'],
+            'valid Zulu timezone' => [true, '2001-10-26Z'],
+            'valid 00:00 timezone' => [true, '2001-10-26+00:00'],
+            '2001 BC' => [true, '-2001-10-26'],
+            '2000 BC' => [true, '-20000-04-01'],
+            'missing part' => [false, '2001-10'],
+            'day out of range' => [false, '2001-10-32'],
+            'month out of range' => [false, '2001-13-26+02:00'],
+            'century part missing' => [false, '01-10-26'],
+        ];
+    }
+}