feat: Course Home progress bar

PavloNetrebchuk · PavloNetrebchuk · commit eb6402372114 · 2024-05-20T18:31:13.000+03:00
diff --git a/core/src/main/java/org/openedx/core/data/model/CourseStructureModel.kt b/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
         )
     }
 }
diff --git a/core/src/main/java/org/openedx/core/data/model/Progress.kt b/core/src/main/java/org/openedx/core/data/model/Progress.kt
@@ -0,0 +1,23 @@
+package org.openedx.core.data.model
+
+import com.google.gson.annotations.SerializedName
+import org.openedx.core.data.model.room.discovery.ProgressDb
+
+data class Progress(
+    @SerializedName("assignments_completed")
+    val assignmentsCompleted: Int?,
+    @SerializedName("total_assignments_count")
+    val totalAssignmentsCount: Int?
+) {
+    fun mapToDomain(): org.openedx.core.domain.model.Progress {
+        return org.openedx.core.domain.model.Progress(
+            assignmentsCompleted = assignmentsCompleted ?: 0,
+            totalAssignmentsCount = totalAssignmentsCount ?: 0
+        )
+    }
+
+    fun mapToRoomEntity() = ProgressDb(
+        assignmentsCompleted = assignmentsCompleted ?: 0,
+        totalAssignmentsCount = totalAssignmentsCount ?: 0
+    )
+}
diff --git a/core/src/main/java/org/openedx/core/data/model/room/CourseStructureEntity.kt b/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()
         )
     }
 
diff --git a/core/src/main/java/org/openedx/core/data/model/room/discovery/EnrolledCourseEntity.kt b/core/src/main/java/org/openedx/core/data/model/room/discovery/EnrolledCourseEntity.kt
@@ -5,7 +5,12 @@ import androidx.room.Embedded
 import androidx.room.Entity
 import androidx.room.PrimaryKey
 import org.openedx.core.data.model.room.MediaDb
-import org.openedx.core.domain.model.*
+import org.openedx.core.domain.model.Certificate
+import org.openedx.core.domain.model.CourseSharingUtmParameters
+import org.openedx.core.domain.model.CoursewareAccess
+import org.openedx.core.domain.model.EnrolledCourse
+import org.openedx.core.domain.model.EnrolledCourseData
+import org.openedx.core.domain.model.Progress
 import org.openedx.core.utils.TimeUtils
 
 @Entity(tableName = "course_enrolled_table")
@@ -135,6 +140,19 @@ data class CoursewareAccessDb(
 
 }
 
+data class ProgressDb(
+    @ColumnInfo("assignments_completed")
+    val assignmentsCompleted: Int,
+    @ColumnInfo("total_assignments_count")
+    val totalAssignmentsCount: Int,
+) {
+    companion object {
+        val DEFAULT_PROGRESS = ProgressDb(0, 0)
+    }
+
+    fun mapToDomain() = Progress(assignmentsCompleted, totalAssignmentsCount)
+}
+
 data class CertificateDb(
     @ColumnInfo("certificateURL")
     val certificateURL: String?
diff --git a/core/src/main/java/org/openedx/core/domain/model/CourseStructure.kt b/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?,
 )
