Add a NO_FOUNDATION_COMPAT build setting

karwa · Nov 4, 2021 · 78bdada · 78bdada
1 parent 2f864b6
commit 78bdada
Show file tree

Hide file tree

Showing 4 changed files with 73 additions and 39 deletions.
diff --git a/Package.swift b/Package.swift
@@ -16,6 +16,24 @@
 
 import PackageDescription
 
+// This package recognizes the conditional compilation flags listed below.
+// To use enable them, uncomment the corresponding lines or define them
+// from the package manager command line:
+//
+//     swift build -Xswiftc -DNO_FOUNDATION_COMPAT
+var settings: [SwiftSetting]? = [
+
+  // Do not depend on Foundation.
+  //
+  // This removes:
+  // - UUID <-> UniqueID conversion APIs.
+  // - UUID timestamps as 'Date' (but Date will soon join the standard library).
+  //.define("NO_FOUNDATION_COMPAT"),
+
+]
+
+if settings?.isEmpty == true { settings = nil }
+
 let package = Package(
     name: "UniqueID",
     products: [
@@ -25,7 +43,13 @@ let package = Package(
       .package(name: "swift-atomics", url: "https://github.com/apple/swift-atomics", .upToNextMajor(from: "1.0.0"))
     ],
     targets: [
-      .target(name: "UniqueID", dependencies: [.product(name: "Atomics", package: "swift-atomics")]),
-      .testTarget(name: "UniqueIDTests", dependencies: ["UniqueID"]),
+      .target(
+        name: "UniqueID",
+        dependencies: [.product(name: "Atomics", package: "swift-atomics")],
+        swiftSettings: settings),
+      .testTarget(
+        name: "UniqueIDTests",
+        dependencies: ["UniqueID"],
+        swiftSettings: settings),
     ]
 )
diff --git a/Sources/UniqueID/Foundation+UniqueID.swift b/Sources/UniqueID/Foundation+UniqueID.swift
@@ -12,37 +12,41 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import Foundation
+#if !NO_FOUNDATION_COMPAT
 
-extension UUID {
+  import Foundation
 
-  /// Losslessly convert a `UniqueID` to a Foundation `UUID`.
-  ///
-  @inlinable
-  public init(_ uniqueID: UniqueID) {
-    self.init(uuid: uniqueID.bytes)
+  extension UUID {
+
+    /// Losslessly convert a `UniqueID` to a Foundation `UUID`.
+    ///
+    @inlinable
+    public init(_ uniqueID: UniqueID) {
+      self.init(uuid: uniqueID.bytes)
+    }
   }
-}
 
-extension UniqueID {
+  extension UniqueID {
 
-  /// Losslessly convert a Foundation `UUID` to a `UniqueID`.
-  ///
-  @inlinable
-  public init(_ uuid: Foundation.UUID) {
-    self.init(bytes: uuid.uuid)
+    /// Losslessly convert a Foundation `UUID` to a `UniqueID`.
+    ///
+    @inlinable
+    public init(_ uuid: Foundation.UUID) {
+      self.init(bytes: uuid.uuid)
+    }
   }
-}
 
-// Note: 'Date' will move in to the standard library and increase precision to capture this timestamp exactly.
-// https://forums.swift.org/t/pitch-clock-instant-date-and-duration/52451
+  // Note: 'Date' will move in to the standard library and increase precision to capture this timestamp exactly.
+  // https://forums.swift.org/t/pitch-clock-instant-date-and-duration/52451
 
-extension UniqueID.TimeOrdered {
+  extension UniqueID.TimeOrdered {
 
-  /// The timestamp of the UUID. Note that this has at most 100ns precision.
-  ///
-  @inlinable
-  public var timestamp: Date {
-    Date(timeIntervalSince1970: TimeInterval(_uuid_timestamp_to_unix(timestamp: rawTimestamp)) / 10_000_000)
+    /// The timestamp of the UUID. Note that this has at most 100ns precision.
+    ///
+    @inlinable
+    public var timestamp: Date {
+      Date(timeIntervalSince1970: TimeInterval(_uuid_timestamp_to_unix(timestamp: rawTimestamp)) / 10_000_000)
+    }
   }
-}
+
+#endif  // NO_FOUNDATION_COMPAT
diff --git a/Tests/UniqueIDTests/UUIDv6Tests.swift b/Tests/UniqueIDTests/UUIDv6Tests.swift
@@ -94,9 +94,11 @@ extension UUIDv6Tests {
         XCTFail("Not a valid UUIDv6")
         continue
       }
-      XCTAssertGreaterThan(components.timestamp, beforeCreate)
+      #if !NO_FOUNDATION_COMPAT
+        XCTAssertGreaterThan(components.timestamp, beforeCreate)
+        XCTAssertLessThan(components.timestamp, afterCreate)
+      #endif  // NO_FOUNDATION_COMPAT
       XCTAssertGreaterThan(components.rawTimestamp, beforeCreateRaw)
-      XCTAssertLessThan(components.timestamp, afterCreate)
       XCTAssertLessThan(components.rawTimestamp, afterCreateRaw)
     }
   }

diff --git a/Tests/UniqueIDTests/UniqueIDTests.swift b/Tests/UniqueIDTests/UniqueIDTests.swift
@@ -291,18 +291,22 @@ extension UniqueIDTests {
 
 extension UniqueIDTests {
 
-  func testFoundationCompat() {
-    do {
-      let uuid: UUID = UUID(.timeOrdered())
-      let uniqueID: UniqueID = UniqueID(uuid)
-      XCTAssertEqual(uniqueID.description, uuid.description)
-    }
-    do {
-      let uuid = UUID()
-      let uniqueID = UniqueID(uuid)
-      XCTAssertEqual(uniqueID.description, uuid.description)
+  #if !NO_FOUNDATION_COMPAT
+
+    func testFoundationCompat() {
+      do {
+        let uuid: UUID = UUID(.timeOrdered())
+        let uniqueID: UniqueID = UniqueID(uuid)
+        XCTAssertEqual(uniqueID.description, uuid.description)
+      }
+      do {
+        let uuid = UUID()
+        let uniqueID = UniqueID(uuid)
+        XCTAssertEqual(uniqueID.description, uuid.description)
+      }
     }
-  }
+
+  #endif  // NO_FOUNDATION_COMPAT
 
   func testParseHexTable() {
     XCTAssertEqual(_parseHex_table.count, Int(UInt8.max))