feat: Assessments app Initial model structure

apps/assessments/README.md

@@ -0,0 +1 @@
+# Assessments App

apps/assessments/choices.py

@@ -0,0 +1,8 @@
+# HTK Imports
+from htk.apps.assessments.enums import QuestionType
+from htk.utils.enums import get_enum_choices
+
+
+def get_question_type_choices(include_hidden=True):
+    choices = get_enum_choices(QuestionType, include_hidden=include_hidden)
+    return choices

apps/assessments/constants/defaults.py

@@ -0,0 +1,4 @@
+HTK_ASSESSMENTS_ASSESSMENT_MODEL = 'htk.Assessment'
+HTK_ASSESSMENTS_QUESTION_MODEL = 'htk.Question'
+HTK_ASSESSMENTS_QUESTION_CHOICE_MODEL = 'htk.QuestionChoice'
+HTK_ASSESSMENTS_ANSWER_MODEL = 'htk.Answer'

apps/assessments/enums.py

@@ -0,0 +1,13 @@
+# HTK Imports
+from htk.utils.enums import HtkEnum
+
+
+class QuestionType(HtkEnum):
+    UNSPECIFIED = 0
+    # Answer is a free text response
+    BASIC = 1
+    # Multiple answer choices are presented, only one is correct
+    MULTI_CHOICE = 2
+    # Multiple answer choices are presented, any number (0 or many) can be correct,
+    # all correct responses must be selected
+    MULTI_CHOICE_MULTI_ANSWER = 4

apps/assessments/models/answer.py

@@ -0,0 +1,22 @@
+# Django Imports
+from django.db import models
+
+# HTK Imports
+from htk.apps.assessments.models.fk_fields import (
+    fk_question,
+    fk_question_choice,
+)
+from htk.models.classes import HtkBaseModel
+from htk.models.fk_fields import fk_user
+
+
+DEFAULT_RELATED_NAME = 'answers'
+
+
+class Answer(HtkBaseModel):
+    user = fk_user(DEFAULT_RELATED_NAME, required=True)
+    question = fk_question(DEFAULT_RELATED_NAME, required=True)
+    choice = fk_question_choice(DEFAULT_RELATED_NAME)
+
+    class Meta:
+        verbose_name = 'Assessment Question Answer'

apps/assessments/models/answer_key.py

@@ -0,0 +1,21 @@
+# Django Imports
+from django.db import models
+
+# HTK Imports
+from htk.apps.assessments.models.fk_fields import (
+    fk_assessment,
+    fk_question,
+)
+from htk.models.classes import HtkBaseModel
+
+
+DEFAULT_RELATED_NAME = 'answer_key'
+DEFAULT_RELATED_NAME_PLURAL = 'answer_keys'
+
+
+class AssessmentQuestionAnswerKey(HtkBaseModel):
+    assessment = fk_assessment(DEFAULT_RELATED_NAME_PLURAL, required=True)
+    question = fk_question(DEFAULT_RELATED_NAME, required=True, one_to_one=True)
+
+    class Meta:
+        verbose_name = 'Assessment Question Answer Key'

apps/assessments/models/assessment.py

@@ -0,0 +1,11 @@
+# HTK Imports
+from htk.models.classes import HtkBaseModel
+
+
+class Assessment(HtkBaseModel):
+    class Meta:
+        verbose_name = 'Assessment'
+
+    @property
+    def max_score(self):
+        return self.questions.count()

apps/assessments/models/fk_fields.py

@@ -0,0 +1,35 @@
+# Django Imports
+from django.db import models
+
+# HTK Imports
+from htk.models.fk_fields import build_kwargs
+from htk.utils import htk_setting
+
+
+def fk_assessment(related_name, required=False):
+    field = models.ForeignKey(
+        htk_setting('HTK_ASSESSMENTS_ASSESSMENT_MODEL'),
+        related_name=related_name,
+        **build_kwargs(required=required),
+    )
+    return field
+
+
+def fk_question(related_name, required=False, one_to_one=False):
+    method_name = 'OneToOneField' if one_to_one else 'ForeignKey'
+    field_method = getattr(models, method_name)
+    field = field_method(
+        htk_setting('HTK_ASSESSMENTS_QUESTION_MODEL'),
+        related_name=related_name,
+        **build_kwargs(required=required),
+    )
+    return field
+
+
+def fk_question_choice(related_name, required=False):
+    field = models.ForeignKey(
+        htk_setting('HTK_ASSESSMENTS_QUESTION_MODEL'),
+        related_name=related_name,
+        **build_kwargs(required=required),
+    )
+    return field

apps/assessments/models/question.py

@@ -0,0 +1,60 @@
+# Python Standard Library Imports
+import random
+
+# Django Imports
+from django.db import models
+
+# HTK Imports
+from htk.apps.assessments.choices import get_question_type_choices
+from htk.apps.assessments.enums import QuestionType
+from htk.apps.assessments.models.fk_fields import fk_assessment
+from htk.models.classes import HtkBaseModel
+
+
+DEFAULT_RELATED_NAME = 'questions'
+
+
+class AssessmentQuestion(HtkBaseModel):
+    assessment = fk_assessment(DEFAULT_RELATED_NAME, required=True)
+    type = models.PositiveIntegerField(
+        choices=get_question_type_choices(), default=QuestionType.UNSPECIFIED
+    )
+    text = models.TextField(max_length=512)
+    order = models.PositiveSmallIntegerField(default=0)
+    should_shuffle_choices = models.BooleanField(default=False)
+
+    class Meta:
+        verbose_name = 'Assessment Question'
+
+    ##
+    # Properties
+
+    @property
+    def choices_ordered(self):
+        choices = self.choices.order_by('order')
+        return choices
+
+    @property
+    def choices_shuffled(self):
+        choices = self.choices.all()
+        random.shuffle(choices)
+        return choices
+
+    @property
+    def all_choices(self):
+        choices = (
+            self.choices_shuffled
+            if self.should_shuffle_choices
+            else self.choices_ordered
+        )
+        return choices
+
+    ##
+    # Helpers
+
+    def is_answered_by_user(self, user, check_correction=False):
+        answers = user.answers.filter(choice__question=self)
+        if check_correction:
+            answers = answers.filter(choice__is_correct=True)
+        is_answered = answers.exists()
+        return is_answered

apps/assessments/models/response.py

@@ -0,0 +1,17 @@
+# HTK Imports
+from htk.apps.assessments.models.fk_fields import (
+    fk_assessment,
+    fk_question,
+)
+from htk.models.classes import HtkBaseModel
+
+
+DEFAULT_RELATED_NAME = 'responses'
+
+
+class AssessmentResponse(HtkBaseModel):
+    assessment = fk_assessment(DEFAULT_RELATED_NAME, required=True)
+    question = fk_question(DEFAULT_RELATED_NAME, required=True)
+
+    class Meta:
+        verbose_name = 'Assessment Question Response'