diff options
| author | 2024-07-20 17:48:49 +0100 | |
|---|---|---|
| committer | 2024-07-22 21:39:19 +0100 | |
| commit | 228cacbd8eda41cdc4179e0e66d7a0bdc04f30fe (patch) | |
| tree | ccfbdbc6d1a0dc70a019f3810bb5de84c0f595a1 /backend | |
| parent | Add models and migration files for admins & forms (diff) | |
Add models & migrations for form questions
Diffstat (limited to '')
| -rw-r--r-- | backend/constants.py | 6 | ||||
| -rw-r--r-- | backend/models/orm/form_questions.py | 198 | ||||
| -rw-r--r-- | backend/models/orm/forms.py | 10 | 
3 files changed, 214 insertions, 0 deletions
| diff --git a/backend/constants.py b/backend/constants.py index eb0c68f..4bb051c 100644 --- a/backend/constants.py +++ b/backend/constants.py @@ -56,6 +56,12 @@ QUESTION_TYPES = [      "vote",  ] + +class TextType(Enum): +    SHORT_TEXT = "short_text" +    TEXT_AREA = "text_area" + +  REQUIRED_QUESTION_TYPE_DATA = {      "radio": {          "options": list, diff --git a/backend/models/orm/form_questions.py b/backend/models/orm/form_questions.py new file mode 100644 index 0000000..cde1d0b --- /dev/null +++ b/backend/models/orm/form_questions.py @@ -0,0 +1,198 @@ +"""Discord members who have admin access.""" + +from typing import ClassVar + +from sqlalchemy import Enum, ForeignKey, Text +from sqlalchemy.dialects.postgresql import ARRAY +from sqlalchemy.orm import Mapped, mapped_column, relationship + +from backend.constants import TextType + +from .base import Base + + +class FormQuestion(Base): +    __tablename__ = "form_questions" + +    question_id: Mapped[int] = mapped_column(primary_key=True) +    form_id: Mapped[int] = mapped_column(ForeignKey("forms.form_id")) +    name: Mapped[str] +    type: Mapped[str] +    required: Mapped[bool] + +    __mapper_args__: ClassVar = {"polymorphic_identity": "form_questions", "polymorphic_on": "type"} + +    def __repr__(self): +        return f"{self.__class__.__name__}({self.name!r})" + + +class QuestionWithOptions: +    options: Mapped[list[str]] = mapped_column( +        ARRAY(Text), +        nullable=False, +        use_existing_column=True, +    ) + + +class FormRadioQuestion(QuestionWithOptions, FormQuestion): +    """A radio question type.""" + +    __tablename__ = "form_radio_questions" + +    radio_question_id: Mapped[int] = mapped_column( +        ForeignKey("form_questions.question_id"), +        primary_key=True, +    ) + +    __mapper_args__: ClassVar = { +        "polymorphic_load": "selectin", +        "polymorphic_identity": "form_radio_questions", +    } + + +class FormCheckboxQuestion(QuestionWithOptions, FormQuestion): +    """A radio question type.""" + +    __tablename__ = "form_checkbox_questions" + +    checkbox_question_id: Mapped[int] = mapped_column( +        ForeignKey("form_questions.question_id"), +        primary_key=True, +    ) + +    __mapper_args__: ClassVar = { +        "polymorphic_load": "selectin", +        "polymorphic_identity": "form_checkbox_questions", +    } + + +class FormRangeQuestion(QuestionWithOptions, FormQuestion): +    """A range question type.""" + +    __tablename__ = "form_range_questions" + +    range_question_id: Mapped[int] = mapped_column( +        ForeignKey("form_questions.question_id"), +        primary_key=True, +    ) + +    __mapper_args__: ClassVar = { +        "polymorphic_load": "selectin", +        "polymorphic_identity": "form_range_questions", +    } + + +class FormVoteQuestion(QuestionWithOptions, FormQuestion): +    """A vote question type.""" + +    __tablename__ = "form_vote_questions" + +    range_question_id: Mapped[int] = mapped_column( +        ForeignKey("form_questions.question_id"), +        primary_key=True, +    ) + +    __mapper_args__: ClassVar = { +        "polymorphic_load": "selectin", +        "polymorphic_identity": "form_vote_questions", +    } + + +class FormSelectQuestion(QuestionWithOptions, FormQuestion): +    """A select question type.""" + +    __tablename__ = "form_select_questions" + +    select_question_id: Mapped[int] = mapped_column( +        ForeignKey("form_questions.question_id"), +        primary_key=True, +    ) + +    __mapper_args__: ClassVar = { +        "polymorphic_load": "selectin", +        "polymorphic_identity": "form_select_questions", +    } + + +class FormTextQuestion(FormQuestion): +    """A text question type.""" + +    __tablename__ = "form_text_questions" + +    text_question_id: Mapped[int] = mapped_column( +        ForeignKey("form_questions.question_id"), +        primary_key=True, +    ) +    text_type: Mapped[TextType] = mapped_column(Enum(TextType)) + +    __mapper_args__: ClassVar = { +        "polymorphic_load": "selectin", +        "polymorphic_identity": "form_text_questions", +    } + + +class FormCodeQuestion(FormQuestion): +    """A code question type.""" + +    __tablename__ = "form_code_questions" + +    code_question_id: Mapped[int] = mapped_column( +        ForeignKey("form_questions.question_id"), +        primary_key=True, +    ) +    language: Mapped[str] +    allow_failure: Mapped[bool] +    unit_tests: Mapped[list["FormCodeQuestionTest"]] = relationship( +        cascade="all, delete", +        passive_deletes=True, +    ) + +    __mapper_args__: ClassVar = { +        "polymorphic_load": "selectin", +        "polymorphic_identity": "form_code_questions", +    } + + +class FormCodeQuestionTest(Base): +    """Unit tests for a given code question.""" + +    __tablename__ = "form_code_question_tests" +    test_id: Mapped[int] = mapped_column(primary_key=True) +    code_question_id: Mapped[int] = mapped_column( +        ForeignKey("form_code_questions.code_question_id") +    ) +    name: Mapped[str] +    code: Mapped[str] + + +class FormSectionQuestion(FormQuestion): +    """A section question type.""" + +    __tablename__ = "form_section_questions" + +    section_question_id: Mapped[int] = mapped_column( +        ForeignKey("form_questions.question_id"), +        primary_key=True, +    ) +    text: Mapped[str] + +    __mapper_args__: ClassVar = { +        "polymorphic_load": "selectin", +        "polymorphic_identity": "form_section_questions", +    } + + +class FormTimezoneQuestion(FormQuestion): +    """A timezone question type.""" + +    __tablename__ = "form_timezone_questions" + +    timezone_question_id: Mapped[int] = mapped_column( +        ForeignKey("form_questions.question_id"), +        primary_key=True, +    ) + +    __mapper_args__: ClassVar = { +        "polymorphic_load": "selectin", +        "polymorphic_identity": "form_timezone_questions", +    } diff --git a/backend/models/orm/forms.py b/backend/models/orm/forms.py index 489b71b..71119c7 100644 --- a/backend/models/orm/forms.py +++ b/backend/models/orm/forms.py @@ -1,5 +1,7 @@  """All forms that can have submissions.""" +from typing import TYPE_CHECKING +  import sqlalchemy.dialects.postgresql as pg  from sqlalchemy import ForeignKey  from sqlalchemy.orm import Mapped, mapped_column, relationship @@ -9,6 +11,9 @@ from backend.constants import FormFeatures  from .base import Base +if TYPE_CHECKING: +    from . import FormQuestion +  class Form(Base):      """A form that users can submit responses to.""" @@ -22,6 +27,11 @@ class Form(Base):      description: Mapped[str] = mapped_column(Text, nullable=False)      submission_text: Mapped[str | None] = mapped_column(Text, nullable=True) +    form_questions: Mapped[list["FormQuestion"]] = relationship( +        cascade="all, delete", +        passive_deletes=True, +    ) +      webhook_url: Mapped[str | None] = mapped_column(Text, nullable=True)      webhook_message: Mapped[str | None] = mapped_column(Text, nullable=True) | 
