[Refactoring] Foreign key sponsorship --> package (#1852)

berinhard · web-flow · commit 8716928ca7d2 · 2021-09-07T11:00:18.000-04:00
* Add and populape new fk Sponsorship --&gt; SponsorshipPackage

* Populate package fk when creating new sponsorship

* Update admin and sponsorship approval process to use package FK instead

* Refactor to replace level_name by the new FK;

* Simplify package filtering

* Update sponsorship accept process to reference package

* Update form initial to set package

* Store logo dimension info in sponsorship package object

* Refactor agreed_fee property to check for fk instead of get query

* Wrap level name field with properties to isolate the behavior.
diff --git a/sponsors/admin.py b/sponsors/admin.py
@@ -114,6 +114,11 @@ class SponsorshipPackageAdmin(OrderedModelAdmin):
     ordering = ("order",)
     list_display = ["name", "move_up_down_links"]
 
+    def get_readonly_fields(self, request, obj=None):
+        if request.user.is_superuser:
+            return []
+        return ["logo_dimension"]
+
 
 class SponsorContactInline(admin.TabularInline):
     model = SponsorContact
@@ -154,21 +159,6 @@ def has_delete_permission(self, request, obj=None):
         return obj.open_for_editing
 
 
-class LevelNameFilter(admin.SimpleListFilter):
-    title = "level name"
-    parameter_name = "level"
-
-    def lookups(self, request, model_admin):
-        qs = SponsorshipPackage.objects.all()
-        return list({(program.name, program.name) for program in qs})
-
-    def queryset(self, request, queryset):
-        if self.value() == "all":
-            return queryset
-        if self.value():
-            return queryset.filter(level_name=self.value())
-
-
 @admin.register(Sponsorship)
 class SponsorshipAdmin(admin.ModelAdmin):
     change_form_template = "sponsors/admin/sponsorship_change_form.html"
@@ -178,31 +168,13 @@ class SponsorshipAdmin(admin.ModelAdmin):
     list_display = [
         "sponsor",
         "status",
-        "level_name",
+        "package",
         "applied_on",
         "approved_on",
         "start_date",
         "end_date",
     ]
-    list_filter = ["status", LevelNameFilter]
-    readonly_fields = [
-        "for_modified_package",
-        "sponsor",
-        "status",
-        "applied_on",
-        "rejected_on",
-        "approved_on",
-        "finalized_on",
-        "get_estimated_cost",
-        "get_sponsor_name",
-        "get_sponsor_description",
-        "get_sponsor_landing_page_url",
-        "get_sponsor_web_logo",
-        "get_sponsor_print_logo",
-        "get_sponsor_primary_phone",
-        "get_sponsor_mailing_address",
-        "get_sponsor_contacts",
-    ]
+    list_filter = ["status", "package"]
 
     fieldsets = [
         (
@@ -211,13 +183,14 @@ class SponsorshipAdmin(admin.ModelAdmin):
                 "fields": (
                     "sponsor",
                     "status",
+                    "package",
                     "for_modified_package",
-                    "level_name",
                     "sponsorship_fee",
                     "get_estimated_cost",
                     "start_date",
                     "end_date",
-                    "get_contract"
+                    "get_contract",
+                    "level_name",
                 ),
             },
         ),
@@ -259,6 +232,7 @@ def get_readonly_fields(self, request, obj):
             "rejected_on",
             "approved_on",
             "finalized_on",
+            "level_name",
             "get_estimated_cost",
             "get_sponsor_name",
             "get_sponsor_description",
@@ -272,7 +246,7 @@ def get_readonly_fields(self, request, obj):
         ]
 
         if obj and obj.status != Sponsorship.APPLIED:
-            extra = ["start_date", "end_date", "level_name", "sponsorship_fee"]
+            extra = ["start_date", "end_date", "package", "level_name", "sponsorship_fee"]
             readonly_fields.extend(extra)
 
         return readonly_fields
diff --git a/sponsors/forms.py b/sponsors/forms.py
@@ -348,7 +348,7 @@ def __init__(self, *args, **kwargs):
 
     class Meta:
         model = Sponsorship
-        fields = ["start_date", "end_date", "level_name", "sponsorship_fee"]
+        fields = ["start_date", "end_date", "package", "sponsorship_fee"]
 
     def clean(self):
         cleaned_data = super().clean()
