akvo / iwsims-demo / #72

Committed 28 Apr 2025 03:28AM UTC coverage: 86.134% (+1.1%) from 85.024%

Build # #72

Build Type

push

coveralls-python

Committed by

web-flow

Commit Message

Merge pull request #20 from akvo/feature/19-eng-1231-dynamic-level-approval

Feature/19 eng 1231 dynamic level approval

Run Details

2646 of 3188 branches covered (83.0%)

Branch coverage included in aggregate %.

5995 of 6844 relevant lines covered (87.59%)

0.88 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

94.2

backend/api/v1/v1_forms/models.py

import uuid

from django.db import models

# Create your models here.
from api.v1.v1_forms.constants import (
    QuestionTypes,
    FormTypes,
    AttributeTypes,
    SubmissionTypes,
    FormAccessTypes,
)
from api.v1.v1_profile.models import Administration
from api.v1.v1_users.models import SystemUser
from django.contrib.postgres.fields import ArrayField


class Forms(models.Model):
    name = models.TextField()
    version = models.IntegerField(default=1)
    uuid = models.UUIDField(default=uuid.uuid4, editable=False, unique=True)
    type = models.IntegerField(
        choices=FormTypes.FieldStr.items(), default=None, null=True
    )
    submission_types = ArrayField(
        models.IntegerField(choices=SubmissionTypes.FieldStr.items()),
        default=list,
        blank=True,
    )
    approval_instructions = models.JSONField(default=None, null=True)

    def __str__(self):
        return self.name

    class Meta:
        db_table = "form"


class FormApprovalAssignment(models.Model):
    form = models.ForeignKey(
        to=Forms, on_delete=models.CASCADE, related_name="form_data_approval"
    )
    administration = models.ForeignKey(
        to=Administration,
        on_delete=models.PROTECT,
        related_name="administration_data_approval",
    )
    user = models.ForeignKey(
        to=SystemUser,
        on_delete=models.CASCADE,
        related_name="user_data_approval",
    )
    updated = models.DateTimeField(default=None, null=True)

    def __str__(self):
        return self.user.email

    class Meta:
        db_table = "form_approval_assignment"


class QuestionGroup(models.Model):
    form = models.ForeignKey(
        to=Forms, on_delete=models.CASCADE, related_name="form_question_group"
    )
    name = models.CharField(max_length=255)
    label = models.TextField(null=True, default=None)
    order = models.BigIntegerField(null=True, default=None)

    def __str__(self):
        return self.name

    class Meta:
        unique_together = ("form", "name")
        constraints = [
            models.UniqueConstraint(
                fields=["form", "name"], name="unique_form_question_group"
            )
        ]
        db_table = "question_group"


class Questions(models.Model):
    form = models.ForeignKey(
        to=Forms, on_delete=models.CASCADE, related_name="form_questions"
    )
    question_group = models.ForeignKey(
        to=QuestionGroup,
        on_delete=models.CASCADE,
        related_name="question_group_question",
    )
    order = models.BigIntegerField(null=True, default=None)
    label = models.TextField()
    short_label = models.TextField(null=True, default=None)
    name = models.CharField(max_length=255, default=None, null=True)
    type = models.IntegerField(choices=QuestionTypes.FieldStr.items())
    meta = models.BooleanField(default=False)
    required = models.BooleanField(default=True)
    rule = models.JSONField(default=None, null=True)
    dependency = models.JSONField(default=None, null=True)
    api = models.JSONField(default=None, null=True)
    extra = models.JSONField(default=None, null=True)
    tooltip = models.JSONField(default=None, null=True)
    fn = models.JSONField(default=None, null=True)
    pre = models.JSONField(default=None, null=True)
    hidden = models.JSONField(default=None, null=True)
    display_only = models.BooleanField(default=False, null=True)
    default_value = models.JSONField(default=None, null=True)
    meta_uuid = models.BooleanField(default=False, null=True)
    disabled = models.JSONField(default=None, null=True)

    def __str__(self):
        return f"[TYPE: {self.type}] {self.label}"

    def to_definition(self):
        options = self.options.values("label", "value")
        return {
            "id": self.id,
            "qg_id": self.question_group.id,
            "order": (self.order or 0) + 1,
            "name": self.name,
            "label": self.label,
            "short_label": self.short_label,
            "type": QuestionTypes.FieldStr.get(self.type),
            "required": self.required,
            "hidden": self.hidden,
            "rule": self.rule,
            "dependency": self.dependency,
            "options": options,
            "extra": self.extra,
            "tooltip": self.tooltip,
            "fn": self.fn,
            "pre": self.pre,
            "display_only": self.display_only,
            "meta_uuid": self.meta_uuid,
            "default_value": self.default_value,
            "disabled": self.disabled,
        }

    class Meta:
        unique_together = ("form", "name")
        constraints = [
            models.UniqueConstraint(
                fields=["form", "name"], name="unique_form_question"
            )
        ]
        db_table = "question"


