From 20831103160fd5dac2090df8b1997977ed782e42 Mon Sep 17 00:00:00 2001
From: Ben Ramsey <ben@benramsey.com>
Date: Fri, 12 Aug 2022 20:16:41 -0500
Subject: [PATCH] feat: deprecate variant and version constants

---
 psalm-baseline.xml | 45 +++++++++++++++++++++++++++++++++++++++++++++
 src/Uuid.php       | 30 ++++++++++++++++++++++++++++++
 2 files changed, 75 insertions(+)

diff --git a/psalm-baseline.xml b/psalm-baseline.xml
index 8ddfeaf..b5f529e 100644
--- a/psalm-baseline.xml
+++ b/psalm-baseline.xml
@@ -16,6 +16,12 @@
       <code>$this</code>
     </ImpureVariable>
   </file>
+  <file src="src/Codec/OrderedTimeCodec.php">
+    <DeprecatedConstant occurrences="2">
+      <code>Uuid::UUID_TYPE_TIME</code>
+      <code>Uuid::UUID_TYPE_TIME</code>
+    </DeprecatedConstant>
+  </file>
   <file src="src/Converter/Number/BigNumberConverter.php">
     <ImpureVariable occurrences="2">
       <code>$this</code>
@@ -67,6 +73,12 @@
       <code>uuid_parse</code>
     </ImpureFunctionCall>
   </file>
+  <file src="src/Guid/Fields.php">
+    <DeprecatedConstant occurrences="2">
+      <code>Uuid::RESERVED_MICROSOFT</code>
+      <code>Uuid::RFC_4122</code>
+    </DeprecatedConstant>
+  </file>
   <file src="src/Guid/Guid.php">
     <DeprecatedInterface occurrences="1">
       <code>Guid</code>
@@ -109,6 +121,9 @@
     </ImpureVariable>
   </file>
   <file src="src/Nonstandard/UuidV6.php">
+    <DeprecatedConstant occurrences="1">
+      <code>Uuid::UUID_TYPE_PEABODY</code>
+    </DeprecatedConstant>
     <DeprecatedInterface occurrences="1">
       <code>UuidV6</code>
     </DeprecatedInterface>
@@ -133,6 +148,13 @@
       <code>$macs[]</code>
     </MixedArrayAssignment>
   </file>
+  <file src="src/Rfc4122/Fields.php">
+    <DeprecatedConstant occurrences="3">
+      <code>Uuid::RFC_4122</code>
+      <code>Uuid::UUID_TYPE_DCE_SECURITY</code>
+      <code>Uuid::UUID_TYPE_PEABODY</code>
+    </DeprecatedConstant>
+  </file>
   <file src="src/Rfc4122/NilUuid.php">
     <DeprecatedInterface occurrences="1">
       <code>NilUuid</code>
@@ -161,6 +183,9 @@
     </ImpureVariable>
   </file>
   <file src="src/Rfc4122/UuidV1.php">
+    <DeprecatedConstant occurrences="1">
+      <code>Uuid::UUID_TYPE_TIME</code>
+    </DeprecatedConstant>
     <DeprecatedInterface occurrences="1">
       <code>UuidV1</code>
     </DeprecatedInterface>
@@ -169,6 +194,9 @@
     </DeprecatedMethod>
   </file>
   <file src="src/Rfc4122/UuidV2.php">
+    <DeprecatedConstant occurrences="1">
+      <code>Uuid::UUID_TYPE_DCE_SECURITY</code>
+    </DeprecatedConstant>
     <DeprecatedInterface occurrences="1">
       <code>UuidV2</code>
     </DeprecatedInterface>
@@ -177,6 +205,9 @@
     </DeprecatedMethod>
   </file>
   <file src="src/Rfc4122/UuidV3.php">
+    <DeprecatedConstant occurrences="1">
+      <code>Uuid::UUID_TYPE_HASH_MD5</code>
+    </DeprecatedConstant>
     <DeprecatedInterface occurrences="1">
       <code>UuidV3</code>
     </DeprecatedInterface>
@@ -185,6 +216,9 @@
     </DeprecatedMethod>
   </file>
   <file src="src/Rfc4122/UuidV4.php">
+    <DeprecatedConstant occurrences="1">
+      <code>Uuid::UUID_TYPE_RANDOM</code>
+    </DeprecatedConstant>
     <DeprecatedInterface occurrences="1">
       <code>UuidV4</code>
     </DeprecatedInterface>
@@ -193,6 +227,9 @@
     </DeprecatedMethod>
   </file>
   <file src="src/Rfc4122/UuidV5.php">
+    <DeprecatedConstant occurrences="1">
+      <code>Uuid::UUID_TYPE_HASH_SHA1</code>
+    </DeprecatedConstant>
     <DeprecatedInterface occurrences="1">
       <code>UuidV5</code>
     </DeprecatedInterface>
@@ -200,6 +237,14 @@
       <code>parent::__construct($fields, $numberConverter, $codec, $timeConverter)</code>
     </DeprecatedMethod>
   </file>
