Remove relativeURL and absoluteURL helpers on URLConvertible (#561)

mickael-menu · web-flow · commit b1698b517aa4 · 2025-03-17T13:02:09.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,8 +6,19 @@ All notable changes to this project will be documented in this file. Take a look
 
 ## [Unreleased]
 
+### Added
+
+#### LCP
+
+* Support for streaming an LCP-protected publication from its License Document (LCPL). [Take a look at the LCP guide for more information](docs/Guides/Readium%20LCP.md#streaming-an-lcp-protected-package).
+
 ### Changed
 
+#### Shared
+
+* The `absoluteURL` and `relativeURL` extensions on `URLConvertible` were removed as they conflict with the native `URL.absoluteURL`.
+    * If you were using them, you can for example still use `anyURL.absoluteURL` instead.
+
 #### Streamer
 
 * A `self` link is not required anymore when parsing a RWPM.
@@ -21,10 +32,6 @@ All notable changes to this project will be documented in this file. Take a look
 
 * Support for streaming ZIP packages over HTTP. This lets you open a remote EPUB, audiobook, or any other ZIP-based publication without needing to download it first.
 
-#### LCP
-
-* Support for streaming an LCP-protected publication from its License Document (LCPL). [Take a look at the LCP guide for more information](docs/Guides/Readium%20LCP.md#streaming-an-lcp-protected-package).
-
 ### Deprecated
 
 * The `close()` and `Closeable` APIs are now deprecated. Resources are automatically released upon `deinit`, which aligns better with Swift.
diff --git a/Sources/Navigator/Audiobook/PublicationMediaLoader.swift b/Sources/Navigator/Audiobook/PublicationMediaLoader.swift
@@ -193,7 +193,7 @@ private let schemePrefix = "readium"
 
 extension URL {
     var audioHREF: AnyURL? {
-        guard let url = absoluteURL, url.scheme.rawValue.hasPrefix(schemePrefix) == true else {
+        guard let url = anyURL.absoluteURL, url.scheme.rawValue.hasPrefix(schemePrefix) == true else {
             return nil
         }
 
diff --git a/Sources/Shared/Toolkit/File/FileContainer.swift b/Sources/Shared/Toolkit/File/FileContainer.swift
@@ -26,7 +26,7 @@ public final class FileContainer: Container, Loggable {
 
     public subscript(url: any URLConvertible) -> Resource? {
         guard
-            let url = url.relativeURL?.normalized,
+            let url = url.anyURL.relativeURL?.normalized,
             let file = files[url]
         else {
             return nil
diff --git a/Sources/Shared/Toolkit/URL/Absolute URL/AbsoluteURL.swift b/Sources/Shared/Toolkit/URL/Absolute URL/AbsoluteURL.swift
@@ -59,7 +59,7 @@ public extension AbsoluteURL {
     ///     returns bar/baz
     func relativize<T: URLConvertible>(_ other: T) -> RelativeURL? {
         guard
-            let absoluteURL = other.absoluteURL,
+            let absoluteURL = other.anyURL.absoluteURL,
             scheme == absoluteURL.scheme,
             origin == absoluteURL.origin
         else {
@@ -75,16 +75,14 @@ public extension AbsoluteURL {
 
     /// Indicates whether the receiver is relative to the given `base` URL.
     func isRelative<T: URLConvertible>(to base: T) -> Bool {
-        base.absoluteURL?.scheme == scheme
-            && base.absoluteURL?.origin == origin
+        base.anyURL.absoluteURL?.scheme == scheme
+            && base.anyURL.absoluteURL?.origin == origin
     }
 }
 
 /// Implements ``URLConvertible``.
 public extension AbsoluteURL {
     var anyURL: AnyURL { .absolute(self) }
-    var relativeURL: RelativeURL? { nil }
-    var absoluteURL: AbsoluteURL? { self }
 }
 
 /// A URL scheme, e.g. http or file.
diff --git a/Sources/Shared/Toolkit/URL/Absolute URL/FileURL.swift b/Sources/Shared/Toolkit/URL/Absolute URL/FileURL.swift
@@ -79,6 +79,6 @@ public struct FileURL: AbsoluteURL, Hashable, Sendable {
 public extension URLConvertible {
     /// Returns a `FileURL` if the URL has a `file` scheme.
     var fileURL: FileURL? {
-        (absoluteURL as? FileURL) ?? FileURL(url: anyURL.url)
+        (anyURL.absoluteURL as? FileURL) ?? FileURL(url: anyURL.url)
     }
 }
diff --git a/Sources/Shared/Toolkit/URL/Absolute URL/HTTPURL.swift b/Sources/Shared/Toolkit/URL/Absolute URL/HTTPURL.swift
@@ -51,6 +51,6 @@ public struct HTTPURL: AbsoluteURL, Hashable, Sendable {
 public extension URLConvertible {
     /// Returns an `HTTPURL` if the URL has an `http` or `https` scheme.
     var httpURL: HTTPURL? {
-        (absoluteURL as? HTTPURL) ?? HTTPURL(url: anyURL.url)
+        (anyURL.absoluteURL as? HTTPURL) ?? HTTPURL(url: anyURL.url)
     }
 }
diff --git a/Sources/Shared/Toolkit/URL/AnyURL.swift b/Sources/Shared/Toolkit/URL/AnyURL.swift
@@ -58,6 +58,22 @@ public enum AnyURL: URLProtocol {
         }
     }
 
+    /// Returns the wrapped ``RelativeURL``, if this URL is relative.
+    public var relativeURL: RelativeURL? {
+        guard case let .relative(url) = self else {
+            return nil
+        }
+        return url
+    }
+
+    /// Returns the wrapped ``AbsoluteURL``, if this URL is absolute.
+    public var absoluteURL: AbsoluteURL? {
+        guard case let .absolute(url) = self else {
+            return nil
+        }
+        return url
+    }
+
     private var wrapped: URLProtocol {
         switch self {
         case let .absolute(url):
@@ -104,20 +120,6 @@ public enum AnyURL: URLProtocol {
 /// Implements `URLConvertible`.
 extension AnyURL: URLConvertible {
     public var anyURL: AnyURL { self }
-
-    public var relativeURL: RelativeURL? {
-        guard case let .relative(url) = self else {
-            return nil
-        }
-        return url
-    }
-
-    public var absoluteURL: AbsoluteURL? {
-        guard case let .absolute(url) = self else {
-            return nil
-        }
-        return url
-    }
 }
 
 /// Implements `Hashable` and `Equatable`.
diff --git a/Sources/Shared/Toolkit/URL/RelativeURL.swift b/Sources/Shared/Toolkit/URL/RelativeURL.swift
@@ -35,7 +35,7 @@ public struct RelativeURL: URLProtocol, Hashable {
     ///     returns foo/baz
     public func resolve<T: URLConvertible>(_ other: T) -> AnyURL? {
         // other is absolute?
-        guard let relativeURL = other.relativeURL else {
+        guard let relativeURL = other.anyURL.relativeURL else {
             return other.anyURL
         }
         return resolve(relativeURL)?.anyURL
@@ -84,7 +84,7 @@ public struct RelativeURL: URLProtocol, Hashable {
     ///     returns baz
     public func relativize<T: URLConvertible>(_ other: T) -> RelativeURL? {
         guard
-            let relativeURL = other.relativeURL,
+            let relativeURL = other.anyURL.relativeURL,
             relativeURL.string.hasPrefix(string)
         else {
             return nil
@@ -112,8 +112,6 @@ public struct RelativeURL: URLProtocol, Hashable {
 /// Implements `URLConvertible`.
 extension RelativeURL: URLConvertible {
     public var anyURL: AnyURL { .relative(self) }
-    public var relativeURL: RelativeURL? { self }
-    public var absoluteURL: AbsoluteURL? { nil }
 }
 
 public extension RelativeURL {
diff --git a/Sources/Shared/Toolkit/URL/URLConvertible.swift b/Sources/Shared/Toolkit/URL/URLConvertible.swift
@@ -10,19 +10,6 @@ import Foundation
 public protocol URLConvertible {
     /// Converts the receiver to an ``AnyURL``.
     var anyURL: AnyURL { get }
-
-    /// Converts the receiver to a ``RelativeURL``, if the represented URL is
-    /// relative.
-    var relativeURL: RelativeURL? { get }
-
-    /// Converts the receiver to an ``AnyAbsoluteURL``, if the represented URL
-    /// is absolute.
-    var absoluteURL: AbsoluteURL? { get }
-}
-
-public extension URLConvertible {
-    var relativeURL: RelativeURL? { anyURL.relativeURL }
-    var absoluteURL: AbsoluteURL? { anyURL.absoluteURL }
 }
 
 extension URL: URLConvertible {
diff --git a/Sources/Shared/Toolkit/ZIP/Minizip/MinizipContainer.swift b/Sources/Shared/Toolkit/ZIP/Minizip/MinizipContainer.swift
@@ -60,7 +60,7 @@ final class MinizipContainer: Container, Loggable {
 
     subscript(url: any URLConvertible) -> (any Resource)? {
         guard
-            let url = url.relativeURL?.normalized,
+            let url = url.anyURL.relativeURL?.normalized,
             let metadata = entriesMetadata[url]
         else {
             return nil
diff --git a/Sources/Shared/Toolkit/ZIP/ZIPFoundation/ZIPFoundationContainer.swift b/Sources/Shared/Toolkit/ZIP/ZIPFoundation/ZIPFoundationContainer.swift
@@ -60,7 +60,7 @@ final class ZIPFoundationContainer: Container, Loggable {
 
     subscript(url: any URLConvertible) -> (any Resource)? {
         guard
-            let url = url.relativeURL?.normalized,
+            let url = url.anyURL.relativeURL?.normalized,
             let entry = entriesByPath[url]
         else {
             return nil
diff --git a/TestApp/Integrations/Local/TestApp.xctestplan b/TestApp/Integrations/Local/TestApp.xctestplan
@@ -20,36 +20,36 @@
     {
       "target" : {
         "containerPath" : "container:..",
-        "identifier" : "R2NavigatorTests",
-        "name" : "R2NavigatorTests"
+        "identifier" : "ReadiumInternalTests",
+        "name" : "ReadiumInternalTests"
       }
     },
     {
       "target" : {
         "containerPath" : "container:..",
-        "identifier" : "R2SharedTests",
-        "name" : "R2SharedTests"
+        "identifier" : "ReadiumOPDSTests",
+        "name" : "ReadiumOPDSTests"
       }
     },
     {
       "target" : {
         "containerPath" : "container:..",
-        "identifier" : "R2StreamerTests",
-        "name" : "R2StreamerTests"
+        "identifier" : "ReadiumNavigatorTests",
+        "name" : "ReadiumNavigatorTests"
       }
     },
     {
       "target" : {
         "containerPath" : "container:..",
-        "identifier" : "ReadiumInternalTests",
-        "name" : "ReadiumInternalTests"
+        "identifier" : "ReadiumSharedTests",
+        "name" : "ReadiumSharedTests"
       }
     },
     {
       "target" : {
         "containerPath" : "container:..",
-        "identifier" : "ReadiumOPDSTests",
-        "name" : "ReadiumOPDSTests"
+        "identifier" : "ReadiumStreamerTests",
+        "name" : "ReadiumStreamerTests"
       }
     }
   ],
diff --git a/TestApp/Sources/AppDelegate.swift b/TestApp/Sources/AppDelegate.swift
@@ -53,7 +53,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
     }
 
     func application(_ application: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey: Any] = [:]) -> Bool {
-        guard let url = url.absoluteURL, let vc = window?.rootViewController else {
+        guard let url = url.anyURL.absoluteURL, let vc = window?.rootViewController else {
             return false
         }
 
diff --git a/TestApp/Sources/Library/LibraryService.swift b/TestApp/Sources/Library/LibraryService.swift
@@ -81,7 +81,7 @@ final class LibraryService: Loggable {
     /// Imports a bunch of publications.
     func importPublications(from sourceURLs: [URL], sender: UIViewController) async throws {
         for url in sourceURLs {
-            guard let url = url.absoluteURL else {
+            guard let url = url.anyURL.absoluteURL else {
                 continue
             }
             try await importPublication(from: url, sender: sender, progress: { _ in })

Original file line number	Diff line number	Diff line change
`@@ -193,7 +193,7 @@ private let schemePrefix = "readium"`
`193`	`193`
`194`	`194`	`extension URL {`
`195`	`195`	`var audioHREF: AnyURL? {`
`196`		`- guard let url = absoluteURL, url.scheme.rawValue.hasPrefix(schemePrefix) == true else {`
	`196`	`+ guard let url = anyURL.absoluteURL, url.scheme.rawValue.hasPrefix(schemePrefix) == true else {`
`197`	`197`	`return nil`
`198`	`198`	`}`
`199`	`199`
Original file line number	Diff line number	Diff line change
`@@ -79,6 +79,6 @@ public struct FileURL: AbsoluteURL, Hashable, Sendable {`
`79`	`79`	`public extension URLConvertible {`
`80`	`80`	/// Returns a `FileURL` if the URL has a `file` scheme.
`81`	`81`	`var fileURL: FileURL? {`
`82`		`- (absoluteURL as? FileURL) ?? FileURL(url: anyURL.url)`
	`82`	`+ (anyURL.absoluteURL as? FileURL) ?? FileURL(url: anyURL.url)`
`83`	`83`	`}`
`84`	`84`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,6 @@ public struct HTTPURL: AbsoluteURL, Hashable, Sendable {`
`51`	`51`	`public extension URLConvertible {`
`52`	`52`	/// Returns an `HTTPURL` if the URL has an `http` or `https` scheme.
`53`	`53`	`var httpURL: HTTPURL? {`
`54`		`- (absoluteURL as? HTTPURL) ?? HTTPURL(url: anyURL.url)`
	`54`	`+ (anyURL.absoluteURL as? HTTPURL) ?? HTTPURL(url: anyURL.url)`
`55`	`55`	`}`
`56`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,36 +20,36 @@`
`20`	`20`	`{`
`21`	`21`	`"target" : {`
`22`	`22`	`"containerPath" : "container:..",`
`23`		`- "identifier" : "R2NavigatorTests",`
`24`		`- "name" : "R2NavigatorTests"`
	`23`	`+ "identifier" : "ReadiumInternalTests",`
	`24`	`+ "name" : "ReadiumInternalTests"`
`25`	`25`	`}`
`26`	`26`	`},`
`27`	`27`	`{`
`28`	`28`	`"target" : {`
`29`	`29`	`"containerPath" : "container:..",`
`30`		`- "identifier" : "R2SharedTests",`
`31`		`- "name" : "R2SharedTests"`
	`30`	`+ "identifier" : "ReadiumOPDSTests",`
	`31`	`+ "name" : "ReadiumOPDSTests"`
`32`	`32`	`}`
`33`	`33`	`},`
`34`	`34`	`{`
`35`	`35`	`"target" : {`
`36`	`36`	`"containerPath" : "container:..",`
`37`		`- "identifier" : "R2StreamerTests",`
`38`		`- "name" : "R2StreamerTests"`
	`37`	`+ "identifier" : "ReadiumNavigatorTests",`
	`38`	`+ "name" : "ReadiumNavigatorTests"`
`39`	`39`	`}`
`40`	`40`	`},`
`41`	`41`	`{`
`42`	`42`	`"target" : {`
`43`	`43`	`"containerPath" : "container:..",`
`44`		`- "identifier" : "ReadiumInternalTests",`
`45`		`- "name" : "ReadiumInternalTests"`
	`44`	`+ "identifier" : "ReadiumSharedTests",`
	`45`	`+ "name" : "ReadiumSharedTests"`
`46`	`46`	`}`
`47`	`47`	`},`
`48`	`48`	`{`
`49`	`49`	`"target" : {`
`50`	`50`	`"containerPath" : "container:..",`
`51`		`- "identifier" : "ReadiumOPDSTests",`
`52`		`- "name" : "ReadiumOPDSTests"`
	`51`	`+ "identifier" : "ReadiumStreamerTests",`
	`52`	`+ "name" : "ReadiumStreamerTests"`
`53`	`53`	`}`
`54`	`54`	`}`
`55`	`55`	`],`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`func application(_ application: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey: Any] = [:]) -> Bool {`
`56`		`- guard let url = url.absoluteURL, let vc = window?.rootViewController else {`
	`56`	`+ guard let url = url.anyURL.absoluteURL, let vc = window?.rootViewController else {`
`57`	`57`	`return false`
`58`	`58`	`}`
`59`	`59`
Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ final class LibraryService: Loggable {`
`81`	`81`	`/// Imports a bunch of publications.`
`82`	`82`	`func importPublications(from sourceURLs: [URL], sender: UIViewController) async throws {`
`83`	`83`	`for url in sourceURLs {`
`84`		`- guard let url = url.absoluteURL else {`
	`84`	`+ guard let url = url.anyURL.absoluteURL else {`
`85`	`85`	`continue`
`86`	`86`	`}`
`87`	`87`	`try await importPublication(from: url, sender: sender, progress: { _ in })`