Merge pull request #149 from codersforcauses/i144-update_statistics_to_match_new_scope

LJW-Dev · web-flow · commit 65ab55a6b795 · 2022-07-24T00:38:56.000+08:00
I144 update statistics to match new scope
diff --git a/documentation/docs/backend/quiz/shared_models.md b/documentation/docs/backend/quiz/shared_models.md
@@ -8,21 +8,24 @@ The `shared_models` app is designed to hold the models and serializers that need
 
 ### Quiz
 
-There are three shared quiz models:
+There are four shared quiz models:
 
 * Question - a model representing a generic quiz question. Questions come in three types (represented by the `question_type` field): multiple choice, numerical answer and short answer.
-* Tag - a model representing a generic tag which can be attached to many Questions (and each Question may have many associated Tags). Example Tags would include the subject and unit of study the question pertains to, as well as the topic within that subject/unit. Tags will be able to be created and modified by admins for regular users to use to tag their questions.
+* Topic - a model representing a specific subject topic. Topics can be attached to many Questions (and each Question may have many associated topics). topics will be able to be created and modified by admins for regular users to use to tag their questions.
+* Subject - a model representing a school subject. There can be many topics for one subject. Subjects are not connected to questions, as it is simpler for the backend to derive the subjects from the topics instead of having both topics and subjects connected to a question which complicates things. Subjects can also be created and modified by admins.
 * Answer - a model representing an answer associated with a particular Question. Each Question can have multiple associated answers. Each answer can be marked as being correct or incorrect. For the three different types of Question, the intended use of the Answer model varies:
   * For multiple choice questions, each Answer will appear as an option for the user taking the quiz to select. One or more Answers will be correct, and the remaining Answers will be incorrect.
   * For numerical answer questions, no options will be displayed, and the user must enter a numerical value into a text field. Each of the Answers associated with such a Question should have `is_correct = True`, and if the user's input matches any of these answers, they will be marked correct. Answers which have `is_correct = False` will not do anything and hence **should not be added** to numerical answer questions.
   * For short answer questions, the user will be given an extended text field to enter their answer into. Due to the nature of this question, automated marking is not possible, and so the user will have to self-mark their response. Upon submitting their answer, all Answers associated to the Question with `is_correct = True` will be displayed for the user to compare their response to. As with numerical answer questions, Answers with `is_correct = False` will not do anything and hence **should not be added**.
 
 ### Statistics
 
-* QuestionResponse - a model representing a response to a Question submitted by a User, stored in the database for statistics purposes. The QuestionResponse model contains all of the necessary data for the following statistics to be surmised, as per the client's requirements:
-  * How long the User took to complete the Question
-  * How many Users in total have attempted a given Question
-  * How many Users have gotten the Question right and how many have gotten it wrong
+* QuizStatistics - a model representing a response to a Quiz submitted by a User, stored in the database for statistics purposes. The QuizStatistics model contains all of the necessary data for the following statistics to be surmised, as per the client's requirements:
+  * How many questions the quiz has
+  * Total marks and the user's mark
+  * How long the User took to complete the Quiz
+  * When the quiz was taken
+  * How many Users in total have attempted a given Quiz
   * The average score (across all Users) for a given Question
   * The average score (across all Users) for a given Tag (i.e. subject and topic)
 
diff --git a/server/api/apps/shared_models/admin.py b/server/api/apps/shared_models/admin.py
@@ -1,24 +1,30 @@
 from django.contrib import admin
-from .models.quiz_models import Question, Tag, Answer
-from .models.statistics_models import QuestionResponse
+from .models.quiz_models import Question, Subject, Topic, Answer
+from .models.statistics_models import QuizStatistics
 
 
 class AnswerInline(admin.TabularInline):
     model = Answer
 
 
-class TagInline(admin.TabularInline):
-    model = Tag.question.through
-    verbose_name = "Tag"
+class SubjectInline(admin.TabularInline):
+    model = Topic.question.through
+    verbose_name = "Subject"
+
+
+class TopicInline(admin.TabularInline):
+    model = Subject
+    verbose_name = "Topic"
 
 
 @admin.register(Question)
 class QuestionAdmin(admin.ModelAdmin):
     inlines = [
         AnswerInline,
-        TagInline,
+        SubjectInline,
     ]
 
 
