Implement new sponsorship system - Frontend (#1662)

* apply black formatting to sponsors application

* initial modeling for sponsorships revamp

* add fixtures with rough draft of sponsor programs, levels, benefits

* update modeling with capacity and make Django admin rendering a bit nicer

* tidy up benefit admin list

* New form to list sponsorship benefits

* Simplest FormView so I can access the form

* Split benefits by programs

* Change fieldname

* Organize levels' benefits in the HTML

* JS code to auto-fill the benefits from level

* adjust modeling based on further clarification

rename "Levels" to "Packages"
-----------------------------
we will abstract levels as packages for now and just name them as such "Diamond Sponsorship Level"

Benefits: minimum_level -> package_only
---------------------------------------
rather than specifying a minimum level, these benefits should be selectable only via choosing a package

Benefits: add "new" flag
------------------------
this should render a "New For This Year" badge next to benefits where selected

Benefits: "soft" capacities
---------------------------
for future implementation, some capacities are soft in the sense that we will allow people to "register interest" when they are exhausted

* Remove empty choice from the frontend

* Clear form button

* Unit test the helper property

* Implement conflict behavior in the frontend

* Backend validation on benefits conflicts

* New view to calc the benefits cost

* Run black

* Safeguard if internal_value is not set

* Fix element definition

* Display sponsorship cost in the frontend

* Only display price if level changes

* Move JS code to specific file

* Option label should be benefit's name

* Better display for packages select

* Organize benefits in columns

* Disable active labels if checkbox wasn't checked

* Display benefits checkboxes manually

* Disable packages only benefits

* Disable choices if no available quantity

* Field shouldn't be required in django admin

* Better control of cost message's update

* Fits better in mobile

* Labels should be updated even if unselect

* Install font awesome

* Refactoring

* Display icons and legend

* Improve benefits admin

* Render packages info in html using context data

* Fetch package cost from html tag attribute

* Remove price calculator view

* Remove reference for unexisting named url

* Unit test package only validation

* Validate benefits capacity

* Remove form code that was moved to view's context

* Unit test invalid post scenario

* Unit test models

* Code format

* Use package attr to display cost

* Only staff users can acess sponsorship application form

Co-authored-by: Bernardo Fontes <[email protected]>

Author: ewdurbin

base-requirements.txt

@@ -36,3 +36,4 @@ django-waffle==0.14
 
 djangorestframework==3.8.2
 django-filter==1.1.0
+django-ordered-model==3.4.1

dev-requirements.txt

@@ -12,3 +12,4 @@ responses==0.10.5
 django-debug-toolbar==1.9.1
 coverage
 ddt
+model-bakery==1.2.0

fixtures/sponsors.json

@@ -151,6 +151,7 @@
     'haystack',
     'honeypot',
     'waffle',
+    'ordered_model',
 
     'users',
     'boxes',

pydotorg/settings/base.py

@@ -31,6 +31,15 @@
             'media': 'screen',
         },
     },