class QuestionOptions(models.Model):
    question = models.ForeignKey(
        to=Questions, on_delete=models.CASCADE, related_name="options"
    )
    order = models.BigIntegerField(null=True, default=None)
    label = models.TextField(default=None, null=True)
    value = models.CharField(max_length=255, default=None, null=True)
    other = models.BooleanField(default=False)
    color = models.TextField(default=None, null=True)

    def __str__(self):
        return self.value

    class Meta:
        unique_together = ("question", "value")
        constraints = [
            models.UniqueConstraint(
                fields=["question", "value"], name="unique_question_option"
            )
        ]
        db_table = "option"


class UserForms(models.Model):
    user = models.ForeignKey(
        to=SystemUser, on_delete=models.CASCADE, related_name="user_form"
    )
    form = models.ForeignKey(
        to=Forms, on_delete=models.CASCADE, related_name="form_user"
    )

    def __str__(self):
        return self.user.email

    class Meta:
        unique_together = ("user", "form")
        db_table = "user_form"


class FormAccess(models.Model):
    user_form = models.ForeignKey(
        to=UserForms,
        on_delete=models.CASCADE,
        related_name="user_form_access",
    )
    access_type = models.IntegerField(
        choices=FormAccessTypes.FieldStr.items()
    )

    def __str__(self):
        return self.user.email

    class Meta:
        db_table = "user_form_access"


class QuestionAttribute(models.Model):
    name = models.TextField(null=True, default=None)
    question = models.ForeignKey(
        to=Questions,
        on_delete=models.CASCADE,
        related_name="question_question_attribute",
    )
    attribute = models.IntegerField(choices=AttributeTypes.FieldStr.items())
    options = models.JSONField(default=None, null=True)

    def __str__(self):
        return self.name

    class Meta:
        unique_together = ("name", "question", "attribute", "options")
        db_table = "question_attribute"

