Implement Web Module (#73)

* Implement Web Module * Update help text * Fix iSort * PR Changes * Fix Migrations
flare-kcl · Jun 1, 2021 · 8440d7c · 8440d7c
1 parent dbc74a5
commit 8440d7c
Show file tree

Hide file tree

Showing 7 changed files with 116 additions and 1 deletion.
diff --git a/flare_portal/experiments/factories.py b/flare_portal/experiments/factories.py
@@ -12,6 +12,7 @@
     FearConditioningModule,
     Participant,
     Project,
+    WebModule,
 )
 
 
@@ -93,3 +94,13 @@ class Meta:
     required_answer = factory.Faker("random_element", elements=[True, False])
 
     module = factory.SubFactory(CriterionModuleFactory)
+
+
+class WebModuleFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = WebModule
+
+    url = "http://google.com"
+    intro_text = factory.Faker("heading")
+    help_text = factory.Faker("paragraph")
+    append_participant_id = True
diff --git a/flare_portal/experiments/migrations/0029_webmodule.py b/flare_portal/experiments/migrations/0029_webmodule.py
@@ -0,0 +1,49 @@
+# Generated by Django 3.1.4 on 2020-12-21 08:59
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("experiments", "0028_basic_info_unique"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="WebModule",
+            fields=[
+                (
+                    "basemodule_ptr",
+                    models.OneToOneField(
+                        auto_created=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        parent_link=True,
+                        primary_key=True,
+                        serialize=False,
+                        to="experiments.basemodule",
+                    ),
+                ),
+                ("heading", models.CharField(max_length=255)),
+                ("description", models.TextField(blank=True)),
+                ("url", models.URLField(verbose_name="URL")),
+                (
+                    "auto_close_url",
+                    models.URLField(
+                        blank=True,
+                        help_text="Optional: Enter a URL here that if redirected to will automatically close this module.",
+                        verbose_name="Automatic close URL",
+                    ),
+                ),
+                (
+                    "append_participant_id",
+                    models.BooleanField(
+                        blank=True,
+                        help_text="Optional: Enabling this feature will append theparticpant's id to the url. This is useful if you are using a survey service such as Qualtrics or Google Forms.",
+                    ),
+                ),
+            ],
+            bases=("experiments.basemodule",),
+        ),
+    ]
diff --git a/flare_portal/experiments/models/__init__.py b/flare_portal/experiments/models/__init__.py
@@ -6,6 +6,7 @@
     CriterionModule,
     CriterionQuestion,
     FearConditioningModule,
+    WebModule,
 )
 
 __all__ = [
@@ -21,4 +22,5 @@
     "FearConditioningModule",
     "Participant",
     "Project",
+    "WebModule",
 ]
diff --git a/flare_portal/experiments/models/modules.py b/flare_portal/experiments/models/modules.py
@@ -238,3 +238,40 @@ def get_module_description(self) -> str:
 
     def __str__(self) -> str:
         return "Criterion - " + super().__str__()
+
+
+class WebModule(BaseModule):
+    heading = models.CharField(max_length=255)
+    description = models.TextField(blank=True)
+    url = models.URLField(verbose_name="URL")
+    auto_close_url = models.URLField(
+        blank=True,
+        verbose_name="Automatic close URL",
+        help_text="Optional: Enter a URL here that if redirected to will "
+        "automatically close this module.",
+    )
+    append_participant_id = models.BooleanField(
+        blank=True,
+        help_text="Optional: Enabling this feature will append the"
+        "particpant's id to the url. This is useful if you are using a "
+        "survey service such as Qualtrics or Google Forms.",
+    )
+
+    def get_module_config(self) -> constants.ModuleConfigType:
+        return constants.ModuleConfigType(
+            id=self.pk,
+            type=self.get_module_tag(),
+            config={
+                "heading": self.heading,
+                "description": self.description,
+                "url": self.url,
+                "append_participant_id": self.append_participant_id,
+                "auto_close_url": self.auto_close_url,
+            },
+        )
+
+    def get_module_description(self) -> str:
+        return f"{self.heading} ({self.url})"
+
+    def __str__(self) -> str:
+        return "Web - " + super().__str__()
diff --git a/flare_portal/experiments/registry.py b/flare_portal/experiments/registry.py
@@ -26,6 +26,7 @@
     FearConditioningData,
     FearConditioningModule,
     Participant,
+    WebModule,
 )
 
 
@@ -208,6 +209,7 @@ class CreateMeta:
 module_registry.register(BasicInfoModule)
 module_registry.register(CriterionModule)
 module_registry.register(FearConditioningModule)
+module_registry.register(WebModule)
 
 
 class DataViewMixin:

diff --git a/flare_portal/static_src/sass/vendor/_tabler.scss b/flare_portal/static_src/sass/vendor/_tabler.scss
@@ -16078,6 +16078,16 @@ a.tag-addon:hover {
     margin: 0;
 }
 
+.custom-switch--with-description {
+    padding-top: 0.75rem;
+    align-items: flex-start;
+    justify-content: space-between;
+
+    .custom-switch-description {
+        width: 50%;
+    }
+}
+
 .custom-switch-input {
     position: absolute;
     z-index: -1;

diff --git a/flare_portal/templates/includes/form-group.html b/flare_portal/templates/includes/form-group.html
@@ -16,10 +16,14 @@
             {% if field|widget_type == 'horizontalcheckboxselectmultiple' %}
                 {{ field|add_error_class:"is-invalid" }}
             {% elif field|widget_type == 'checkboxinput' %}
-                <label class="custom-switch">
+                <label class="custom-switch {% if field.help_text %}custom-switch--with-description{% endif %}">
                     {{ field|add_class:"custom-switch-input" }}
                     <span class="custom-switch-indicator"></span>
                     <span class="custom-switch-description">{{ field.label }}</span>
+
+                    {% if field.help_text %}
+                        <p class="custom-switch-description">{{ field.help_text }}</p>
+                    {% endif %}
                 </label>
             {% elif field|widget_type == 'select' %}
                 {{ field|add_class:"form-control custom-select"|add_error_class:"is-invalid"|attr:"data-selectize" }}