Merge branch 'main' into type-results-exporter

Author: fidoriel

evap/development/fixtures/test_data.json

@@ -132980,7 +132980,7 @@
     "title": "",
     "first_name_given": "",
     "first_name_chosen": "",
-    "last_name": "",
+    "last_name": "reviewer",
     "language": "",
     "is_proxy_user": false,
     "login_key": null,
@@ -133008,7 +133008,7 @@
     "title": "",
     "first_name_given": "",
     "first_name_chosen": "",
-    "last_name": "",
+    "last_name": "proxy",
     "language": "",
     "is_proxy_user": true,
     "login_key": null,
@@ -133043,7 +133043,7 @@
     "title": "",
     "first_name_given": "",
     "first_name_chosen": "",
-    "last_name": "",
+    "last_name": "proxy_delegate",
     "language": "",
     "is_proxy_user": false,
     "login_key": null,
@@ -133071,7 +133071,79 @@
     "title": "",
     "first_name_given": "",
     "first_name_chosen": "",
-    "last_name": "",
+    "last_name": "proxy_delegate_2",
+    "language": "",
+    "is_proxy_user": false,
+    "login_key": null,
+    "login_key_valid_until": null,
+    "is_active": true,
+    "notes": "",
+    "startpage": "DE",
+    "groups": [],
+    "user_permissions": [],
+    "delegates": [],
+    "cc_users": []
+  }
+},
+{
+  "model": "evaluation.userprofile",
+  "fields": {
+    "password": "eZAyFmtqHydCIFtGdbevAxiVjiRpqMtmaVUCrmkcfXdoJDigmGWPVNHeoYYyRojokKUJjsgPSPvZkjiiIHSIQlBfOKtQFDbZlPEyKnrQRrHdPtEhUYHqJauIlyIkYpBM",
+    "last_login": null,
+    "is_superuser": false,
+    "email": "[email protected]",
+    "title": "",
+    "first_name_given": "Vincenzo Alfredo",
+    "first_name_chosen": "",
+    "last_name": "Boston",
+    "language": "",
+    "is_proxy_user": false,
+    "login_key": null,
+    "login_key_valid_until": null,
+    "is_active": true,
+    "notes": "",
+    "startpage": "DE",
+    "groups": [],
+    "user_permissions": [],
+    "delegates": [],
+    "cc_users": []
+  }
+},
+{
+  "model": "evaluation.userprofile",
+  "fields": {
+    "password": "utAhMBbTpirVqtaoPpadEHdamaehnXWbEsliMMSnwDBYJcTnHluinAxkTeEupPoBzpuDBMYeXbpwmockMtQNYegbMuxkUBEBKqWGkOEFAWxzUFjdxevtIwYzvAgHCAwD",
+    "last_login": null,
+    "is_superuser": false,
+    "email": "[email protected]",
+    "title": "",
+    "first_name_given": "Bud",
+    "first_name_chosen": "",
+    "last_name": "LedBetter",
+    "language": "",
+    "is_proxy_user": false,
+    "login_key": null,
+    "login_key_valid_until": null,
+    "is_active": true,
+    "notes": "",
+    "startpage": "DE",
+    "groups": [],
+    "user_permissions": [],
+    "delegates": [],
+    "cc_users": []
+  }
+},
+{
+  "model": "evaluation.userprofile",
+  "fields": {
+    "password": "naFmzOVrFhXrVVLsIGFYceDAarTGwDRFZKGJwBvKhNFCpupezBrwhorUHsyQSpUxLFKSQuOurcIyoBBYRjARXjzcJCbqYRiKRMOwvdTqwNjAbYDhUKbopBPDYhANXUkI",
+    "last_login": null,
+    "is_superuser": false,
+    "email": "[email protected]",
+    "title": "",
+    "first_name_given": "Melody",
+    "first_name_chosen": "",
+    "last_name": "Large",
     "language": "",
     "is_proxy_user": false,
     "login_key": null,

evap/evaluation/migrations/0142_alter_evaluation_state.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.7 on 2023-11-13 20:59
+
+from django.db import migrations
+import django_fsm
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("evaluation", "0141_userprofile_notes"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="evaluation",
+            name="state",
+            field=django_fsm.FSMIntegerField(default=10, protected=True, verbose_name="state"),
+        ),
+    ]

evap/evaluation/models.py

@@ -2,10 +2,10 @@
 import secrets
 import uuid
 from collections import defaultdict
+from dataclasses import dataclass
 from datetime import date, datetime, timedelta
 from enum import Enum, auto
-from numbers import Number
-from typing import NamedTuple
+from numbers import Real
 
 from django.conf import settings
 from django.contrib import messages
@@ -389,7 +389,7 @@ class State:
         REVIEWED = 70
         PUBLISHED = 80
 
-    state = FSMIntegerField(default=State.NEW, protected=True)
+    state = FSMIntegerField(default=State.NEW, protected=True, verbose_name=_("state"))
 
     course = models.ForeignKey(Course, models.PROTECT, verbose_name=_("course"), related_name="evaluations")
 
@@ -779,14 +779,14 @@ def unpublish(self):
         self._participant_count = None
 
     STATE_STR_CONVERSION = {
-        State.NEW: "new",
-        State.PREPARED: "prepared",
-        State.EDITOR_APPROVED: "editor_approved",
-        State.APPROVED: "approved",
-        State.IN_EVALUATION: "in_evaluation",
-        State.EVALUATED: "evaluated",
-        State.REVIEWED: "reviewed",
-        State.PUBLISHED: "published",
+        State.NEW: _("new"),
+        State.PREPARED: _("prepared"),
+        State.EDITOR_APPROVED: _("editor_approved"),
+        State.APPROVED: _("approved"),
+        State.IN_EVALUATION: _("in_evaluation"),
+        State.EVALUATED: _("evaluated"),
+        State.REVIEWED: _("reviewed"),
+        State.PUBLISHED: _("published"),
     }
 
     @classmethod
@@ -994,7 +994,7 @@ def unlogged_fields(self):
 
     @classmethod
     def transform_log_action(cls, field_action):
-        if field_action.label == "State":
+        if field_action.label.lower() == Evaluation.state.field.verbose_name.lower():
             return FieldAction(
                 field_action.label, field_action.type, [cls.state_to_str(state) for state in field_action.items]
             )
@@ -1236,25 +1236,23 @@ def can_have_textanswers(self):
         return self.is_text_question or self.is_rating_question and self.allows_additional_textanswers
 
 
-# Let's deduplicate the fields here once mypy is smart enough to keep up with us :)
-class Choices(NamedTuple):
+@dataclass
+class Choices:
     css_class: str
-    values: tuple[Number]
+    values: tuple[Real]
     colors: tuple[str]
-    grades: tuple[Number]
+    grades: tuple[Real]
     names: list[StrOrPromise]
     is_inverted: bool
 
+    def as_name_color_value_tuples(self):
+        return zip(self.names, self.colors, self.values, strict=True)
 
-class BipolarChoices(NamedTuple):
-    css_class: str
-    values: tuple[Number]
-    colors: tuple[str]
-    grades: tuple[Number]
-    names: list[StrOrPromise]
+
+@dataclass
+class BipolarChoices(Choices):
     plus_name: StrOrPromise
     minus_name: StrOrPromise
-    is_inverted: bool
 
 
 NO_ANSWER = 6

evap/evaluation/templates/base.html

@@ -47,12 +47,6 @@
 
         {% if user.is_authenticated %}
             {% include 'notebook.html' %}
-
-            <div class="collapse show" tabindex="-1" id="notebookButton">
-                <button class="btn btn-outline-secondary button-open-notebook" type="button" data-bs-toggle="collapse" data-bs-target="#notebook">
-                    <span class="fas fa-pen-to-square"></span>
-                </button>
-            </div>
         {% endif %}
 
         <div class="p-3 mb-4" id="evapContent">
@@ -207,11 +201,6 @@
             };
 
         </script>
