Drop R2 prefix

Author: mickael-menu

CHANGELOG.md

@@ -4,23 +4,11 @@ All notable changes to this project will be documented in this file. Take a look
 
 **Warning:** Features marked as *alpha* may change or be removed in a future release without notice. Use with caution.
 
-<!-- ## [Unreleased] -->
-
-## [2.7.0]
-
-### Added
-
-#### Shared
-
-* You can now use `DefaultHTTPClientDelegate.httpClient(_:request:didReceive:completion:)` to handle authentication challenges (e.g. Basic) with `DefaultHTTPClient`.
-
-#### Navigator
-
-* The `AudioNavigator` API has been promoted to stable and ships with a new Preferences API.
-* The new `NavigatorDelegate.didFailToLoadResourceAt(_:didFailToLoadResourceAt:withError:)` delegate API notifies when an error occurs while loading a publication resource (contributed by [@ettore](https://github.com/readium/swift-toolkit/pull/400)).
+## [Unreleased]
 
 ### Changed
 
+* The `R2Shared`, `R2Streamer` and `R2Navigator` packages are now called `ReadiumShared`, `ReadiumStreamer` and `ReadiumNavigator`.
 * Many APIs now expect one of the new URL types (`RelativeURL`, `AbsoluteURL`, `HTTPURL` and `FileURL`). This is helpful because:
     * It validates at compile time that we provide a URL that is supported.
     * The API's capabilities are better documented, e.g. a download API could look like this : `download(url: HTTPURL) -> FileURL`. 
@@ -32,6 +20,20 @@ All notable changes to this project will be documented in this file. Take a look
 * Links are not resolved to the `self` URL of a manifest anymore. However, you can still normalize the HREFs yourselves by calling `Manifest.normalizeHREFsToSelf()`.
 * `Publication.localizedTitle` is now optional, as we cannot guarantee a publication will always have a title.
 
+
+## [2.7.0]
+
+### Added
+
+#### Shared
+
+* You can now use `DefaultHTTPClientDelegate.httpClient(_:request:didReceive:completion:)` to handle authentication challenges (e.g. Basic) with `DefaultHTTPClient`.
+
+#### Navigator
+
+* The `AudioNavigator` API has been promoted to stable and ships with a new Preferences API.
+* The new `NavigatorDelegate.didFailToLoadResourceAt(_:didFailToLoadResourceAt:withError:)` delegate API notifies when an error occurs while loading a publication resource (contributed by [@ettore](https://github.com/readium/swift-toolkit/pull/400)).
+
 ### Fixed
 
 * [#390](https://github.com/readium/swift-toolkit/issues/390) Fixed logger not logging above the minimum severity level (contributed by [@ettore](https://github.com/readium/swift-toolkit/pull/391)).

Documentation/Guides/Navigator Preferences.md

@@ -163,7 +163,7 @@ This stateless view displays the actual preferences for a fixed-layout publicati
 @ViewBuilder func fixedLayoutUserPreferences(
     commit: @escaping () -> Void,
     scroll: AnyPreference<Bool>? = nil,
-    fit: AnyEnumPreference<R2Navigator.Fit>? = nil,
+    fit: AnyEnumPreference<ReadiumNavigator.Fit>? = nil,
     pageSpacing: AnyRangePreference<Double>? = nil
 ) -> some View {
     if let scroll = scroll {

Documentation/Migration Guide.md

@@ -4,6 +4,24 @@ All migration steps necessary in reading apps to upgrade to major versions of th
 
 ## Unreleased
 
+### R2 prefix dropped
+
+The `R2` prefix is now deprecated. The `R2Shared`, `R2Streamer` and `R2Navigator` packages were renamed as `ReadiumShared`, `ReadiumStreamer` and `ReadiumNavigator`.
+
+You will need to update your imports, as well as the dependencies you include in your project:
+
+* Swift Package Manager: There's nothing to do.
+* Carthage:
+    * Update the Carthage dependencies and make sure the new `ReadiumShared.xcframework`, `ReadiumStreamer.xcframework` and `ReadiumNavigator.xcframework` were built.
+    * Replace the old frameworks with the new ones in your project.
+* CocoaPods:
+    * Update the `pod` statements in your `Podfile` with the following, before running `pod install`:
+        ```
+        pod 'ReadiumShared', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/3.0.0/Support/CocoaPods/ReadiumShared.podspec'
+        pod 'ReadiumStreamer', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/3.0.0/Support/CocoaPods/ReadiumStreamer.podspec'
+        pod 'ReadiumNavigator', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/3.0.0/Support/CocoaPods/ReadiumNavigator.podspec'
+        ```
+
 ### Migration of HREFs and Locators (bookmarks, annotations, etc.)
 
  :warning: This requires a database migration in your application, if you were persisting `Locator` objects.
@@ -105,7 +123,7 @@ Instead, the EPUB, PDF and CBZ navigators expect an instance of `HTTPServer` upo
 You can implement your own HTTP server using a third-party library. But the easiest way to migrate is to use the one provided in the new Readium package `ReadiumAdapterGCDWebServer`.
 
 ```swift
-import R2Navigator
+import ReadiumNavigator
 import ReadiumAdapterGCDWebServer
 
 let navigator = try EPUBNavigatorViewController(
@@ -216,15 +234,15 @@ Then, rebuild the libraries using `carthage update --platform ios --use-xcframew
 If you are using CocoaPods, you will need to update the URL to the Podspecs in your `Podfile`:
 
 ```diff
-+  pod 'R2Shared', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.2.0/Support/CocoaPods/ReadiumShared.podspec'
-+  pod 'R2Streamer', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.2.0/Support/CocoaPods/ReadiumStreamer.podspec'
-+  pod 'R2Navigator', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.2.0/Support/CocoaPods/ReadiumNavigator.podspec'
++  pod 'ReadiumShared', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.2.0/Support/CocoaPods/ReadiumShared.podspec'
++  pod 'ReadiumStreamer', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.2.0/Support/CocoaPods/ReadiumStreamer.podspec'
++  pod 'ReadiumNavigator', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.2.0/Support/CocoaPods/ReadiumNavigator.podspec'
 +  pod 'ReadiumOPDS', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.2.0/Support/CocoaPods/ReadiumOPDS.podspec'
 +  pod 'ReadiumLCP', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.2.0/Support/CocoaPods/ReadiumLCP.podspec'
 
--  pod 'R2Shared', podspec: 'https://raw.githubusercontent.com/readium/r2-shared-swift/2.2.0/R2Shared.podspec'
--  pod 'R2Streamer', podspec: 'https://raw.githubusercontent.com/readium/r2-streamer-swift/2.2.0/R2Streamer.podspec'
--  pod 'R2Navigator', podspec: 'https://raw.githubusercontent.com/readium/r2-navigator-swift/2.2.0/R2Navigator.podspec'
+-  pod 'ReadiumShared', podspec: 'https://raw.githubusercontent.com/readium/r2-shared-swift/2.2.0/ReadiumShared.podspec'
+-  pod 'ReadiumStreamer', podspec: 'https://raw.githubusercontent.com/readium/r2-streamer-swift/2.2.0/ReadiumStreamer.podspec'
+-  pod 'ReadiumNavigator', podspec: 'https://raw.githubusercontent.com/readium/r2-navigator-swift/2.2.0/ReadiumNavigator.podspec'
 -  pod 'ReadiumOPDS', podspec: 'https://raw.githubusercontent.com/readium/r2-opds-swift/2.2.0/ReadiumOPDS.podspec'
 -  pod 'ReadiumLCP', podspec: 'https://raw.githubusercontent.com/readium/r2-lcp-swift/2.2.0/ReadiumLCP.podspec'
 ```
@@ -324,7 +342,7 @@ Migrating a project to XCFrameworks is [explained on Carthage's repository](http
 
 #### Troubleshooting
 
-If after migrating to XCFrameworks you experience some build issues like **Could not find module 'R2Shared' for target 'X'**, try building the `r2-shared-swift` target with Xcode manually, before building your app. If you know of a better way to handle this, [please share it with the community](https://github.com/readium/r2-testapp-swift/issues/new).
+If after migrating to XCFrameworks you experience some build issues like **Could not find module 'ReadiumShared' for target 'X'**, try building the `r2-shared-swift` target with Xcode manually, before building your app. If you know of a better way to handle this, [please share it with the community](https://github.com/readium/r2-testapp-swift/issues/new).
 
 ### LCP
 

Makefile

@@ -32,7 +32,7 @@ update-scripts:
 
 .PHONY: test
 test:
-	# To limit to a particular test suite: -only-testing:R2SharedTests
+	# To limit to a particular test suite: -only-testing:ReadiumSharedTests
 	xcodebuild test -scheme "Readium-Package" -destination "platform=iOS Simulator,name=iPhone 15" | xcbeautify -q
 
 .PHONY: lint-format

Package.swift

@@ -12,9 +12,9 @@ let package = Package(
     defaultLocalization: "en",
     platforms: [.iOS(.v11)],
     products: [
-        .library(name: "R2Shared", targets: ["R2Shared"]),
-        .library(name: "R2Streamer", targets: ["R2Streamer"]),
-        .library(name: "R2Navigator", targets: ["R2Navigator"]),
+        .library(name: "ReadiumShared", targets: ["ReadiumShared"]),
+        .library(name: "ReadiumStreamer", targets: ["ReadiumStreamer"]),
+        .library(name: "ReadiumNavigator", targets: ["ReadiumNavigator"]),
         .library(name: "ReadiumOPDS", targets: ["ReadiumOPDS"]),
         .library(name: "ReadiumLCP", targets: ["ReadiumLCP"]),
 
@@ -37,7 +37,7 @@ let package = Package(
     ],
     targets: [
         .target(
-            name: "R2Shared",
+            name: "ReadiumShared",
             dependencies: ["ReadiumInternal", "Fuzi", "SwiftSoup", "Zip"],
             path: "Sources/Shared",
             exclude: [
@@ -53,42 +53,42 @@ let package = Package(
             ]
         ),
         .testTarget(
-            name: "R2SharedTests",
-            dependencies: ["R2Shared"],
+            name: "ReadiumSharedTests",
+            dependencies: ["ReadiumShared"],
             path: "Tests/SharedTests",
             resources: [
                 .copy("Fixtures"),
             ]
         ),
 
         .target(
-            name: "R2Streamer",
+            name: "ReadiumStreamer",
             dependencies: [
                 "CryptoSwift",
                 "Fuzi",
                 .product(name: "ReadiumGCDWebServer", package: "GCDWebServer"),
                 "Zip",
-                "R2Shared",
+                "ReadiumShared",
             ],
             path: "Sources/Streamer",
             resources: [
                 .copy("Assets"),
             ]
         ),
         .testTarget(
-            name: "R2StreamerTests",
-            dependencies: ["R2Streamer"],
+            name: "ReadiumStreamerTests",
+            dependencies: ["ReadiumStreamer"],
             path: "Tests/StreamerTests",
             resources: [
                 .copy("Fixtures"),
             ]
         ),
 
         .target(
-            name: "R2Navigator",
+            name: "ReadiumNavigator",
             dependencies: [
                 "ReadiumInternal",
-                "R2Shared",
+                "ReadiumShared",
                 "DifferenceKit",
                 "SwiftSoup",
             ],
@@ -102,16 +102,16 @@ let package = Package(
             ]
         ),
         .testTarget(
-            name: "R2NavigatorTests",
-            dependencies: ["R2Navigator"],
+            name: "ReadiumNavigatorTests",
+            dependencies: ["ReadiumNavigator"],
             path: "Tests/NavigatorTests"
         ),
 
         .target(
             name: "ReadiumOPDS",
             dependencies: [
                 "Fuzi",
-                "R2Shared",
+                "ReadiumShared",
             ],
             path: "Sources/OPDS"
         ),
@@ -129,7 +129,7 @@ let package = Package(
             dependencies: [
                 "CryptoSwift",
                 "ZIPFoundation",
-                "R2Shared",
+                "ReadiumShared",
                 .product(name: "SQLite", package: "SQLite.swift"),
             ],
             path: "Sources/LCP",
@@ -152,7 +152,7 @@ let package = Package(
             name: "ReadiumAdapterGCDWebServer",
             dependencies: [
                 .product(name: "ReadiumGCDWebServer", package: "GCDWebServer"),
-                "R2Shared",
+                "ReadiumShared",
             ],
             path: "Sources/Adapters/GCDWebServer"
         ),

README.md

@@ -4,9 +4,9 @@
 
 This toolkit is a modular project, which follows the [Readium Architecture](https://github.com/readium/architecture).
 
-* [`R2Shared`](Sources/Shared) – Shared `Publication` models and utilities
-* [`R2Streamer`](Sources/Streamer) – Publication parsers and local HTTP server
-* [`R2Navigator`](Sources/Navigator) – Plain `UIViewController` classes rendering publications
+* [`ReadiumShared`](Sources/Shared) – Shared `Publication` models and utilities
+* [`ReadiumStreamer`](Sources/Streamer) – Publication parsers and local HTTP server
+* [`ReadiumNavigator`](Sources/Navigator) – Plain `UIViewController` classes rendering publications
 * [`ReadiumOPDS`](Sources/OPDS) – Parsers for OPDS catalog feeds
 * [`ReadiumLCP`](Sources/LCP) – Service and models for [Readium LCP](https://www.edrlab.org/readium-lcp/)
 
@@ -53,9 +53,9 @@ Note that Carthage will build all Readium modules and their dependencies, but yo
 
 Refer to the following table to know which dependencies are required for each Readium library.
 
-|                       |     `R2Shared`     |    `R2Streamer`    |    `R2Navigator`   |    `ReadiumOPDS`   |    `ReadiumLCP`    |
+|                       |   `ReadiumShared`  |  `ReadiumStreamer` | `ReadiumNavigator` |    `ReadiumOPDS`   |    `ReadiumLCP`    |
 |-----------------------|:------------------:|:------------------:|:------------------:|:------------------:|:------------------:|
-| **`R2Shared`**        |                    | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
+| **`ReadiumShared`**   |                    | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
 | **`ReadiumInternal`** | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
 | `CryptoSwift`         |                    | :heavy_check_mark: |                    |                    | :heavy_check_mark: |
 | `DifferenceKit`       |                    |                    | :heavy_check_mark: |                    |                    |
@@ -71,14 +71,14 @@ Refer to the following table to know which dependencies are required for each Re
 Add the following `pod` statements to your `Podfile` for the Readium libraries you want to use:
 
 ```
-pod 'R2Shared', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.7.0/Support/CocoaPods/ReadiumShared.podspec'
-pod 'R2Streamer', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.7.0/Support/CocoaPods/ReadiumStreamer.podspec'
-pod 'R2Navigator', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.7.0/Support/CocoaPods/ReadiumNavigator.podspec'
+pod 'ReadiumShared', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.7.0/Support/CocoaPods/ReadiumShared.podspec'
+pod 'ReadiumStreamer', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.7.0/Support/CocoaPods/ReadiumStreamer.podspec'
+pod 'ReadiumNavigator', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.7.0/Support/CocoaPods/ReadiumNavigator.podspec'
 pod 'ReadiumOPDS', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.7.0/Support/CocoaPods/ReadiumOPDS.podspec'
 pod 'ReadiumLCP', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.7.0/Support/CocoaPods/ReadiumLCP.podspec'
 pod 'ReadiumInternal', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.7.0/Support/CocoaPods/ReadiumInternal.podspec'
 
-# Required if you use R2Streamer.
+# Required if you use ReadiumStreamer.
 pod 'ReadiumGCDWebServer', podspec: 'https://raw.githubusercontent.com/readium/GCDWebServer/4.0.0/GCDWebServer.podspec'
 ```
 

Sources/Adapters/GCDWebServer/GCDHTTPServer.swift

@@ -5,8 +5,8 @@
 //
 
 import Foundation
-import R2Shared
 import ReadiumGCDWebServer
+import ReadiumShared
 import UIKit
 
 public enum GCDHTTPServerError: Error {

Sources/Adapters/GCDWebServer/ResourceResponse.swift

@@ -5,8 +5,8 @@
 //
 
 import Foundation
-import R2Shared
 import ReadiumGCDWebServer
+import ReadiumShared
 
 /// Errors thrown by the `WebServerResourceResponse`
 ///

Sources/LCP/Authentications/LCPDialogAuthentication.swift

@@ -5,7 +5,7 @@
 //
 
 import Foundation
-import R2Shared
+import ReadiumShared
 import UIKit
 
 /// An `LCPAuthenticating` implementation presenting a dialog to the user.

Sources/LCP/Authentications/LCPDialogViewController.swift

@@ -68,9 +68,9 @@ final class LCPDialogViewController: UIViewController {
 
         switch reason {
         case .passphraseNotFound:
-            label.text = R2LCPLocalizedString("dialog.reason.passphraseNotFound")
+            label.text = ReadiumLCPLocalizedString("dialog.reason.passphraseNotFound")
         case .invalidPassphrase:
-            label.text = R2LCPLocalizedString("dialog.reason.invalidPassphrase")
+            label.text = ReadiumLCPLocalizedString("dialog.reason.invalidPassphrase")
             passphraseField.layer.borderWidth = 1
             passphraseField.layer.borderColor = UIColor.red.cgColor
         }
@@ -84,12 +84,12 @@ final class LCPDialogViewController: UIViewController {
         let leftItem = UIBarButtonItem(customView: label)
         navigationItem.leftBarButtonItem = leftItem
 
-        promptLabel.text = R2LCPLocalizedString("dialog.prompt.message1")
-        messageLabel.text = String(format: R2LCPLocalizedString("dialog.prompt.message2"), provider)
-        forgotPassphraseButton.setTitle(R2LCPLocalizedString("dialog.prompt.forgotPassphrase"), for: .normal)
-        supportButton.setTitle(R2LCPLocalizedString("dialog.prompt.support"), for: .normal)
-        continueButton.setTitle(R2LCPLocalizedString("dialog.prompt.continue"), for: .normal)
-        passphraseField.placeholder = R2LCPLocalizedString("dialog.prompt.passphrase")
+        promptLabel.text = ReadiumLCPLocalizedString("dialog.prompt.message1")
+        messageLabel.text = String(format: ReadiumLCPLocalizedString("dialog.prompt.message2"), provider)
+        forgotPassphraseButton.setTitle(ReadiumLCPLocalizedString("dialog.prompt.forgotPassphrase"), for: .normal)
+        supportButton.setTitle(ReadiumLCPLocalizedString("dialog.prompt.support"), for: .normal)
+        continueButton.setTitle(ReadiumLCPLocalizedString("dialog.prompt.continue"), for: .normal)
+        passphraseField.placeholder = ReadiumLCPLocalizedString("dialog.prompt.passphrase")
         hintLabel.text = license.hint
 
         navigationItem.rightBarButtonItem = UIBarButtonItem(
@@ -142,24 +142,24 @@ final class LCPDialogViewController: UIViewController {
                 if let scheme = url.scheme {
                     switch scheme {
                     case "http", "https":
-                        return R2LCPLocalizedString("dialog.support.website")
+                        return ReadiumLCPLocalizedString("dialog.support.website")
                     case "tel":
-                        return R2LCPLocalizedString("dialog.support.phone")
+                        return ReadiumLCPLocalizedString("dialog.support.phone")
                     case "mailto":
-                        return R2LCPLocalizedString("dialog.support.mail")
+                        return ReadiumLCPLocalizedString("dialog.support.mail")
                     default:
                         break
                     }
                 }
-                return R2LCPLocalizedString("dialog.support")
+                return ReadiumLCPLocalizedString("dialog.support")
             }()
 
             let action = UIAlertAction(title: title, style: .default) { _ in
                 open(url)
             }
             alert.addAction(action)
         }
-        alert.addAction(UIAlertAction(title: R2LCPLocalizedString("dialog.cancel"), style: .cancel))
+        alert.addAction(UIAlertAction(title: ReadiumLCPLocalizedString("dialog.cancel"), style: .cancel))
 
         if let popover = alert.popoverPresentationController, let sender = sender as? UIView {
             popover.sourceView = sender

Sources/LCP/Content Protection/LCPContentProtection.swift

@@ -5,7 +5,7 @@
 //
 
 import Foundation
-import R2Shared
+import ReadiumShared
 
 final class LCPContentProtection: ContentProtection, Loggable {
     private let service: LCPService