diff --git a/sponsors/migrations/0037_sponsorship_package.py b/sponsors/migrations/0037_sponsorship_package.py
@@ -0,0 +1,19 @@
+# Generated by Django 2.0.13 on 2021-08-27 12:23
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('sponsors', '0036_auto_20210826_1930'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='sponsorship',
+            name='package',
+            field=models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, to='sponsors.SponsorshipPackage'),
+        ),
+    ]
diff --git a/sponsors/migrations/0038_auto_20210827_1223.py b/sponsors/migrations/0038_auto_20210827_1223.py
@@ -0,0 +1,27 @@
+# Generated by Django 2.0.13 on 2021-08-27 12:23
+
+from django.db import migrations
+
+
+def populate_sponsorship_package_fk(apps, schema_editor):
+    Sponsorship = apps.get_model('sponsors.Sponsorship')
+    SponsorshipPackage = apps.get_model('sponsors.SponsorshipPackage')
+
+    for sponsorship in Sponsorship.objects.all().iterator():
+        try:
+            package = SponsorshipPackage.objects.get(name=sponsorship.level_name)
+            sponsorship.package = package
+            sponsorship.save()
+        except SponsorshipPackage.DoesNotExist:
+            continue
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('sponsors', '0037_sponsorship_package'),
+    ]
+
+    operations = [
+        migrations.RunPython(populate_sponsorship_package_fk, migrations.RunPython.noop)
+    ]
diff --git a/sponsors/migrations/0039_auto_20210827_1248.py b/sponsors/migrations/0039_auto_20210827_1248.py
@@ -0,0 +1,18 @@
+# Generated by Django 2.0.13 on 2021-08-27 12:48
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('sponsors', '0038_auto_20210827_1223'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='sponsorship',
+            name='level_name',
+            field=models.CharField(blank=True, default='', help_text='DEPRECATED: will be removed after manual data sanity check.', max_length=64),
+        ),
+    ]
diff --git a/sponsors/migrations/0040_auto_20210827_1313.py b/sponsors/migrations/0040_auto_20210827_1313.py
@@ -0,0 +1,23 @@
+# Generated by Django 2.0.13 on 2021-08-27 13:13
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('sponsors', '0039_auto_20210827_1248'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='sponsorshippackage',
+            name='logo_dimension',
+            field=models.PositiveIntegerField(default=175),
+        ),
+        migrations.AlterField(
+            model_name='sponsorship',
+            name='level_name',
+            field=models.CharField(blank=True, default='', help_text='DEPRECATED: shall be removed after manual data sanity check.', max_length=64),
+        ),
+    ]
diff --git a/sponsors/migrations/0041_auto_20210827_1313.py b/sponsors/migrations/0041_auto_20210827_1313.py
@@ -0,0 +1,36 @@
+# Generated by Django 2.0.13 on 2021-08-27 13:13
+
+from django.db import migrations
+
+
+def populate_logo_dimensions(apps, schema_editor):
+    SponsorshipPackage = apps.get_model("sponsors.SponsorshipPackage")
+    logo_dimensions = {
+        "Visionary": 350,
+        "Sustainability": 300,
+        "Maintaining": 300,
+        "Contributing": 275,
+        "Supporting": 250,
+        "Partner": 225,
+        "Participating": 225,
+        "Associate": 175,
+    }
+
+    for name, dimension in logo_dimensions.items():
+        SponsorshipPackage.objects.filter(name=name).update(logo_dimension=dimension)
+
+
+def reset_logo_dimensions(apps, schema_editor):
+    SponsorshipPackage = apps.get_model("sponsors.SponsorshipPackage")
+    SponsorshipPackage.objects.all().update(logo_dimension=175)
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('sponsors', '0040_auto_20210827_1313'),
+    ]
+
+    operations = [
+        migrations.RunPython(populate_logo_dimensions, reset_logo_dimensions)
+    ]
diff --git a/sponsors/migrations/0042_auto_20210827_1318.py b/sponsors/migrations/0042_auto_20210827_1318.py
@@ -0,0 +1,18 @@
+# Generated by Django 2.0.13 on 2021-08-27 13:18
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('sponsors', '0041_auto_20210827_1313'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='sponsorshippackage',
+            name='logo_dimension',
+            field=models.PositiveIntegerField(blank=True, default=175, help_text='Internal value used to control logos dimensions at sponsors page'),
+        ),
+    ]
diff --git a/sponsors/migrations/0043_auto_20210827_1343.py b/sponsors/migrations/0043_auto_20210827_1343.py
@@ -0,0 +1,18 @@
+# Generated by Django 2.0.13 on 2021-08-27 13:43
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('sponsors', '0042_auto_20210827_1318'),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name='sponsorship',
+            old_name='level_name',
+            new_name='level_name_old',
+        ),
+    ]
diff --git a/sponsors/migrations/0044_auto_20210827_1344.py b/sponsors/migrations/0044_auto_20210827_1344.py
@@ -0,0 +1,18 @@
+# Generated by Django 2.0.13 on 2021-08-27 13:44
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('sponsors', '0043_auto_20210827_1343'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='sponsorship',
+            name='level_name_old',
+            field=models.CharField(blank=True, default='', help_text='DEPRECATED: shall be removed after manual data sanity check.', max_length=64, verbose_name='Level name'),
+        ),
+    ]
diff --git a/sponsors/models.py b/sponsors/models.py
@@ -41,6 +41,7 @@ class SponsorshipPackage(OrderedModel):
 
     name = models.CharField(max_length=64)
     sponsorship_amount = models.PositiveIntegerField()
