get more detailed report

Author: rockstarr-programmerr

classroom/business/all/student_report.py

@@ -16,13 +16,22 @@ def make(self):
 
             if submission:
                 report['submitted'] = True
-                questions = exercise.questions.all()
+                questions = exercise.questions.all().prefetch_related('answers')
                 answers = submission.answers.all()
 
-                report['passage_1'] = self.calculate_score(questions, answers, 1)
-                report['passage_2'] = self.calculate_score(questions, answers, 2)
-                report['passage_3'] = self.calculate_score(questions, answers, 3)
-                report['total'] = report['passage_1'] + report['passage_2'] + report['passage_3']
+                passage_1_report = self.passage_report(questions, answers, 1)
+                passage_2_report = self.passage_report(questions, answers, 2)
+                passage_3_report = self.passage_report(questions, answers, 3)
+
+                report['passage_1_total'], report['passage_1_detail'] = passage_1_report
+                report['passage_2_total'], report['passage_2_detail'] = passage_2_report
+                report['passage_3_total'], report['passage_3_detail'] = passage_3_report
+
+                report['total'] = (
+                    report['passage_1_total'] +
+                    report['passage_2_total'] +
+                    report['passage_3_total']
+                )
                 report['band_score'] = self.calculate_band(report['total'])
 
             reports.append(report)
@@ -33,35 +42,58 @@ def make(self):
     def new_report(exercise):
         return {
             'exercise': exercise.identifier,
-            'passage_1': 0,
-            'passage_2': 0,
-            'passage_3': 0,
+            'passage_1_total': 0,
+            'passage_2_total': 0,
+            'passage_3_total': 0,
+            'passage_1_detail': [],
+            'passage_2_detail': [],
+            'passage_3_detail': [],
             'total': 0,
             'band_score': 1,
             'submitted': False,
         }
 
+    @staticmethod
+    def new_detail():
+        return {
+            'question_number': None,
+            'submitted_answer': '',
+            'possible_answers': [],
+            'is_correct': False,
+        }
+
     def get_exercises(self):
         return self.classroom.reading_exercises.all().prefetch_related('questions')
 
     def get_submission(self, exercise):
         return exercise.submissions.filter(submitter=self.student).prefetch_related('answers').first()
 
-    def calculate_score(self, questions, answers, passage):
+    def passage_report(self, questions, answers, passage):
         questions = filter(
             lambda question: getattr(question, f'is_passage_{passage}')(),
             questions
         )
 
         score = 0
+        details = []
         for question in questions:
+            detail = self.new_detail()
             answer = self.get_answer(answers, question)
+
+            detail['question_number'] = question.number
+            detail['possible_answers'] = question.get_answers_content()
+
             if answer:
                 is_correct = question.check_answer(answer.content)
                 if is_correct:
                     score += 1
 
-        return score
+                detail['submitted_answer'] = answer.content
+                detail['is_correct'] = is_correct
+
+            details.append(detail)
+
+        return score, details
 
     @staticmethod
     def calculate_band(score):

classroom/migrations/0014_alter_readingquestion_options.py

@@ -0,0 +1,17 @@
+# Generated by Django 3.2.7 on 2021-10-07 16:50
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('classroom', '0013_alter_readingsubmission_unique_together'),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='readingquestion',
+            options={'ordering': ['exercise', 'number']},
+        ),
+    ]

classroom/models/reading_question.py

@@ -10,7 +10,7 @@ class ReadingQuestion(Question):
     passage = models.PositiveSmallIntegerField(default=1)
 
     class Meta:
-        ordering = ['exercise']
+        ordering = ['exercise', 'number']
 
     def __str__(self):
         return f'{self.exercise.identifier} | {self.get_question_type_display()}'

classroom/serializers/classroom.py

@@ -52,12 +52,22 @@ class RemoveReadingExerciseSerializer(serializers.Serializer):
     pk = serializers.IntegerField()
 
 
+class _PassageDetailSerializer(serializers.Serializer):
+    question_number = serializers.IntegerField()
+    submitted_answer = serializers.CharField()
+    possible_answers = serializers.ListField(child=serializers.CharField())
+    is_correct = serializers.BooleanField()
+
+
 class StudentReadingReportSerializer(serializers.Serializer):
     student = serializers.IntegerField(write_only=True)
     exercise = serializers.CharField(read_only=True)
-    passage_1 = serializers.IntegerField(read_only=True)
-    passage_2 = serializers.IntegerField(read_only=True)
-    passage_3 = serializers.IntegerField(read_only=True)
+    passage_1_total = serializers.IntegerField(read_only=True)
+    passage_2_total = serializers.IntegerField(read_only=True)
+    passage_3_total = serializers.IntegerField(read_only=True)
     total = serializers.IntegerField(read_only=True)
     band_score = serializers.FloatField(read_only=True)
     submitted = serializers.BooleanField(read_only=True)
+    passage_1_detail = _PassageDetailSerializer(read_only=True, many=True)
+    passage_2_detail = _PassageDetailSerializer(read_only=True, many=True)
+    passage_3_detail = _PassageDetailSerializer(read_only=True, many=True)