feat: color coding

Author: PavloNetrebchuk

app/schemas/org.openedx.app.room.AppDatabase/3.json

@@ -2,7 +2,7 @@
   "formatVersion": 1,
   "database": {
     "version": 3,
-    "identityHash": "d6028101c7598e8d1c5dedfcfc73d304",
+    "identityHash": "bcf7a22441e12e4c8b6fb332754827bf",
     "entities": [
       {
         "tableName": "course_discovery_table",
@@ -1008,7 +1008,7 @@
       },
       {
         "tableName": "course_progress_table",
-        "createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`courseId` TEXT NOT NULL, `verifiedMode` TEXT NOT NULL, `accessExpiration` TEXT NOT NULL, `creditCourseRequirements` TEXT NOT NULL, `end` TEXT NOT NULL, `enrollmentMode` TEXT NOT NULL, `hasScheduledContent` INTEGER NOT NULL, `sectionScores` TEXT NOT NULL, `studioUrl` TEXT NOT NULL, `username` TEXT NOT NULL, `userHasPassingGrade` INTEGER NOT NULL, `disableProgressGraph` INTEGER NOT NULL, `assignment_colors` TEXT, `certificate_certStatus` TEXT, `certificate_certWebViewUrl` TEXT, `certificate_downloadUrl` TEXT, `certificate_certificateAvailableDate` TEXT, `completion_completeCount` INTEGER, `completion_incompleteCount` INTEGER, `completion_lockedCount` INTEGER, `grade_letterGrade` TEXT, `grade_percent` REAL, `grade_isPassing` INTEGER, `grading_assignmentPolicies` TEXT, `grading_gradeRange` TEXT, `verification_link` TEXT, `verification_status` TEXT, `verification_statusDate` TEXT, PRIMARY KEY(`courseId`))",
+        "createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`courseId` TEXT NOT NULL, `verifiedMode` TEXT NOT NULL, `accessExpiration` TEXT NOT NULL, `creditCourseRequirements` TEXT NOT NULL, `end` TEXT NOT NULL, `enrollmentMode` TEXT NOT NULL, `hasScheduledContent` INTEGER NOT NULL, `sectionScores` TEXT NOT NULL, `studioUrl` TEXT NOT NULL, `username` TEXT NOT NULL, `userHasPassingGrade` INTEGER NOT NULL, `disableProgressGraph` INTEGER NOT NULL, `certificate_certStatus` TEXT, `certificate_certWebViewUrl` TEXT, `certificate_downloadUrl` TEXT, `certificate_certificateAvailableDate` TEXT, `completion_completeCount` INTEGER, `completion_incompleteCount` INTEGER, `completion_lockedCount` INTEGER, `grade_letterGrade` TEXT, `grade_percent` REAL, `grade_isPassing` INTEGER, `grading_assignmentPolicies` TEXT, `grading_gradeRange` TEXT, `grading_assignmentColors` TEXT, `verification_link` TEXT, `verification_status` TEXT, `verification_statusDate` TEXT, PRIMARY KEY(`courseId`))",
         "fields": [
           {
             "fieldPath": "courseId",
@@ -1082,12 +1082,6 @@
             "affinity": "INTEGER",
             "notNull": true
           },
-          {
-            "fieldPath": "assignmentColors",
-            "columnName": "assignment_colors",
-            "affinity": "TEXT",
-            "notNull": false
-          },
           {
             "fieldPath": "certificateData.certStatus",
             "columnName": "certificate_certStatus",
@@ -1160,6 +1154,12 @@
             "affinity": "TEXT",
             "notNull": false
           },
+          {
+            "fieldPath": "gradingPolicy.assignmentColors",
+            "columnName": "grading_assignmentColors",
+            "affinity": "TEXT",
+            "notNull": false
+          },
           {
             "fieldPath": "verificationData.link",
             "columnName": "verification_link",
@@ -1192,7 +1192,7 @@
     "views": [],
     "setupQueries": [
       "CREATE TABLE IF NOT EXISTS room_master_table (id INTEGER PRIMARY KEY,identity_hash TEXT)",
-      "INSERT OR REPLACE INTO room_master_table (id,identity_hash) VALUES(42, 'd6028101c7598e8d1c5dedfcfc73d304')"
+      "INSERT OR REPLACE INTO room_master_table (id,identity_hash) VALUES(42, 'bcf7a22441e12e4c8b6fb332754827bf')"
     ]
   }
 }

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

@@ -29,7 +29,6 @@ data class CourseProgressResponse(
     @SerializedName("user_has_passing_grade") val userHasPassingGrade: Boolean?,
     @SerializedName("verification_data") val verificationData: VerificationData?,
     @SerializedName("disable_progress_graph") val disableProgressGraph: Boolean?,
-    @SerializedName("assignment_colors") val assignmentColors: List<String>?
 ) {
     data class CertificateData(
         @SerializedName("cert_status") val certStatus: String?,
@@ -90,17 +89,26 @@ data class CourseProgressResponse(
 
     data class GradingPolicy(
         @SerializedName("assignment_policies") val assignmentPolicies: List<AssignmentPolicy>?,
-        @SerializedName("grade_range") val gradeRange: Map<String, Float>?
+        @SerializedName("grade_range") val gradeRange: Map<String, Float>?,
+        @SerializedName("assignment_colors") val assignmentColors: List<String>?
     ) {
+        // Temporary solution. Backend will returns color list later
+        val defaultColors = listOf("#fe553a", "#32c0ff", "#a3ff7b", "#ff30ee")
+
         fun mapToRoomEntity() = GradingPolicyDb(
             assignmentPolicies = assignmentPolicies?.map { it.mapToRoomEntity() } ?: emptyList(),
-            gradeRange = gradeRange ?: emptyMap()
+            gradeRange = gradeRange ?: emptyMap(),
+            assignmentColors = assignmentColors ?: defaultColors
         )
 
         fun mapToDomain() = CourseProgress.GradingPolicy(
             assignmentPolicies = assignmentPolicies?.map { it.mapToDomain() } ?: emptyList(),
-            gradeRange = gradeRange ?: emptyMap()
+            gradeRange = gradeRange ?: emptyMap(),
+            assignmentColors = assignmentColors?.map { colorString ->
+                Color(colorString.toColorInt())
+            } ?: defaultColors.map { Color(it.toColorInt()) }
         )
+
         data class AssignmentPolicy(
             @SerializedName("num_droppable") val numDroppable: Int?,
             @SerializedName("num_total") val numTotal: Int?,
@@ -238,9 +246,6 @@ data class CourseProgressResponse(
             userHasPassingGrade = userHasPassingGrade ?: false,
             verificationData = verificationData?.mapToDomain(),
             disableProgressGraph = disableProgressGraph ?: false,
-            assignmentColors = assignmentColors?.map { colorString ->
-                Color(colorString.toColorInt())
-            } ?: listOf()
         )
     }
 
@@ -263,7 +268,6 @@ data class CourseProgressResponse(
             userHasPassingGrade = userHasPassingGrade ?: false,
             verificationData = verificationData?.mapToRoomEntity(),
             disableProgressGraph = disableProgressGraph ?: false,
-            assignmentColors = assignmentColors,
         )
     }
 }

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

@@ -45,8 +45,6 @@ data class CourseProgressEntity(
     val verificationData: VerificationDataDb?,
     @ColumnInfo("disableProgressGraph")
     val disableProgressGraph: Boolean,
-    @ColumnInfo("assignment_colors")
-    val assignmentColors: List<String>?
 ) {
     fun mapToDomain(): CourseProgress {
         return CourseProgress(
@@ -66,9 +64,6 @@ data class CourseProgressEntity(
             userHasPassingGrade = userHasPassingGrade,
             verificationData = verificationData?.mapToDomain(),
             disableProgressGraph = disableProgressGraph,
-            assignmentColors = assignmentColors?.map { colorString ->
-                Color(colorString.toColorInt())
-            } ?: listOf()
         )
     }
 }
@@ -125,11 +120,16 @@ data class GradingPolicyDb(
     @ColumnInfo("assignmentPolicies")
     val assignmentPolicies: List<AssignmentPolicyDb>,
     @ColumnInfo("gradeRange")
-    val gradeRange: Map<String, Float>
+    val gradeRange: Map<String, Float>,
+    @ColumnInfo("assignmentColors")
+    val assignmentColors: List<String>
 ) {
     fun mapToDomain() = CourseProgress.GradingPolicy(
         assignmentPolicies = assignmentPolicies.map { it.mapToDomain() },
-        gradeRange = gradeRange
+        gradeRange = gradeRange,
+        assignmentColors = assignmentColors.map { colorString ->
+            Color(colorString.toColorInt())
+        }
     )
     data class AssignmentPolicyDb(
         @ColumnInfo("numDroppable")

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

@@ -5,7 +5,6 @@ import androidx.compose.ui.graphics.Color
 data class CourseProgress(
     val verifiedMode: String,
     val accessExpiration: String,
-    val assignmentColors: List<Color>,
     val certificateData: CertificateData?,
     val completionSummary: CompletionSummary?,
     val courseGrade: CourseGrade?,
@@ -47,13 +46,15 @@ data class CourseProgress(
             subsection.problemScores.sumOf { it.possible }
         }
 
-    fun getAssignmentGradedPercent(type: String) = sectionScores
-        .flatMap { it.subsections }
-        .filter { it.assignmentType == type }
-        .sumOf { it.percentGraded }
+    fun getAssignmentGradedPercent(type: String): Float {
+        val assignmentSections = sectionScores
+            .flatMap { it.subsections }
+            .filter { it.assignmentType == type }
+        return assignmentSections.sumOf { it.percentGraded }.toFloat() / assignmentSections.size
+    }
 
     fun getAssignmentWeightedGradedPercent(assignmentPolicy: GradingPolicy.AssignmentPolicy): Float {
-        return (assignmentPolicy.weight * getAssignmentGradedPercent(assignmentPolicy.type) * 100.0).toFloat()
+        return (assignmentPolicy.weight * getAssignmentGradedPercent(assignmentPolicy.type) * 100f).toFloat()
     }
 
     fun getTotalWeightPercent() =
@@ -87,7 +88,8 @@ data class CourseProgress(
 
     data class GradingPolicy(
         val assignmentPolicies: List<AssignmentPolicy>,
-        val gradeRange: Map<String, Float>
+        val gradeRange: Map<String, Float>,
+        val assignmentColors: List<Color>,
     ) {
         data class AssignmentPolicy(
             val numDroppable: Int,

course/src/main/java/org/openedx/course/presentation/progress/CourseProgressScreen.kt

@@ -67,8 +67,6 @@ import org.openedx.foundation.presentation.UIMessage
 import org.openedx.foundation.presentation.WindowSize
 import org.openedx.foundation.presentation.windowSizeValue
 
-const val EMPTY_STATE_VIEW_HEIGHT = 0.4f
-
 @Composable
 fun CourseProgressScreen(
     windowSize: WindowSize,
@@ -149,8 +147,8 @@ private fun CourseProgressContent(
                             AssignmentTypeRow(
                                 progress = uiState.progress,
                                 policy = policy,
-                                color = if (uiState.progress.assignmentColors.isNotEmpty()) {
-                                    uiState.progress.assignmentColors[index % uiState.progress.assignmentColors.size]
+                                color = if (gradingPolicy.assignmentColors.isNotEmpty()) {
+                                    gradingPolicy.assignmentColors[index % gradingPolicy.assignmentColors.size]
                                 } else {
                                     MaterialTheme.appColors.primary
                                 }
@@ -170,8 +168,8 @@ private fun CourseProgressContent(
                         item {
                             Box(
                                 modifier = Modifier
-                                    .fillParentMaxHeight(EMPTY_STATE_VIEW_HEIGHT)
-                                    .fillMaxWidth(),
+                                    .fillMaxSize()
+                                    .padding(top = 60.dp),
                                 contentAlignment = Alignment.Center
                             ) {
                                 NoGradesView()
@@ -317,7 +315,7 @@ private fun OverallGradeView(
                     )
             ) {
                 gradingPolicy.assignmentPolicies.forEach { assignmentPolicy ->
-                    val assignmentColors = progress.assignmentColors
+                    val assignmentColors = gradingPolicy.assignmentColors
                     val color = if (assignmentColors.isNotEmpty()) {
                         assignmentColors[
                             gradingPolicy.assignmentPolicies.indexOf(
@@ -394,7 +392,7 @@ private fun OverallGradeView(
                 Text(
                     text = stringResource(
                         R.string.course_progress_required_grade_percent,
-                        progress.requiredGradePercent
+                        progress.requiredGradePercent.toString()
                     ),
                     style = MaterialTheme.appTypography.labelLarge,
                     color = MaterialTheme.appColors.textDark,

course/src/main/java/org/openedx/course/presentation/progress/CourseProgressViewModel.kt

@@ -11,9 +11,9 @@ import kotlinx.coroutines.flow.asStateFlow
 import kotlinx.coroutines.flow.catch
 import kotlinx.coroutines.flow.collectLatest
 import kotlinx.coroutines.launch
-import org.openedx.core.system.notifier.CourseCompletionSet
 import org.openedx.core.system.notifier.CourseLoading
 import org.openedx.core.system.notifier.CourseNotifier
+import org.openedx.core.system.notifier.CourseStructureUpdated
 import org.openedx.core.system.notifier.RefreshProgress
 import org.openedx.course.domain.interactor.CourseInteractor
 import org.openedx.foundation.presentation.BaseViewModel
@@ -64,7 +64,7 @@ class CourseProgressViewModel(
         viewModelScope.launch {
             courseNotifier.notifier.collect { event ->
                 when (event) {
-                    is RefreshProgress, is CourseCompletionSet -> loadCourseProgress(true)
+                    is RefreshProgress, is CourseStructureUpdated -> loadCourseProgress(true)
                 }
             }
         }

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

@@ -41,7 +41,7 @@
     <string name="course_progress_overall_title">Overall Grade</string>
     <string name="course_progress_overall_description">This represents your weighted grade against the grade needed to pass this course.</string>
     <string name="course_progress_current_overall">Current Overall Weighted Grade:</string>
-    <string name="course_progress_required_grade_percent">A weighted grade of %1$d%% is required to pass this course</string>
+    <string name="course_progress_required_grade_percent">A weighted grade of %1$s%% is required to pass this course</string>
     <string name="course_progress_grade_details">Grade Details</string>
     <string name="course_progress_assignment_type">Assignment Type</string>
     <string name="course_progress_current_max">Current / Max %</string>