feat: Make top_corporate_members more generic

Author: antoinehashbang

djangoproject/templates/aggregator/index.html

@@ -99,5 +99,5 @@ <h2 class="bullet-icon"><i class="icon icon-rss blue"></i> {{ feedtype.name }}</
 {% endblock %}
 
 {% block content-related-extra %}
-  {% top_and_gold_corporate_members %}
+  {% top_corporate_members "diamond" "platinum" "gold" header="Diamond, Platinum and Gold Members" %}
 {% endblock %}

djangoproject/templates/flatpages/foundation.html

@@ -10,5 +10,5 @@ <h1>{{ flatpage.title }}</h1>
 {% endblock %}
 
 {% block content-related-extra %}
-    {% top_and_gold_corporate_members %}
+    {% top_corporate_members "diamond" "platinum" "gold" header="Diamond, Platinum and Gold Members" %}
 {% endblock %}

djangoproject/templates/fundraising/includes/top_and_gold_corporate_members.html

@@ -1,6 +1,6 @@
 {% if members %}
   <div class="corporate-members">
-    <h3>Diamond and Platinum Members</h3>
+    <h3>{{header}}</h3>
     {% for obj in members %}
       <div class="clearfix">
         <div class="member-logo">

djangoproject/templates/fundraising/includes/top_corporate_members.html

@@ -279,7 +279,7 @@ <h2 id="unsupported-versions">Unsupported previous releases</h2>
   <div role="complementary">
     <h2 class="visuallyhidden" id="aside-header">Additional Information</h2>
 
-    {% top_corporate_members %}
+    {% top_corporate_members "diamond" "platinum" header="Diamond and Platinum Members" %}
 
     {% donation_snippet %}
 

djangoproject/templates/releases/download.html

@@ -223,6 +223,6 @@ <h3 id="links-wrapper-header">{% trans "Download:" %}</h3>
       </section>
     {% endblock links-wrapper %}
 
-    {% top_corporate_members %}
+    {% top_corporate_members "diamond" "platinum" header="Diamond and Platinum Members" %}
   </div>
 {% endblock content-related %}

docs/templates/docs/doc.html

@@ -114,14 +114,16 @@ def display_django_heroes():
 
 
 @register.inclusion_tag("fundraising/includes/top_corporate_members.html")
-def top_corporate_members():
-    members = CorporateMember.objects.by_membership_level()
+def top_corporate_members(*levels, header=None):
+    """
+    Usage:
+    {% top_corporate_members "diamond" "platinum" header="Diamond and Platinum Members" %}
+    """
 
-    return {"members": members["diamond"] + members["platinum"]}
+    all_members: dict = CorporateMember.objects.by_membership_level()
 
+    members = []
+    for level in levels:
+        members.extend(all_members.get(level, []))
 
-@register.inclusion_tag("fundraising/includes/top_and_gold_corporate_members.html")
-def top_and_gold_corporate_members():
-    members = CorporateMember.objects.by_membership_level()
-
-    return {"members": members["diamond"] + members["platinum"] + members["gold"]}
+    return {"header": header, "members": members}

fundraising/templatetags/fundraising_extras.py

@@ -17,7 +17,6 @@
 from ..templatetags.fundraising_extras import (
     display_django_heroes,
     donation_form_with_heart,
-    top_and_gold_corporate_members,
     top_corporate_members,
 )
 
@@ -111,12 +110,14 @@ def setUpTestData(cls):
 
         member_1.invoice_set.create(amount=5, expiration_date=cls.future_date)
         member_2.invoice_set.create(amount=5, expiration_date=cls.future_date)
-        member_3.invoice_set.create(amount=5, expiration_date=cls.future_date)
+        member_3.invoice_set.create(amount=5, expiration_date=cls.past_date)
         member_4.invoice_set.create(amount=5, expiration_date=cls.past_date)
         member_5.invoice_set.create(amount=5, expiration_date=cls.past_date)
 
     def test_with_no_platinum_or_diamond_members(self):
-        members = top_corporate_members()["members"]
+        members = top_corporate_members(
+            "diamond", "platinum", header="Diamond and Platinum members"
+        )["members"]
 
         self.assertEqual(members, [])
 
@@ -129,7 +130,9 @@ def test_with_diamond_members_and_no_platinum_members(self):
         member_2.invoice_set.create(amount=8, expiration_date=self.future_date)
         member_3.invoice_set.create(amount=2, expiration_date=self.future_date)
 
-        members = top_corporate_members()["members"]
+        members = top_corporate_members(
+            "diamond", "platinum", header="Diamond and Platinum members"
+        )["members"]
 
         self.assertEqual(members, [member_2, member_1, member_3])
 
@@ -142,7 +145,9 @@ def test_with_platinum_members_and_no_diamond_members(self):
         member_2.invoice_set.create(amount=8, expiration_date=self.future_date)
         member_3.invoice_set.create(amount=2, expiration_date=self.future_date)
 
