[PATCH v4 3/5] patch-list: move and refactor patch-forms
Raxel Gutierrez
raxel at google.com
Tue Aug 24 04:28:31 AEST 2021
Move patch forms in patch-list and detail page to a new template file
patch-forms.html and move them to the top of the patch-list page to
improve their discoverability.
Refactor forms.py, __init__.py, patch.py, and test_bundles.py files so
that the shared bundle form in patch-forms.html works for both the
patch-list and patch-detail pages. In particular, the changes normalize
the behavior of the error and update messages of the patch forms and
updates tests to reflect the changes. Overall, these changes make patch
forms ready for change and more synchronized in their behavior. More
specifically:
- Previously patch forms changes were separated between the patch-detail
and patch-list pages. Thus, desired changes to the patch forms
required changes to patch-list.html, submission.html, and forms.py.
So, the most important benefit to this change is that forms.py and
patch-forms.html become the two places to adjust the forms to handle
form validation and functionality as well as UI changes.
- Previously the patch forms in patch-list.html handled error and
update messages through views in patch.py, whereas the patch forms in
submission.html handled the messages with forms.py. Now, with a single
patch forms component in patch-forms.html, forms.py is set to handle
the messages and handle form validation for both pages.
Signed-off-by: Raxel Gutierrez <raxel at google.com>
---
patchwork/forms.py | 12 ++-
.../patchwork/partials/patch-forms.html | 45 ++++++++
.../patchwork/partials/patch-list.html | 100 ++----------------
patchwork/templates/patchwork/submission.html | 89 +---------------
patchwork/tests/views/test_bundles.py | 26 ++---
patchwork/views/__init__.py | 71 +++++++------
patchwork/views/patch.py | 35 ++----
7 files changed, 126 insertions(+), 252 deletions(-)
create mode 100644 patchwork/templates/patchwork/partials/patch-forms.html
diff --git a/patchwork/forms.py b/patchwork/forms.py
index 24322c78..33103f4d 100644
--- a/patchwork/forms.py
+++ b/patchwork/forms.py
@@ -6,6 +6,7 @@
from django.contrib.auth.models import User
from django import forms
from django.db.models import Q
+from django.core.exceptions import ValidationError
from django.db.utils import ProgrammingError
from patchwork.models import Bundle
@@ -51,7 +52,7 @@ class EmailForm(forms.Form):
class BundleForm(forms.ModelForm):
name = forms.RegexField(
- regex=r'^[^/]+$', min_length=1, max_length=50, label=u'Name',
+ regex=r'^[^/]+$', min_length=1, max_length=50, required=False,
error_messages={'invalid': 'Bundle names can\'t contain slashes'})
class Meta:
@@ -70,11 +71,16 @@ class CreateBundleForm(BundleForm):
def clean_name(self):
name = self.cleaned_data['name']
+ if not name:
+ raise ValidationError('No bundle name was specified',
+ code="invalid")
+
count = Bundle.objects.filter(owner=self.instance.owner,
name=name).count()
if count > 0:
- raise forms.ValidationError('A bundle called %s already exists'
- % name)
+ raise ValidationError('A bundle called %(name)s already exists',
+ code="invalid",
+ params={'name': name})
return name
diff --git a/patchwork/templates/patchwork/partials/patch-forms.html b/patchwork/templates/patchwork/partials/patch-forms.html
new file mode 100644
index 00000000..5a824aaf
--- /dev/null
+++ b/patchwork/templates/patchwork/partials/patch-forms.html
@@ -0,0 +1,45 @@
+<div class="patch-forms" id="patch-forms">
+{% if patchform %}
+ <div id="patch-form-properties" class="patch-form">
+ <div id="patch-form-state">
+ {{ patchform.state.errors }}
+ {{ patchform.state }}
+ </div>
+ <div id="patch-form-delegate">
+ {{ patchform.delegate.errors }}
+ {{ patchform.delegate }}
+ </div>
+ <div id="patch-form-archive">
+ {{ patchform.archived.errors }}
+ {{ patchform.archived.label_tag }} {{ patchform.archived }}
+ </div>
+ <button class="patch-form-submit btn btn-primary" name="action" value="update">Update</button>
+ </div>
+{% endif %}
+{% if user.is_authenticated %}
+ <div id="patch-form-bundle" class="patch-form">
+ <div id="create-bundle">
+ {{ createbundleform.name.errors }}
+ {{ createbundleform.name }}
+ <input class="patch-form-submit btn btn-primary" name="action" value="Create" type="submit"/>
+ </div>
+ {% if bundles %}
+ <div id="add-to-bundle">
+ <select class="add-bundle" name="bundle_id">
+ <option value="" selected>Add to bundle</option>
+ {% for bundle in bundles %}
+ <option value="{{bundle.id}}">{{bundle.name}}</option>
+ {% endfor %}
+ </select>
+ <input class="patch-form-submit btn btn-primary" name="action" value="Add" type="submit"/>
+ </div>
+ {% endif %}
+ {% if bundle %}
+ <div id="remove-bundle">
+ <input type="hidden" name="removed_bundle_id" value="{{bundle.id}}"/>
+ <button class="patch-form-submit btn btn-primary" name="action" value="Remove">Remove from bundle</button>
+ </div>
+ {% endif %}
+ </div>
+{% endif %}
+</div>
diff --git a/patchwork/templates/patchwork/partials/patch-list.html b/patchwork/templates/patchwork/partials/patch-list.html
index 19b019cd..aeb26aa8 100644
--- a/patchwork/templates/patchwork/partials/patch-list.html
+++ b/patchwork/templates/patchwork/partials/patch-list.html
@@ -10,8 +10,6 @@
{% include "patchwork/partials/filters.html" %}
-{% include "patchwork/partials/pagination.html" %}
-
{% if order.editable %}
<table class="patch-list">
<tr>
@@ -31,19 +29,15 @@
</table>
{% endif %}
-{% if page.paginator.long_page and user.is_authenticated %}
-<div class="floaty">
- <a title="jump to form" href="#patch-forms">
- <span style="font-size: 120%">▾</span>
- </a>
-</div>
-{% endif %}
-
-<form method="post">
+<form id="patch-list-form" method="post">
{% csrf_token %}
<input type="hidden" name="form" value="patch-list-form"/>
<input type="hidden" name="project" value="{{project.id}}"/>
-<table id="patch-list" class="table table-hover table-extra-condensed table-striped pw-list"
+<div class="patch-list-actions">
+ {% include "patchwork/partials/patch-forms.html" %}
+ {% include "patchwork/partials/pagination.html" %}
+</div>
+<table id="patchlist" class="table table-hover table-extra-condensed table-striped pw-list"
data-toggle="checkboxes" data-range="true">
<thead>
<tr>
@@ -163,7 +157,7 @@
<tbody>
{% for patch in page.object_list %}
- <tr id="patch-row:{{patch.id}}">
+ <tr id="patch-row:{{patch.id}}" data-patch-id="{{patch.id}}">
{% if user.is_authenticated %}
<td id="select-patch:{{patch.id}}" style="text-align: center;">
<input type="checkbox" name="patch_id:{{patch.id}}"/>
@@ -206,86 +200,6 @@
{% if page.paginator.count %}
{% include "patchwork/partials/pagination.html" %}
-
-<div class="patch-forms" id="patch-forms">
-
-{% if patchform %}
- <div class="patch-form patch-form-properties">
- <h3>Properties</h3>
- <table class="form">
- <tr>
- <th>Change state:</th>
- <td>
- {{ patchform.state }}
- {{ patchform.state.errors }}
- </td>
- </tr>
- <tr>
- <th>Delegate to:</th>
- <td>
- {{ patchform.delegate }}
- {{ patchform.delegate.errors }}
- </td>
- </tr>
- <tr>
- <th>Archive:</th>
- <td>
- {{ patchform.archived }}
- {{ patchform.archived.errors }}
- </td>
- </tr>
- <tr>
- <td></td>
- <td>
- <input type="submit" name="action" value="{{patchform.action}}"/>
- </td>
- </tr>
- </table>
- </div>
-
-{% endif %}
-
-{% if user.is_authenticated %}
- <div class="patch-form patch-form-bundle">
- <h3>Bundling</h3>
- <table class="form">
- <tr>
- <td>Create bundle:</td>
- <td>
- <input type="text" name="bundle_name"/>
- <input name="action" value="Create" type="submit"/>
- </td>
- </tr>
- {% if bundles %}
- <tr>
- <td>Add to bundle:</td>
- <td>
- <select name="bundle_id">
- {% for bundle in bundles %}
- <option value="{{bundle.id}}">{{bundle.name}}</option>
- {% endfor %}
- </select>
- <input name="action" value="Add" type="submit"/>
- </td>
- </tr>
- {% endif %}
- {% if bundle %}
- <tr>
- <td>Remove from bundle:</td>
- <td>
- <input type="hidden" name="removed_bundle_id" value="{{bundle.id}}"/>
- <input name="action" value="Remove" type="submit"/>
- </td>
- </tr>
- {% endif %}
- </table>
- </div>
-{% endif %}
-
- <div style="clear: both;">
- </div>
-</div>
-
{% endif %}
</form>
diff --git a/patchwork/templates/patchwork/submission.html b/patchwork/templates/patchwork/submission.html
index b617d366..4b0e9601 100644
--- a/patchwork/templates/patchwork/submission.html
+++ b/patchwork/templates/patchwork/submission.html
@@ -135,91 +135,10 @@
{% endif %}
</table>
-<div class="patch-forms">
-{% if patchform %}
- <div class="patch-form patch-form-properties">
- <h3>Patch Properties</h3>
- <form method="post">
- {% csrf_token %}
- <table class="form">
- <tr>
- <th>Change state:</th>
- <td>
- {{ patchform.state }}
- {{ patchform.state.errors }}
- </td>
- </tr>
- <tr>
- <th>Delegate to:</th>
- <td>
- {{ patchform.delegate }}
- {{ patchform.delegate.errors }}
- </td>
- </tr>
- <tr>
- <th>Archived:</th>
- <td>
- {{ patchform.archived }}
- {{ patchform.archived.errors }}
- </td>
- </tr>
- <tr>
- <td></td>
- <td>
- <input type="submit" value="Update">
- </td>
- </tr>
- </table>
- </form>
- </div>
-{% endif %}
-
-{% if createbundleform %}
- <div class="patch-form patch-form-bundle">
- <h3>Bundling</h3>
- <table class="form">
- <tr>
- <td>Create bundle:</td>
- <td>
- {% if createbundleform.non_field_errors %}
- <dd class="errors">{{createbundleform.non_field_errors}}</dd>
- {% endif %}
- <form method="post">
- {% csrf_token %}
- <input type="hidden" name="action" value="createbundle"/>
- {% if createbundleform.name.errors %}
- <dd class="errors">{{createbundleform.name.errors}}</dd>
- {% endif %}
- {{ createbundleform.name }}
- <input value="Create" type="submit"/>
- </form>
- </td>
- </tr>
-{% if bundles %}
- <tr>
- <td>Add to bundle:</td>
- <td>
- <form method="post">
- {% csrf_token %}
- <input type="hidden" name="action" value="addtobundle"/>
- <select name="bundle_id"/>
- {% for bundle in bundles %}
- <option value="{{bundle.id}}">{{bundle.name}}</option>
- {% endfor %}
- </select>
- <input value="Add" type="submit"/>
- </form>
- </td>
- </tr>
-{% endif %}
- </table>
-
- </div>
-{% endif %}
-
- <div style="clear: both;">
- </div>
-</div>
+<form id="patch-list-form" method="POST">
+ {% csrf_token %}
+ {% include "patchwork/partials/patch-forms.html" %}
+</form>
{% if submission.pull_url %}
<h2>Pull-request</h2>
diff --git a/patchwork/tests/views/test_bundles.py b/patchwork/tests/views/test_bundles.py
index e265eb69..b9818f71 100644
--- a/patchwork/tests/views/test_bundles.py
+++ b/patchwork/tests/views/test_bundles.py
@@ -354,7 +354,7 @@ class BundleCreateFromListTest(BundleTestBase):
def test_create_empty_bundle(self):
newbundlename = 'testbundle-new'
params = {'form': 'patch-list-form',
- 'bundle_name': newbundlename,
+ 'name': newbundlename,
'action': 'Create',
'project': self.project.id}
@@ -370,7 +370,7 @@ class BundleCreateFromListTest(BundleTestBase):
patch = self.patches[0]
params = {'form': 'patch-list-form',
- 'bundle_name': newbundlename,
+ 'name': newbundlename,
'action': 'Create',
'project': self.project.id,
'patch_id:%d' % patch.id: 'checked'}
@@ -394,7 +394,7 @@ class BundleCreateFromListTest(BundleTestBase):
n_bundles = Bundle.objects.count()
params = {'form': 'patch-list-form',
- 'bundle_name': '',
+ 'name': '',
'action': 'Create',
'project': self.project.id,
'patch_id:%d' % patch.id: 'checked'}
@@ -415,7 +415,7 @@ class BundleCreateFromListTest(BundleTestBase):
patch = self.patches[0]
params = {'form': 'patch-list-form',
- 'bundle_name': newbundlename,
+ 'name': newbundlename,
'action': 'Create',
'project': self.project.id,
'patch_id:%d' % patch.id: 'checked'}
@@ -440,7 +440,9 @@ class BundleCreateFromListTest(BundleTestBase):
params)
self.assertNotContains(response, 'Bundle %s created' % newbundlename)
- self.assertContains(response, 'You already have a bundle called')
+ self.assertContains(
+ response,
+ 'A bundle called %s already exists' % newbundlename)
self.assertEqual(Bundle.objects.count(), n_bundles)
self.assertEqual(bundle.patches.count(), 1)
@@ -452,7 +454,7 @@ class BundleCreateFromPatchTest(BundleTestBase):
patch = self.patches[0]
params = {'name': newbundlename,
- 'action': 'createbundle'}
+ 'action': 'Create'}
response = self.client.post(
reverse('patch-detail',
@@ -471,7 +473,7 @@ class BundleCreateFromPatchTest(BundleTestBase):
patch = self.patches[0]
params = {'name': newbundlename,
- 'action': 'createbundle'}
+ 'action': 'Create'}
response = self.client.post(
reverse('patch-detail',
@@ -584,7 +586,7 @@ class BundleAddFromPatchTest(BundleTestBase):
def test_add_to_empty_bundle(self):
patch = self.patches[0]
- params = {'action': 'addtobundle',
+ params = {'action': 'Add',
'bundle_id': self.bundle.id}
response = self.client.post(
@@ -594,7 +596,7 @@ class BundleAddFromPatchTest(BundleTestBase):
self.assertContains(
response,
- 'added to bundle "%s"' % self.bundle.name,
+ 'added to bundle %s' % self.bundle.name,
count=1)
self.assertEqual(self.bundle.patches.count(), 1)
@@ -603,7 +605,7 @@ class BundleAddFromPatchTest(BundleTestBase):
def test_add_to_non_empty_bundle(self):
self.bundle.append_patch(self.patches[0])
patch = self.patches[1]
- params = {'action': 'addtobundle',
+ params = {'action': 'Add',
'bundle_id': self.bundle.id}
response = self.client.post(
@@ -613,7 +615,7 @@ class BundleAddFromPatchTest(BundleTestBase):
self.assertContains(
response,
- 'added to bundle "%s"' % self.bundle.name,
+ 'added to bundle %s' % self.bundle.name,
count=1)
self.assertEqual(self.bundle.patches.count(), 2)
@@ -651,7 +653,7 @@ class BundleInitialOrderTest(BundleTestBase):
# need to define our querystring explicity to enforce ordering
params = {'form': 'patch-list-form',
- 'bundle_name': newbundlename,
+ 'name': newbundlename,
'action': 'Create',
'project': self.project.id,
}
diff --git a/patchwork/views/__init__.py b/patchwork/views/__init__.py
index 7700b734..5da8046d 100644
--- a/patchwork/views/__init__.py
+++ b/patchwork/views/__init__.py
@@ -3,11 +3,14 @@
#
# SPDX-License-Identifier: GPL-2.0-or-later
+import json
+
from django.contrib import messages
from django.shortcuts import get_object_or_404
from django.db.models import Prefetch
from patchwork.filters import Filters
+from patchwork.forms import CreateBundleForm
from patchwork.forms import MultiplePatchForm
from patchwork.models import Bundle
from patchwork.models import BundlePatch
@@ -108,46 +111,34 @@ class Order(object):
# TODO(stephenfin): Refactor this to break it into multiple, testable functions
-def set_bundle(request, project, action, data, patches, context):
+def set_bundle(request, project, action, data, patches):
# set up the bundle
bundle = None
user = request.user
if action == 'create':
- bundle_name = data['bundle_name'].strip()
- if '/' in bundle_name:
- return ['Bundle names can\'t contain slashes']
-
- if not bundle_name:
- return ['No bundle name was specified']
-
- if Bundle.objects.filter(owner=user, name=bundle_name).count() > 0:
- return ['You already have a bundle called "%s"' % bundle_name]
-
+ bundle_name = data['name'].strip()
bundle = Bundle(owner=user, project=project,
name=bundle_name)
- bundle.save()
- messages.success(request, "Bundle %s created" % bundle.name)
+ create_bundle_form = CreateBundleForm(instance=bundle,
+ data=request.POST)
+ if create_bundle_form.is_valid():
+ create_bundle_form.save()
+ add_bundle_patches(request, patches, bundle)
+ bundle.save()
+ messages.success(request, 'Bundle %s created' % bundle.name)
+ else:
+ formErrors = json.loads(create_bundle_form.errors.as_json())
+ errors = [e['message'] for e in formErrors['name']]
+ return errors
elif action == 'add':
+ if not data['bundle_id']:
+ return ['No bundle was selected']
bundle = get_object_or_404(Bundle, id=data['bundle_id'])
+ add_bundle_patches(request, patches, bundle)
elif action == 'remove':
bundle = get_object_or_404(Bundle, id=data['removed_bundle_id'])
-
- if not bundle:
- return ['no such bundle']
-
- for patch in patches:
- if action in ['create', 'add']:
- bundlepatch_count = BundlePatch.objects.filter(bundle=bundle,
- patch=patch).count()
- if bundlepatch_count == 0:
- bundle.append_patch(patch)
- messages.success(request, "Patch '%s' added to bundle %s" %
- (patch.name, bundle.name))
- else:
- messages.warning(request, "Patch '%s' already in bundle %s" %
- (patch.name, bundle.name))
- elif action == 'remove':
+ for patch in patches:
try:
bp = BundlePatch.objects.get(bundle=bundle, patch=patch)
bp.delete()
@@ -158,10 +149,21 @@ def set_bundle(request, project, action, data, patches, context):
request,
"Patch '%s' removed from bundle %s\n" % (patch.name,
bundle.name))
+ return []
- bundle.save()
- return []
+def add_bundle_patches(request, patches, bundle):
+ for patch in patches:
+ bundlepatch_count = BundlePatch.objects.filter(bundle=bundle,
+ patch=patch).count()
+ if bundlepatch_count == 0:
+ bundle.append_patch(patch)
+ bundle.save()
+ messages.success(request, "Patch '%s' added to bundle %s" %
+ (patch.name, bundle.name))
+ else:
+ messages.warning(request, "Patch '%s' already in bundle %s" %
+ (patch.name, bundle.name))
def generic_list(request, project, view, view_args=None, filter_settings=None,
@@ -216,6 +218,7 @@ def generic_list(request, project, view, view_args=None, filter_settings=None,
data = None
user = request.user
properties_form = None
+ create_bundle_form = None
if user.is_authenticated:
# we only pass the post data to the MultiplePatchForm if that was
@@ -225,19 +228,20 @@ def generic_list(request, project, view, view_args=None, filter_settings=None,
data_tmp = data
properties_form = MultiplePatchForm(project, data=data_tmp)
+ create_bundle_form = CreateBundleForm()
if request.method == 'POST' and data.get('form') == 'patch-list-form':
action = data.get('action', '').lower()
# special case: the user may have hit enter in the 'create bundle'
# text field, so if non-empty, assume the create action:
- if data.get('bundle_name', False):
+ if data.get('name', False):
action = 'create'
ps = Patch.objects.filter(id__in=get_patch_ids(data))
if action in bundle_actions:
- errors = set_bundle(request, project, action, data, ps, context)
+ errors = set_bundle(request, project, action, data, ps)
elif properties_form and action == properties_form.action:
errors = process_multiplepatch_form(request, properties_form,
@@ -288,6 +292,7 @@ def generic_list(request, project, view, view_args=None, filter_settings=None,
context.update({
'page': paginator.current_page,
'patchform': properties_form,
+ 'createbundleform': create_bundle_form,
'project': project,
'order': order,
})
diff --git a/patchwork/views/patch.py b/patchwork/views/patch.py
index 00b0147f..39ff9132 100644
--- a/patchwork/views/patch.py
+++ b/patchwork/views/patch.py
@@ -14,11 +14,11 @@ from django.urls import reverse
from patchwork.forms import CreateBundleForm
from patchwork.forms import PatchForm
-from patchwork.models import Bundle
from patchwork.models import Cover
from patchwork.models import Patch
from patchwork.models import Project
from patchwork.views import generic_list
+from patchwork.views import set_bundle
from patchwork.views.utils import patch_to_mbox
from patchwork.views.utils import series_patch_to_mbox
@@ -60,6 +60,7 @@ def patch_detail(request, project_id, msgid):
form = None
createbundleform = None
+ errors = None
if editable:
form = PatchForm(instance=patch)
@@ -71,34 +72,14 @@ def patch_detail(request, project_id, msgid):
if action:
action = action.lower()
- if action == 'createbundle':
- bundle = Bundle(owner=request.user, project=project)
- createbundleform = CreateBundleForm(instance=bundle,
- data=request.POST)
- if createbundleform.is_valid():
- createbundleform.save()
- bundle.append_patch(patch)
- bundle.save()
- createbundleform = CreateBundleForm()
- messages.success(request, 'Bundle %s created' % bundle.name)
- elif action == 'addtobundle':
- bundle = get_object_or_404(
- Bundle, id=request.POST.get('bundle_id'))
- if bundle.append_patch(patch):
- messages.success(request,
- 'Patch "%s" added to bundle "%s"' % (
- patch.name, bundle.name))
- else:
- messages.error(request,
- 'Failed to add patch "%s" to bundle "%s": '
- 'patch is already in bundle' % (
- patch.name, bundle.name))
-
- # all other actions require edit privs
+ if action in ['create', 'add']:
+ errors = set_bundle(request, project, action,
+ request.POST, [patch])
+
elif not editable:
return HttpResponseForbidden()
- elif action is None:
+ elif action == 'update':
form = PatchForm(data=request.POST, instance=patch)
if form.is_valid():
form.save()
@@ -135,6 +116,8 @@ def patch_detail(request, project_id, msgid):
context['project'] = patch.project
context['related_same_project'] = related_same_project
context['related_different_project'] = related_different_project
+ if errors:
+ context['errors'] = errors
return render(request, 'patchwork/submission.html', context)
--
2.33.0.rc2.250.ged5fa647cd-goog
More information about the Patchwork
mailing list