Create assertion and type-class for xs:gYear

simplesamlphp · Jan 14, 2025 · c5b1a18 · c5b1a18
1 parent fa2f710
commit c5b1a18
Show file tree

Hide file tree

Showing 5 changed files with 183 additions and 0 deletions.
diff --git a/src/Assert/Assert.php b/src/Assert/Assert.php
@@ -49,6 +49,7 @@
  * @method static void validUnsignedInt(mixed $value, string $message = '', string $exception = '')
  * @method static void validUnsignedLong(mixed $value, string $message = '', string $exception = '')
  * @method static void validUnsignedShort(mixed $value, string $message = '', string $exception = '')
+ * @method static void validYear(mixed $value, string $message = '', string $exception = '')
  * @method static void validYearMonth(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidAnyURI(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidBase64Binary(mixed $value, string $message = '', string $exception = '')
@@ -90,6 +91,7 @@
  * @method static void nullOrValidUnsignedInt(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidUnsignedLong(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidUnsignedShort(mixed $value, string $message = '', string $exception = '')
+ * @method static void nullOrValidYear(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidYearMonth(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidAnyURI(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidBase64Binary(mixed $value, string $message = '', string $exception = '')
@@ -131,6 +133,7 @@
  * @method static void allValidUnsignedInt(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidUnsignedLong(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidUnsignedShort(mixed $value, string $message = '', string $exception = '')
+ * @method static void allValidYear(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidYearMonth(mixed $value, string $message = '', string $exception = '')
  */
 class Assert extends BaseAssert
@@ -175,5 +178,6 @@ class Assert extends BaseAssert
     use UnsignedIntTrait;
     use UnsignedLongTrait;
     use UnsignedShortTrait;
+    use YearTrait;
     use YearMonthTrait;
 }
diff --git a/src/Assert/YearTrait.php b/src/Assert/YearTrait.php
@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Assert;
+
+use InvalidArgumentException;
+
+/**
+ * @package simplesamlphp/xml-common
+ */
+trait YearTrait
+{
+    /** @var string */
+    private static string $year_regex  = '/^-?([1-9][0-9]*|[0-9]{4})((\+|-)([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 validYear(string $value, string $message = ''): void
+    {
+        parent::regex(
+            $value,
+            self::$year_regex,
+            $message ?: '%s is not a valid xs:gYear',
+            InvalidArgumentException::class,
+        );
+    }
+}
diff --git a/src/Type/YearValue.php b/src/Type/YearValue.php
@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Type;
+
+use SimpleSAML\XML\Assert\Assert;
+use SimpleSAML\XML\Exception\SchemaViolationException;
+
+use function preg_replace;
+use function trim;
+
+/**
+ * @package simplesaml/xml-common
+ */
+class YearValue extends AbstractValueType
+{
+    /**
+     * Sanitize the value.
+     *
+     * @param string $value  The unsanitized value
+     * @return string
+     */
+    protected function sanitizeValue(string $value): string
+    {
+        return trim(preg_replace('/\s+/', ' ', $value));
+    }
+
+
+    /**
+     * Validate the value.
+     *
+     * @param string $value
+     * @throws \SimpleSAML\XML\Exception\SchemaViolationException on failure
+     * @return void
+     */
+    protected function validateValue(string $value): void
+    {
+        Assert::validYear($this->sanitizeValue($value), SchemaViolationException::class);
+    }
+}
diff --git a/tests/Assert/YearTest.php b/tests/Assert/YearTest.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\YearTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(Assert::class)]
+final class YearTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $year
+     */
+    #[DataProvider('provideYear')]
+    public function testValidYear(bool $shouldPass, string $year): void
+    {
+        try {
+            Assert::validYear($year);
+            $this->assertTrue($shouldPass);
+        } catch (AssertionFailedException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideYear(): array
+    {
+        return [
+            'empty' => [false, ''],
+            'valid' => [true, '2001'],
+            'whitespace' => [false, ' 2001 '],
+            'valid numeric timezone' => [true, '2001+02:00'],
+            'valid Zulu timezone' => [true, '2001Z'],
+            'valid 00:00 timezone' => [true, '2001+00:00'],
+            '2001 BC' => [true, '-2001'],
+            '20000 BC' => [true, '-20000'],
+        ];
+    }
+}
diff --git a/tests/Type/YearValueTest.php b/tests/Type/YearValueTest.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\YearValue;
+
+/**
+ * Class \SimpleSAML\Test\Type\YearValueTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(YearValue::class)]
+final class YearValueTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $year
+     */
+    #[DataProvider('provideYear')]
+    public function testYear(bool $shouldPass, string $year): void
+    {
+        try {
+            YearValue::fromString($year);
+            $this->assertTrue($shouldPass);
+        } catch (SchemaViolationException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideYear(): array
+    {
+        return [
+            'empty' => [false, ''],
+            'whitespace collapse' => [false, ' 2001  '],
+            'valid' => [true, '2001'],
+            'valid numeric timezone' => [true, '2001+02:00'],
+            'valid Zulu timezone' => [true, '2001Z'],
+            'whitespace collapse' => [true, ' 2001Z '],
+            'valid 00:00 timezone' => [true, '2001+00:00'],
+            '2001 BC' => [true, '-2001'],
+            '20000 BC' => [true, '-20000'],
+        ];
+    }
+}