Implement REVIEW_SCORE_SHOW_TOTAL for review all views, review detail view and Slack messages as well.

Author: frjo

docs/setup/administrators/configuration.md

@@ -207,7 +207,7 @@ Send out e-mail, slack messages etc. from Hypha. Set to true for production.
 
 ----
 
-Show the total (sum) of a review's scored answers instead of the average of them, in the "Reviews & assignees" block on the submission detail page. The block's overall score is then the sum of every review's total, rather than the average of their averages.
+Show the total (sum) of a review's scored answers instead of the average of them. Affects the "Reviews & assignees" block on the submission detail page, the review detail page and the all-reviews comparison table. The overall score in the "Reviews & assignees" block is then the sum of every review's total, rather than the average of their averages.
 
     REVIEW_SCORE_SHOW_TOTAL = env.bool('REVIEW_SCORE_SHOW_TOTAL', False)
 

hypha/apply/activity/adapters/slack.py

@@ -58,7 +58,7 @@ class SlackAdapter(AdapterBase):
             "<{link}|{source.title_text_display}> by {source.user} has been invited to submit a proposal"
         ),
         MESSAGES.NEW_REVIEW: _(
-            "{user} has submitted a review for <{link}|{source.title_text_display}>. Outcome: {review.outcome},  Score: {review.get_score_display}"
+            "{user} has submitted a review for <{link}|{source.title_text_display}>. Outcome: {review.outcome},  Score: {review.score_display}"
         ),
         MESSAGES.READY_FOR_REVIEW: "notify_reviewers",
         MESSAGES.OPENED_SEALED: _(

hypha/apply/funds/templates/funds/includes/review_sidebar_item.html

@@ -1,4 +1,4 @@
-{% load i18n review_tags wagtailimages_tags heroicons %}
+{% load i18n wagtailimages_tags heroicons %}
 
 <li
     class="px-0 py-2 {% if not reviewer.review %}text-base-content/80 {% endif %}"
@@ -49,7 +49,7 @@
                     {% if reviewer.role %}{% image reviewer.role.icon max-12x12 %}{% endif %}
                 </div>
             {% endif %}
-            {% with reviewer.review.get_recommendation_display as recommendation and reviewer.review|review_score as score %}
+            {% with reviewer.review.get_recommendation_display as recommendation and reviewer.review.score_display as score %}
                 <div class="col-span-1 {{ recommendation|slugify }}">{{ recommendation }}</div>
                 <div class="col-span-1 {{ recommendation|slugify }}">{{ score }}</div>
             {% endwith %}

hypha/apply/review/models.py

@@ -1,3 +1,4 @@
+from django.conf import settings
 from django.core.serializers.json import DjangoJSONEncoder
 from django.db import models
 from django.urls import reverse
@@ -230,7 +231,15 @@ def get_score_display(self):
 
     @property
     def get_total_score_display(self):
-        return "{:.1f}".format(self.total_score) if self.total_score != NA else "-"
+        # Scores are whole numbers, so their total is one too.
+        return "{:.0f}".format(self.total_score) if self.total_score != NA else "-"
+
+    @property
+    def score_display(self):
+        """The score to show in the UI, set with REVIEW_SCORE_SHOW_TOTAL."""
+        if settings.REVIEW_SCORE_SHOW_TOTAL:
+            return self.get_total_score_display
+        return self.get_score_display
 
     def get_absolute_url(self):
         return reverse(

hypha/apply/review/templates/review/review_detail.html

@@ -42,7 +42,7 @@
                                 </div>
                                 <div>
                                     <dt class="mb-2 font-bold">{% trans "Score" %}</dt>
-                                    <dd><p class="badge badge-outline">{{ review.get_score_display }}</p></dd>
+                                    <dd><p class="badge badge-outline">{{ review.score_display }}</p></dd>
                                 </div>
                                 <div>
                                     <dt class="mb-2 font-bold">{% trans "Visibility" %}</dt>

hypha/apply/review/templatetags/review_tags.py

@@ -51,14 +51,6 @@ def has_draft(user, submission):
     )
 
 
-@register.filter
-def review_score(review):
-    """The score of a single review, as shown in the reviews sidebar."""
-    if settings.REVIEW_SCORE_SHOW_TOTAL:
-        return review.get_total_score_display
-    return review.get_score_display
-
-
 @register.filter
 def reviews_score(reviewers):
     """The combined score of the submitted reviews, for the reviews sidebar.
@@ -80,7 +72,7 @@ def reviews_score(reviewers):
     if settings.REVIEW_SCORE_SHOW_TOTAL:
         totals = [review.total_score for review in reviews if review.total_score != NA]
         if totals:
-            return _("Total score: {total}").format(total=sum(totals))
+            return _("Total score: {total}").format(total="{:.0f}".format(sum(totals)))
         return ""
 
     scores = [review.score for review in reviews if review.score != NA]

hypha/apply/review/tests/test_models.py

@@ -1,4 +1,4 @@
-from django.test import TestCase
+from django.test import TestCase, override_settings
 
 from hypha.apply.funds.tests.factories import ApplicationSubmissionFactory
 
@@ -100,3 +100,19 @@ def test_na_answers_score_zero(self):
         field = review.score_fields[0]
         review.form_data[field.id] = ["", NA]
         self.assertEqual(review.get_scores(review.form_data)[0], 0)
+
+
+class TestReviewScoreDisplay(TestCase):
+    def test_average_shown_by_default(self):
+        review = ReviewFactory(score=4.5, total_score=18)
+        self.assertEqual(review.score_display, "4.5")
+
+    @override_settings(REVIEW_SCORE_SHOW_TOTAL=True)
+    def test_total_shown_when_enabled(self):
+        review = ReviewFactory(score=4.5, total_score=18)
+        self.assertEqual(review.score_display, "18")
+
+    @override_settings(REVIEW_SCORE_SHOW_TOTAL=True)
+    def test_review_without_scores_shown_as_dash(self):
+        review = ReviewFactory(score=NA, total_score=NA)
+        self.assertEqual(review.score_display, "-")

hypha/apply/review/views.py

@@ -495,7 +495,7 @@ def get_context_data(self, **kwargs):
                 {"opinions": review.opinions.select_related("author").all()}
             )
             review_data["opinions"]["answers"].append(opinions_html)
-            review_data["score"]["answers"].append(review.get_score_display)
+            review_data["score"]["answers"].append(review.score_display)
             review_data["recommendation"]["answers"].append(
                 review.get_recommendation_display()
             )

hypha/settings/base.py

@@ -217,7 +217,7 @@
 REVIEW_VISIBILITY_DEFAULT = env.str("REVIEW_VISIBILITY_DEFAULT", "private")
 
 # Show the total (sum) of a review's scored answers instead of the average of
-# them, in the "Reviews & assignees" block on the submission detail page.
+# them, wherever a review score is shown.
 REVIEW_SCORE_SHOW_TOTAL = env.bool("REVIEW_SCORE_SHOW_TOTAL", False)
 
 # Require an applicant to view their rendered application before submitting