-        <script type="module">
-            import  { NotebookLogic } from "{% static 'js/notebook.js' %}"
-
-            new NotebookLogic("#notebook").attach();
-        </script>
 
         {% block additional_javascript %}{% endblock %}
     </body>

evap/evaluation/templates/notebook.html

@@ -1,3 +1,4 @@
+{% load static %}
 <div class="notebook">
    <div class="collapse position-fixed collapse-horizontal notebook-animation mt-0 d-print-none" tabindex="-1" id="notebook" aria-expanded="false">
         <div class="card">
@@ -27,3 +28,15 @@ <h5 class="card-title m-0">
         </div>
     </div>
 </div>
+
+<div class="collapse show" tabindex="-1" id="notebookButton">
+    <button class="btn btn-outline-secondary button-open-notebook" type="button" data-bs-toggle="collapse" data-bs-target="#notebook">
+        <span class="fas fa-pen-to-square"></span>
+    </button>
+</div>
+
+<script type="module">
+    import { NotebookLogic } from "{% static 'js/notebook.js' %}";
+    import { selectOrError } from "{% static 'js/utils.js' %}";
+    new NotebookLogic(selectOrError("#notebook"), selectOrError("#notebook-form"), selectOrError("#evapContent"), selectOrError("#notebookButton"), "evap_notebook_open").attach();
+</script>

