Rename positionList to positions

r2-shared/src/main/java/org/readium/r2/shared/publication/Locator.kt

@@ -171,7 +171,10 @@ data class Locator(
 
     companion object {
 
-        fun fromJSON(json: JSONObject?, warnings: WarningLogger<JsonWarning>? = null): Locator? {
+        fun fromJSON(json: JSONObject?): Locator? =
+            fromJSON(json, null)
+
+        internal fun fromJSON(json: JSONObject?, warnings: WarningLogger<JsonWarning>?): Locator? {
             val href = json?.optNullableString("href")
             val type = json?.optNullableString("type")
             if (href == null || type == null) {

r2-shared/src/main/java/org/readium/r2/shared/publication/Publication.kt

@@ -37,7 +37,7 @@ import java.net.URL
  *
  * @param type The kind of publication it is ( Epub, Cbz, ... )
  * @param version The version of the publication, if the type needs any.
- * @param positionListFactory Factory used to build lazily the [positionList].
+ * @param positionsFactory Factory used to build lazily the [positions].
  */
 @Parcelize
 data class Publication(
@@ -50,7 +50,7 @@ data class Publication(
     val resources: List<Link> = emptyList(),
     val tableOfContents: List<Link> = emptyList(),
     val otherCollections: List<PublicationCollection> = emptyList(),
-    val positionListFactory: @WriteWith<PositionListFactory.Parceler> PositionListFactory? = null,
+    val positionsFactory: @WriteWith<PositionListFactory.Parceler> PositionListFactory? = null,
 
     // FIXME: To be refactored, with the TYPE and EXTENSION enums as well
     var type: TYPE = TYPE.EPUB,
@@ -66,7 +66,7 @@ data class Publication(
 ) : JSONable, Parcelable {
 
     /**
-     * Creates a [Publication]'s [positionList].
+     * Creates a [Publication]'s [positions].
      *
      * The parsers provide an implementation of this interface for each format, but a host app
      * might want to use a custom factory to implement, for example, a caching mechanism or use a
@@ -79,16 +79,16 @@ data class Publication(
          * Implementation of a [Parceler] to be used with [@Parcelize] to serialize a
          * [PositionListFactory].
          *
-         * Since we can't serialize a factory, we're loading eagerly the [positionList] to be
+         * Since we can't serialize a factory, we're loading eagerly the [positions] to be
          * serialized. Upon deserialization, the positions will be wrapped in a static factory.
          *
          * This won't be needed anymore once we use [Fragment] instead of [Activity] in the
          * navigator.
          */
         object Parceler : kotlinx.android.parcel.Parceler<PositionListFactory?> {
 
-            private class StaticPositionListFactory(private val positionList: List<Locator>): PositionListFactory {
-                override fun create(): List<Locator> = positionList
+            private class StaticPositionListFactory(private val positions: List<Locator>): PositionListFactory {
+                override fun create(): List<Locator> = positions
             }
 
             override fun create(parcel: Parcel): PositionListFactory? =
@@ -141,16 +141,16 @@ data class Publication(
      * List of all the positions in the publication.
      */
     @IgnoredOnParcel
-    val positionList: List<Locator> by lazy {
-        positionListFactory?.create() ?: emptyList()
+    val positions: List<Locator> by lazy {
+        positionsFactory?.create() ?: emptyList()
     }
 
     /**
      * List of all the positions in each resource, indexed by their [href].
      */
     @IgnoredOnParcel
-    val positionListByResource: Map<String, List<Locator>> by lazy {
-        positionList.groupBy { it.href }
+    val positionsByResource: Map<String, List<Locator>> by lazy {
+        positions.groupBy { it.href }
     }
 
     /**
@@ -274,8 +274,8 @@ data class Publication(
      * The provided closure will be used to build the [PositionListFactory], with [this] being the
      * [Publication].
      */
-    fun copyWithPositionListFactory(createFactory: Publication.() -> PositionListFactory): Publication {
-        return run { copy(positionListFactory = createFactory()) }
+    fun copyWithPositionsFactory(createFactory: Publication.() -> PositionListFactory): Publication {
+        return run { copy(positionsFactory = createFactory()) }
     }
 
     companion object {

r2-shared/src/main/java/org/readium/r2/shared/publication/html/DomRange.kt

@@ -76,7 +76,10 @@ data class DomRange(
 
         companion object {
 
-            fun fromJSON(json: JSONObject?, warnings: WarningLogger<JsonWarning>? = null): Point? {
+            fun fromJSON(json: JSONObject?): Point? =
+                fromJSON(json, null)
+
+            internal fun fromJSON(json: JSONObject?, warnings: WarningLogger<JsonWarning>?): Point? {
                 val cssSelector = json?.optNullableString("cssSelector")
                 val textNodeIndex = json?.optPositiveInt("textNodeIndex")
                 if (cssSelector == null || textNodeIndex == null) {
@@ -104,7 +107,10 @@ data class DomRange(
 
     companion object {
 
-        fun fromJSON(json: JSONObject?, warnings: WarningLogger<JsonWarning>? = null): DomRange? {
+        fun fromJSON(json: JSONObject?): DomRange? =
+            fromJSON(json, null)
+
+        internal fun fromJSON(json: JSONObject?, warnings: WarningLogger<JsonWarning>?): DomRange? {
             val start = Point.fromJSON(json?.optJSONObject("start"))
             if (start == null) {
                 warnings?.log(DomRange::class.java, "[start] is required", json)

r2-shared/src/test/java/org/readium/r2/shared/publication/PublicationTest.kt

@@ -25,7 +25,7 @@ class PublicationTest {
         links: List<Link> = listOf(),
         readingOrder: List<Link> = emptyList(),
         resources: List<Link> = emptyList(),
-        positionListFactory: Publication.PositionListFactory? = null
+        positionsFactory: Publication.PositionListFactory? = null
     ) = Publication(
         metadata = Metadata(
             localizedTitle = LocalizedString(title),
@@ -35,7 +35,7 @@ class PublicationTest {
         links = links,
         readingOrder = readingOrder,
         resources = resources,
-        positionListFactory = positionListFactory
+        positionsFactory = positionsFactory
     )
 
     @Test fun `parse minimal JSON`() {
@@ -261,23 +261,23 @@ class PublicationTest {
         )
     }
 
-    @Test fun `get the default empty {positionList}`() {
-        assertEquals(emptyList<Locator>(), createPublication().positionList)
+    @Test fun `get the default empty {positions}`() {
+        assertEquals(emptyList<Locator>(), createPublication().positions)
     }
 
-    @Test fun `get the {positionList} computed from the {positionListFactory}`() {
+    @Test fun `get the {positions} computed from the {positionsFactory}`() {
         assertEquals(
             listOf(Locator(href = "locator", type = "")),
             createPublication(
-                positionListFactory = object : Publication.PositionListFactory {
+                positionsFactory = object : Publication.PositionListFactory {
                     override fun create(): List<Locator> =
                         listOf(Locator(href = "locator", type = ""))
                 }
-            ).positionList
+            ).positions
         )
     }
 
-    @Test fun `get the {positionListByResource} computed from the {positionListFactory}`() {
+    @Test fun `get the {positionsByResource} computed from the {positionsFactory}`() {
         assertEquals(
             mapOf(
                 "res1" to listOf(
@@ -289,14 +289,14 @@ class PublicationTest {
                 )
             ),
             createPublication(
-                positionListFactory = object : Publication.PositionListFactory {
+                positionsFactory = object : Publication.PositionListFactory {
                     override fun create(): List<Locator> = listOf(
                         Locator(href="res1", type = "text/html", title = "Loc A"),
                         Locator(href="res2", type = "text/html", title = "Loc B"),
                         Locator(href="res1", type = "text/html", title = "Loc B")
                     )
                 }
-            ).positionListByResource
+            ).positionsByResource
         )
     }