Create assertion and type-class for xs:boolean

Author: tvdijen

src/Assert/Assert.php

@@ -11,6 +11,7 @@
  *
  * @method static void validAnyURI(mixed $value, string $message = '', string $exception = '')
  * @method static void validBase64Binary(mixed $value, string $message = '', string $exception = '')
+ * @method static void validBoolean(mixed $value, string $message = '', string $exception = '')
  * @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 = '')
@@ -35,6 +36,7 @@
  * @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 = '')
+ * @method static void nullOrValidBoolean(mixed $value, string $message = '', string $exception = '')
  * @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 = '')
@@ -59,6 +61,7 @@
  * @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 = '')
+ * @method static void allValidBoolean(mixed $value, string $message = '', string $exception = '')
  * @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 = '')
@@ -86,6 +89,7 @@ class Assert extends BaseAssert
 {
     use AnyURITrait;
     use Base64BinaryTrait;
+    use BooleanTrait;
     use DateTrait;
     use DateTimeTrait;
     use DayTrait;

src/Assert/BooleanTrait.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Assert;
+
+use InvalidArgumentException;
+
+/**
+ * @package simplesamlphp/xml-common
+ */
+trait BooleanTrait
+{
+    /**
+     * @param string $value
+     * @param string $message
+     */
+    protected static function validBoolean(string $value, string $message = ''): void
+    {
+        parent::oneOf(
+            $value,
+            ['true', 'false', '1', '0'],
+            $message ?: '%s is not a valid xs:boolean',
+            InvalidArgumentException::class,
+        );
+    }
+}

src/Type/BooleanValue.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 str_replace;
+
+/**
+ * @package simplesaml/xml-common
+ */
+class BooleanValue 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::validBoolean($this->sanitizeValue($value), SchemaViolationException::class);
+    }
+}

tests/Assert/BooleanTest.php

@@ -0,0 +1,51 @@
+<?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\BooleanTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(Assert::class)]
+final class BooleanTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $boolean
+     */
+    #[DataProvider('provideBoolean')]
+    public function testValidBoolean(bool $shouldPass, string $boolean): void
+    {
+        try {
+            Assert::validBoolean($boolean);
+            $this->assertTrue($shouldPass);
+        } catch (AssertionFailedException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideBoolean(): array
+    {
+        return [
+            'true' => [true, 'true'],
+            'false' => [true, 'false'],
+            'one' => [true, '1'],
+            'zero' => [true, '0'],
+            'vrai' => [false, 'vrai'],
+            'faux' => [false, 'faux'],
+        ];
+    }
+}

tests/Type/BooleanValueTest.php

@@ -0,0 +1,52 @@
+<?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\BooleanValue;
+
+/**
+ * Class \SimpleSAML\Test\Type\BooleanValueTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(BooleanValue::class)]
+final class BooleanValueTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $boolean
+     */
+    #[DataProvider('provideBoolean')]
+    public function testBoolean(bool $shouldPass, string $boolean): void
+    {
+        try {
+            BooleanValue::fromString($boolean);
+            $this->assertTrue($shouldPass);
+        } catch (SchemaViolationException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideBoolean(): array
+    {
+        return [
+            'true' => [true, 'true'],
+            'false' => [true, 'false'],
+            'one' => [true, '1'],
+            'zero' => [true, '0'],
+            'whitespace collapse' => [true, ' tr ue '],
+            'vrai' => [false, 'vrai'],
+            'faux' => [false, 'faux'],
+        ];
+    }
+}