feat: add support for dependent answers

fahari/sims/migrations/0001_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 3.2.9 on 2021-11-16 18:06
+# Generated by Django 3.2.9 on 2021-11-19 10:00
 
 from django.db import migrations, models
 import django.db.models.deletion
@@ -28,6 +28,7 @@ class Migration(migrations.Migration):
                 ('updated_by', models.UUIDField(blank=True, null=True)),
                 ('precedence_display_type', models.CharField(blank=True, choices=[('bullet', 'Bullets'), ('numbered_td', 'Numbered with a trailing dot, E.g. 1., 2., 3.'), ('lower_case_letters_tcb', 'Lower case letter with trailing closing bracket, E.g. a), b), c)')], help_text='The precedence display type of a "container". This sets the precedence display type for all the child elements of this container but not the container itself.', max_length=150, null=True)),
                 ('query', models.TextField(verbose_name='Question')),
+                ('question_code', models.CharField(editable=False, help_text='A simple code that can be used to uniquely identify a question. This is mostly useful in the context of dependent question answers.', max_length=100, unique=True)),
                 ('answer_type', models.CharField(choices=[('true_false', 'True/False'), ('yes_no', 'Yes/No'), ('number', 'Whole Number'), ('fraction', 'Fractional Number'), ('short_answer', 'Short Answer'), ('radio_option', 'Select One'), ('select_list', 'Select Multiple'), ('dependent', 'Dependent on Another Answer'), ('ratio', 'Ratio'), ('none', 'Not Applicable')], default='short_answer', help_text='Expected answer type', max_length=15)),
                 ('precedence', models.PositiveSmallIntegerField(help_text='The rank of a question within it\'s "container". Used to position the question when rendering a questionnaire.')),
                 ('metadata', models.JSONField(blank=True, default=dict)),
@@ -120,6 +121,7 @@ class Migration(migrations.Migration):
                 ('created_by', models.UUIDField(blank=True, null=True)),
                 ('updated', models.DateTimeField(default=django.utils.timezone.now)),
                 ('updated_by', models.UUIDField(blank=True, null=True)),
+                ('is_not_applicable', models.BooleanField(default=False, help_text='Indicates that answer is not applicable for the attached question.')),
                 ('response', models.JSONField(default=dict)),
                 ('answered_on', models.DateTimeField(auto_now=True)),
                 ('comments', models.TextField(blank=True, null=True)),

fahari/sims/models.py

@@ -35,16 +35,23 @@ class QuestionAnswerResponse(TypedDict):
     """This is the actual content of the answer."""
 
 
-class QuestionMetadata(TypedDict):
-    """The structure of a question metadata dictionary."""
+class QuestionConstraints(TypedDict):
+    """The structure of a question's constraints metadata dictionary."""
 
     max_length: Optional[Number]
     max_value: Optional[Number]
     min_length: Optional[Number]
     min_value: Optional[Number]
-    optional: Optional[bool]
     ratio_lower_bound: Optional[int]
     ratio_upper_bound: Optional[int]
+
+
+class QuestionMetadata(TypedDict):
+    """The structure of a question metadata dictionary."""
+
+    constraints: Optional[QuestionConstraints]
+    depends_on: Optional[str]
+    optional: Optional[bool]
     select_list_options: Optional[Sequence[str]]
 
 
@@ -305,6 +312,16 @@ class AnswerType(models.TextChoices):
     )
 
     query = models.TextField(verbose_name="Question")
+    question_code = models.CharField(
+        max_length=100,
+        editable=False,
+        help_text=(
+            "A simple code that can be used to uniquely identify a question. "
+            "This is mostly useful in the context of dependent question "
+            "answers."
+        ),
+        unique=True,
+    )
     answer_type = models.CharField(
         max_length=15,
         choices=AnswerType.choices,