-        members = top_corporate_members()["members"]
+        members = top_corporate_members(
+            "diamond", "platinum", header="Diamond and Platinum members"
+        )["members"]
 
         self.assertEqual(members, [member_2, member_1, member_3])
 
@@ -163,60 +168,50 @@ def test_with_diamond_members_and_platinum_members(self):
         member_5.invoice_set.create(amount=8, expiration_date=self.future_date)
         member_6.invoice_set.create(amount=2, expiration_date=self.future_date)
 
-        members = top_corporate_members()["members"]
+        members = top_corporate_members(
+            "diamond", "platinum", header="Diamond and Platinum members"
+        )["members"]
 
         expected = [member_5, member_4, member_6, member_2, member_1, member_3]
 
         self.assertEqual(members, expected)
 
+    def test_with_diamond_platinum_and_gold_members(self):
+        member_1 = CorporateMember.objects.create(membership_level=4)
+        member_2 = CorporateMember.objects.create(membership_level=4)
+        member_3 = CorporateMember.objects.create(membership_level=4)
 
-class TestTopAndGoldCorporateMembers(TestCase):
-    past_date = date(2000, 1, 1)
-    future_date = date(3000, 1, 1)
-
-    def test_with_no_gold_members(self):
-        members = top_and_gold_corporate_members()["members"]
-        self.assertEqual(members, [])
+        member_4 = CorporateMember.objects.create(membership_level=5)
+        member_5 = CorporateMember.objects.create(membership_level=5)
+        member_6 = CorporateMember.objects.create(membership_level=5)
 
-    def test_with_gold_members(self):
-        member_1 = CorporateMember.objects.create(membership_level=3)
-        member_2 = CorporateMember.objects.create(membership_level=3)
-        member_3 = CorporateMember.objects.create(membership_level=3)
+        member_7 = CorporateMember.objects.create(membership_level=3)
+        member_8 = CorporateMember.objects.create(membership_level=3)
 
         member_1.invoice_set.create(amount=4, expiration_date=self.future_date)
         member_2.invoice_set.create(amount=8, expiration_date=self.future_date)
         member_3.invoice_set.create(amount=2, expiration_date=self.future_date)
 
-        members = top_and_gold_corporate_members()["members"]
-
-        self.assertEqual(members, [member_2, member_1, member_3])
-
-    def test_with_gold_members_and_other_members(self):
-        member_1 = CorporateMember.objects.create(membership_level=3)
-        member_2 = CorporateMember.objects.create(membership_level=3)
-        member_3 = CorporateMember.objects.create(membership_level=4)
-        member_4 = CorporateMember.objects.create(membership_level=5)
-        member_5 = CorporateMember.objects.create(membership_level=2)
-
-        member_1.invoice_set.create(amount=4, expiration_date=self.future_date)
-        member_2.invoice_set.create(amount=8, expiration_date=self.future_date)
-        member_3.invoice_set.create(amount=2, expiration_date=self.future_date)
-        member_4.invoice_set.create(amount=2, expiration_date=self.future_date)
-        member_5.invoice_set.create(amount=2, expiration_date=self.future_date)
+        member_4.invoice_set.create(amount=4, expiration_date=self.future_date)
+        member_5.invoice_set.create(amount=8, expiration_date=self.future_date)
+        member_6.invoice_set.create(amount=2, expiration_date=self.future_date)
 
-        members = top_and_gold_corporate_members()["members"]
-        self.assertEqual(members, [member_4, member_3, member_2, member_1])
-        self.assertNotIn(member_5, members)
+        member_7.invoice_set.create(amount=8, expiration_date=self.future_date)
+        member_8.invoice_set.create(amount=2, expiration_date=self.future_date)
 
-    def test_with_gold_members_and_expired_invoice(self):
-        member_1 = CorporateMember.objects.create(membership_level=3)
-        member_2 = CorporateMember.objects.create(membership_level=3)
-        member_3 = CorporateMember.objects.create(membership_level=4)
+        members = top_corporate_members(
+            "diamond", "platinum", "gold", header="Diamond, Platinum and Gold members"
+        )["members"]
 
-        member_1.invoice_set.create(amount=4, expiration_date=self.future_date)
-        member_2.invoice_set.create(amount=8, expiration_date=self.future_date)
-        member_3.invoice_set.create(amount=2, expiration_date=self.past_date)
+        expected = [
+            member_5,
+            member_4,
+            member_6,
+            member_2,
+            member_1,
+            member_3,
+            member_7,
+            member_8,
+        ]
 
-        members = top_and_gold_corporate_members()["members"]
-        self.assertEqual(members, [member_2, member_1])
-        self.assertNotIn(member_3, members)
+        self.assertEqual(members, expected)