evap/evaluation/templatetags/evaluation_filters.py

@@ -5,6 +5,7 @@
 from django.utils.translation import gettext_lazy as _
 
 from evap.evaluation.models import BASE_UNIPOLAR_CHOICES, Contribution, Evaluation
+from evap.results.tools import RatingResult
 from evap.rewards.tools import can_reward_points_be_used_by
 from evap.student.forms import HeadingField
 
@@ -76,12 +77,7 @@
 
 @register.filter(name="zip")
 def _zip(a, b):
-    return zip(a, b)
-
-
-@register.filter()
-def zip_choices(counts, choices):
-    return zip(counts, choices.names, choices.colors, choices.values)
+    return zip(a, b, strict=True)
 
 
 @register.filter
@@ -115,12 +111,12 @@ def percentage_one_decimal(fraction, population):
 
 
 @register.filter
-def to_colors(choices):
-    if not choices:
+def to_colors(question_result: RatingResult | None):
+    if question_result is None:
         # When displaying the course distribution, there are no associated voting choices.
         # In that case, we just use the colors of a unipolar scale.
-        return BASE_UNIPOLAR_CHOICES["colors"]
-    return choices.colors
+        return BASE_UNIPOLAR_CHOICES["colors"][:-1]
+    return question_result.colors
 
 
 @register.filter

evap/evaluation/tests/test_models.py

@@ -127,11 +127,10 @@ def test_in_evaluation_to_published(self):
             wait_for_grade_upload_before_publishing=False,
         )
 
-        with patch(
-            "evap.evaluation.models.EmailTemplate.send_participant_publish_notifications"
-        ) as participant_mock, patch(
-            "evap.evaluation.models.EmailTemplate.send_contributor_publish_notifications"
-        ) as contributor_mock:
+        with (
+            patch("evap.evaluation.models.EmailTemplate.send_participant_publish_notifications") as participant_mock,
+            patch("evap.evaluation.models.EmailTemplate.send_contributor_publish_notifications") as contributor_mock,
+        ):
             Evaluation.update_evaluations()
 
         participant_mock.assert_called_once_with([evaluation])

evap/results/templates/distribution_with_grade.html

@@ -5,7 +5,7 @@
     <div class="distribution-bar {{ question_result.choices.css_class }}"
         {% if question_result.question.is_bipolar_likert_question %} style="left: {{ question_result.minus_balance_count|percentage_one_decimal:question_result.count_sum }}"{% endif %}
     >
