Make global evaluation progress feature generic (#2621)

Close #2617

Author: hansegucker

evap/development/localsettings.template.py

@@ -42,18 +42,23 @@
 ALLOWED_HOSTS = ["localhost", "127.0.0.1"]
 
 ### Evaluation progress rewards
-GLOBAL_EVALUATION_PROGRESS_REWARDS: list[tuple[Fraction, str]] = [
-    (Fraction("0"), "0€"),
-    (Fraction("0.25"), "1.000€"),
-    (Fraction("0.6"), "3.000€"),
-    (Fraction("0.7"), "7.000€"),
-    (Fraction("0.9"), "10.000€"),
+GLOBAL_EVALUATION_PROGRESS_REWARDS: list[tuple[Fraction, dict[str, str]]] = [
+    (Fraction("0"), {"de": "0 €", "en": "0€"}),
+    (Fraction("0.25"), {"de": "1.000 €", "en": "1,000€"}),
+    (Fraction("0.6"), {"de": "3.000 €", "en": "3,000€"}),
+    (Fraction("0.7"), {"de": "7.000 €", "en": "7,000€"}),
+    (Fraction("0.9"), {"de": "10.000 €", "en": "10,000€"}),
 ]
 GLOBAL_EVALUATION_PROGRESS_EXCLUDED_COURSE_TYPE_IDS: list[int] = []
 GLOBAL_EVALUATION_PROGRESS_EXCLUDED_EVALUATION_IDS: list[int] = []
-GLOBAL_EVALUATION_PROGRESS_INFO_TEXT = {
-    "de": mark_safe("Deine Teilnahme am Evaluationsprojekt wird helfen. Evaluiere also <b>jetzt</b>!"),
-    "en": mark_safe("Your participation in the evaluation helps, so evaluate <b>now</b>!"),
+GLOBAL_EVALUATION_PROGRESS_CAMPAIGN: dict[str, str] = {
+    "title_de": "Spendenaktion",
+    "title_en": "Fundraising",
+    "info_title_de": "Jede Stimme zählt! Erfahre mehr über unser Spendenziel.",
+    "info_title_en": "Every vote counts! Read more about our fundraising goal.",
+    "info_text_de": mark_safe("Deine Teilnahme am Evaluationsprojekt wird helfen. Evaluiere also <b>jetzt</b>!"),
+    "info_text_en": mark_safe("Your participation in the evaluation helps, so evaluate <b>now</b>!"),
 }
+
 # Questionnaires automatically added to exam evaluations
 EXAM_QUESTIONNAIRE_IDS = [111]

evap/settings.py

@@ -390,11 +390,18 @@ class ManifestStaticFilesStorageWithJsReplacement(ManifestStaticFilesStorage):
 
 ### Evaluation progress rewards
 GLOBAL_EVALUATION_PROGRESS_REWARDS: list[
-    tuple[Fraction, str]
+    tuple[Fraction, dict[str, str]]
 ] = []  # (required_voter_ratio between 0 and 1, reward_text)
 GLOBAL_EVALUATION_PROGRESS_EXCLUDED_COURSE_TYPE_IDS: list[int] = []
 GLOBAL_EVALUATION_PROGRESS_EXCLUDED_EVALUATION_IDS: list[int] = []
-GLOBAL_EVALUATION_PROGRESS_INFO_TEXT: dict[str, str] = {"de": "", "en": ""}
+GLOBAL_EVALUATION_PROGRESS_CAMPAIGN: dict[str, str] = {
+    "title_de": "",
+    "title_en": "",
+    "info_title_de": "",
+    "info_title_en": "",
+    "info_text_de": "",
+    "info_text_en": "",
+}
 
 ### Slogans
 SLOGANS_DE = [

…ent/templates/student_global_reward.html …/student_global_evaluation_progress.htmlevap/student/templates/student_global_reward.html renamed to evap/student/templates/student_global_evaluation_progress.html evap/student/templates/student_global_reward.html renamed to evap/student/templates/student_global_evaluation_progress.html

@@ -1,12 +1,12 @@
 {% load evaluation_filters %}
 
-{% if global_rewards %}
+{% if global_evaluation_progress %}
     <div class="card mb-3">
         <div class="card-header d-flex">
-            {% translate "Fundraising" %}
-            {% if global_rewards.last_vote_datetime %}
+            {{ global_evaluation_progress.campaign.title }}
+            {% if global_evaluation_progress.last_vote_datetime %}
                 <div class="ms-auto fw-normal fst-italic">
-                    {% blocktranslate trimmed with time_interval=global_rewards.last_vote_datetime|timesince %}
+                    {% blocktranslate trimmed with time_interval=global_evaluation_progress.last_vote_datetime|timesince %}
                         Last evaluation: {{ time_interval }} ago
                     {% endblocktranslate %}
                 </div>
@@ -16,17 +16,17 @@
             <div class="global-rewards-progress-bar pt-2 px-4">
                 <span class="progress-container">
                     <span class="progress m-0 bg-info">
-                        <span class="progress-bar bg-primary width-percent-{% widthratio global_rewards.bar_width_votes global_rewards.max_reward_votes 100 %}"></span>
+                        <span class="progress-bar bg-primary width-percent-{% widthratio global_evaluation_progress.bar_width_votes global_evaluation_progress.max_reward_votes 100 %}"></span>
                         <span class="progress-bartext">
-                            {% blocktranslate trimmed count votes=global_rewards.vote_count with percent=global_rewards.vote_count|percentage_zero_on_error:global_rewards.participation_count %}
+                            {% blocktranslate trimmed count votes=global_evaluation_progress.vote_count with percent=global_evaluation_progress.vote_count|percentage_zero_on_error:global_evaluation_progress.participation_count %}
                                 {{ votes }} submitted evaluation ({{ percent }})
                             {% plural %}
                                 {{ votes }} submitted evaluations ({{ percent }})
                             {% endblocktranslate %}
                         </span>
                     </span>
                 </span>
-                {% for reward in global_rewards.rewards_with_progress %}
+                {% for reward in global_evaluation_progress.rewards_with_progress %}
                     <div class="position-relative progress-step left-percent-{% widthratio reward.progress 1 100 %}">
                         <div class="mx-auto seperator"></div>
                         <div class="small text-center">
@@ -39,12 +39,12 @@
             <div class="card card-outline-light collapsible mt-2">
                 <div class="card-header d-flex">
                     <a class="collapse-toggle collapse-toggle-light collapsed" data-bs-toggle="collapse" href="#goal-info-text" aria-controls="goal-info-text">
-                        {% translate "Every vote counts! Read more about our fundraising goal." %}
+                        {{ global_evaluation_progress.campaign.info_title }}
                     </a>
                 </div>
                 <div class="collapse" id="goal-info-text">
                     <div class="card-body">
-                        {{ global_rewards.info_text }}
+                        {{ global_evaluation_progress.campaign.info_text }}
                     </div>
                 </div>
             </div>

evap/student/templates/student_index.html

@@ -17,7 +17,7 @@
         </div>
     {% endif %}
 
-    {% include 'student_global_reward.html' with global_rewards=global_rewards %}
+    {% include 'student_global_evaluation_progress.html' with global_evaluation_progress=global_evaluation_progress %}
 
     {% if unfinished_evaluations %}
         <div class="card card-outline-primary mb-3">

evap/student/tests/test_views.py

@@ -58,12 +58,22 @@ def test_num_queries_is_constant(self):
             self.app.get(self.url, user=self.user)
 
     @override_settings(
-        GLOBAL_EVALUATION_PROGRESS_REWARDS=[(Fraction(1, 10), "a dog"), (Fraction(5, 10), "a quokka")],
-        GLOBAL_EVALUATION_PROGRESS_INFO_TEXT={"de": "info_text_str", "en": "info_text_str"},
+        GLOBAL_EVALUATION_PROGRESS_REWARDS=[
+            (Fraction(1, 10), {"de": "a dog", "en": "a dog"}),
+            (Fraction(5, 10), {"de": "a quokka", "en": "a quokka"}),
+        ],
+        GLOBAL_EVALUATION_PROGRESS_CAMPAIGN={
+            "title_de": "global_evaluation_progress_title_str",
+            "title_en": "global_evaluation_progress_title_str",
+            "info_title_de": "global_evaluation_progress_info_title_str",
+            "info_title_en": "global_evaluation_progress_info_title_str",
+            "info_text_de": "global_evaluation_progress_info_text_str",
+            "info_text_en": "global_evaluation_progress_info_text_str",
+        },
         GLOBAL_EVALUATION_PROGRESS_EXCLUDED_COURSE_TYPE_IDS=[1042],
         GLOBAL_EVALUATION_PROGRESS_EXCLUDED_EVALUATION_IDS=[1043],
     )
-    def test_global_reward_progress(self):
+    def test_global_evaluation_progress(self):
         excluded_states = [state for state in Evaluation.State if state < Evaluation.State.APPROVED]
         included_states = [state for state in Evaluation.State if state >= Evaluation.State.APPROVED]
 
@@ -97,17 +107,18 @@ def test_global_reward_progress(self):
         expected_voter_percent = 100 * expected_voters // expected_participants
 
         page = self.app.get(self.url, user=self.user)
-        self.assertIn("Fundraising", page)
-        self.assertIn("info_text_str", page)
+        self.assertIn("global_evaluation_progress_title_str", page)
+        self.assertIn("global_evaluation_progress_info_title_str", page)
+        self.assertIn("global_evaluation_progress_info_text_str", page)
         self.assertIn("Last evaluation:", page)
         self.assertIn(f"{expected_voters} submitted evaluations ({expected_voter_percent}%)", page)
         self.assertIn("a quokka", page)
         self.assertIn("10%", page)
         self.assertIn("a dog", page)
         self.assertIn("50%", page)
 
-    @override_settings(GLOBAL_EVALUATION_PROGRESS_REWARDS=[(Fraction("0.07"), "a dog")])
-    def test_global_reward_progress_edge_cases(self):
+    @override_settings(GLOBAL_EVALUATION_PROGRESS_REWARDS=[(Fraction("0.07"), {"de": "a dog", "en": "a dog"})])
+    def test_global_evaluation_progress_edge_cases(self):
         # no active semester
         Semester.objects.update(is_active=False)
         page = self.app.get(self.url, user=self.user)
@@ -138,12 +149,20 @@ def test_global_reward_progress_edge_cases(self):
 
     @override_settings(
         GLOBAL_EVALUATION_PROGRESS_REWARDS=[],
-        GLOBAL_EVALUATION_PROGRESS_INFO_TEXT={"de": "info_text_str", "en": "info_text_str"},
+        GLOBAL_EVALUATION_PROGRESS_CAMPAIGN={
+            "title_de": "global_evaluation_progress_title_str",
+            "title_en": "global_evaluation_progress_title_str",
+            "info_title_de": "global_evaluation_progress_info_title_str",
+            "info_title_en": "global_evaluation_progress_info_title_str",
+            "info_text_de": "global_evaluation_progress_info_text_str",
+            "info_text_en": "global_evaluation_progress_info_text_str",
+        },
     )
-    def test_global_reward_progress_hidden(self):
+    def test_global_evaluation_progress_hidden(self):
         page = self.app.get(self.url, user=self.user)
-        self.assertNotIn("Fundraising", page)
-        self.assertNotIn("info_text_str", page)
+        self.assertNotIn("global_evaluation_progress_title_str", page)
+        self.assertNotIn("global_evaluation_progress_info_title_str", page)
+        self.assertNotIn("global_evaluation_progress_info_text_str", page)
 
 
 @override_settings(INSTITUTION_EMAIL_DOMAINS=["example.com"])

evap/student/views.py

@@ -28,6 +28,7 @@
     TextAnswer,
     VoteTimestamp,
 )
+from evap.evaluation.tools import translate
 from evap.results.tools import (
     annotate_distributions_and_grades,
     get_evaluations_with_course_result_attributes,
@@ -41,29 +42,45 @@
 
 
 @dataclass
-class GlobalRewards:
+class GlobalEvaluationProgress:
     @dataclass
     class RewardProgress:
         progress: Fraction  # progress towards this reward, relative to max reward, between 0 and 1
         vote_ratio: Fraction
         text: str
 
+    @dataclass
+    class Campaign:
+        title_de: str
+        title_en: str
+        title = translate(en="title_en", de="title_de")
+
+        info_title_de: str
+        info_title_en: str
+        info_title = translate(en="info_title_en", de="info_title_de")
+
+        info_text_de: str
+        info_text_en: str
+        info_text = translate(en="info_text_en", de="info_text_de")
+
     vote_count: int
     participation_count: int
     max_reward_votes: int
     bar_width_votes: int
     last_vote_datetime: datetime.datetime
     rewards_with_progress: list[RewardProgress]
-    info_text: str
+    campaign: Campaign
 
     @staticmethod
-    def from_settings() -> "GlobalRewards | None":
+    def from_settings() -> "GlobalEvaluationProgress | None":
         if not settings.GLOBAL_EVALUATION_PROGRESS_REWARDS:
             return None
 
         if not Semester.active_semester():
             return None
 
+        language = get_language()
+
         evaluations = (
             Semester.active_semester()
             .evaluations.exclude(state__lt=Evaluation.State.APPROVED)
@@ -83,22 +100,24 @@ def from_settings() -> "GlobalRewards | None":
         max_reward_votes = math.ceil(max_reward_vote_ratio * participation_count)
 
         rewards_with_progress = [
-            GlobalRewards.RewardProgress(progress=vote_ratio / max_reward_vote_ratio, vote_ratio=vote_ratio, text=text)
+            GlobalEvaluationProgress.RewardProgress(
+                progress=vote_ratio / max_reward_vote_ratio, vote_ratio=vote_ratio, text=text[language]
+            )
             for vote_ratio, text in settings.GLOBAL_EVALUATION_PROGRESS_REWARDS
         ]
 
         last_vote_datetime = VoteTimestamp.objects.filter(evaluation__in=evaluations).aggregate(Max("timestamp"))[
             "timestamp__max"
         ]
 
-        return GlobalRewards(
+        return GlobalEvaluationProgress(
             vote_count=vote_count,
             participation_count=participation_count,
             max_reward_votes=max_reward_votes,
             bar_width_votes=min(vote_count, max_reward_votes),
             last_vote_datetime=last_vote_datetime,
             rewards_with_progress=rewards_with_progress,
-            info_text=settings.GLOBAL_EVALUATION_PROGRESS_INFO_TEXT[get_language()],
+            campaign=GlobalEvaluationProgress.Campaign(**settings.GLOBAL_EVALUATION_PROGRESS_CAMPAIGN),
         )
 
 
@@ -189,7 +208,7 @@ def sorter(evaluation):
         "can_download_grades": request.user.can_download_grades,
         "unfinished_evaluations": unfinished_evaluations,
         "evaluation_end_warning_period": settings.EVALUATION_END_WARNING_PERIOD,
-        "global_rewards": GlobalRewards.from_settings(),
+        "global_evaluation_progress": GlobalEvaluationProgress.from_settings(),
     }
 
     return render(request, "student_index.html", template_data)