Implement page for user to submit assets information (#1911)

* Add missing migrations after changes on the field names and texts

* Add new benefit feature to flag benefits with required image assets

* Add new configuration to admin

* Validate min/max ranges

* Model class to hold generic img assets

* Use UUID to format file paths

* Add new class to require text inputs

* Add asset to store text input from user

* Do not use UUID field as primary key

Django polymorphic does not work with non-integer ids

* Move benefit feature creation to specific method under feature cfg

* Remove duplicated tests

* Create empty ImgAsset during sponsorship creation

* Create empty TextAsset during sponsorship creation

* Check if asset relates to sponsor or sponsorship before creating it

* Add generic relation to iter over all assets from sponsor/sponsorship models

* Assets base models Meta should inherit too

* Prevent same required asset from being created twice

* Optimizes query to list sponsorship benefits

* List sponsorship assets under sponsor/sponsorship detail admin

* Add extra card on sponsorship detail page to link to assets form

* Revert "Add extra card on sponsorship detail page to link to assets form"

This reverts commit 30a8672.

* Add extra card on sponsorship detail page to link to assets form

* Isolate customization on how to create a benefit feature in a mixin

Without that change, an RequiredImgAsset feature was able to call the
create_benefit_feature method and this is wrong, since only the feature
configuration objects should be able to create benefit features.

* Create helper manager to operate on top of benefit features

* Implement a higher level API to get assets values from the required assets model

* Minimal dynamic form construction

* Every asset should have an input label and an optional help text

* Unit test form field

* Add test to make sure of field names

* Add missing directory slash and remove duplicated extension

* Implement method to update assets with information uploaded from the user

* Refactor to use Python properties instead of Java-ish get/set methods

* Make sure initials are being populated and add property to check if form has inputs

* If field has initial data, it shouldn't be removed.

* Refactor how initial is being populated so widgets can work properly

Widgets only consider a field as required if this flag was passed to the
field during creation time. So, this PR refactors the as_form_field methods
to accept parameters so the form initialization can control required fields

* Refactor form to use init and, thus, to expose a more Django-ish API

* Implement view to update sponsor assets

* Update HTML/CSS to display assets form

* Print logo should be an image field too

* Update migrations dependencies after merge with main branch

* Build form with for specific asset via querystring

* Update sponsorship detail to separate fulfilled from pending assets

* Display links to specific assets at the sponsorship detail page

* Add links for user to submit required assets in the new sponsorship application notification

* Customize message if assets form with no fields due to unexisting required asset

Author: berinhard

sponsors/forms.py

@@ -19,6 +19,7 @@
     SponsorBenefit,
     SponsorEmailNotificationTemplate,
     RequiredImgAssetConfiguration,
+    BenefitFeature,
 )
 
 
@@ -174,7 +175,7 @@ class SponsorshipApplicationForm(forms.Form):
         help_text="For display on our sponsor webpage. High resolution PNG or JPG, smallest dimension no less than 256px",
         required=False,
     )
