refactor: Introduce DraftIdentifers enum

DannyvdSluijs · DannyvdSluijs · commit 77156cd031c3 · 2025-08-29T14:48:17.000+02:00
diff --git a/src/JsonSchema/Constraints/Factory.php b/src/JsonSchema/Constraints/Factory.php
@@ -11,6 +11,7 @@
 
 namespace JsonSchema\Constraints;
 
+use JsonSchema\DraftIdentifiers;
 use JsonSchema\Exception\InvalidArgumentException;
 use JsonSchema\SchemaStorage;
 use JsonSchema\SchemaStorageInterface;
@@ -51,7 +52,7 @@ class Factory
     protected $errorContext = Validator::ERROR_DOCUMENT_VALIDATION;
 
     /** @var string */
-    private $defaultDialect = 'http://json-schema.org/draft-06/schema#';
+    private $defaultDialect = DraftIdentifiers::DRAFT_6;
 
     /**
      * @var array
diff --git a/src/JsonSchema/Constraints/SchemaConstraint.php b/src/JsonSchema/Constraints/SchemaConstraint.php
@@ -12,6 +12,7 @@
 namespace JsonSchema\Constraints;
 
 use JsonSchema\ConstraintError;
+use JsonSchema\DraftIdentifiers;
 use JsonSchema\Entity\JsonPointer;
 use JsonSchema\Exception\InvalidArgumentException;
 use JsonSchema\Exception\InvalidSchemaException;
@@ -26,7 +27,7 @@
  */
 class SchemaConstraint extends Constraint
 {
-    private const DEFAULT_SCHEMA_SPEC = 'http://json-schema.org/draft-04/schema#';
+    private const DEFAULT_SCHEMA_SPEC = DraftIdentifiers::DRAFT_4;
 
     /**
      * {@inheritdoc}
diff --git a/src/JsonSchema/DraftIdentifiers.php b/src/JsonSchema/DraftIdentifiers.php
@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JsonSchema;
+
+/**
+ * @extends Enum<DraftIdentifiers::*>
+ *
+ * @method static DraftIdentifiers DRAFT_3()
+ * @method static DraftIdentifiers DRAFT_4()
+ * @method static DraftIdentifiers DRAFT_6()
+ * @method static DraftIdentifiers DRAFT_7()
+ * @method static DraftIdentifiers DRAFT_2019_09()
+ * @method static DraftIdentifiers DRAFT_2020_12()
+ */
+class DraftIdentifiers extends Enum
+{
+    public const DRAFT_3 = 'http://json-schema.org/draft-03/schema#';
+    public const DRAFT_4 = 'http://json-schema.org/draft-04/schema#';
+    public const DRAFT_6 = 'http://json-schema.org/draft-06/schema#';
+    public const DRAFT_7 = 'http://json-schema.org/draft-07/schema#';
+    public const DRAFT_2019_09 = 'https://json-schema.org/draft/2019-09/schema';
+    public const DRAFT_2020_12 = 'https://json-schema.org/draft/2020-12/schema';
+
+    public function toConstraintName(): string
+    {
+        switch ($this->getValue()) {
+            case self::DRAFT_3:
+                return 'draft03';
+            case self::DRAFT_4:
+                return 'draft04';
+            case self::DRAFT_6:
+                return 'draft06';
+            case self::DRAFT_7:
+                return 'draft07';
+            case self::DRAFT_2019_09:
+                return 'draft2019-09';
+            case self::DRAFT_2020_12:
+                return 'draft2020-12';
+
+        }
+
+        throw new \Exception('Unsupported schema URI: ' . $this->getValue());
+    }
+
+    public function withoutFragment(): string
+    {
+        return rtrim($this->getValue(), '#');
+    }
+}
diff --git a/src/JsonSchema/SchemaStorage.php b/src/JsonSchema/SchemaStorage.php
@@ -62,9 +62,9 @@ public function addSchema(string $id, $schema = null): void
         // workaround for bug in draft-03 & draft-04 meta-schemas (id & $ref defined with incorrect format)
         // see https://github.com/json-schema-org/JSON-Schema-Test-Suite/issues/177#issuecomment-293051367
         if (is_object($schema) && property_exists($schema, 'id')) {
-            if ($schema->id === 'http://json-schema.org/draft-04/schema#') {
+            if ($schema->id === DraftIdentifiers::DRAFT_4) {
                 $schema->properties->id->format = 'uri-reference';
-            } elseif ($schema->id === 'http://json-schema.org/draft-03/schema#') {
+            } elseif ($schema->id === DraftIdentifiers::DRAFT_3) {
                 $schema->properties->id->format = 'uri-reference';
                 $schema->properties->{'$ref'}->format = 'uri-reference';
             }
diff --git a/src/JsonSchema/Validator.php b/src/JsonSchema/Validator.php
@@ -85,7 +85,7 @@ public function validate(&$value, $schema = null, ?int $checkMode = null): int
             }
 
             $validator = $this->factory->createInstanceFor(
-                $this->schemaUriToConstraintName($dialect)
+                DraftIdentifiers::byValue($dialect)->toConstraintName()
             );
         }
 
@@ -127,18 +127,4 @@ public function coerce(&$value, $schema): int
     {
         return $this->validate($value, $schema, Constraint::CHECK_MODE_COERCE_TYPES);
     }
-
-    private function schemaUriToConstraintName(string $schemaUri): string
-    {
-        switch ($schemaUri) {
-            case 'http://json-schema.org/draft-03/schema#':
-                return 'draft03';
-            case 'http://json-schema.org/draft-04/schema#':
-                return 'draft04';
-            case 'http://json-schema.org/draft-06/schema#':
-                return 'draft06';
-        }
-
-        throw new \Exception('Unsupported schema URI: ' . $schemaUri);
-    }
 }
