Merge pull request #88 from readium/fixes/publication-models

Refactoring Publication models + XmlParser rewrite with namespaces handling

Author: mickael-menu

r2-shared/build.gradle

@@ -50,9 +50,15 @@ dependencies {
     implementation 'nl.komponents.kovenant:kovenant-jvm:3.3.0'
     implementation 'nl.komponents.kovenant:kovenant-functional:3.3.0'
     implementation 'joda-time:joda-time:2.9.9'
+
+    testImplementation "org.jetbrains.kotlin:kotlin-test-junit:$kotlin_version"
     testImplementation 'junit:junit:4.12'
+    testImplementation 'org.assertj:assertj-core:3.14.0'
     testImplementation 'org.mockito:mockito-core:2.19.0'
+    testImplementation 'xmlpull:xmlpull:1.1.3.1'
+    testImplementation 'net.sf.kxml:kxml2:2.3.0'
+    testImplementation 'org.json:json:20190722'
+    
     androidTestImplementation 'androidx.test:runner:1.2.0'
     androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'
-    testImplementation "org.jetbrains.kotlin:kotlin-test-junit:$kotlin_version"
 }

r2-shared/src/main/java/org/readium/r2/shared/Collection.kt

@@ -0,0 +1,92 @@
+/*
+ * Module: r2-shared-kotlin
+ * Developers: Mickaël Menu
+ *
+ * Copyright (c) 2020. Readium Foundation. All rights reserved.
+ * Use of this source code is governed by a BSD-style license which is detailed in the
+ * LICENSE file present in the project repository where this source code is maintained.
+ */
+
+@file:Suppress("RemoveRedundantQualifierName")
+
+package org.readium.r2.shared
+
+import org.json.JSONObject
+import org.readium.r2.shared.extensions.removeLastComponent
+import org.readium.r2.shared.publication.Collection
+import org.readium.r2.shared.publication.Contributor
+import org.readium.r2.shared.publication.Link
+import org.readium.r2.shared.publication.Metadata
+import org.readium.r2.shared.publication.Properties
+import org.readium.r2.shared.publication.Subject
+import org.readium.r2.shared.publication.encryption.Encryption
+import org.readium.r2.shared.publication.presentation.Presentation
+import java.net.URL
+
+
+@Deprecated("Refactored into [LocalizedString]", ReplaceWith("org.readium.r2.shared.publication.LocalizedString"))
+typealias MultilanguageString = org.readium.r2.shared.publication.LocalizedString
+
+@Deprecated("Renamed into [ContentLayout]", ReplaceWith("org.readium.r2.shared.publication.ContentLayout"))
+typealias ContentLayoutStyle = org.readium.r2.shared.publication.ContentLayout
+
+@Deprecated("Renamed into [ReadingProgression]", ReplaceWith("org.readium.r2.shared.publication.ReadingProgression"))
+typealias PageProgressionDirection = org.readium.r2.shared.publication.ReadingProgression
+
+@Deprecated("Moved to another package", ReplaceWith("org.readium.r2.shared.publication.Publication"))
+typealias Publication = org.readium.r2.shared.publication.Publication
+
+@Deprecated("Moved to another package", ReplaceWith("org.readium.r2.shared.publication.Link"))
+typealias Link = Link
+
+@Deprecated("Moved to another package", ReplaceWith("org.readium.r2.shared.publication.Properties"))
+typealias Properties = Properties
+
+@Deprecated("Moved to another package", ReplaceWith("org.readium.r2.shared.publication.Metadata"))
+typealias Metadata = Metadata
+
+@Deprecated("Moved to another package", ReplaceWith("org.readium.r2.shared.publication.Contributor"))
+typealias Contributor = Contributor
+
+@Deprecated("Moved to another package", ReplaceWith("org.readium.r2.shared.publication.Collection"))
+typealias Collection = Collection
+
+@Deprecated("Moved to another package", ReplaceWith("org.readium.r2.shared.publication.Subject"))
+typealias Subject = Subject
+
+@Deprecated("Moved to another package", ReplaceWith("org.readium.r2.shared.publication.encryption.Encryption"))
+typealias Encryption = Encryption
+
+@Deprecated("Refactored into [Presentation]", ReplaceWith("org.readium.r2.shared.publication.presentation.Presentation"))
+typealias Rendition = Presentation
+
+@Deprecated("Refactored into [EpubLayout]", ReplaceWith("org.readium.r2.shared.publication.epub.EpubLayout"))
+typealias RenditionLayout = org.readium.r2.shared.publication.epub.EpubLayout
+
+@Deprecated("Refactored into [Presentation.Overflow]", ReplaceWith("org.readium.r2.shared.publication.presentation.Presentation.Overflow"))
+typealias RenditionFlow = Presentation.Overflow
+
+@Deprecated("Refactored into [Presentation.Orientation]", ReplaceWith("org.readium.r2.shared.publication.presentation.Presentation.Orientation"))
+typealias RenditionOrientation = Presentation.Orientation
+
+@Deprecated("Refactored into [Presentation.Spread]", ReplaceWith("org.readium.r2.shared.publication.presentation.Presentation.Spread"))
+typealias RenditionSpread = Presentation.Spread
+
+@Deprecated("Use [Publication::fromJSON] instead", ReplaceWith("Publication.fromJSON(pubDict)", "org.readium.r2.shared.publication.Publication"))
+fun parsePublication(pubDict: JSONObject): org.readium.r2.shared.publication.Publication {
+    return org.readium.r2.shared.publication.Publication.fromJSON(pubDict)
+        ?: throw Exception("Invalid publication")
+}
+
+@Deprecated("Use [Link::fromJSON] instead", ReplaceWith("Link.fromJSON(linkDict)", "org.readium.r2.shared.publication.Link"))
+fun parseLink(linkDict: JSONObject, feedUrl: URL? = null): Link =
+    Link.fromJSON(linkDict, normalizeHref = {
+        if (feedUrl == null) {
+            it
+        } else {
+            getAbsolute(it, feedUrl.toString())
+        }
+    }) ?: Link(href = "#")
+
+@Deprecated("Moved to another package", ReplaceWith("removeLastComponent()", "org.readium.r2.shared.extensions.removeLastComponent"))
+fun URL.removeLastComponent(): URL = removeLastComponent()

