Deprecate the Presentation Hints from the RWPM models (#631)

Author: mickael-menu

CHANGELOG.md

@@ -10,6 +10,12 @@ All notable changes to this project will be documented in this file. Take a look
 
 * You can now access the `viewport` property of an `EPUBNavigatorViewController` to obtain information about the visible portion of the publication, including the visible positions and reading order indices.
 
+### Deprecated
+
+#### Shared
+
+* The Presentation Hints properties are deprecated from the Readium Web Publication Manifest models. [See the official documentation](https://readium.org/webpub-manifest/profiles/epub.html#appendix-b---deprecated-properties).
+
 ### Fixed
 
 #### Navigator

Sources/Navigator/EPUB/EPUBNavigatorViewController.swift

@@ -1202,7 +1202,7 @@ extension EPUBNavigatorViewController: EditingActionsControllerDelegate {
 extension EPUBNavigatorViewController: PaginationViewDelegate {
     func paginationView(_ paginationView: PaginationView, pageViewAtIndex index: Int) -> (UIView & PageView)? {
         let spread = spreads[index]
-        let spreadViewType = (spread.layout == .fixed) ? EPUBFixedSpreadView.self : EPUBReflowableSpreadView.self
+        let spreadViewType = (publication.metadata.layout == .fixed) ? EPUBFixedSpreadView.self : EPUBReflowableSpreadView.self
         let spreadView = spreadViewType.init(
             viewModel: viewModel,
             spread: spread,

Sources/Navigator/EPUB/EPUBNavigatorViewModel.swift

@@ -288,7 +288,7 @@ final class EPUBNavigatorViewModel: Loggable {
         guard
             let link = publication.linkWithHREF(href),
             link.mediaType?.isHTML == true,
-            publication.metadata.presentation.layout(of: link) == .reflowable
+            publication.metadata.layout == .reflowable
         else {
             return resource
         }

Sources/Navigator/EPUB/EPUBSpread.swift

@@ -23,17 +23,13 @@ struct EPUBSpread: Loggable {
     /// Spread reading progression direction.
     var readingProgression: ReadingProgression
 
-    /// Rendition layout of the links in the spread.
-    var layout: EPUBLayout
-
-    init(spread: Bool, readingOrderIndices: ReadingOrderIndices, readingProgression: ReadingProgression, layout: EPUBLayout) {
+    init(spread: Bool, readingOrderIndices: ReadingOrderIndices, readingProgression: ReadingProgression) {
         precondition(!readingOrderIndices.isEmpty, "A spread must have at least one page")
         precondition(spread || readingOrderIndices.count == 1, "A one-page spread must have only one page")
         precondition(!spread || 1 ... 2 ~= readingOrderIndices.count, "A two-pages spread must have one or two pages max")
         self.spread = spread
         self.readingOrderIndices = readingOrderIndices
         self.readingProgression = readingProgression
-        self.layout = layout
     }
 
     /// Returns the left-most reading order index in the spread.
@@ -83,7 +79,7 @@ struct EPUBSpread: Loggable {
     ///   - url: Full URL to the resource.
     ///   - page [left|center|right]: (optional) Page position of the linked resource in the spread.
     func json(forBaseURL baseURL: HTTPURL, readingOrder: ReadingOrder) -> [[String: Any]] {
-        func makeLinkJSON(_ index: ReadingOrder.Index, page: Presentation.Page? = nil) -> [String: Any]? {
+        func makeLinkJSON(_ index: ReadingOrder.Index, page: Properties.Page? = nil) -> [String: Any]? {
             guard let link = readingOrder.getOrNil(index) else {
                 return nil
             }
@@ -136,12 +132,11 @@ struct EPUBSpread: Loggable {
         readingOrder: [Link],
         readingProgression: ReadingProgression
     ) -> [EPUBSpread] {
-        readingOrder.enumerated().map { index, link in
+        readingOrder.enumerated().map { index, _ in
             EPUBSpread(
                 spread: false,
                 readingOrderIndices: index ... index,
-                readingProgression: readingProgression,
-                layout: publication.metadata.presentation.layout(of: link)
+                readingProgression: readingProgression
             )
         }
     }
@@ -157,22 +152,20 @@ struct EPUBSpread: Loggable {
         var index = 0
         while index < readingOrder.count {
             let first = readingOrder[index]
-            let layout = publication.metadata.presentation.layout(of: first)
 
             var spread = EPUBSpread(
                 spread: true,
                 readingOrderIndices: index ... index,
-                readingProgression: readingProgression,
-                layout: layout
+                readingProgression: readingProgression
             )
 
             let nextIndex = index + 1
-            // To be displayed together, the two pages must have a fixed layout,
-            // and have consecutive position hints (Properties.Page).
+            // To be displayed together, two pages must be part of a fixed
+            // layout publication and have consecutive position hints
+            // (Properties.Page).
             if
                 let second = readingOrder.getOrNil(nextIndex),
-                layout == .fixed,
-                layout == publication.metadata.presentation.layout(of: second),
+                publication.metadata.layout == .fixed,
                 publication.areConsecutive(first, second, index: index)
             {
                 spread.readingOrderIndices = index ... nextIndex

Sources/Navigator/EPUB/Preferences/EPUBPreferencesEditor.swift

@@ -21,7 +21,12 @@ public final class EPUBPreferencesEditor: StatefulPreferencesEditor<EPUBPreferen
         metadata: Metadata,
         defaults: EPUBDefaults
     ) {
-        layout = metadata.presentation.layout ?? .reflowable
+        switch metadata.layout {
+        case .fixed:
+            layout = .fixed
+        default:
+            layout = .reflowable
+        }
         self.defaults = defaults
 
         super.init(

Sources/Navigator/EPUB/Preferences/EPUBSettings.swift

@@ -169,7 +169,6 @@ public struct EPUBSettings: ConfigurableSettings {
             readingProgression: readingProgression,
             scroll: scroll,
             spread: preferences.spread
-                ?? Spread(metadata.presentation.spread)
                 ?? defaults.spread
                 ?? .auto,
             textAlign: preferences.textAlign

Sources/Navigator/Preferences/Types.swift

@@ -23,20 +23,6 @@ public enum Spread: String, Codable, Hashable {
     case never
     /// The publication should always be displayed in a spread.
     case always
-
-    init?(_ spread: ReadiumShared.Presentation.Spread?) {
-        guard let spread = spread else {
-            return nil
-        }
-        switch spread {
-        case .both:
-            self = .always
-        case .none:
-            self = .never
-        case .auto, .landscape:
-            self = .auto
-        }
-    }
 }
 
 /// Direction of the reading progression across resources.
@@ -53,7 +39,7 @@ public enum ReadingProgression: String, Codable, Hashable {
     }
 
     /// Returns the starting page for the reading progression.
-    var startingPage: Presentation.Page {
+    var startingPage: Properties.Page {
         switch self {
         case .ltr:
             return .right

Sources/Shared/Publication/Accessibility/AccessibilityMetadataDisplayGuide.swift

@@ -206,7 +206,7 @@ public struct AccessibilityMetadataDisplayGuide: Sendable, Equatable {
         }
 
         public init(publication: Publication) {
-            let isFixedLayout = publication.metadata.presentation.layout == .fixed
+            let isFixedLayout = publication.metadata.layout == .fixed
             let a11y = publication.metadata.accessibility ?? Accessibility()
 
             visualAdjustments = {

Sources/Shared/Publication/Extensions/EPUB/Properties+EPUB.swift

@@ -23,6 +23,7 @@ public extension Properties {
     }
 
     /// Hint about the nature of the layout for the linked resources.
+    @available(*, unavailable, message: "This was removed from RWPM. You can still use the EPUB extensibility to access the original value.")
     var layout: EPUBLayout? {
         parseRaw(otherProperties["layout"])
     }

Sources/Shared/Publication/Extensions/Presentation/Metadata+Presentation.swift

@@ -8,7 +8,6 @@ import Foundation
 
 /// Presentation extensions for `Metadata`.
 public extension Metadata {
-    var presentation: Presentation {
-        (try? Presentation(json: otherMetadata["presentation"], warnings: self)) ?? Presentation()
-    }
+    @available(*, unavailable, message: "This was removed from RWPM. You can still use the EPUB extensibility to access the original values.")
+    var presentation: Presentation { fatalError() }
 }