diff --git a/tests/Constraints/BaseTestCase.php b/tests/Constraints/BaseTestCase.php
@@ -7,13 +7,14 @@
 use Generator;
 use JsonSchema\Constraints\Constraint;
 use JsonSchema\Constraints\Factory;
+use JsonSchema\DraftIdentifiers;
 use JsonSchema\SchemaStorage;
 use JsonSchema\Uri\UriResolver;
 use JsonSchema\Validator;
 
 abstract class BaseTestCase extends VeryBaseTestCase
 {
-    protected $schemaSpec = 'http://json-schema.org/draft-04/schema#';
+    protected $schemaSpec = DraftIdentifiers::DRAFT_4;
     protected $validateSchema = false;
 
     /**
diff --git a/tests/Constraints/BasicTypesTest.php b/tests/Constraints/BasicTypesTest.php
@@ -4,10 +4,12 @@
 
 namespace JsonSchema\Tests\Constraints;
 
+use JsonSchema\DraftIdentifiers;
+
 class BasicTypesTest extends BaseTestCase
 {
     /** @var string */
-    protected $schemaSpec = 'http://json-schema.org/draft-03/schema#';
+    protected $schemaSpec = DraftIdentifiers::DRAFT_3;
     /** @var bool */
     protected $validateSchema = true;
 
diff --git a/tests/Constraints/ConstTest.php b/tests/Constraints/ConstTest.php
@@ -4,10 +4,12 @@
 
 namespace JsonSchema\Tests\Constraints;
 
+use JsonSchema\DraftIdentifiers;
+
 class ConstTest extends BaseTestCase
 {
     /** @var string */
-    protected $schemaSpec = 'http://json-schema.org/draft-06/schema#';
+    protected $schemaSpec = DraftIdentifiers::DRAFT_6;
     /** @var bool */
     protected $validateSchema = true;
 
diff --git a/tests/Constraints/DependenciesTest.php b/tests/Constraints/DependenciesTest.php
@@ -4,10 +4,12 @@
 
 namespace JsonSchema\Tests\Constraints;
 
+use JsonSchema\DraftIdentifiers;
+
 class DependenciesTest extends BaseTestCase
 {
     /** @var string */
-    protected $schemaSpec = 'http://json-schema.org/draft-03/schema#';
+    protected $schemaSpec = DraftIdentifiers::DRAFT_3;
     /** @var bool */
     protected $validateSchema = true;
 
diff --git a/tests/Constraints/DisallowTest.php b/tests/Constraints/DisallowTest.php
@@ -4,6 +4,8 @@
 
 namespace JsonSchema\Tests\Constraints;
 
+use JsonSchema\DraftIdentifiers;
+
 /**
  * Schemas in these tests look like draft-03, but the 'disallow' patterns provided are in
  * violation of the spec - 'disallow' as defined in draft-03 accepts the same values as the
@@ -14,7 +16,7 @@
 class DisallowTest extends BaseTestCase
 {
     /** @var string */
-    protected $schemaSpec = 'http://json-schema.org/draft-03/schema#';
+    protected $schemaSpec = DraftIdentifiers::DRAFT_3;
 
     public function getInvalidTests(): \Generator
     {
diff --git a/tests/Constraints/EnumTest.php b/tests/Constraints/EnumTest.php
@@ -4,10 +4,12 @@
 
 namespace JsonSchema\Tests\Constraints;
 
+use JsonSchema\DraftIdentifiers;
+
 class EnumTest extends BaseTestCase
 {
     /** @var string */
-    protected $schemaSpec = 'http://json-schema.org/draft-03/schema#';
+    protected $schemaSpec = DraftIdentifiers::DRAFT_3;
     /** @var bool */
     protected $validateSchema = true;
 
diff --git a/tests/Constraints/ExtendsTest.php b/tests/Constraints/ExtendsTest.php
@@ -4,10 +4,12 @@
 
 namespace JsonSchema\Tests\Constraints;
 
+use JsonSchema\DraftIdentifiers;
+
 class ExtendsTest extends BaseTestCase
 {
     /** @var string */
-    protected $schemaSpec = 'http://json-schema.org/draft-03/schema#';
+    protected $schemaSpec = DraftIdentifiers::DRAFT_3;
     /** @var bool */
     protected $validateSchema = true;
 
diff --git a/tests/Constraints/RequiredPropertyTest.php b/tests/Constraints/RequiredPropertyTest.php
@@ -6,6 +6,7 @@
 
 use JsonSchema\Constraints\Constraint;
 use JsonSchema\Constraints\UndefinedConstraint;
+use JsonSchema\DraftIdentifiers;
 
 class RequiredPropertyTest extends BaseTestCase
 {
@@ -16,7 +17,7 @@ class RequiredPropertyTest extends BaseTestCase
      *
      * @var string
      * */
-    protected $schemaSpec = 'http://json-schema.org/draft-03/schema#';
+    protected $schemaSpec = DraftIdentifiers::DRAFT_3;
 
     public function testErrorPropertyIsPopulatedForRequiredIfMissingInInput(): void
     {
diff --git a/tests/Constraints/VeryBaseTestCase.php b/tests/Constraints/VeryBaseTestCase.php
@@ -4,6 +4,7 @@
 
 namespace JsonSchema\Tests\Constraints;
 
+use JsonSchema\DraftIdentifiers;
 use JsonSchema\UriRetrieverInterface;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
@@ -32,14 +33,14 @@ protected function getUriRetrieverMock($schema): object
         $that = $this;
         $uriRetriever->retrieve(Argument::any())
             ->will(function ($args) use ($that): stdClass {
-                if (strpos($args[0], 'http://json-schema.org/draft-03/schema') === 0) {
+                if (strpos($args[0], DraftIdentifiers::DRAFT_3()->withoutFragment()) === 0) {
                     return $that->getDraftSchema('json-schema-draft-03.json');
                 }
 
-                if (strpos($args[0], 'http://json-schema.org/draft-04/schema') === 0) {
+                if (strpos($args[0], DraftIdentifiers::DRAFT_4()->withoutFragment()) === 0) {
                     return $that->getDraftSchema('json-schema-draft-04.json');
                 }
-                if (strpos($args[0], 'http://json-schema.org/draft-06/schema') === 0) {
+                if (strpos($args[0],DraftIdentifiers::DRAFT_6()->withoutFragment()) === 0) {
                     return $that->getDraftSchema('json-schema-draft-06.json');
                 }
 
diff --git a/tests/Drafts/Draft3Test.php b/tests/Drafts/Draft3Test.php
@@ -5,13 +5,14 @@
 namespace JsonSchema\Tests\Drafts;
 
 use JsonSchema\Constraints\Factory;
+use JsonSchema\DraftIdentifiers;
 use JsonSchema\SchemaStorage;
 use JsonSchema\Validator;
 
 class Draft3Test extends BaseDraftTestCase
 {
     /** @var string */
-    protected $schemaSpec = 'http://json-schema.org/draft-03/schema#';
+    protected $schemaSpec = DraftIdentifiers::DRAFT_3;
     /** @var bool */
     protected $validateSchema = true;
 
diff --git a/tests/JsonSchemaTestSuiteTest.php b/tests/JsonSchemaTestSuiteTest.php
@@ -7,6 +7,7 @@
 use CallbackFilterIterator;
 use JsonSchema\Constraints\Constraint;
 use JsonSchema\Constraints\Factory;
+use JsonSchema\DraftIdentifiers;
 use JsonSchema\SchemaStorage;
 use JsonSchema\SchemaStorageInterface;
 use JsonSchema\Validator;
@@ -87,7 +88,7 @@ function ($file) {
                     // Since draft6 can only be validated using the strict check mode we need to ensure the $schema
                     // property is set in the test schema
                     if ($baseDraftName === 'draft6' && is_object($testCase->schema)) {
-                        $testCase->schema->{'$schema'} = 'http://json-schema.org/draft-06/schema#';
+                        $testCase->schema->{'$schema'} = DraftIdentifiers::DRAFT_6;
                     }
                     foreach ($testCase->tests as $test) {
                         $name = sprintf(
diff --git a/tests/SchemaStorageTest.php b/tests/SchemaStorageTest.php
@@ -4,6 +4,7 @@
 
 namespace JsonSchema\Tests;
 
+use JsonSchema\DraftIdentifiers;
 use JsonSchema\SchemaStorage;
 use JsonSchema\Uri\UriRetriever;
 use JsonSchema\Validator;
@@ -125,7 +126,7 @@ private function getMainSchema(): object
     {
         return (object) [
             'version' => 'v1',
-            '$schema' => 'http://json-schema.org/draft-04/schema#',
+            '$schema' => DraftIdentifiers::DRAFT_4,
             'id' => 'http://www.example.com/schema.json',
             'type' => 'object',
             'additionalProperties' => true,
@@ -184,7 +185,7 @@ private function getSchema2(): object
     {
         return (object) [
             'version' => 'v1',
-            '$schema' => 'http://json-schema.org/draft-04/schema#',
+            '$schema' => DraftIdentifiers::DRAFT_4,
             'id' => 'http://www.my-domain.com/schema2.json',
             'definitions' => (object) [
                 'car' => (object) [
@@ -211,7 +212,7 @@ private function getSchema3(): object
     {
         return (object) [
             'version' => 'v1',
-            '$schema' => 'http://json-schema.org/draft-04/schema#',
+            '$schema' => DraftIdentifiers::DRAFT_4,
             'title' => 'wheel',
             'wheel' => (object) [
                 'properties' => (object) [
@@ -233,7 +234,7 @@ private function getInvalidSchema(): object
     {
         return (object) [
             'version' => 'v1',
-            '$schema' => 'http://json-schema.org/draft-04/schema#',
+            '$schema' => DraftIdentifiers::DRAFT_4,
             'type' => 'object',
             'properties' => (object) [
                 'spokes' => (object) [
@@ -258,24 +259,24 @@ private function getInvalidSchema(): object
     public function testGetUriRetriever(): void
     {
         $s = new SchemaStorage();
-        $s->addSchema('http://json-schema.org/draft-04/schema#');
+        $s->addSchema(DraftIdentifiers::DRAFT_4);
         $this->assertInstanceOf(\JsonSchema\Uri\UriRetriever::class, $s->getUriRetriever());
     }
 
     public function testGetUriResolver(): void
     {
         $s = new SchemaStorage();
-        $s->addSchema('http://json-schema.org/draft-04/schema#');
+        $s->addSchema(DraftIdentifiers::DRAFT_4);
         $this->assertInstanceOf(\JsonSchema\Uri\UriResolver::class, $s->getUriResolver());
     }
 
     public function testMetaSchemaFixes(): void
     {
         $s = new SchemaStorage();
-        $s->addSchema('http://json-schema.org/draft-03/schema#');
-        $s->addSchema('http://json-schema.org/draft-04/schema#');
-        $draft_03 = $s->getSchema('http://json-schema.org/draft-03/schema#');
-        $draft_04 = $s->getSchema('http://json-schema.org/draft-04/schema#');
+        $s->addSchema(DraftIdentifiers::DRAFT_3);
+        $s->addSchema(DraftIdentifiers::DRAFT_4);
+        $draft_03 = $s->getSchema(DraftIdentifiers::DRAFT_3);
+        $draft_04 = $s->getSchema(DraftIdentifiers::DRAFT_4);
 
         $this->assertEquals('uri-reference', $draft_03->properties->id->format);
         $this->assertEquals('uri-reference', $draft_03->properties->{'$ref'}->format);
diff --git a/tests/Uri/UriRetrieverTest.php b/tests/Uri/UriRetrieverTest.php

Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ public function validate(&$value, $schema = null, ?int $checkMode = null): int`
`85`	`85`	`}`
`86`	`86`
`87`	`87`	`$validator = $this->factory->createInstanceFor(`
`88`		`- $this->schemaUriToConstraintName($dialect)`
	`88`	`+ DraftIdentifiers::byValue($dialect)->toConstraintName()`
`89`	`89`	`);`
`90`	`90`	`}`
`91`	`91`
`@@ -127,18 +127,4 @@ public function coerce(&$value, $schema): int`
`127`	`127`	`{`
`128`	`128`	`return $this->validate($value, $schema, Constraint::CHECK_MODE_COERCE_TYPES);`
`129`	`129`	`}`
`130`		`-`
`131`		`- private function schemaUriToConstraintName(string $schemaUri): string`
`132`		`- {`
`133`		`- switch ($schemaUri) {`
`134`		`- case 'http://json-schema.org/draft-03/schema#':`
`135`		`- return 'draft03';`
`136`		`- case 'http://json-schema.org/draft-04/schema#':`
`137`		`- return 'draft04';`
`138`		`- case 'http://json-schema.org/draft-06/schema#':`
`139`		`- return 'draft06';`
`140`		`- }`
`141`		`-`
`142`		`- throw new \Exception('Unsupported schema URI: ' . $schemaUri);`
`143`		`- }`
`144`	`130`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,8 @@`
`4`	`4`
`5`	`5`	`namespace JsonSchema\Tests\Constraints;`
`6`	`6`
	`7`	`+use JsonSchema\DraftIdentifiers;`
	`8`	`+`
`7`	`9`	`/**`
`8`	`10`	`* Schemas in these tests look like draft-03, but the 'disallow' patterns provided are in`
`9`	`11`	`* violation of the spec - 'disallow' as defined in draft-03 accepts the same values as the`
`@@ -14,7 +16,7 @@`
`14`	`16`	`class DisallowTest extends BaseTestCase`
`15`	`17`	`{`
`16`	`18`	`/** @var string */`
`17`		`- protected $schemaSpec = 'http://json-schema.org/draft-03/schema#';`
	`19`	`+ protected $schemaSpec = DraftIdentifiers::DRAFT_3;`
`18`	`20`
`19`	`21`	`public function getInvalidTests(): \Generator`
`20`	`22`	`{`