+    logo_dimension = models.PositiveIntegerField(default=175, blank=True, help_text="Internal value used to control logos dimensions at sponsors page")
 
     def __str__(self):
         return self.name
@@ -330,14 +331,23 @@ class Sponsorship(models.Model):
         default=False,
         help_text="If true, it means the user customized the package's benefits.",
     )
-    level_name = models.CharField(max_length=64, default="")
+    level_name_old = models.CharField(max_length=64, default="", blank=True, help_text="DEPRECATED: shall be removed after manual data sanity check.", verbose_name="Level name")
+    package = models.ForeignKey(SponsorshipPackage, null=True, on_delete=models.SET_NULL)
     sponsorship_fee = models.PositiveIntegerField(null=True, blank=True)
 
     class Meta:
         permissions = [
             ("sponsor_publisher", "Can access sponsor placement API"),
         ]
 
+    @property
+    def level_name(self):
+        return self.package.name if self.package else self.level_name_old
+
+    @level_name.setter
+    def level_name(self, value):
+        self.level_name_old = value
+
     def __str__(self):
         repr = f"{self.level_name} ({self.get_status_display()}) for sponsor {self.sponsor.name}"
         if self.start_date and self.end_date:
@@ -370,6 +380,7 @@ def new(cls, sponsor, benefits, package=None, submited_by=None):
             submited_by=submited_by,
             sponsor=sponsor,
             level_name="" if not package else package.name,
+            package=package,
             sponsorship_fee=None if not package else package.sponsorship_amount,
             for_modified_package=for_modified_package,
         )
@@ -403,9 +414,8 @@ def agreed_fee(self):
         if self.status in valid_status:
             return self.sponsorship_fee
         try:
-            package = SponsorshipPackage.objects.get(name=self.level_name)
             benefits = [sb.sponsorship_benefit for sb in self.package_benefits.all().select_related('sponsorship_benefit')]
-            if package and not package.has_user_customization(benefits):
+            if self.package and not self.package.has_user_customization(benefits):
                 return self.sponsorship_fee
         except SponsorshipPackage.DoesNotExist:  # sponsorship level names can change over time
             return None
@@ -1028,7 +1038,7 @@ def benefit_feature_class(self):
         return TieredQuantity
 
     def get_benefit_feature_kwargs(self, **kwargs):
-        if kwargs["sponsor_benefit"].sponsorship.level_name == self.package.name:
+        if kwargs["sponsor_benefit"].sponsorship.package == self.package:
             return super().get_benefit_feature_kwargs(**kwargs)
         return None
 
diff --git a/sponsors/templatetags/sponsors.py b/sponsors/templatetags/sponsors.py
@@ -35,25 +35,14 @@ def list_sponsors(logo_place, publisher=PublisherChoices.FOUNDATION.value):
     # logos must be grouped by package and each package muse use
     # specific dimensions to control the logos' grid
     if logo_place == LogoPlacementChoices.SPONSORS_PAGE.value:
-        logo_dimensions = {
-            "Visionary": "350",
-            "Sustainability": "300",
-            "Maintaining": "300",
-            "Contributing": "275",
-            "Supporting": "250",
-            "Partner": "225",
-            "Participating": "225",
-            "Associate": "175",
-        }
         sponsorships_by_package = OrderedDict()
         for pkg in packages:
-            key = pkg.name
-            sponsorships_by_package[key] = {
-                "logo_dimension": logo_dimensions.get(key, "175"),
+            sponsorships_by_package[pkg] = {
+                "logo_dimension": str(pkg.logo_dimension),
                 "sponsorships": [
                     sp
                     for sp in sponsorships
-                    if sp.level_name == key
+                    if sp.package == pkg
                 ]
             }
 
diff --git a/sponsors/tests/test_models.py b/sponsors/tests/test_models.py
diff --git a/sponsors/tests/test_use_cases.py b/sponsors/tests/test_use_cases.py
diff --git a/sponsors/tests/test_views_admin.py b/sponsors/tests/test_views_admin.py
diff --git a/sponsors/use_cases.py b/sponsors/use_cases.py
diff --git a/sponsors/views_admin.py b/sponsors/views_admin.py
