Enable changing display type of weights (factor or percentage) (#1712)

Adds changing the display type of weights (as factor or as percent) in the term settings. [Changing weight display type.webm](https://github.com/user-attachments/assets/131389f5-771e-4451-ae5b-fac602811370) | Before | After | |--------|--------| | ![before](https://raw.githubusercontent.com/SharezoneApp/sharezone-app/main/app/test_goldens/grades/pages/term_settings_page/goldens/terms_settings_page_with_data_2_light.iphone11.png) | ![after](https://raw.githubusercontent.com/SharezoneApp/sharezone-app/fc0488322cea9c65a1d065a140b5c08fb781c89b/app/test_goldens/grades/pages/term_settings_page/goldens/terms_settings_page_with_data_2_light.iphone11.png) | The numbers are currently rounded in the weight overview, I'll fix this in another PR.
SharezoneApp · Aug 21, 2024 · abb86c1 · abb86c1
1 parent c9c0aac
commit abb86c1
Show file tree

Hide file tree

Showing 28 changed files with 490 additions and 97 deletions.
diff --git a/app/lib/grades/grades_service/grades_service.dart b/app/lib/grades/grades_service/grades_service.dart
@@ -180,6 +180,11 @@ class TermRef {
   void removeGradeTypeWeight(GradeTypeId gradeType) {
     _service.removeGradeTypeWeightForTerm(termId: id, gradeType: gradeType);
   }
+
+  void changeWeightDisplayType(WeightDisplayType weightDisplayType) {
+    _service.changeWeightDisplayTypeForTerm(
+        termId: id, weightDisplayType: weightDisplayType);
+  }
 }
 
 class TermSubjectRef {
@@ -552,6 +557,7 @@ class TermResult extends Equatable {
   final String name;
   final GradeType finalGradeType;
   final IMap<GradeTypeId, Weight> gradeTypeWeightings;
+  final WeightDisplayType weightDisplayType;
 
   SubjectResult subject(SubjectId id) {
     final subject = subjects.firstWhere((element) => element.id == id);
@@ -567,6 +573,7 @@ class TermResult extends Equatable {
     required this.isActiveTerm,
     required this.finalGradeType,
     required this.gradeTypeWeightings,
+    required this.weightDisplayType,
   });
 
   @override
@@ -579,6 +586,7 @@ class TermResult extends Equatable {
         name,
         finalGradeType,
         gradeTypeWeightings,
+        weightDisplayType,
       ];
 }
 
@@ -663,6 +671,8 @@ extension on GradeInput {
   }
 }
 
+enum WeightDisplayType { percent, factor }
+
 enum WeightType {
   perGrade,
   perGradeType,

diff --git a/app/lib/grades/grades_service/src/grades_repository.dart b/app/lib/grades/grades_service/src/grades_repository.dart
@@ -287,6 +287,7 @@ class FirestoreGradesStateRepository extends GradesStateRepository {
             createdOn: dto.createdOn?.toDate(),
             gradingSystem: dto.gradingSystem.toGradingSystemModel(),
             isActiveTerm: data['currentTerm'] == dto.id,
+            weightDisplayType: dto.weightDisplayType,
             subjects: termSubjects
                 .where((subject) => subject.termId.value == dto.id)
                 .toIList(),
@@ -436,6 +437,7 @@ class TermDto {
   final Timestamp? createdOn;
   final GradingSystem gradingSystem;
   final Map<_SubjectId, WeightDto> subjectWeights;
+  final WeightDisplayType weightDisplayType;
   final Map<_GradeTypeId, WeightDto> gradeTypeWeights;
   final List<TermSubjectDto> subjects;
   final _GradeTypeId finalGradeTypeId;
@@ -446,6 +448,7 @@ class TermDto {
     required this.createdOn,
     required this.gradingSystem,
     required this.subjectWeights,
+    required this.weightDisplayType,
     required this.gradeTypeWeights,
     required this.finalGradeTypeId,
     required this.subjects,
@@ -459,6 +462,7 @@ class TermDto {
       finalGradeTypeId: term.finalGradeType.value,
       gradingSystem: term.gradingSystem.spec.gradingSystem,
       subjects: term.subjects.map(TermSubjectDto.fromSubject).toList(),
+      weightDisplayType: term.weightDisplayType,
       subjectWeights: Map.fromEntries(term.subjects.map((subject) =>
           MapEntry(subject.id.value, subject.weightingForTermGrade.toDto()))),
       gradeTypeWeights: term.gradeTypeWeightings
@@ -475,6 +479,9 @@ class TermDto {
       gradingSystem:
           GradingSystem.values.byName(data['gradingSystem'] as String),
       subjectWeights: data['subjectWeights'].toWeightsDtoMap(),
+      weightDisplayType: data['weightDisplayType'] is String
+          ? WeightDisplayType.values.byName(data['weightDisplayType'] as String)
+          : WeightDisplayType.factor,
       gradeTypeWeights: data['gradeTypeWeights'].toWeightsDtoMap(),
       subjects: (data['subjects'] as Map)
           .mapTo((_, sub) => TermSubjectDto.fromData(sub))
@@ -491,6 +498,7 @@ class TermDto {
       if (createdOn == null) 'createdOn': FieldValue.serverTimestamp(),
       'gradingSystem': gradingSystem.name,
       'subjectWeights': subjectWeights.toWeightDataMap(),
+      'weightDisplayType': weightDisplayType.name,
       'gradeTypeWeights': gradeTypeWeights.toWeightDataMap(),
       'subjects': subjects
           .map((subject) => MapEntry(subject.id, subject.toData()))

diff --git a/app/lib/grades/grades_service/src/grades_service_internal.dart b/app/lib/grades/grades_service/src/grades_service_internal.dart
@@ -64,6 +64,7 @@ class _GradesServiceInternal {
           ? term.gradingSystem.toGradeResult(term.tryGetTermGrade()!)
           : null,
       gradeTypeWeightings: term.gradeTypeWeightings,
+      weightDisplayType: term.weightDisplayType,
       subjects: term.subjects
           .map(
             (subject) => SubjectResult(
@@ -330,6 +331,12 @@ class _GradesServiceInternal {
     _updateTerm(newTerm);
   }
 
+  void changeWeightDisplayTypeForTerm(
+      {required TermId termId, required WeightDisplayType weightDisplayType}) {
+    final newTerm = _term(termId).changeWeightDisplayType(weightDisplayType);
+    _updateTerm(newTerm);
+  }
+
   void changeGradeTypeWeightForTerm(
       {required TermId termId,
       required GradeTypeId gradeType,

diff --git a/app/lib/grades/grades_service/src/term.dart b/app/lib/grades/grades_service/src/term.dart
@@ -20,13 +20,15 @@ class TermModel extends Equatable {
   final GradeTypeId finalGradeType;
   final bool isActiveTerm;
   final String name;
+  final WeightDisplayType weightDisplayType;
 
   @override
   List<Object?> get props => [
         id,
         createdOn,
         subjects,
         gradeTypeWeightings,
+        weightDisplayType,
         gradingSystem,
         finalGradeType,
         isActiveTerm,
@@ -42,12 +44,14 @@ class TermModel extends Equatable {
     this.createdOn,
     this.subjects = const IListConst([]),
     this.gradeTypeWeightings = const IMapConst({}),
+    this.weightDisplayType = WeightDisplayType.factor,
   });
 
   const TermModel.internal(
     this.id,
     this.subjects,
     this.gradeTypeWeightings,
+    this.weightDisplayType,
     this.finalGradeType,
     this.isActiveTerm,
     this.name,
@@ -93,6 +97,7 @@ class TermModel extends Equatable {
     TermId? id,
     IList<SubjectModel>? subjects,
     IMap<GradeTypeId, Weight>? gradeTypeWeightings,
+    WeightDisplayType? weightDisplayType,
     GradeTypeId? finalGradeType,
     bool? isActiveTerm,
     String? name,
@@ -103,6 +108,7 @@ class TermModel extends Equatable {
       id ?? this.id,
       subjects ?? this.subjects,
       gradeTypeWeightings ?? this.gradeTypeWeightings,
+      weightDisplayType ?? this.weightDisplayType,
       finalGradeType ?? this.finalGradeType,
       isActiveTerm ?? this.isActiveTerm,
       name ?? this.name,
@@ -322,6 +328,10 @@ class TermModel extends Equatable {
   bool containsGrade(GradeId id) {
     return subjects.any((s) => s.hasGrade(id));
   }
+
+  TermModel changeWeightDisplayType(WeightDisplayType weightDisplayType) {
+    return _copyWith(weightDisplayType: weightDisplayType);
+  }
 }
 
 class SubjectModel extends Equatable {