-        {% with colors=question_result.choices|to_colors %}
+        {% with colors=question_result|to_colors %}
             {% for value, color in distribution|zip:colors %}
                 {% if value != 0 %}
                     <div class="vote-bg-{{ color }}" style="width: {{ value|percentage_one_decimal:1 }};">&nbsp;</div>

evap/results/templates/evaluation_result_widget.html

@@ -7,7 +7,7 @@
         data-bs-toggle="tooltip" data-bs-placement="left" data-fallback-placement='["left", "bottom"]'
         title="{% spaceless %}{% include 'result_widget_tooltip.html' with question_result=course_or_evaluation.single_result_rating_result weight_info=course_or_evaluation|weight_info %}{% endspaceless %}"
     >
-        {% include "distribution_with_grade.html" with distribution=course_or_evaluation.distribution average=course_or_evaluation.avg_grade weight_info=course_or_evaluation|weight_info %}
+        {% include "distribution_with_grade.html" with distribution=course_or_evaluation.distribution average=course_or_evaluation.avg_grade weight_info=course_or_evaluation|weight_info question_result=None %}
     </div>
 {% else %}
     <div class="d-flex" data-bs-toggle="tooltip" data-bs-placement="left" title="{% trans 'Not enough answers were given.' %}">

evap/results/templates/result_widget_tooltip.html

@@ -13,7 +13,7 @@
     {% endif %}
     {% with question_result.question.is_bipolar_likert_question as is_bipolar %}
         <p>
-            {% for count, name, color, value in question_result.counts|zip_choices:question_result.choices %}
+            {% for count, name, color, value in question_result.zipped_choices %}
                 <span class='vote-text-{{ color }} fas fa-fw-absolute
                     {% if is_bipolar and value < 0 %}fa-caret-down pole-icon
                     {% elif is_bipolar and value > 0 %}fa-caret-up pole-icon

evap/results/tools.py

@@ -58,23 +58,31 @@ def is_published(cls, rating_result) -> TypeGuard["PublishedRatingResult"]:
     def has_answers(cls, rating_result) -> TypeGuard["AnsweredRatingResult"]:
         return isinstance(rating_result, AnsweredRatingResult)
 
-    def __init__(self, question, additional_text_result=None):
+    def __init__(self, question, additional_text_result=None) -> None:
         assert question.is_rating_question
         self.question = discard_cached_related_objects(copy(question))
         self.additional_text_result = additional_text_result
+        self.colors = tuple(
+            color for _, color, value in self.choices.as_name_color_value_tuples() if value != NO_ANSWER
+        )
 
     @property
     def choices(self):
         return CHOICES[self.question.type]
 
 
 class PublishedRatingResult(RatingResult):
-    def __init__(self, question, answer_counters, additional_text_result=None):
+    def __init__(self, question, answer_counters, additional_text_result=None) -> None:
         super().__init__(question, additional_text_result)
-        counts = OrderedDict((value, 0) for value in self.choices.values if value != NO_ANSWER)
+        counts = OrderedDict(
+            (value, [0, name, color, value]) for (name, color, value) in self.choices.as_name_color_value_tuples()
+        )
+        counts.pop(NO_ANSWER)
         for answer_counter in answer_counters:
-            counts[answer_counter.answer] = answer_counter.count
-        self.counts = tuple(counts.values())
+            assert counts[answer_counter.answer][0] == 0
+            counts[answer_counter.answer][0] = answer_counter.count
+        self.counts = tuple(count for count, _, _, _ in counts.values())
+        self.zipped_choices = tuple(counts.values())
 
     @property
     def count_sum(self) -> int:

evap/settings.py

@@ -67,7 +67,7 @@
 
 # email domains for the internal users of the hosting institution used to
 # figure out who is an internal user
-INSTITUTION_EMAIL_DOMAINS = ["institution.example.com"]
+INSTITUTION_EMAIL_DOMAINS = ["institution.example.com", "student.institution.example.com"]
 
 # List of tuples defining email domains that should be replaced on saving UserProfiles.
 # Emails ending on the first value will have this part replaced by the second value.