chore: [ANDROSDK-2339] migrate RepositoryScope to Kotlin (#2656)

Author: taridepaco

core/api/core.api

@@ -0,0 +1,72 @@
+/*
+ *  Copyright (c) 2004-2025, University of Oslo
+ *  All rights reserved.
+ *
+ *  Redistribution and use in source and binary forms, with or without
+ *  modification, are permitted provided that the following conditions are met:
+ *  Redistributions of source code must retain the above copyright notice, this
+ *  list of conditions and the following disclaimer.
+ *
+ *  Redistributions in binary form must reproduce the above copyright notice,
+ *  this list of conditions and the following disclaimer in the documentation
+ *  and/or other materials provided with the distribution.
+ *  Neither the name of the HISP project nor the names of its contributors may
+ *  be used to endorse or promote products derived from this software without
+ *  specific prior written permission.
+ *
+ *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ *  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ *  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ *  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ *  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package org.hisp.dhis.android.core.arch.repositories.scope
+
+import org.hisp.dhis.android.annotations.ModelBuilder
+import org.hisp.dhis.android.core.arch.repositories.children.internal.ChildrenSelection
+import org.hisp.dhis.android.core.arch.repositories.scope.internal.RepositoryScopeComplexFilterItem
+import org.hisp.dhis.android.core.arch.repositories.scope.internal.RepositoryScopeFilterItem
+import org.hisp.dhis.android.core.arch.repositories.scope.internal.RepositoryScopeOrderByItem
+
+@ConsistentCopyVisibility
+@ModelBuilder
+data class RepositoryScope internal constructor(
+    val filters: List<RepositoryScopeFilterItem>,
+    val complexFilters: List<RepositoryScopeComplexFilterItem>,
+    internal val orderBy: List<RepositoryScopeOrderByItem>,
+    internal val children: ChildrenSelection,
+) {
+    enum class OrderByDirection(val api: String) {
+        ASC("asc"),
+        DESC("desc"),
+    }
+
+    fun filters(): List<RepositoryScopeFilterItem> = filters
+    fun complexFilters(): List<RepositoryScopeComplexFilterItem> = complexFilters
+    internal fun orderBy(): List<RepositoryScopeOrderByItem> = orderBy
+    internal fun children(): ChildrenSelection = children
+
+    fun hasFilters(): Boolean = filters.isNotEmpty() || complexFilters.isNotEmpty()
+
+    fun toBuilder(): Builder = RepositoryScopeBuilder.from(this)
+
+    class Builder : RepositoryScopeBuilder()
+
+    companion object {
+        @JvmStatic
+        fun empty(): RepositoryScope = builder()
+            .children(ChildrenSelection.empty())
+            .filters(emptyList())
+            .complexFilters(emptyList())
+            .orderBy(emptyList())
+            .build()
+
+        @JvmStatic
+        fun builder(): Builder = Builder()
+    }
+}

core/src/main/java/org/hisp/dhis/android/core/arch/repositories/scope/RepositoryScope.java

@@ -34,7 +34,6 @@ import org.hisp.dhis.android.core.attribute.ProgramStageAttributeValueLink
 import org.hisp.dhis.android.core.attribute.internal.ProgramStageAttributeValueLinkHandler
 import org.hisp.dhis.android.core.common.ObjectWithUid
 import org.hisp.dhis.android.core.program.ProgramStage
-import org.hisp.dhis.android.core.program.ProgramStageSection
 import org.koin.core.annotation.Singleton
 
 @Singleton
@@ -52,11 +51,7 @@ internal class ProgramStageHandler(
         programStageDataElementHandler.handleMany(o.programStageDataElements())
         programStageSectionHandler.handleMany(
             o.programStageSections(),
-        ) { programStageSection: ProgramStageSection ->
-            programStageSection.toBuilder()
-                .programStage(ObjectWithUid.create(o.uid()))
-                .build()
-        }
+        )
 
         if (action === HandleAction.Update) {
             programStageDataElementCleaner.deleteOrphan(o, o.programStageDataElements())

core/src/main/java/org/hisp/dhis/android/core/arch/repositories/scope/RepositoryScope.kt

@@ -113,7 +113,7 @@ internal data class ProgramStageDTO(
             minDaysFromStart(minDaysFromStart)
             standardInterval(standardInterval)
             enableUserAssignment?.let { enableUserAssignment(it) }
-            programStageSections(programStageSections?.map { it.toDomain() })
+            programStageSections(programStageSections?.map { it.toDomain(id) })
             programStageDataElements(programStageDataElements?.map { it.toDomain() })
             periodType(periodType?.let { PeriodType.valueOf(it) })
             program(program?.toDomain())

core/src/main/java/org/hisp/dhis/android/core/program/internal/ProgramStageHandler.kt

@@ -29,6 +29,7 @@
 package org.hisp.dhis.android.network.programstage
 
 import kotlinx.serialization.Serializable
+import org.hisp.dhis.android.core.common.ObjectWithUid
 import org.hisp.dhis.android.core.program.ProgramStageSection
 import org.hisp.dhis.android.network.common.dto.BaseIdentifiableObjectDTO
 import org.hisp.dhis.android.network.common.dto.ObjectWithUidDTO
@@ -53,14 +54,14 @@ internal data class ProgramStageSectionDTO(
     val description: String?,
     val displayDescription: String?,
 ) : BaseIdentifiableObjectDTO {
-    fun toDomain(): ProgramStageSection {
+    fun toDomain(programStageUid: String): ProgramStageSection {
         return ProgramStageSection.builder()
             .applyBaseIdentifiableFields(this)
             .sortOrder(sortOrder)
             .programIndicators(programIndicators?.map { it.toDomain() })
             .dataElements(dataElements?.map { it.toDomain() })
             .renderType(renderType?.toDomain())
-            .programStage(programStage!!.toDomain())
+            .programStage(ObjectWithUid.create(programStageUid))
             .description(description)
             .displayDescription(displayDescription)
             .build()

core/src/main/java/org/hisp/dhis/android/network/programstage/ProgramStageDTO.kt

@@ -109,7 +109,7 @@ class ProgramStageHandlerShould {
     @Throws(Exception::class)
     fun call_program_stage_section_handler() = runTest {
         programStageHandler.handle(programStage)
-        verify(programStageSectionHandler).handleMany(eq(programStageSections), any())
+        verify(programStageSectionHandler).handleMany(eq(programStageSections))
     }
 
     @Test

core/src/main/java/org/hisp/dhis/android/network/programstage/ProgramStageSectionDTO.kt

@@ -184,11 +184,17 @@ class ModelBuilderProcessor(
             .contains(field.type.toString())
         val isNotNull = !field.type.isMarkedNullable
         val type = renderType(field.type)
+        // An internal field may reference an internal type. A `protected` backing property in a
+        // public builder would leak that internal type, so use `private` visibility instead. It
+        // must stay `private` (not `internal`): the backing property is only used by the generated
+        // setters and build() within this class, and a module-visible `internal` property would
+        // shadow identically-named properties inside callers' `builder().apply { }` blocks.
+        val visibility = if (field.isInternal) "private" else "protected"
 
         return when {
-            isNotNull && isPrimitive -> "protected var ${field.name} by Delegates.notNull<$type>()"
-            isNotNull -> "protected lateinit var ${field.name}: $type"
-            else -> "protected var ${field.name}: $type = null"
+            isNotNull && isPrimitive -> "$visibility var ${field.name} by Delegates.notNull<$type>()"
+            isNotNull -> "$visibility lateinit var ${field.name}: $type"
+            else -> "$visibility var ${field.name}: $type = null"
         }
     }