r2-shared/src/main/java/org/readium/r2/shared/Contributor.kt

@@ -9,14 +9,14 @@
 
 package org.readium.r2.shared
 
+import org.readium.r2.shared.util.MapCompanion
 import java.io.Serializable
 
 enum class Injectable(val rawValue: String): Serializable {
     Script("scripts"),
     Font("fonts"),
     Style("styles");
 
-    companion object {
-        operator fun invoke(rawValue: String) = values().firstOrNull { it.rawValue == rawValue }
-    }
+    companion object : MapCompanion<String, Injectable>(values(), Injectable::rawValue)
+
 }

r2-shared/src/main/java/org/readium/r2/shared/Deprecated.kt

@@ -1,18 +1,28 @@
 /*
  * Module: r2-shared-kotlin
- * Developers: Aferdita Muriqi, Clément Baumann
+ * Developers: Aferdita Muriqi, Clément Baumann, Mickaël Menu
  *
- * Copyright (c) 2018. Readium Foundation. All rights reserved.
+ * Copyright (c) 2020. Readium Foundation. All rights reserved.
  * Use of this source code is governed by a BSD-style license which is detailed in the
  * LICENSE file present in the project repository where this source code is maintained.
  */
 
 package org.readium.r2.shared
 
+import org.json.JSONArray
 import org.json.JSONObject
 
 interface JSONable {
 
+    /**
+     * Serializes the object to its JSON representation.
+     */
     fun toJSON(): JSONObject
 
-}
+}
+
+/**
+ * Serializes a list of [JSONable] into a [JSONArray].
+ */
+fun List<JSONable>.toJSON(): JSONArray =
+    JSONArray(map(JSONable::toJSON))