Force people to consider adding a tag when creating a patch

Author: JelteF

pgcommitfest/commitfest/forms.py

@@ -80,6 +80,10 @@ def __init__(self, data, commitfest=None, *args, **kwargs):
             self.fields[f].widget.attrs = {"class": "input-medium"}
 
 
+# Tags that get their own checkbox buttons as shortcuts (also appear in selectize dropdown)
+CHECKBOX_TAG_NAMES = ["Bugfix", "Security", "Performance"]
+
+
 class PatchForm(forms.ModelForm):
     selectize_fields = {
         "authors": "/lookups/user",
@@ -112,6 +116,13 @@ def __init__(self, *args, **kwargs):
         self.fields["authors"].widget.attrs["class"] = "add-user-picker"
         self.fields["reviewers"].widget.attrs["class"] = "add-user-picker"
 
+        # Cache checkbox tags for use in JavaScript syncing and template rendering
+        self.checkbox_tags = list(
+            Tag.objects.filter(name__in=CHECKBOX_TAG_NAMES).values(
+                "id", "name", "color"
+            )
+        )
+
         # Selectize multiple fields -- don't pre-populate everything
         for field, url in list(self.selectize_fields.items()):
             if url is None:
@@ -157,6 +168,13 @@ class NewPatchForm(PatchForm):
         widget=ThreadPickWidget,
     )
 
+    # "No tags apply" checkbox to force users to explicitly opt out of tagging
+    no_tags_apply = forms.BooleanField(
+        required=False,
+        label="No tags apply",
+        help_text="Check this if none of the tags above apply to this patch",
+    )
+
     def __init__(self, *args, **kwargs):
         request = kwargs.pop("request", None)
         super(NewPatchForm, self).__init__(*args, **kwargs)
@@ -165,6 +183,24 @@ def __init__(self, *args, **kwargs):
             self.fields["authors"].queryset = User.objects.filter(pk=request.user.id)
             self.fields["authors"].initial = [request.user.id]
 
+    def clean(self):
+        cleaned_data = super().clean()
+
+        has_tags = bool(cleaned_data.get("tags"))
+        no_tags = cleaned_data.get("no_tags_apply")
+
+        if no_tags and has_tags:
+            raise ValidationError(
+                "You cannot select 'No tags apply' while also selecting tags."
+            )
+
+        if not no_tags and not has_tags:
+            raise ValidationError(
+                "Please select at least one tag, or check 'No tags apply' if none are applicable."
+            )
+
+        return cleaned_data
+
     def clean_threadmsgid(self):
         try:
             _archivesAPI("/message-id.json/%s" % self.cleaned_data["threadmsgid"])

pgcommitfest/commitfest/templates/base_form.html

@@ -14,6 +14,35 @@
   {%endif%}
   {%for field in form%}
    {%if not field.is_hidden%}
+    {%if field.name == 'tags' and form.checkbox_tags %}
+     {# Render the tags field with checkbox shortcuts #}
+     <div class="form-group">
+      <label class="control-label">Tags</label>
+      <div class="col-lg-12 controls">
+       {# Checkbox shortcuts for common tags #}
+       <div class="btn-group flex-wrap tag-checkbox-group mb-2" role="group" aria-label="Quick tag selection">
+        <button type="button" class="btn btn-sm btn-outline-secondary" disabled>Shortcuts:</button>
+        {%for tag in form.checkbox_tags%}
+         <input type="checkbox" class="btn-check tag-shortcut-checkbox" data-tag-id="{{tag.id}}" data-tag-name="{{tag.name}}" id="tag_shortcut_{{tag.id}}" autocomplete="off">
+         <label class="btn btn-sm btn-outline-primary d-inline-flex align-items-center" for="tag_shortcut_{{tag.id}}"><span class="tag-color" style="background-color: {{tag.color}}; width: 10px; height: 10px; border-radius: 2px; margin-right: 4px; margin-top: 1px;"></span>{{tag.name}}</label>
+        {%endfor%}
+       </div>
+       {# The actual selectize field for all tags #}
+       {{field}}
+       {%if field.help_text%}<br/>{{field.help_text|safe}}{%endif%}
+       {# "No tags apply" checkbox below the selectize (only for new patches) #}
+       {%if form.no_tags_apply %}
+       <div class="form-check mt-2">
+        <input type="checkbox" class="form-check-input" name="no_tags_apply" id="id_no_tags_apply" {% if form.no_tags_apply.value %}checked{% endif %}>
+        <label class="form-check-label" for="id_no_tags_apply">{{form.no_tags_apply.label}}</label>
+        {%if form.no_tags_apply.help_text%}<small class="form-text text-muted d-block">{{form.no_tags_apply.help_text}}</small>{%endif%}
+       </div>
+       {%endif%}
+      </div>
+     </div>
+    {%elif field.name == 'no_tags_apply' %}
+     {# Skip - rendered as part of the tags group above #}
+    {%else%}
     <div class="form-group">
      {{field|label_class:"control-label"}}
      <div class="col-lg-12 controls">
@@ -32,6 +61,7 @@
       {%elif not field.name in form.selectize_fields%}{{field|field_class:"form-control"}}{%else%}{{field}}{%endif%}
       {%if field.help_text%}<br/>{{field.help_text|safe}}{%endif%}</div>
     </div>
+    {%endif%}
    {%else%}
     {{field}}
    {%endif%}
@@ -92,5 +122,63 @@ <h3 class="modal-title">Search user</h3>
     $('#searchUserSearchField').focus();
    });
   {%endif%}
+
+  // Tag shortcut checkbox synchronization with selectize
+  (function() {
+   var $tagsSelect = $('#id_tags');
+   if (!$tagsSelect.length || !$tagsSelect[0].selectize) return;
+
+   var selectize = $tagsSelect[0].selectize;
+   var $checkboxes = $('.tag-shortcut-checkbox');
+   var $noTagsCheckbox = $('#id_no_tags_apply');
+
+   // Initialize checkbox state from current selectize values
+   function syncCheckboxesFromSelectize() {
+    var selectedIds = selectize.getValue();
+    if (typeof selectedIds === 'string') {
+     selectedIds = selectedIds ? selectedIds.split(',') : [];
+    }
+    selectedIds = selectedIds.map(function(id) { return String(id); });
+
+    $checkboxes.each(function() {
+     var tagId = String($(this).data('tag-id'));
+     $(this).prop('checked', selectedIds.indexOf(tagId) !== -1);
+    });
+
+    // Uncheck "no tags apply" if any tags are selected
+    if ($noTagsCheckbox.length && selectedIds.length > 0) {
+     $noTagsCheckbox.prop('checked', false);
+    }
+   }
+
+   // Sync on selectize change
+   selectize.on('change', syncCheckboxesFromSelectize);
+
+   // Handle checkbox clicks
+   $checkboxes.on('change', function() {
+    var tagId = String($(this).data('tag-id'));
+    if ($(this).is(':checked')) {
+     selectize.addItem(tagId, true);
+     if ($noTagsCheckbox.length) {
+      $noTagsCheckbox.prop('checked', false);
+     }
+    } else {
+     selectize.removeItem(tagId, true);
+    }
+   });
+
+   // Handle "no tags apply" checkbox (only exists for new patches)
+   if ($noTagsCheckbox.length) {
+    $noTagsCheckbox.on('change', function() {
+     if ($(this).is(':checked')) {
+      selectize.clear(true);
+      $checkboxes.prop('checked', false);
+     }
+    });
+   }
+
+   // Initial sync
+   syncCheckboxesFromSelectize();
+  })();
  </script>
 {%endblock%}