New boolean to SponsorshipPackage (#1865)

* Add boolean flag to toggle package in application form

* Data migration to update existing sponsorship packages

* Only list advertisable packages in the application form

* reorder migrations

* minor rename and text updates

Co-authored-by: Ee Durbin <[email protected]>

Author: berinhard

sponsors/admin.py

@@ -112,7 +112,9 @@ def update_related_sponsorships(self, *args, **kwargs):
 @admin.register(SponsorshipPackage)
 class SponsorshipPackageAdmin(OrderedModelAdmin):
     ordering = ("order",)
-    list_display = ["name", "move_up_down_links"]
+    list_display = ["name", "advertise", "move_up_down_links"]
+    list_filter = ["advertise"]
+    search_fields = ["name"]
 
     def get_readonly_fields(self, request, obj=None):
         if request.user.is_superuser:

sponsors/forms.py

@@ -46,7 +46,7 @@ class Meta:
 
 class SponsorshiptBenefitsForm(forms.Form):
     package = forms.ModelChoiceField(
-        queryset=SponsorshipPackage.objects.all(),
+        queryset=SponsorshipPackage.objects.list_advertisables(),
         widget=forms.RadioSelect(),
         required=False,
         empty_label=None,

sponsors/managers.py

@@ -67,3 +67,8 @@ def with_packages(self):
             .exclude(num_packages=0)
             .order_by("-num_packages", "order")
         )
+
+
+class SponsorshipPackageManager(OrderedModelManager):
+    def list_advertisables(self):
+        return self.filter(advertise=True)

sponsors/migrations/0046_sponsorshippackage_advertise.py

@@ -0,0 +1,18 @@
+# Generated by Django 2.0.13 on 2021-09-08 13:52
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('sponsors', '0045_add_added_by_user_sponsorbenefit'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='sponsorshippackage',
+            name='advertise',
+            field=models.BooleanField(default=False, help_text='If checked, this package will be advertised in the sponsosrhip application'),
+        ),
+    ]

sponsors/migrations/0047_auto_20210908_1357.py

@@ -0,0 +1,20 @@
+# Generated by Django 2.0.13 on 2021-09-08 13:57
+
+from django.db import migrations
+
+
+def update_package_as_advertisable(apps, schema_editor):
+    SponsorshipPackage = apps.get_model("sponsors.SponsorshipPackage")
+    # initial sponsorship packages should remaing visible in the form
+    SponsorshipPackage.objects.all().update(advertise=True)
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('sponsors', '0046_sponsorshippackage_advertise'),
+    ]
+
+    operations = [
+        migrations.RunPython(update_package_as_advertisable, migrations.RunPython.noop)
+    ]

sponsors/models.py

@@ -23,6 +23,7 @@
     SponsorContactQuerySet,
     SponsorshipQuerySet,
     SponsorshipBenefitManager,
