Update display modifiers to prioritize label instead of quantity

berinhard · ewdurbin · commit f2872e094114 · 2022-08-11T14:57:07.000-04:00
diff --git a/sponsors/models/benefits.py b/sponsors/models/benefits.py
@@ -424,7 +424,7 @@ def __str__(self):
     def display_modifier(self, name, **kwargs):
         if kwargs.get("package") != self.package:
             return name
-        return f"{name} ({self.quantity})"
+        return f"{name} ({self.display_label or self.quantity})"
 
     def get_clone_kwargs(self, new_benefit):
         kwargs = super().get_clone_kwargs(new_benefit)
@@ -570,7 +570,7 @@ class Meta(BaseTieredBenefit.Meta, BenefitFeature.Meta):
         verbose_name_plural = "Tiered Benefits"
 
     def display_modifier(self, name, **kwargs):
-        return f"{name} ({self.quantity})"
+        return f"{name} ({self.display_label or self.quantity})"
 
     def __str__(self):
         return f"{self.quantity} of {self.sponsor_benefit} for {self.package}"
diff --git a/sponsors/tests/test_models.py b/sponsors/tests/test_models.py
@@ -1004,7 +1004,14 @@ def test_display_modifier_only_modifies_name_if_same_package(self):
         name = "Benefit"
         other_package = baker.make(SponsorshipPackage)
 
+        # modifies for the same package as the config + label prioritized
+        self.config.save(update_fields=["display_label"])
+        modified_name = self.config.display_modifier(name, package=self.package)
+        self.assertEqual(modified_name, f"{name} (Foo)")
+
         # modifies for the same package as the config
+        self.config.display_label = ""
+        self.config.save(update_fields=["display_label"])
         modified_name = self.config.display_modifier(name, package=self.package)
         self.assertEqual(modified_name, f"{name} (10)")
 
@@ -1046,6 +1053,11 @@ def test_display_modifier_adds_quantity_to_the_name(self):
         name = 'Benefit'
         self.assertEqual(placement.display_modifier(name), 'Benefit (10)')
 
+    def test_display_modifier_adds_display_label_to_the_name(self):
+        placement = baker.make(TieredBenefit, quantity=10, display_label="Foo")
+        name = 'Benefit'
+        self.assertEqual(placement.display_modifier(name), 'Benefit (Foo)')
+
 
 class RequiredImgAssetConfigurationTests(TestCase):
 