-admin.site.register(Tag)
-admin.site.register(QuestionResponse)
+admin.site.register(Subject)
+admin.site.register(Topic)
+admin.site.register(QuizStatistics)
diff --git a/server/api/apps/shared_models/migrations/0005_quizstatistics_subject_topic_remove_tag_question_and_more.py b/server/api/apps/shared_models/migrations/0005_quizstatistics_subject_topic_remove_tag_question_and_more.py
@@ -0,0 +1,123 @@
+# Generated by Django 4.0.6 on 2022-07-23 06:02
+
+import datetime
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ("shared_models", "0004_question_creator_questionresponse_user"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="QuizStatistics",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("name", models.CharField(max_length=200)),
+                ("question_count", models.PositiveIntegerField()),
+                ("total_marks", models.PositiveIntegerField()),
+                ("user_mark", models.PositiveIntegerField()),
+                (
+                    "time_taken",
+                    models.DurationField(default=datetime.timedelta(0)),
+                ),
+                (
+                    "date_taken",
+                    models.DateTimeField(auto_now_add=True, null=True),
+                ),
+            ],
+        ),
+        migrations.CreateModel(
+            name="Subject",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("name", models.CharField(max_length=100)),
+            ],
+        ),
+        migrations.CreateModel(
+            name="Topic",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("name", models.CharField(max_length=100)),
+                (
+                    "subject",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to="shared_models.subject",
+                    ),
+                ),
+            ],
+        ),
+        migrations.RemoveField(
+            model_name="tag",
+            name="question",
+        ),
+        migrations.AddField(
+            model_name="question",
+            name="is_verified",
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name="question",
+            name="mark",
+            field=models.PositiveIntegerField(null=True),
+        ),
+        migrations.DeleteModel(
+            name="QuestionResponse",
+        ),
+        migrations.DeleteModel(
+            name="Tag",
+        ),
+        migrations.AddField(
+            model_name="subject",
+            name="question",
+            field=models.ManyToManyField(to="shared_models.question"),
+        ),
+        migrations.AddField(
+            model_name="quizstatistics",
+            name="subjects",
+            field=models.ManyToManyField(to="shared_models.subject"),
+        ),
+        migrations.AddField(
+            model_name="quizstatistics",
+            name="topics",
+            field=models.ManyToManyField(to="shared_models.topic"),
+        ),
+        migrations.AddField(
+            model_name="quizstatistics",
+            name="user",
+            field=models.ForeignKey(
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                to=settings.AUTH_USER_MODEL,
+            ),
+        ),
+    ]
diff --git a/server/api/apps/shared_models/migrations/0006_remove_subject_question_topic_question.py b/server/api/apps/shared_models/migrations/0006_remove_subject_question_topic_question.py
@@ -0,0 +1,24 @@
+# Generated by Django 4.0.6 on 2022-07-23 11:02
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        (
+            "shared_models",
+            "0005_quizstatistics_subject_topic_remove_tag_question_and_more",
+        ),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="subject",
+            name="question",
+        ),
+        migrations.AddField(
+            model_name="topic",
+            name="question",
+            field=models.ManyToManyField(to="shared_models.question"),
+        ),
+    ]
diff --git a/server/api/apps/shared_models/models/quiz_models.py b/server/api/apps/shared_models/models/quiz_models.py
@@ -19,14 +19,24 @@ class QuestionType(models.TextChoices):
         settings.AUTH_USER_MODEL, on_delete=models.SET_NULL, null=True
     )
     date_created = models.DateTimeField(auto_now_add=True, null=True)
+    is_verified = models.BooleanField(default=False)
+    mark = models.PositiveIntegerField(null=True)
 
     def __str__(self):
         return self.text
 
 
-class Tag(models.Model):
+class Subject(models.Model):
+    name = models.CharField(max_length=defines.TAG_NAME_MAXLEN)
+
+    def __str__(self):
+        return self.name
+
+
+class Topic(models.Model):
     name = models.CharField(max_length=defines.TAG_NAME_MAXLEN)
     question = models.ManyToManyField(Question)
+    subject = models.ForeignKey(Subject, on_delete=models.CASCADE)
 
     def __str__(self):
         return self.name
diff --git a/server/api/apps/shared_models/models/statistics_models.py b/server/api/apps/shared_models/models/statistics_models.py
@@ -1,21 +1,22 @@
 from django.conf import settings
 from django.db import models
-from .quiz_models import Question, Answer
-
+from .quiz_models import Subject, Topic
+from . import defines
 from datetime import timedelta
 
 
-class QuestionResponse(models.Model):
+class QuizStatistics(models.Model):
     user = models.ForeignKey(
         settings.AUTH_USER_MODEL, on_delete=models.SET_NULL, null=True
     )
-    question = models.ForeignKey(Question, on_delete=models.CASCADE)
-    selected_answer = models.ForeignKey(
-        Answer, on_delete=models.CASCADE, null=True
-    )
-    is_correct = models.BooleanField(default=False)
+    name = models.CharField(max_length=defines.QUIZ_NAME_MAXLEN)
+    question_count = models.PositiveIntegerField()
+    total_marks = models.PositiveIntegerField()
+    user_mark = models.PositiveIntegerField()
+    subjects = models.ManyToManyField(Subject)
+    topics = models.ManyToManyField(Topic)
     time_taken = models.DurationField(default=timedelta())
-    date_created = models.DateTimeField(auto_now_add=True, null=True)
+    date_taken = models.DateTimeField(auto_now_add=True, null=True)
 
     def __str__(self):