diff --git a/core/src/main/java/org/openedx/core/domain/model/Progress.kt b/core/src/main/java/org/openedx/core/domain/model/Progress.kt
@@ -0,0 +1,16 @@
+package org.openedx.core.domain.model
+
+import android.os.Parcelable
+import kotlinx.parcelize.Parcelize
+
+@Parcelize
+data class Progress(
+    val assignmentsCompleted: Int,
+    val totalAssignmentsCount: Int,
+) : Parcelable {
+    fun getProgress(): Float = try {
+        assignmentsCompleted.toFloat() / totalAssignmentsCount.toFloat()
+    } catch (_: ArithmeticException) {
+        0f
+    }
+}
diff --git a/core/src/main/java/org/openedx/core/ui/theme/AppColors.kt b/core/src/main/java/org/openedx/core/ui/theme/AppColors.kt
@@ -58,7 +58,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
diff --git a/core/src/main/java/org/openedx/core/ui/theme/Theme.kt b/core/src/main/java/org/openedx/core/ui/theme/Theme.kt
@@ -78,7 +78,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(
@@ -149,7 +152,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
diff --git a/core/src/openedx/org/openedx/core/ui/theme/Colors.kt b/core/src/openedx/org/openedx/core/ui/theme/Colors.kt
@@ -56,9 +56,11 @@ val light_tab_selected_btn_content = Color.White
 val light_course_home_header_shade = Color(0xFFBABABA)
 val light_course_home_back_btn_background = Color.White
 val light_settings_title_content = Color.White
+val light_progress_bar_color = light_primary
+val light_progress_bar_background_color = Color(0xFF97A5BB)
 
 
-val dark_primary = Color(0xFF5478F9)
+val dark_primary = Color(0xFF3F68F8)
 val dark_primary_variant = Color(0xFF3700B3)
 val dark_secondary = Color(0xFF03DAC6)
 val dark_secondary_variant = Color(0xFF373E4F)
@@ -112,3 +114,5 @@ val dark_tab_selected_btn_content = Color.White
 val dark_course_home_header_shade = Color(0xFF999999)
 val dark_course_home_back_btn_background = Color.Black
 val dark_settings_title_content = Color.White
+val dark_progress_bar_color = light_primary
+val dark_progress_bar_background_color = Color(0xFF8E9BAE)
diff --git a/course/src/main/java/org/openedx/course/presentation/container/CourseContainerViewModel.kt b/course/src/main/java/org/openedx/course/presentation/container/CourseContainerViewModel.kt
@@ -168,7 +168,7 @@ class CourseContainerViewModel(
         _showProgress.value = true
         viewModelScope.launch {
             try {
-                val courseStructure = interactor.getCourseStructure(courseId)
+                val courseStructure = interactor.getCourseStructure(courseId, true)
                 courseName = courseStructure.name
                 _organization = courseStructure.org
                 _isSelfPaced = courseStructure.isSelfPaced
diff --git a/course/src/main/java/org/openedx/course/presentation/outline/CourseOutlineScreen.kt b/course/src/main/java/org/openedx/course/presentation/outline/CourseOutlineScreen.kt
@@ -18,8 +18,10 @@ import androidx.compose.foundation.layout.width
 import androidx.compose.foundation.layout.widthIn
 import androidx.compose.foundation.lazy.LazyColumn
 import androidx.compose.foundation.lazy.items
+import androidx.compose.foundation.shape.CircleShape
 import androidx.compose.material.Divider
 import androidx.compose.material.Icon
+import androidx.compose.material.LinearProgressIndicator
 import androidx.compose.material.MaterialTheme
 import androidx.compose.material.Scaffold
 import androidx.compose.material.Surface
@@ -32,6 +34,7 @@ import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.remember
 import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
+import androidx.compose.ui.draw.clip
 import androidx.compose.ui.platform.AndroidUriHandler
 import androidx.compose.ui.platform.LocalContext
 import androidx.compose.ui.res.painterResource
@@ -49,6 +52,7 @@ import org.openedx.core.domain.model.BlockCounts
 import org.openedx.core.domain.model.CourseDatesBannerInfo
 import org.openedx.core.domain.model.CourseStructure
 import org.openedx.core.domain.model.CoursewareAccess
+import org.openedx.core.domain.model.Progress
 import org.openedx.core.extension.takeIfNotEmpty
 import org.openedx.core.presentation.course.CourseViewMode
 import org.openedx.core.ui.HandleUIMessage
@@ -272,6 +276,19 @@ private fun CourseOutlineUI(
                                         }
                                     }
                                 }
+
+                                val progress = uiState.courseStructure.progress
+                                if (progress != null && progress.totalAssignmentsCount > 0) {
+                                    item {
+                                        CourseProgress(
+                                            modifier = Modifier
+                                                .fillMaxWidth()
+                                                .padding(top = 16.dp, start = 24.dp, end = 24.dp),
+                                            progress = progress
+                                        )
+                                    }
+                                }
+
                                 if (uiState.resumeComponent != null) {
                                     item {
                                         Box(listPadding) {
@@ -484,6 +501,36 @@ private fun ResumeCourseTablet(
     }
 }
 
+@Composable
+private fun CourseProgress(
+    modifier: Modifier = Modifier,
+    progress: Progress
+) {
+    Column(
+        modifier = modifier,
+        verticalArrangement = Arrangement.spacedBy(8.dp)
+    ) {
+        LinearProgressIndicator(
+            modifier = Modifier
+                .fillMaxWidth()
+                .height(10.dp)
+                .clip(CircleShape),
+            progress = progress.getProgress(),
+            color = MaterialTheme.appColors.progressBarColor,
+            backgroundColor = MaterialTheme.appColors.progressBarBackgroundColor
+        )
+        Text(
+            text = stringResource(
+                R.string.course_assignments_complete,
+                progress.assignmentsCompleted,
+                progress.totalAssignmentsCount
+            ),
+            color = MaterialTheme.appColors.textDark,
+            style = MaterialTheme.appTypography.labelSmall
+        )
+    }
+}
+
 fun getUnitBlockIcon(block: Block): Int {
     return when (block.type) {
         BlockType.VIDEO -> R.drawable.ic_course_video
@@ -628,5 +675,6 @@ private val mockCourseStructure = CourseStructure(
     ),
     media = null,
     certificate = null,
-    isSelfPaced = false
+    isSelfPaced = false,
+    progress = Progress(1, 3)
 )
diff --git a/course/src/main/java/org/openedx/course/presentation/ui/CourseVideosUI.kt b/course/src/main/java/org/openedx/course/presentation/ui/CourseVideosUI.kt
@@ -63,6 +63,7 @@ import org.openedx.core.domain.model.Block
 import org.openedx.core.domain.model.BlockCounts
 import org.openedx.core.domain.model.CourseStructure
 import org.openedx.core.domain.model.CoursewareAccess
+import org.openedx.core.domain.model.Progress
 import org.openedx.core.domain.model.VideoSettings
 import org.openedx.core.extension.toFileSize
 import org.openedx.core.module.download.DownloadModelsSize
@@ -849,5 +850,6 @@ private val mockCourseStructure = CourseStructure(
     ),
     media = null,
     certificate = null,
-    isSelfPaced = false
+    isSelfPaced = false,
+    progress = Progress(1, 3)
 )
diff --git a/course/src/main/res/values/strings.xml b/course/src/main/res/values/strings.xml
@@ -95,5 +95,6 @@
     <string name="course_delete_while_downloading_confirmation_text" formatted="false">Turning off the switch will stop downloading and delete all downloaded videos for \"%s\"?</string>
     <string name="course_delete_downloads_confirmation_text" formatted="false">Are you sure you want to delete all video(s) for \"%s\"?</string>
     <string name="course_delete_download_confirmation_text" formatted="false">Are you sure you want to delete video(s) for \"%s\"?</string>
+    <string name="course_assignments_complete">%1$s of %2$s  assignments complete</string>
 
 </resources>

Original file line number	Diff line number	Diff line change
`@@ -16,5 +16,6 @@ data class CourseStructure(`
`16`	`16`	`val coursewareAccess: CoursewareAccess?,`
`17`	`17`	`val media: Media?,`
`18`	`18`	`val certificate: Certificate?,`
`19`		`- val isSelfPaced: Boolean`
	`19`	`+ val isSelfPaced: Boolean,`
	`20`	`+ val progress: Progress?,`
`20`	`21`	`)`