-    print_logo = forms.FileField(
+    print_logo = forms.ImageField(
         label="Sponsor print logo",
         help_text="For printed materials, signage, and projection. SVG or EPS",
         required=False,
@@ -546,3 +547,54 @@ def clean(self):
     class Meta:
         model = RequiredImgAssetConfiguration
         fields = "__all__"
+
+
+class SponsorRequiredAssetsForm(forms.Form):
+    """
+    This form is used by the sponsor to fullfill their information related
+    to the required assets. The form is built dynamically by fetching the
+    required assets from the sponsorship.
+    """
+
+    def __init__(self, *args, **kwargs):
+        """
+        Init method introspect the sponsorship object and
+        build the form object
+        """
+        self.sponsorship = kwargs.pop("instance", None)
+        required_assets_ids = kwargs.pop("required_assets_ids", [])
+        if not self.sponsorship:
+            msg = "Form must be initialized with a sponsorship passed by the instance parameter"
+            raise TypeError(msg)
+        super().__init__(*args, **kwargs)
+        self.required_assets = BenefitFeature.objects.required_assets().from_sponsorship(self.sponsorship)
+        if required_assets_ids:
+            self.required_assets = self.required_assets.filter(pk__in=required_assets_ids)
+
+        fields = {}
+        for required_asset in self.required_assets:
+            value = required_asset.value
+            f_name = self._get_field_name(required_asset)
+            required = bool(value)
+            fields[f_name] = required_asset.as_form_field(required=required, initial=value)
+
+        self.fields.update(fields)
+
+    def _get_field_name(self, asset):
+        return slugify(asset.internal_name).replace("-", "_")
+
+    def update_assets(self):
+        """
+        Iterate over every required asset, get the value from form data and
+        update it
+        """
+        for req_asset in self.required_assets:
+            f_name = self._get_field_name(req_asset)
+            value = self.cleaned_data.get(f_name, None)
+            if value is None:
+                continue
+            req_asset.value = value
+
+    @property
+    def has_input(self):
+        return bool(self.fields)

sponsors/migrations/0060_auto_20211108_1419.py

@@ -0,0 +1,45 @@
+# Generated by Django 2.2.24 on 2021-11-08 14:19
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('sponsors', '0060_auto_20211111_1526'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='requiredimgasset',
+            name='help_text',
+            field=models.CharField(blank=True, default='', help_text='Any helper comment on how the input should be populated', max_length=256),
+        ),
+        migrations.AddField(
+            model_name='requiredimgasset',
+            name='label',
+            field=models.CharField(default='label', help_text="What's the title used to display the input to the sponsor?", max_length=256),
+            preserve_default=False,
+        ),
+        migrations.AddField(
+            model_name='requiredimgassetconfiguration',
+            name='help_text',
+            field=models.CharField(blank=True, default='', help_text='Any helper comment on how the input should be populated', max_length=256),
+        ),
+        migrations.AddField(
+            model_name='requiredimgassetconfiguration',
+            name='label',
+            field=models.CharField(default='label', help_text="What's the title used to display the input to the sponsor?", max_length=256),
+            preserve_default=False,
+        ),
+        migrations.AlterField(
+            model_name='requiredtextasset',
+            name='label',
+            field=models.CharField(help_text="What's the title used to display the input to the sponsor?", max_length=256),
+        ),
+        migrations.AlterField(
+            model_name='requiredtextassetconfiguration',
+            name='label',
+            field=models.CharField(help_text="What's the title used to display the input to the sponsor?", max_length=256),
+        ),
+    ]

sponsors/migrations/0061_auto_20211111_1529.py

@@ -6,7 +6,7 @@
 class Migration(migrations.Migration):
 
     dependencies = [
-        ('sponsors', '0060_auto_20211111_1526'),
+        ('sponsors', '0060_auto_20211108_1419')
     ]
 
     operations = [

sponsors/models/assets.py

@@ -17,8 +17,8 @@ def generic_asset_path(instance, filename):
     """
     directory = "sponsors-app-assets"
     ext = "".join(Path(filename).suffixes)
-    name = f"{instance.uuid}{ext}"
-    return f"{directory}{name}{ext}"
+    name = f"{instance.uuid}"
+    return f"{directory}/{name}{ext}"
 
 
 class GenericAsset(PolymorphicModel):
@@ -68,6 +68,10 @@ class Meta:
     def value(self):
         return self.image
 
+    @value.setter
+    def value(self, value):
+        self.image = value
+
 
 class TextAsset(GenericAsset):
     text = models.TextField(default="")
@@ -82,3 +86,7 @@ class Meta:
     @property
     def value(self):
         return self.text
+
+    @value.setter
+    def value(self, value):
+        self.text = value

sponsors/models/benefits.py

@@ -1,14 +1,19 @@
 """
 This module holds models related to benefits features and configurations
 """
-
-from django.db import models, IntegrityError, transaction
+from django import forms
+from django.db import models
 from django.db.models import UniqueConstraint
+from django.urls import reverse
 from polymorphic.models import PolymorphicModel
 
 from sponsors.models.assets import ImgAsset, TextAsset
 from sponsors.models.enums import PublisherChoices, LogoPlacementChoices, AssetsRelatedTo
 
+########################################
+# Benefit features abstract classes
+from sponsors.models.managers import BenefitFeatureQuerySet
+
 
 ########################################
 # Benefit features abstract classes
@@ -67,10 +72,32 @@ class BaseRequiredAsset(models.Model):
         unique=False,
         db_index=True,
     )
+    label = models.CharField(
+        max_length=256,
+        help_text="What's the title used to display the input to the sponsor?"
+    )
+    help_text = models.CharField(
+        max_length=256,
+        help_text="Any helper comment on how the input should be populated",
+        default="",
+        blank=True
+    )
+
+    class Meta:
+        abstract = True
+
+
+class RequiredAssetConfigurationMixin:
+    """
+    This class should be used to implement assets configuration.
+    It's a mixin to updates the benefit feature creation to also
+    create the related assets models
+    """
 
     def create_benefit_feature(self, sponsor_benefit, **kwargs):
         if not self.ASSET_CLASS:
-            raise NotImplementedError("Subclasses of BaseRequiredAsset must define an ASSET_CLASS attribute.")
+            raise NotImplementedError(
+                "Subclasses of RequiredAssetConfigurationMixin must define an ASSET_CLASS attribute.")
 
         # Super: BenefitFeatureConfiguration.create_benefit_feature
         benefit_feature = super().create_benefit_feature(sponsor_benefit, **kwargs)
@@ -122,6 +149,37 @@ class Meta(BaseRequiredAsset.Meta):
         abstract = True
 
 
+class RequiredAssetMixin:
+    """
+    This class should be used to implement required assets.
+    It's a mixin to get the information submitted by the user
+    and which is stored in the related asset class.
+    """
+
+    def __related_asset(self):
+        object = self.sponsor_benefit.sponsorship
+        if self.related_to == AssetsRelatedTo.SPONSOR.value:
+            object = self.sponsor_benefit.sponsorship.sponsor
+
+        return object.assets.get(internal_name=self.internal_name)
+
+    @property
+    def value(self):
+        asset = self.__related_asset()
+        return asset.value
+
+    @value.setter
+    def value(self, value):
+        asset = self.__related_asset()
+        asset.value = value
+        asset.save()
+
+    @property
+    def user_edit_url(self):
+        url = reverse("users:update_sponsorship_assets", args=[self.sponsor_benefit.sponsorship.pk])
+        return url + f"?required_asset={self.pk}"
+
+
 ######################################################
 # SponsorshipBenefit features configuration models
 class BenefitFeatureConfiguration(PolymorphicModel):
@@ -245,8 +303,7 @@ def __str__(self):
         return f"Email targeatable configuration"
 
 
-class RequiredImgAssetConfiguration(BaseRequiredImgAsset, BenefitFeatureConfiguration):
-
+class RequiredImgAssetConfiguration(RequiredAssetConfigurationMixin, BaseRequiredImgAsset, BenefitFeatureConfiguration):
     class Meta(BaseRequiredImgAsset.Meta, BenefitFeatureConfiguration.Meta):
         verbose_name = "Require Image Configuration"
         verbose_name_plural = "Require Image Configurations"
@@ -260,7 +317,8 @@ def benefit_feature_class(self):
         return RequiredImgAsset
 
 
-class RequiredTextAssetConfiguration(BaseRequiredTextAsset, BenefitFeatureConfiguration):
+class RequiredTextAssetConfiguration(RequiredAssetConfigurationMixin, BaseRequiredTextAsset,
+                                     BenefitFeatureConfiguration):
     class Meta(BaseRequiredTextAsset.Meta, BenefitFeatureConfiguration.Meta):
         verbose_name = "Require Text Configuration"
         verbose_name_plural = "Require Text Configurations"
@@ -280,6 +338,7 @@ class BenefitFeature(PolymorphicModel):
     """
     Base class for sponsor benefits features.
     """
+    objects = BenefitFeatureQuerySet.as_manager()
 
     sponsor_benefit = models.ForeignKey("sponsors.SponsorBenefit", on_delete=models.CASCADE)
 
@@ -333,19 +392,31 @@ def __str__(self):
         return f"Email targeatable"
 
 
-class RequiredImgAsset(BaseRequiredImgAsset, BenefitFeature):
+class RequiredImgAsset(RequiredAssetMixin, BaseRequiredImgAsset, BenefitFeature):
     class Meta(BaseRequiredImgAsset.Meta, BenefitFeature.Meta):
         verbose_name = "Require Image"
         verbose_name_plural = "Require Images"
 
     def __str__(self):
         return f"Require image"
 
+    def as_form_field(self, **kwargs):
+        help_text = kwargs.pop("help_text", self.help_text)
+        label = kwargs.pop("label", self.label)
+        required = kwargs.pop("required", False)
+        return forms.ImageField(required=required, help_text=help_text, label=label, widget=forms.ClearableFileInput, **kwargs)
 
-class RequiredTextAsset(BaseRequiredTextAsset, BenefitFeature):
+
+class RequiredTextAsset(RequiredAssetMixin, BaseRequiredTextAsset, BenefitFeature):
     class Meta(BaseRequiredTextAsset.Meta, BenefitFeature.Meta):
         verbose_name = "Require Text"
         verbose_name_plural = "Require Texts"
 
     def __str__(self):
         return f"Require text"
+
+    def as_form_field(self, **kwargs):
+        help_text = kwargs.pop("help_text", self.help_text)
+        label = kwargs.pop("label", self.label)
+        required = kwargs.pop("required", False)
+        return forms.CharField(required=required, help_text=help_text, label=label, widget=forms.TextInput, **kwargs)

sponsors/models/managers.py

@@ -3,6 +3,7 @@
 from django.db.models import Q, Subquery
 from django.db.models.query import QuerySet
 from django.utils import timezone
+from polymorphic.query import PolymorphicQuerySet
 
 
 class SponsorshipQuerySet(QuerySet):
@@ -92,3 +93,14 @@ def with_packages(self):
 class SponsorshipPackageManager(OrderedModelManager):
     def list_advertisables(self):
         return self.filter(advertise=True)
+
+
+class BenefitFeatureQuerySet(PolymorphicQuerySet):
+
+    def from_sponsorship(self, sponsorship):
+        return self.filter(sponsor_benefit__sponsorship=sponsorship).select_related("sponsor_benefit__sponsorship")
+
+    def required_assets(self):
+        from sponsors.models.benefits import RequiredAssetMixin
+        required_assets_classes = RequiredAssetMixin.__subclasses__()
+        return self.instance_of(*required_assets_classes).select_related("sponsor_benefit__sponsorship")

sponsors/notifications.py

@@ -4,7 +4,7 @@
 from django.contrib.admin.models import LogEntry, CHANGE, ADDITION
 from django.contrib.contenttypes.models import ContentType
 
-from sponsors.models import Sponsorship, Contract
+from sponsors.models import Sponsorship, Contract, BenefitFeature
 
 
 class BaseEmailSponsorshipNotification:
@@ -27,8 +27,11 @@ def get_attachments(self, context):
         """
         return []
 
+    def get_email_context(self, **kwargs):
+        return {k: kwargs.get(k) for k in self.email_context_keys}
+
     def notify(self, **kwargs):
-        context = {k: kwargs.get(k) for k in self.email_context_keys}
+        context = self.get_email_context(**kwargs)
 
         email = EmailMessage(
             subject=self.get_subject(context),
@@ -54,11 +57,16 @@ def get_recipient_list(self, context):
 class AppliedSponsorshipNotificationToSponsors(BaseEmailSponsorshipNotification):
     subject_template = "sponsors/email/sponsor_new_application_subject.txt"
     message_template = "sponsors/email/sponsor_new_application.txt"
-    email_context_keys = ["sponsorship"]
+    email_context_keys = ["sponsorship", "request"]
 
     def get_recipient_list(self, context):
         return context["sponsorship"].verified_emails
 
+    def get_email_context(self, **kwargs):
+        context = super().get_email_context(**kwargs)
+        context["required_assets"] = BenefitFeature.objects.from_sponsorship(context["sponsorship"]).required_assets()
+        return context
+
 
 class RejectedSponsorshipNotificationToPSF(BaseEmailSponsorshipNotification):
     subject_template = "sponsors/email/psf_rejected_sponsorship_subject.txt"