+    SponsorshipPackageManager
 )
 from .exceptions import (
     SponsorWithExistingApplicationException,
@@ -38,9 +39,11 @@ class SponsorshipPackage(OrderedModel):
     """
     Represent default packages of benefits (visionary, sustainability etc)
     """
+    objects = SponsorshipPackageManager()
 
     name = models.CharField(max_length=64)
     sponsorship_amount = models.PositiveIntegerField()
+    advertise = models.BooleanField(default=False, blank=True, help_text="If checked, this package will be advertised in the sponsosrhip application")
     logo_dimension = models.PositiveIntegerField(default=175, blank=True, help_text="Internal value used to control logos dimensions at sponsors page")
 
     def __str__(self):

sponsors/tests/test_forms.py

@@ -28,7 +28,7 @@ def setUp(self):
         self.program_2_benefits = baker.make(
             SponsorshipBenefit, program=self.wk, _quantity=5
         )
-        self.package = baker.make("sponsors.SponsorshipPackage")
+        self.package = baker.make("sponsors.SponsorshipPackage", advertise=True)
         self.package.benefits.add(*self.program_1_benefits)
         self.package.benefits.add(*self.program_2_benefits)
 
@@ -63,6 +63,15 @@ def test_specific_field_to_select_add_ons(self):
         for benefit in self.program_2_benefits:
             self.assertIn(benefit.id, [c[0] for c in choices])
 
+    def test_package_list_only_advertisable_ones(self):
+        ads_pkgs = baker.make('SponsorshipPackage', advertise=True, _quantity=2)
+        baker.make('SponsorshipPackage', advertise=False)
+
+        form = SponsorshiptBenefitsForm()
+        field = form.fields.get("package")
+
+        self.assertEqual(3, field.queryset.count())
+
     def test_invalidate_form_without_benefits(self):
         form = SponsorshiptBenefitsForm(data={})
         self.assertFalse(form.is_valid())
@@ -127,19 +136,19 @@ def test_package_only_benefit_without_package_should_not_validate(self):
 
     def test_package_only_benefit_with_wrong_package_should_not_validate(self):
         SponsorshipBenefit.objects.all().update(package_only=True)
-        package = baker.make("sponsors.SponsorshipPackage")
+        package = baker.make("sponsors.SponsorshipPackage", advertise=True)
         package.benefits.add(*SponsorshipBenefit.objects.all())
 
         data = {
             "benefits_psf": [self.program_1_benefits[0]],
-            "package": baker.make("sponsors.SponsorshipPackage").id,  # other package
+            "package": baker.make("sponsors.SponsorshipPackage", advertise=True).id,  # other package
         }
 
         form = SponsorshiptBenefitsForm(data=data)
         self.assertFalse(form.is_valid())
         self.assertIn(
             "The application has 1 or more package only benefits but wrong sponsor package.",
-            form.errors["__all__"],
+            form.errors["__all__"][0],
         )
 
         data = {

sponsors/tests/test_views.py

@@ -35,9 +35,9 @@ def setUp(self):
         self.program_2_benefits = baker.make(
             SponsorshipBenefit, program=self.wk, _quantity=5
         )
-        self.package = baker.make("sponsors.SponsorshipPackage")
+        self.package = baker.make("sponsors.SponsorshipPackage", advertise=True)
         self.package.benefits.add(*self.program_1_benefits)
-        package_2 = baker.make("sponsors.SponsorshipPackage")
+        package_2 = baker.make("sponsors.SponsorshipPackage", advertise=True)
         package_2.benefits.add(*self.program_2_benefits)
         self.add_on_benefits = baker.make(
             SponsorshipBenefit, program=self.psf, _quantity=2
@@ -61,8 +61,8 @@ def populate_test_cookie(self):
         session.save()
 
     def test_display_template_with_form_and_context(self):
-        psf_package = baker.make("sponsors.SponsorshipPackage")
-        extra_package = baker.make("sponsors.SponsorshipPackage")
+        psf_package = baker.make("sponsors.SponsorshipPackage", advertise=True)
+        extra_package = baker.make("sponsors.SponsorshipPackage", advertise=True)
 
         r = self.client.get(self.url)
         packages = r.context["sponsorship_packages"]
@@ -103,15 +103,15 @@ def test_populate_form_initial_with_values_from_cookie(self):
         self.assertEqual(self.data, r.context["form"].initial)
 
     def test_capacity_flag(self):
-        psf_package = baker.make("sponsors.SponsorshipPackage")
+        psf_package = baker.make("sponsors.SponsorshipPackage", advertise=True)
         r = self.client.get(self.url)
         self.assertEqual(False, r.context["capacities_met"])
 
     def test_capacity_flag_when_needed(self):
         at_capacity_benefit = baker.make(
             SponsorshipBenefit, program=self.psf, capacity=0, soft_capacity=False
         )
-        psf_package = baker.make("sponsors.SponsorshipPackage")
+        psf_package = baker.make("sponsors.SponsorshipPackage", advertise=True)
 
         r = self.client.get(self.url)
         self.assertEqual(True, r.context["capacities_met"])
@@ -149,7 +149,7 @@ def setUp(self):
         self.program_1_benefits = baker.make(
             SponsorshipBenefit, program=self.psf, _quantity=3
         )
-        self.package = baker.make("sponsors.SponsorshipPackage")
+        self.package = baker.make("sponsors.SponsorshipPackage", advertise=True)
         for benefit in self.program_1_benefits:
             benefit.packages.add(self.package)
         self.client.cookies["sponsorship_selected_benefits"] = json.dumps(