feat: [FC-0047] Course progress and collapsing sections

Documentation/ConfigurationManagement.md

@@ -88,7 +88,7 @@ android:
 - **PRE_LOGIN_EXPERIENCE_ENABLED:** Enables the pre login courses discovery experience.
 - **WHATS_NEW_ENABLED:** Enables the "What's New" feature to present the latest changes to the user.
 - **SOCIAL_AUTH_ENABLED:** Enables SSO buttons on the SignIn and SignUp screens.
-- **COURSE_NESTED_LIST_ENABLED:** Enables an alternative visual representation for the course structure.
+- **COURSE_DROPDOWN_NAVIGATION_ENABLED:** Enables an alternative visual representation for the course structure.
 - **COURSE_UNIT_PROGRESS_ENABLED:** Enables the display of the unit progress within the courseware. 
 
 ## Future Support

core/src/main/java/org/openedx/core/config/Config.kt

@@ -111,8 +111,8 @@ class Config(context: Context) {
         return getBoolean(PRE_LOGIN_EXPERIENCE_ENABLED, true)
     }
 
-    fun isCourseNestedListEnabled(): Boolean {
-        return getBoolean(COURSE_NESTED_LIST_ENABLED, false)
+    fun isCourseDropdownNavigationEnabled(): Boolean {
+        return getBoolean(COURSE_DROPDOWN_NAVIGATION_ENABLED, false)
     }
 
     fun isCourseUnitProgressEnabled(): Boolean {
@@ -175,7 +175,7 @@ class Config(context: Context) {
         private const val PROGRAM = "PROGRAM"
         private const val DASHBOARD = "DASHBOARD"
         private const val BRANCH = "BRANCH"
-        private const val COURSE_NESTED_LIST_ENABLED = "COURSE_NESTED_LIST_ENABLED"
+        private const val COURSE_DROPDOWN_NAVIGATION_ENABLED = "COURSE_DROPDOWN_NAVIGATION_ENABLED"
         private const val COURSE_UNIT_PROGRESS_ENABLED = "COURSE_UNIT_PROGRESS_ENABLED"
         private const val PLATFORM_NAME = "PLATFORM_NAME"
     }

core/src/main/java/org/openedx/core/data/model/AssignmentProgress.kt

@@ -0,0 +1,25 @@
+package org.openedx.core.data.model
+
+import com.google.gson.annotations.SerializedName
+import org.openedx.core.data.model.room.AssignmentProgressDb
+
+data class AssignmentProgress(
+    @SerializedName("assignment_type")
+    val assignmentType: String?,
+    @SerializedName("num_points_earned")
+    val numPointsEarned: Float?,
+    @SerializedName("num_points_possible")
+    val numPointsPossible: Float?,
+) {
+    fun mapToDomain() = org.openedx.core.domain.model.AssignmentProgress(
+        assignmentType = assignmentType ?: "",
+        numPointsEarned = numPointsEarned ?: 0f,
+        numPointsPossible = numPointsPossible ?: 0f
+    )
+
+    fun mapToRoomEntity() = AssignmentProgressDb(
+        assignmentType = assignmentType,
+        numPointsEarned = numPointsEarned,
+        numPointsPossible = numPointsPossible
+    )
+}

core/src/main/java/org/openedx/core/data/model/Block.kt

@@ -3,6 +3,7 @@ package org.openedx.core.data.model
 import com.google.gson.annotations.SerializedName
 import org.openedx.core.BlockType
 import org.openedx.core.domain.model.Block
+import org.openedx.core.utils.TimeUtils
 
 data class Block(
     @SerializedName("id")
@@ -33,6 +34,10 @@ data class Block(
     val completion: Double?,
     @SerializedName("contains_gated_content")
     val containsGatedContent: Boolean?,
+    @SerializedName("assignment_progress")
+    val assignmentProgress: AssignmentProgress?,
+    @SerializedName("due")
+    val due: String?
 ) {
     fun mapToDomain(blockData: Map<String, org.openedx.core.data.model.Block>): Block {
         val blockType = BlockType.getBlockType(type ?: "")
@@ -61,7 +66,9 @@ data class Block(
             studentViewMultiDevice = studentViewMultiDevice ?: false,
             blockCounts = blockCounts?.mapToDomain()!!,
             completion = completion ?: 0.0,
-            containsGatedContent = containsGatedContent ?: false
+            containsGatedContent = containsGatedContent ?: false,
+            assignmentProgress = assignmentProgress?.mapToDomain(),
+            due = TimeUtils.iso8601ToDate(due ?: ""),
         )
     }
 }

core/src/main/java/org/openedx/core/data/model/CourseStructureModel.kt

@@ -4,6 +4,7 @@ import com.google.gson.annotations.SerializedName
 import org.openedx.core.data.model.room.BlockDb
 import org.openedx.core.data.model.room.CourseStructureEntity
 import org.openedx.core.data.model.room.MediaDb
+import org.openedx.core.data.model.room.discovery.ProgressDb
 import org.openedx.core.domain.model.CourseStructure
 import org.openedx.core.utils.TimeUtils
 
@@ -35,7 +36,9 @@ data class CourseStructureModel(
     @SerializedName("certificate")
     val certificate: Certificate?,
     @SerializedName("is_self_paced")
-    var isSelfPaced: Boolean?
+    var isSelfPaced: Boolean?,
+    @SerializedName("course_progress")
+    val progress: Progress?,
 ) {
     fun mapToDomain(): CourseStructure {
         return CourseStructure(
@@ -54,7 +57,8 @@ data class CourseStructureModel(
             coursewareAccess = coursewareAccess?.mapToDomain(),
             media = media?.mapToDomain(),
             certificate = certificate?.mapToDomain(),
-            isSelfPaced = isSelfPaced ?: false
+            isSelfPaced = isSelfPaced ?: false,
+            progress = progress?.mapToDomain()
         )
     }
 
@@ -73,7 +77,8 @@ data class CourseStructureModel(
             coursewareAccess = coursewareAccess?.mapToRoomEntity(),
             media = MediaDb.createFrom(media),
             certificate = certificate?.mapToRoomEntity(),
-            isSelfPaced = isSelfPaced ?: false
+            isSelfPaced = isSelfPaced ?: false,
+            progress = progress?.mapToRoomEntity() ?: ProgressDb.DEFAULT_PROGRESS
         )
     }
 }

core/src/main/java/org/openedx/core/data/model/room/BlockDb.kt

@@ -3,7 +3,12 @@ package org.openedx.core.data.model.room
 import androidx.room.ColumnInfo
 import androidx.room.Embedded
 import org.openedx.core.BlockType
-import org.openedx.core.domain.model.*
+import org.openedx.core.domain.model.Block
+import org.openedx.core.domain.model.BlockCounts
+import org.openedx.core.domain.model.EncodedVideos
+import org.openedx.core.domain.model.StudentViewData
+import org.openedx.core.domain.model.VideoInfo
+import org.openedx.core.utils.TimeUtils
 
 data class BlockDb(
     @ColumnInfo("id")
@@ -33,7 +38,11 @@ data class BlockDb(
     @ColumnInfo("completion")
     val completion: Double,
     @ColumnInfo("contains_gated_content")
-    val containsGatedContent: Boolean
+    val containsGatedContent: Boolean,
+    @Embedded
+    val assignmentProgress: AssignmentProgressDb?,
+    @ColumnInfo("due")
+    val due: String?
 ) {
     fun mapToDomain(blocks: List<BlockDb>): Block {
         val blockType = BlockType.getBlockType(type)
@@ -62,7 +71,9 @@ data class BlockDb(
             descendants = descendants,
             descendantsType = descendantsType,
             completion = completion,
-            containsGatedContent = containsGatedContent
+            containsGatedContent = containsGatedContent,
+            assignmentProgress = assignmentProgress?.mapToDomain(),
+            due = TimeUtils.iso8601ToDate(due ?: ""),
         )
     }
 
@@ -86,7 +97,9 @@ data class BlockDb(
                     studentViewMultiDevice = studentViewMultiDevice ?: false,
                     blockCounts = BlockCountsDb.createFrom(blockCounts),
                     completion = completion ?: 0.0,
-                    containsGatedContent = containsGatedContent ?: false
+                    containsGatedContent = containsGatedContent ?: false,
+                    assignmentProgress = assignmentProgress?.mapToRoomEntity(),
+                    due = due
                 )
             }
         }
@@ -201,3 +214,18 @@ data class BlockCountsDb(
         }
     }
 }
+
+data class AssignmentProgressDb(
+    @ColumnInfo("assignment_type")
+    val assignmentType: String?,
+    @ColumnInfo("num_points_earned")
+    val numPointsEarned: Float?,
+    @ColumnInfo("num_points_possible")
+    val numPointsPossible: Float?,
+) {
+    fun mapToDomain() = org.openedx.core.domain.model.AssignmentProgress(
+        assignmentType = assignmentType ?: "",
+        numPointsEarned = numPointsEarned ?: 0f,
+        numPointsPossible = numPointsPossible ?: 0f
+    )
+}

core/src/main/java/org/openedx/core/data/model/room/CourseStructureEntity.kt

@@ -6,6 +6,7 @@ import androidx.room.Entity
 import androidx.room.PrimaryKey
 import org.openedx.core.data.model.room.discovery.CertificateDb
 import org.openedx.core.data.model.room.discovery.CoursewareAccessDb
+import org.openedx.core.data.model.room.discovery.ProgressDb
 import org.openedx.core.domain.model.CourseStructure
 import org.openedx.core.utils.TimeUtils
 
@@ -39,7 +40,9 @@ data class CourseStructureEntity(
     @Embedded
     val certificate: CertificateDb?,
     @ColumnInfo("isSelfPaced")
-    val isSelfPaced: Boolean
+    val isSelfPaced: Boolean,
+    @Embedded
+    val progress: ProgressDb,
 ) {
 
     fun mapToDomain(): CourseStructure {
@@ -57,7 +60,8 @@ data class CourseStructureEntity(
             coursewareAccess?.mapToDomain(),
             media?.mapToDomain(),
             certificate?.mapToDomain(),
-            isSelfPaced
+            isSelfPaced,
+            progress.mapToDomain()
         )
     }
 

core/src/main/java/org/openedx/core/domain/model/AssignmentProgress.kt

@@ -0,0 +1,7 @@
+package org.openedx.core.domain.model
+
+data class AssignmentProgress(
+    val assignmentType: String,
+    val numPointsEarned: Float,
+    val numPointsPossible: Float
+)

core/src/main/java/org/openedx/core/domain/model/Block.kt

@@ -7,6 +7,7 @@ import org.openedx.core.module.db.DownloadModel
 import org.openedx.core.module.db.DownloadedState
 import org.openedx.core.module.db.FileType
 import org.openedx.core.utils.VideoUtil
+import java.util.Date
 
 
 data class Block(
@@ -25,7 +26,9 @@ data class Block(
     val descendantsType: BlockType,
     val completion: Double,
     val containsGatedContent: Boolean = false,
-    val downloadModel: DownloadModel? = null
+    val downloadModel: DownloadModel? = null,
+    val assignmentProgress: AssignmentProgress?,
+    val due: Date?
 ) {
     val isDownloadable: Boolean
         get() {

core/src/main/java/org/openedx/core/domain/model/CourseStructure.kt

@@ -16,5 +16,6 @@ data class CourseStructure(
     val coursewareAccess: CoursewareAccess?,
     val media: Media?,
     val certificate: Certificate?,
-    val isSelfPaced: Boolean
+    val isSelfPaced: Boolean,
+    val progress: Progress?,
 )

core/src/main/java/org/openedx/core/domain/model/Progress.kt

@@ -8,6 +8,13 @@ data class Progress(
     val assignmentsCompleted: Int,
     val totalAssignmentsCount: Int,
 ) : Parcelable {
+
+    fun getProgress(): Float = try {
+        assignmentsCompleted.toFloat() / totalAssignmentsCount.toFloat()
+    } catch (_: ArithmeticException) {
+        0f
+    }
+
     companion object {
         val DEFAULT_PROGRESS = Progress(0, 0)
     }

core/src/main/java/org/openedx/core/ui/theme/AppColors.kt

@@ -50,7 +50,7 @@ data class AppColors(
     val inactiveButtonBackground: Color,
     val inactiveButtonText: Color,
 
-    val accessGreen: Color,
+    val successGreen: Color,
 
     val datesSectionBarPastDue: Color,
     val datesSectionBarToday: Color,
@@ -73,7 +73,10 @@ data class AppColors(
     val courseHomeHeaderShade: Color,
     val courseHomeBackBtnBackground: Color,
 
-    val settingsTitleContent: Color
+    val settingsTitleContent: Color,
+
+    val progressBarColor: Color,
+    val progressBarBackgroundColor: Color
 ) {
     val primary: Color get() = material.primary
     val primaryVariant: Color get() = material.primaryVariant

core/src/main/java/org/openedx/core/ui/theme/Theme.kt

@@ -68,7 +68,7 @@ private val DarkColorPalette = AppColors(
     inactiveButtonBackground = dark_inactive_button_background,
     inactiveButtonText = dark_primary_button_text,
 
-    accessGreen = dark_access_green,
+    successGreen = dark_success_green,
 
     datesSectionBarPastDue = dark_dates_section_bar_past_due,
     datesSectionBarToday = dark_dates_section_bar_today,
@@ -91,7 +91,10 @@ private val DarkColorPalette = AppColors(
     courseHomeHeaderShade = dark_course_home_header_shade,
     courseHomeBackBtnBackground = dark_course_home_back_btn_background,
 
-    settingsTitleContent = dark_settings_title_content
+    settingsTitleContent = dark_settings_title_content,
+
+    progressBarColor = dark_progress_bar_color,
+    progressBarBackgroundColor = dark_progress_bar_background_color
 )
 
 private val LightColorPalette = AppColors(
@@ -152,7 +155,7 @@ private val LightColorPalette = AppColors(
     inactiveButtonBackground = light_inactive_button_background,
     inactiveButtonText = light_primary_button_text,
 
-    accessGreen = light_access_green,
+    successGreen = light_success_green,
 
     datesSectionBarPastDue = light_dates_section_bar_past_due,
     datesSectionBarToday = light_dates_section_bar_today,
@@ -175,7 +178,10 @@ private val LightColorPalette = AppColors(
     courseHomeHeaderShade = light_course_home_header_shade,
     courseHomeBackBtnBackground = light_course_home_back_btn_background,
 
-    settingsTitleContent = light_settings_title_content
+    settingsTitleContent = light_settings_title_content,
+
+    progressBarColor = light_progress_bar_color,
+    progressBarBackgroundColor = light_progress_bar_background_color
 )
 
 val MaterialTheme.appColors: AppColors

core/src/main/java/org/openedx/core/utils/TimeUtils.kt

@@ -242,6 +242,42 @@ object TimeUtils {
         }
     }
 
+    fun getAssignmentFormattedDate(context: Context, date: Date): String {
+        val inputDate = Calendar.getInstance().also {
+            it.time = date
+            it.clearTimeComponents()
+        }
+        val daysDifference = getDayDifference(inputDate)
+
+        return when {
+            daysDifference == 0 -> {
+                context.getString(R.string.core_date_format_assignment_due_today)
+            }
+
+            daysDifference == 1 -> {
+                context.getString(R.string.core_date_format_assignment_due_tomorrow)
+            }
+
+            daysDifference == -1 -> {
+                context.getString(R.string.core_date_format_assignment_due_yesterday)
+            }
+
+            daysDifference <= -2 -> {
+                context.getString(
+                    R.string.core_date_format_assignment_due_days_ago,
+                    ceil(-daysDifference.toDouble()).toInt().toString()
+                )
+            }
+
+            else -> {
+                context.getString(
+                    R.string.core_date_format_assignment_due_in,
+                    ceil(daysDifference.toDouble()).toInt().toString()
+                )
+            }
+        }
+    }
+
     /**
      * Returns the number of days difference between the given date and the current date.
      */

core/src/main/res/values/strings.xml

@@ -96,6 +96,12 @@
     <string name="core_date_format_tomorrow" tools:ignore="MissingTranslation">Tomorrow</string>
     <string name="core_date_format_yesterday" tools:ignore="MissingTranslation">Yesterday</string>
     <string name="core_date_format_days_ago" tools:ignore="MissingTranslation">%1$s days ago</string>
+    <string name="core_date_format_past_due_assignment" tools:ignore="MissingTranslation">Past due assignment</string>
+    <string name="core_date_format_assignment_due_today" tools:ignore="MissingTranslation">Due Today</string>
+    <string name="core_date_format_assignment_due_tomorrow" tools:ignore="MissingTranslation">Due Tomorrow</string>
+    <string name="core_date_format_assignment_due_yesterday" tools:ignore="MissingTranslation">Due Yesterday</string>
+    <string name="core_date_format_assignment_due_in" tools:ignore="MissingTranslation">Due in %1$s days</string>
+    <string name="core_date_format_assignment_due_days_ago" tools:ignore="MissingTranslation">Due %1$s days ago</string>
     <plurals name="core_date_items_hidden" tools:ignore="MissingTranslation">
         <item quantity="one">%d Item Hidden</item>
         <item quantity="other">%d Items Hidden</item>