-        return str((self.question, self.selected_answer))
+        return str(self.name)
diff --git a/server/api/apps/shared_models/serializers/quiz_serializers.py b/server/api/apps/shared_models/serializers/quiz_serializers.py
@@ -5,16 +5,22 @@
 class QuestionSerializer(serializers.HyperlinkedModelSerializer):
     class Meta:
         model = Question
-        fields = ["id", "text", "question_type", "date_created"]
+        fields = ["id", "text", "question_type", "date_created", "mark"]
 
 
-class TagSerializer(serializers.HyperlinkedModelSerializer):
+class SubjectSerializer(serializers.HyperlinkedModelSerializer):
     class Meta:
         model = Tag
-        fields = ["id", "name", "question"]
+        fields = ["id", "name"]
+
+
+class TopicSerializer(serializers.HyperlinkedModelSerializer):
+    class Meta:
+        model = Tag
+        fields = ["id", "name"]
 
 
 class AnswerSerializer(serializers.HyperlinkedModelSerializer):
     class Meta:
         model = Answer
-        fields = ["id", "text", "is_correct", "question"]
+        fields = ["id", "text", "is_correct"]
diff --git a/server/api/apps/shared_models/serializers/statistics_serializers.py b/server/api/apps/shared_models/serializers/statistics_serializers.py
@@ -7,9 +7,9 @@ class Meta:
         model = QuestionResponse
         fields = [
             "id",
-            "question",
-            "selected_answer",
-            "is_correct",
+            "question_count",
+            "total_marks",
+            "user_mark",
             "time_taken",
-            "date_created",
+            "date_taken",
         ]
diff --git a/server/api/apps/shared_models/tests/test_quiz.py b/server/api/apps/shared_models/tests/test_quiz.py
@@ -1,6 +1,6 @@
 from django.test import TestCase
 from django.utils import timezone
-from ..models.quiz_models import Question, Tag, Answer
+from ..models.quiz_models import Question, Answer, Subject, Topic
 
 MC = Question.QuestionType.MULTICHOICE
 NA = Question.QuestionType.NUMERIC
@@ -58,15 +58,16 @@ def setUp(self):
         q = Question.objects.create(
             text="This is a physics question", question_type=NA
         )
-        t = Tag.objects.create(name="Unit 3 Physics")
-        q.tag_set.add(t)
+        s = Subject.objects.create(name="Physics")
+        t = Topic.objects.create(name="Unit 3 Physics", subject=s)
+        q.topic_set.add(t)
 
     def test(self):
         q = Question.objects.get(text="This is a physics question")
-        t = Tag.objects.get(name="Unit 3 Physics")
+        t = Topic.objects.get(name="Unit 3 Physics")
         self.assertEqual(str(t), "Unit 3 Physics")
 
-        self.assertTrue(t in q.tag_set.all())
+        self.assertTrue(t in q.topic_set.all())
 
 
 class AnswerTestCase(TestCase):
diff --git a/server/api/apps/shared_models/tests/test_statistics.py b/server/api/apps/shared_models/tests/test_statistics.py
@@ -1,7 +1,7 @@
 from django.test import TestCase
 from django.utils import timezone
-from ..models.quiz_models import Question, Answer
-from ..models.statistics_models import QuestionResponse
+from ..models.quiz_models import Question
+from ..models.statistics_models import QuizStatistics
 
 from datetime import timedelta
 
@@ -11,27 +11,23 @@
 class QuestionTestCase(TestCase):
     def setUp(self):
         self.creation_time = timezone.now()
-        q = Question.objects.create(text="Question?", question_type=MC)
-        a = Answer.objects.create(text="Answer!", question=q, is_correct=True)
-        QuestionResponse.objects.create(
-            question=q,
-            selected_answer=a,
-            is_correct=a.is_correct,
+        QuizStatistics.objects.create(
+            name="name",
+            question_count=3,
+            total_marks=3,
+            user_mark=2,
             time_taken=timedelta(seconds=5),
         )
 
     def test(self):
-        q = Question.objects.get(text="Question?")
-        a = Answer.objects.get(text="Answer!")
-        qr = QuestionResponse.objects.all()[0]
+        qr = QuizStatistics.objects.all()[0]
 
-        self.assertEquals(str(qr), str((q, a)))
         self.assertIsNone(qr.user)
-        self.assertEquals(qr.question, q)
-        self.assertEquals(qr.selected_answer, a)
-        self.assertEquals(qr.is_correct, a.is_correct)
-        self.assertEquals(qr.is_correct, True)
+        self.assertEquals(qr.name, "name")
+        self.assertEquals(qr.question_count, 3)
+        self.assertEquals(qr.total_marks, 3)
+        self.assertEquals(qr.user_mark, 2)
         self.assertEquals(qr.time_taken, timedelta(seconds=5))
         self.assertLess(
-            (qr.date_created - self.creation_time).total_seconds(), 0.1
+            (qr.date_taken - self.creation_time).total_seconds(), 0.1
         )
diff --git a/server/api/settings.py b/server/api/settings.py