+    'font-awesome': {
+        'source_filenames': (
+            'stylesheets/font-awesome.min.css',
+        ),
+        'output_filename': 'stylesheets/no-mq.css',
+        'extra_context': {
+            'media': 'screen',
+        },
+    },
 }
 
 PIPELINE_JS = {

pydotorg/settings/pipeline.py

@@ -1,17 +1,71 @@
 from django.contrib import admin
+from ordered_model.admin import OrderedModelAdmin
 
-from .models import Sponsor
+from .models import SponsorshipPackage, SponsorshipProgram, SponsorshipBenefit, Sponsor
 from cms.admin import ContentManageableModelAdmin
 
 
+@admin.register(SponsorshipProgram)
+class SponsorshipProgramAdmin(OrderedModelAdmin):
+    pass
+
+
+@admin.register(SponsorshipBenefit)
+class SponsorshipBenefitAdmin(OrderedModelAdmin):
+    ordering = ("program", "order")
+    list_display = [
+        "program",
+        "short_name",
+        "package_only",
+        "internal_value",
+        "move_up_down_links",
+    ]
+    list_filter = ["program"]
+    search_fields = ["name"]
+
+    fieldsets = [
+        (
+            "Public",
+            {
+                "fields": (
+                    "name",
+                    "description",
+                    "program",
+                    "packages",
+                    "package_only",
+                    "new",
+                ),
+            },
+        ),
+        (
+            "Internal",
+            {
+                "fields": (
+                    "internal_description",
+                    "internal_value",
+                    "capacity",
+                    "soft_capacity",
+                    "conflicts",
+                )
+            },
+        ),
+    ]
+
+
+@admin.register(SponsorshipPackage)
+class SponsorshipPackageAdmin(OrderedModelAdmin):
+    ordering = ("order",)
+    list_display = ["name", "move_up_down_links"]
+
+
 @admin.register(Sponsor)
 class SponsorAdmin(ContentManageableModelAdmin):
-    raw_id_fields = ['company']
+    raw_id_fields = ["company"]
 
     def get_list_filter(self, request):
         fields = list(super().get_list_filter(request))
-        return fields + ['is_published']
+        return fields + ["is_published"]
 
     def get_list_display(self, request):
         fields = list(super().get_list_display(request))
-        return fields + ['is_published']
+        return fields + ["is_published"]

sponsors/admin.py

@@ -0,0 +1,102 @@
+from itertools import chain
+from django import forms
+from django.utils.text import slugify
+from django.utils.translation import ugettext_lazy as _
+
+from sponsors.models import SponsorshipBenefit, SponsorshipPackage, SponsorshipProgram
+
+
+class PickSponsorshipBenefitsField(forms.ModelMultipleChoiceField):
+    widget = forms.CheckboxSelectMultiple
+
+    def label_from_instance(self, obj):
+        return obj.name
+
+
+class SponsorshiptBenefitsForm(forms.Form):
+    package = forms.ModelChoiceField(
+        queryset=SponsorshipPackage.objects.all(),
+        widget=forms.RadioSelect(),
+        required=False,
+        empty_label=None,
+    )
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        benefits_qs = SponsorshipBenefit.objects.select_related("program")
+        for program in SponsorshipProgram.objects.all():
+            slug = slugify(program.name).replace("-", "_")
+            self.fields[f"benefits_{slug}"] = PickSponsorshipBenefitsField(
+                queryset=benefits_qs.filter(program=program),
+                required=False,
+                label=_(f"{program.name} Sponsorship Benefits"),
+            )
+
+    @property
+    def benefits_programs(self):
+        return [f for f in self if f.name.startswith("benefits_")]
+
+    @property
+    def benefits_conflicts(self):
+        """
+        Returns a dict with benefits ids as keys and their list of conlicts ids as values
+        """
+        conflicts = {}
+        for benefit in SponsorshipBenefit.objects.with_conflicts():
+            benefits_conflicts = benefit.conflicts.values_list("id", flat=True)
+            if benefits_conflicts:
+                conflicts[benefit.id] = list(benefits_conflicts)
+        return conflicts
+
+    def get_benefits(self, cleaned_data=None):
+        cleaned_data = cleaned_data or self.cleaned_data
+        return list(
+            chain(*(cleaned_data.get(bp.name) for bp in self.benefits_programs))
+        )
+
+    def _clean_benefits(self, cleaned_data):
+        """
+        Validate chosen benefits. Invalid scenarios are:
+        - benefits with conflits
+        - package only benefits and form without SponsorshipProgram
+        - benefit with no capacity, except if soft
+        """
+        package = cleaned_data.get("package")
+        benefits = self.get_benefits(cleaned_data)
+        if not benefits:
+            raise forms.ValidationError(
+                _("You have to pick a minimum number of benefits.")
+            )
+
+        benefits_ids = [b.id for b in benefits]
+        for benefit in benefits:
+            conflicts = set(self.benefits_conflicts.get(benefit.id, []))
+            if conflicts and set(benefits_ids).intersection(conflicts):
+                raise forms.ValidationError(
+                    _("The application has 1 or more benefits that conflicts.")
+                )
+
+            if benefit.package_only:
+                if not package:
+                    raise forms.ValidationError(
+                        _(
+                            "The application has 1 or more package only benefits and no package."
+                        )
+                    )
+                elif not benefit.packages.filter(id=package.id).exists():
+                    raise forms.ValidationError(
+                        _(
+                            "The application has 1 or more package only benefits but wrong package."
+                        )
+                    )
+
+            if not benefit.has_capacity:
+                raise forms.ValidationError(
+                    _("The application has 1 or more benefits with no capacity.")
+                )
+
+        return cleaned_data
+
+    def clean(self):
+        cleaned_data = super().clean()
+        return self._clean_benefits(cleaned_data)

sponsors/forms.py

@@ -11,28 +11,89 @@ class Migration(migrations.Migration):
 
     dependencies = [
         migrations.swappable_dependency(settings.AUTH_USER_MODEL),
-        ('companies', '0001_initial'),
+        ("companies", "0001_initial"),
     ]
 
     operations = [
         migrations.CreateModel(
-            name='Sponsor',
+            name="Sponsor",
             fields=[
-                ('id', models.AutoField(primary_key=True, auto_created=True, serialize=False, verbose_name='ID')),
-                ('created', models.DateTimeField(db_index=True, default=django.utils.timezone.now, blank=True)),
-                ('updated', models.DateTimeField(default=django.utils.timezone.now, blank=True)),
-                ('content', markupfield.fields.MarkupField(rendered_field=True, blank=True)),
-                ('content_markup_type', models.CharField(max_length=30, choices=[('', '--'), ('html', 'html'), ('plain', 'plain'), ('markdown', 'markdown'), ('restructuredtext', 'restructuredtext')], default='restructuredtext', blank=True)),
-                ('is_published', models.BooleanField(db_index=True, default=False)),
-                ('featured', models.BooleanField(help_text='Check to include Sponsor in feature rotation', db_index=True, default=False)),
-                ('_content_rendered', models.TextField(editable=False)),
-                ('company', models.ForeignKey(to='companies.Company', on_delete=models.CASCADE)),
-                ('creator', models.ForeignKey(null=True, to=settings.AUTH_USER_MODEL, related_name='sponsors_sponsor_creator', blank=True, on_delete=models.CASCADE)),
-                ('last_modified_by', models.ForeignKey(null=True, to=settings.AUTH_USER_MODEL, related_name='sponsors_sponsor_modified', blank=True, on_delete=models.CASCADE)),
+                (
+                    "id",
+                    models.AutoField(
+                        primary_key=True,
+                        auto_created=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "created",
+                    models.DateTimeField(
+                        db_index=True, default=django.utils.timezone.now, blank=True
+                    ),
+                ),
+                (
+                    "updated",
+                    models.DateTimeField(default=django.utils.timezone.now, blank=True),
+                ),
+                (
+                    "content",
+                    markupfield.fields.MarkupField(rendered_field=True, blank=True),
+                ),
+                (
+                    "content_markup_type",
+                    models.CharField(
+                        max_length=30,
+                        choices=[
+                            ("", "--"),
+                            ("html", "html"),
+                            ("plain", "plain"),
+                            ("markdown", "markdown"),
+                            ("restructuredtext", "restructuredtext"),
+                        ],
+                        default="restructuredtext",
+                        blank=True,
+                    ),
+                ),
+                ("is_published", models.BooleanField(db_index=True, default=False)),
+                (
+                    "featured",
+                    models.BooleanField(
+                        help_text="Check to include Sponsor in feature rotation",
+                        db_index=True,
+                        default=False,
+                    ),
+                ),
+                ("_content_rendered", models.TextField(editable=False)),
+                (
+                    "company",
+                    models.ForeignKey(to="companies.Company", on_delete=models.CASCADE),
+                ),
+                (
+                    "creator",
+                    models.ForeignKey(
+                        null=True,
+                        to=settings.AUTH_USER_MODEL,
+                        related_name="sponsors_sponsor_creator",
+                        blank=True,
+                        on_delete=models.CASCADE,
+                    ),
+                ),
+                (
+                    "last_modified_by",
+                    models.ForeignKey(
+                        null=True,
+                        to=settings.AUTH_USER_MODEL,
+                        related_name="sponsors_sponsor_modified",
+                        blank=True,
+                        on_delete=models.CASCADE,
+                    ),
+                ),
             ],
             options={
-                'verbose_name': 'sponsor',
-                'verbose_name_plural': 'sponsors',
+                "verbose_name": "sponsor",
+                "verbose_name_plural": "sponsors",
             },
             bases=(models.Model,),
         ),

sponsors/migrations/0001_initial.py

@@ -7,14 +7,25 @@
 class Migration(migrations.Migration):
 
     dependencies = [
-        ('sponsors', '0001_initial'),
+        ("sponsors", "0001_initial"),
     ]
 
     operations = [
         migrations.AlterField(
-            model_name='sponsor',
-            name='content_markup_type',
-            field=models.CharField(max_length=30, choices=[('', '--'), ('html', 'HTML'), ('plain', 'Plain'), ('markdown', 'Markdown'), ('restructuredtext', 'Restructured Text')], default='restructuredtext', blank=True),
+            model_name="sponsor",
+            name="content_markup_type",
+            field=models.CharField(
+                max_length=30,
+                choices=[
+                    ("", "--"),
+                    ("html", "HTML"),
+                    ("plain", "Plain"),
+                    ("markdown", "Markdown"),
+                    ("restructuredtext", "Restructured Text"),
+                ],
+                default="restructuredtext",
+                blank=True,
+            ),
             preserve_default=True,
         ),
     ]

sponsors/migrations/0002_auto_20150416_1853.py

@@ -7,13 +7,23 @@
 class Migration(migrations.Migration):
 
     dependencies = [
-        ('sponsors', '0002_auto_20150416_1853'),
+        ("sponsors", "0002_auto_20150416_1853"),
     ]
 
     operations = [
         migrations.AlterField(
-            model_name='sponsor',
-            name='content_markup_type',
-            field=models.CharField(choices=[('', '--'), ('html', 'HTML'), ('plain', 'Plain'), ('markdown', 'Markdown'), ('restructuredtext', 'Restructured Text')], default='restructuredtext', max_length=30),
+            model_name="sponsor",
+            name="content_markup_type",
+            field=models.CharField(
+                choices=[
+                    ("", "--"),
+                    ("html", "HTML"),
+                    ("plain", "Plain"),
+                    ("markdown", "Markdown"),
+                    ("restructuredtext", "Restructured Text"),
+                ],
+                default="restructuredtext",
+                max_length=30,
+            ),
         ),
     ]