+  <file src="src/Rfc4122/VariantTrait.php">
+    <DeprecatedConstant occurrences="4">
+      <code>Uuid::RESERVED_FUTURE</code>
+      <code>Uuid::RESERVED_MICROSOFT</code>
+      <code>Uuid::RESERVED_NCS</code>
+      <code>Uuid::RFC_4122</code>
+    </DeprecatedConstant>
+  </file>
   <file src="src/Type/Decimal.php">
     <UnusedMethodCall occurrences="1">
       <code>unserialize</code>
diff --git a/src/Uuid.php b/src/Uuid.php
index c849cfd..7d0317f 100644
--- a/src/Uuid.php
+++ b/src/Uuid.php
@@ -85,6 +85,9 @@ class Uuid implements UuidInterface
     /**
      * Variant: reserved, NCS backward compatibility
      *
+     * @deprecated The Ramsey\Uuid\Variant enum will replace this constant in
+     *     ramsey/uuid version 5.
+     *
      * @link http://tools.ietf.org/html/rfc4122#section-4.1.1 RFC 4122, § 4.1.1: Variant
      */
     public const RESERVED_NCS = 0;
@@ -92,6 +95,9 @@ class Uuid implements UuidInterface
     /**
      * Variant: the UUID layout specified in RFC 4122
      *
+     * @deprecated The Ramsey\Uuid\Variant enum will replace this constant in
+     *     ramsey/uuid version 5.
+     *
      * @link http://tools.ietf.org/html/rfc4122#section-4.1.1 RFC 4122, § 4.1.1: Variant
      */
     public const RFC_4122 = 2;
@@ -99,6 +105,9 @@ class Uuid implements UuidInterface
     /**
      * Variant: reserved, Microsoft Corporation backward compatibility
      *
+     * @deprecated The Ramsey\Uuid\Variant enum will replace this constant in
+     *     ramsey/uuid version 5.
+     *
      * @link http://tools.ietf.org/html/rfc4122#section-4.1.1 RFC 4122, § 4.1.1: Variant
      */
     public const RESERVED_MICROSOFT = 6;
@@ -106,6 +115,9 @@ class Uuid implements UuidInterface
     /**
      * Variant: reserved for future definition
      *
+     * @deprecated The Ramsey\Uuid\Variant enum will replace this constant in
+     *     ramsey/uuid version 5.
+     *
      * @link http://tools.ietf.org/html/rfc4122#section-4.1.1 RFC 4122, § 4.1.1: Variant
      */
     public const RESERVED_FUTURE = 7;
@@ -118,6 +130,9 @@ class Uuid implements UuidInterface
     /**
      * Version 1 (time-based) UUID
      *
+     * @deprecated The Ramsey\Uuid\Version enum will replace this constant in
+     *     ramsey/uuid version 5.
+     *
      * @link https://tools.ietf.org/html/rfc4122#section-4.1.3 RFC 4122, § 4.1.3: Version
      */
     public const UUID_TYPE_TIME = 1;
@@ -125,6 +140,9 @@ class Uuid implements UuidInterface
     /**
      * Version 2 (DCE Security) UUID
      *
+     * @deprecated The Ramsey\Uuid\Version enum will replace this constant in
+     *     ramsey/uuid version 5.
+     *
      * @link https://tools.ietf.org/html/rfc4122#section-4.1.3 RFC 4122, § 4.1.3: Version
      */
     public const UUID_TYPE_DCE_SECURITY = 2;
@@ -137,6 +155,9 @@ class Uuid implements UuidInterface
     /**
      * Version 3 (name-based and hashed with MD5) UUID
      *
+     * @deprecated The Ramsey\Uuid\Version enum will replace this constant in
+     *     ramsey/uuid version 5.
+     *
      * @link https://tools.ietf.org/html/rfc4122#section-4.1.3 RFC 4122, § 4.1.3: Version
      */
     public const UUID_TYPE_HASH_MD5 = 3;
@@ -144,6 +165,9 @@ class Uuid implements UuidInterface
     /**
      * Version 4 (random) UUID
      *
+     * @deprecated The Ramsey\Uuid\Version enum will replace this constant in
+     *     ramsey/uuid version 5.
+     *
      * @link https://tools.ietf.org/html/rfc4122#section-4.1.3 RFC 4122, § 4.1.3: Version
      */
     public const UUID_TYPE_RANDOM = 4;
@@ -151,6 +175,9 @@ class Uuid implements UuidInterface
     /**
      * Version 5 (name-based and hashed with SHA1) UUID
      *
+     * @deprecated The Ramsey\Uuid\Version enum will replace this constant in
+     *     ramsey/uuid version 5.
+     *
      * @link https://tools.ietf.org/html/rfc4122#section-4.1.3 RFC 4122, § 4.1.3: Version
      */
     public const UUID_TYPE_HASH_SHA1 = 5;
@@ -161,6 +188,9 @@ class Uuid implements UuidInterface
      * This is named `UUID_TYPE_PEABODY`, since the specification is still in
      * draft form, and the primary author/editor's name is Brad Peabody.
      *
+     * @deprecated The Ramsey\Uuid\Version enum will replace this constant in
+     *     ramsey/uuid version 5.
+     *
      * @link https://github.com/uuid6/uuid6-ietf-draft UUID version 6 IETF draft
      * @link http://gh.peabody.io/uuidv6/ "Version 6" UUIDs
      */