1	import uuid	1✔
2
3	from django.db import models	1✔
4
5	# Create your models here.
6	from api.v1.v1_forms.constants import (	1✔
7	QuestionTypes,
8	FormTypes,
9	AttributeTypes,
10	SubmissionTypes,
11	FormAccessTypes,
12	)
13	from api.v1.v1_profile.models import Administration	1✔
14	from api.v1.v1_users.models import SystemUser	1✔
15	from django.contrib.postgres.fields import ArrayField	1✔
16
17
18	class Forms(models.Model):	1✔
19	name = models.TextField()	1✔
20	version = models.IntegerField(default=1)	1✔
21	uuid = models.UUIDField(default=uuid.uuid4, editable=False, unique=True)	1✔
22	type = models.IntegerField(	1✔
23	choices=FormTypes.FieldStr.items(), default=None, null=True
24	)
25	submission_types = ArrayField(	1✔
26	models.IntegerField(choices=SubmissionTypes.FieldStr.items()),
27	default=list,
28	blank=True,
29	)
30	approval_instructions = models.JSONField(default=None, null=True)	1✔
31
32	def __str__(self):	1✔
33	return self.name	×
34
35	class Meta:	1✔
36	db_table = "form"	1✔
37
38
39	class FormApprovalAssignment(models.Model):	1✔
40	form = models.ForeignKey(	1✔
41	to=Forms, on_delete=models.CASCADE, related_name="form_data_approval"
42	)
43	administration = models.ForeignKey(	1✔
44	to=Administration,
45	on_delete=models.PROTECT,
46	related_name="administration_data_approval",
47	)
48	user = models.ForeignKey(	1✔
49	to=SystemUser,
50	on_delete=models.CASCADE,
51	related_name="user_data_approval",
52	)
53	updated = models.DateTimeField(default=None, null=True)	1✔
54
55	def __str__(self):	1✔
56	return self.user.email	×
57
58	class Meta:	1✔
59	db_table = "form_approval_assignment"	1✔
60
61
62	class QuestionGroup(models.Model):	1✔
63	form = models.ForeignKey(	1✔
64	to=Forms, on_delete=models.CASCADE, related_name="form_question_group"
65	)
66	name = models.CharField(max_length=255)	1✔
67	label = models.TextField(null=True, default=None)	1✔
68	order = models.BigIntegerField(null=True, default=None)	1✔
69
70	def __str__(self):	1✔
71	return self.name	×
72
73	class Meta:	1✔
74	unique_together = ("form", "name")	1✔
75	constraints = [	1✔
76	models.UniqueConstraint(
77	fields=["form", "name"], name="unique_form_question_group"
78	)
79	]
80	db_table = "question_group"	1✔
81
82
83	class Questions(models.Model):	1✔
84	form = models.ForeignKey(	1✔
85	to=Forms, on_delete=models.CASCADE, related_name="form_questions"
86	)
87	question_group = models.ForeignKey(	1✔
88	to=QuestionGroup,
89	on_delete=models.CASCADE,
90	related_name="question_group_question",
91	)
92	order = models.BigIntegerField(null=True, default=None)	1✔
93	label = models.TextField()	1✔
94	short_label = models.TextField(null=True, default=None)	1✔
95	name = models.CharField(max_length=255, default=None, null=True)	1✔
96	type = models.IntegerField(choices=QuestionTypes.FieldStr.items())	1✔
97	meta = models.BooleanField(default=False)	1✔
98	required = models.BooleanField(default=True)	1✔
99	rule = models.JSONField(default=None, null=True)	1✔
100	dependency = models.JSONField(default=None, null=True)	1✔
101	api = models.JSONField(default=None, null=True)	1✔
102	extra = models.JSONField(default=None, null=True)	1✔
103	tooltip = models.JSONField(default=None, null=True)	1✔
104	fn = models.JSONField(default=None, null=True)	1✔
105	pre = models.JSONField(default=None, null=True)	1✔
106	hidden = models.JSONField(default=None, null=True)	1✔
107	display_only = models.BooleanField(default=False, null=True)	1✔
108	default_value = models.JSONField(default=None, null=True)	1✔
109	meta_uuid = models.BooleanField(default=False, null=True)	1✔
110	disabled = models.JSONField(default=None, null=True)	1✔
111
112	def __str__(self):	1✔
113	return f"[TYPE: {self.type}] {self.label}"	×
114
115	def to_definition(self):	1✔
116	options = self.options.values("label", "value")	1✔
117	return {	1✔
118	"id": self.id,
119	"qg_id": self.question_group.id,
120	"order": (self.order or 0) + 1,
121	"name": self.name,
122	"label": self.label,
123	"short_label": self.short_label,
124	"type": QuestionTypes.FieldStr.get(self.type),
125	"required": self.required,
126	"hidden": self.hidden,
127	"rule": self.rule,
128	"dependency": self.dependency,
129	"options": options,
130	"extra": self.extra,
131	"tooltip": self.tooltip,
132	"fn": self.fn,
133	"pre": self.pre,
134	"display_only": self.display_only,
135	"meta_uuid": self.meta_uuid,
136	"default_value": self.default_value,
137	"disabled": self.disabled,
138	}
139
140	class Meta:	1✔
141	unique_together = ("form", "name")	1✔
142	constraints = [	1✔
143	models.UniqueConstraint(
144	fields=["form", "name"], name="unique_form_question"
145	)
146	]
147	db_table = "question"	1✔
148
149
150	class QuestionOptions(models.Model):	1✔
151	question = models.ForeignKey(	1✔
152	to=Questions, on_delete=models.CASCADE, related_name="options"
153	)
154	order = models.BigIntegerField(null=True, default=None)	1✔
155	label = models.TextField(default=None, null=True)	1✔
156	value = models.CharField(max_length=255, default=None, null=True)	1✔
157	other = models.BooleanField(default=False)	1✔
158	color = models.TextField(default=None, null=True)	1✔
159
160	def __str__(self):	1✔
161	return self.value	×
162
163	class Meta:	1✔
164	unique_together = ("question", "value")	1✔
165	constraints = [	1✔
166	models.UniqueConstraint(
167	fields=["question", "value"], name="unique_question_option"
168	)
169	]
170	db_table = "option"	1✔
171
172
173	class UserForms(models.Model):	1✔
174	user = models.ForeignKey(	1✔
175	to=SystemUser, on_delete=models.CASCADE, related_name="user_form"
176	)
177	form = models.ForeignKey(	1✔
178	to=Forms, on_delete=models.CASCADE, related_name="form_user"
179	)
180
181	def __str__(self):	1✔
182	return self.user.email	×
183
184	class Meta:	1✔
185	unique_together = ("user", "form")	1✔
186	db_table = "user_form"	1✔
187
188
189	class FormAccess(models.Model):	1✔
190	user_form = models.ForeignKey(	1✔
191	to=UserForms,
192	on_delete=models.CASCADE,
193	related_name="user_form_access",
194	)
195	access_type = models.IntegerField(	1✔
196	choices=FormAccessTypes.FieldStr.items()
197	)
198
199	def __str__(self):	1✔
200	return self.user.email	×
201
202	class Meta:	1✔
203	db_table = "user_form_access"	1✔
204
205
206	class QuestionAttribute(models.Model):	1✔
207	name = models.TextField(null=True, default=None)	1✔
208	question = models.ForeignKey(	1✔
209	to=Questions,
210	on_delete=models.CASCADE,
211	related_name="question_question_attribute",
212	)
213	attribute = models.IntegerField(choices=AttributeTypes.FieldStr.items())	1✔
214	options = models.JSONField(default=None, null=True)	1✔
215
216	def __str__(self):	1✔
217	return self.name	×
218
219	class Meta:	1✔
220	unique_together = ("name", "question", "attribute", "options")	1✔
221	db_table = "question_attribute"	1✔

akvo / iwsims-demo / #72

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous