Backport common mixin and generics improvements

* Rename get_object_list to get_source_queryset.
* Add uniqueness validation to SingleObjectCreateView.
* Remove MultipleInstanceActionMixin.
* Backport MultipleObjectMixin improvements.
* Remove ObjectListPermissionFilterMixin.
* Add and improve tests.

Signed-off-by: Roberto Rosario <roberto.rosario.gonzalez@gmail.com>
This commit is contained in:
Roberto Rosario
2019-05-06 02:07:35 -04:00
parent 7181852c2d
commit 95a1df8072
72 changed files with 1330 additions and 1092 deletions
@@ -56,7 +56,7 @@ class DocumentTypeViewsTestCase(GenericDocumentViewTestCase):
def test_document_type_delete_view_no_permission(self):
response = self._request_document_type_delete()
self.assertEqual(response.status_code, 403)
self.assertEqual(response.status_code, 404)
self.assertEqual(DocumentType.objects.count(), 1)
@@ -84,7 +84,7 @@ class DocumentTypeViewsTestCase(GenericDocumentViewTestCase):
def test_document_type_edit_view_no_permission(self):
response = self._request_document_type_edit()
self.assertEqual(response.status_code, 403)
self.assertEqual(response.status_code, 404)
self.test_document_type.refresh_from_db()
self.assertEqual(
@@ -123,7 +123,7 @@ class DocumentTypeQuickLabelViewsTestCase(DocumentTypeQuickLabelTestMixin, Gener
)
response = self._request_quick_label_create()
self.assertEqual(response.status_code, 403)
self.assertEqual(response.status_code, 404)
self.assertEqual(self.test_document_type.filenames.count(), 0)
@@ -146,7 +146,7 @@ class DocumentTypeQuickLabelViewsTestCase(DocumentTypeQuickLabelTestMixin, Gener
def test_document_type_quick_label_delete_no_access(self):
self._create_test_quick_label()
response = self._request_quick_label_delete()
self.assertEqual(response.status_code, 403)
self.assertEqual(response.status_code, 404)
self.assertEqual(
self.test_document_type.filenames.count(), 1
@@ -178,7 +178,7 @@ class DocumentTypeQuickLabelViewsTestCase(DocumentTypeQuickLabelTestMixin, Gener
self._create_test_quick_label()
response = self._request_quick_label_edit()
self.assertEqual(response.status_code, 403)
self.assertEqual(response.status_code, 404)
self.test_document_type_filename.refresh_from_db()
self.assertEqual(
@@ -212,7 +212,7 @@ class DocumentTypeQuickLabelViewsTestCase(DocumentTypeQuickLabelTestMixin, Gener
self._create_test_quick_label()
response = self._request_quick_label_list_view()
self.assertEqual(response.status_code, 403)
self.assertEqual(response.status_code, 404)
def test_document_type_quick_label_list_with_access(self):
self._create_test_quick_label()
@@ -20,7 +20,7 @@ class DocumentVersionTestCase(DocumentVersionTestMixin, GenericDocumentViewTestC
self._upload_new_version()
response = self._request_document_version_list_view()
self.assertEqual(response.status_code, 403)
self.assertEqual(response.status_code, 404)
def test_document_version_list_with_access(self):
self._upload_new_version()
@@ -46,7 +46,7 @@ class DocumentVersionTestCase(DocumentVersionTestMixin, GenericDocumentViewTestC
response = self._request_document_version_revert_view(
document_version=first_version
)
self.assertEqual(response.status_code, 403)
self.assertEqual(response.status_code, 404)
self.assertEqual(self.document.versions.count(), 2)
@@ -34,7 +34,7 @@ class DocumentsViewsTestCase(GenericDocumentViewTestCase):
def test_document_view_no_permissions(self):
response = self._request_document_properties_view()
self.assertEqual(response.status_code, 403)
self.assertEqual(response.status_code, 404)
def test_document_view_with_permissions(self):
self.grant_access(
@@ -84,7 +84,7 @@ class DocumentsViewsTestCase(GenericDocumentViewTestCase):
response = self._request_document_type_edit(
document_type=document_type_2
)
self.assertEqual(response.status_code, 302)
self.assertEqual(response.status_code, 404)
self.assertEqual(
Document.objects.get(pk=self.test_document.pk).document_type,
@@ -138,7 +138,7 @@ class DocumentsViewsTestCase(GenericDocumentViewTestCase):
response = self._request_multiple_document_type_edit(
document_type=document_type_2
)
self.assertEqual(response.status_code, 302)
self.assertEqual(response.status_code, 404)
self.assertEqual(
Document.objects.first().document_type, self.test_document_type
@@ -327,7 +327,7 @@ class DocumentsViewsTestCase(GenericDocumentViewTestCase):
self.assertEqual(self.test_document.pages.count(), 0)
response = self._request_document_update_page_count_view()
self.assertEqual(response.status_code, 302)
self.assertEqual(response.status_code, 404)
self.assertEqual(self.test_document.pages.count(), 0)
@@ -356,7 +356,7 @@ class DocumentsViewsTestCase(GenericDocumentViewTestCase):
self.assertEqual(self.test_document.pages.count(), 0)
response = self._request_document_multiple_update_page_count_view()
self.assertEqual(response.status_code, 302)
self.assertEqual(response.status_code, 404)
self.assertEqual(self.test_document.pages.count(), 0)
@@ -397,7 +397,7 @@ class DocumentsViewsTestCase(GenericDocumentViewTestCase):
)
response = self._request_document_clear_transformations_view()
self.assertEqual(response.status_code, 302)
self.assertEqual(response.status_code, 404)
self.assertQuerysetEqual(
Transformation.objects.get_for_object(obj=document_page),
@@ -454,7 +454,7 @@ class DocumentsViewsTestCase(GenericDocumentViewTestCase):
self.grant_permission(permission=permission_document_view)
response = self._request_document_multiple_clear_transformations()
self.assertEqual(response.status_code, 302)
self.assertEqual(response.status_code, 404)
self.assertQuerysetEqual(
Transformation.objects.get_for_object(obj=document_page),
(repr(transformation),)
@@ -578,7 +578,7 @@ class DocumentsQuickLabelViewsTestCase(DocumentTypeQuickLabelTestMixin, GenericD
self._create_test_quick_label()
response = self._request_document_quick_label_edit_view()
self.assertEqual(response.status_code, 403)
self.assertEqual(response.status_code, 404)
def test_document_quick_label_with_access(self):
self._create_test_quick_label()
+1 -1
View File
@@ -66,7 +66,7 @@ class DocumentEventsTestCase(GenericDocumentViewTestCase):
Action.objects.all().delete()
response = self._request_test_document_preview_view()
self.assertEqual(response.status_code, 403)
self.assertEqual(response.status_code, 404)
self.assertEqual(list(Action.objects.any(obj=self.test_document)), [])
@@ -15,7 +15,7 @@ class FavoriteDocumentsTestCase(GenericDocumentViewTestCase):
def test_document_add_to_favorites_view_no_permission(self):
response = self._request_document_add_to_favorites_view()
self.assertEqual(response.status_code, 302)
self.assertEqual(response.status_code, 404)
self.assertEqual(FavoriteDocument.objects.count(), 0)
def test_document_add_to_favorites_view_with_access(self):
@@ -62,7 +62,7 @@ class FavoriteDocumentsTestCase(GenericDocumentViewTestCase):
def test_document_remove_from_favorites_view_no_permission(self):
self._document_add_to_favorites()
response = self._request_document_remove_from_favorites()
self.assertEqual(response.status_code, 302)
self.assertEqual(response.status_code, 404)
self.assertEqual(FavoriteDocument.objects.count(), 1)
def test_document_remove_from_favorites_view_with_access(self):
@@ -10,24 +10,25 @@ from .base import GenericDocumentViewTestCase
class TrashedDocumentTestCase(GenericDocumentViewTestCase):
def _request_document_restore_view(self):
return self.post(
def _request_document_restore_get_view(self):
return self.get(
viewname='documents:document_restore', kwargs={
'pk': self.test_document.pk
}
)
def test_document_restore_view_no_permission(self):
def test_document_restore_get_view_no_permission(self):
self.test_document.delete()
self.assertEqual(Document.objects.count(), 0)
response = self._request_document_restore_view()
self.assertEqual(response.status_code, 302)
document_count = Document.objects.count()
self.assertEqual(DeletedDocument.objects.count(), 1)
self.assertEqual(Document.objects.count(), 0)
response = self._request_document_restore_get_view()
self.assertEqual(response.status_code, 404)
def test_document_restore_view_with_access(self):
self.assertEqual(Document.objects.count(), document_count)
def test_document_restore_get_view_with_access(self):
self.test_document.delete()
self.assertEqual(Document.objects.count(), 0)
@@ -35,56 +36,118 @@ class TrashedDocumentTestCase(GenericDocumentViewTestCase):
obj=self.test_document, permission=permission_document_restore
)
response = self._request_document_restore_view()
document_count = Document.objects.count()
response = self._request_document_restore_get_view()
self.assertEqual(response.status_code, 200)
self.assertEqual(Document.objects.count(), document_count)
def _request_document_restore_post_view(self):
return self.post(
viewname='documents:document_restore', kwargs={
'pk': self.test_document.pk
}
)
def test_document_restore_post_view_no_permission(self):
self.test_document.delete()
self.assertEqual(Document.objects.count(), 0)
response = self._request_document_restore_post_view()
self.assertEqual(response.status_code, 404)
self.assertEqual(DeletedDocument.objects.count(), 1)
self.assertEqual(Document.objects.count(), 0)
def test_document_restore_post_view_with_access(self):
self.test_document.delete()
self.assertEqual(Document.objects.count(), 0)
self.grant_access(
obj=self.test_document, permission=permission_document_restore
)
response = self._request_document_restore_post_view()
self.assertEqual(response.status_code, 302)
self.assertEqual(DeletedDocument.objects.count(), 0)
self.assertEqual(Document.objects.count(), 1)
def _request_document_trash_view(self):
def _request_document_trash_get_view(self):
return self.get(
viewname='documents:document_trash', kwargs={
'pk': self.test_document.pk
}
)
def test_document_trash_get_view_no_permissions(self):
document_count = Document.objects.count()
response = self._request_document_trash_get_view()
self.assertEqual(response.status_code, 404)
self.assertEqual(Document.objects.count(), document_count)
def test_document_trash_get_view_with_access(self):
self.grant_access(
obj=self.test_document, permission=permission_document_trash
)
document_count = Document.objects.count()
response = self._request_document_trash_get_view()
self.assertEqual(response.status_code, 200)
self.assertEqual(Document.objects.count(), document_count)
def _request_document_trash_post_view(self):
return self.post(
viewname='documents:document_trash', kwargs={
'pk': self.test_document.pk
}
)
def test_document_trash_no_permissions(self):
response = self._request_document_trash_view()
self.assertEqual(response.status_code, 302)
def test_document_trash_post_view_no_permissions(self):
response = self._request_document_trash_post_view()
self.assertEqual(response.status_code, 404)
self.assertEqual(DeletedDocument.objects.count(), 0)
self.assertEqual(Document.objects.count(), 1)
def test_document_trash_with_access(self):
def test_document_trash_post_view_with_access(self):
self.grant_access(
obj=self.test_document, permission=permission_document_trash
)
response = self._request_document_trash_view()
response = self._request_document_trash_post_view()
self.assertEqual(response.status_code, 302)
self.assertEqual(DeletedDocument.objects.count(), 1)
self.assertEqual(Document.objects.count(), 0)
def _request_document_delete_view(self):
return self.post(
def _request_document_delete_get_view(self):
return self.get(
viewname='documents:document_delete', kwargs={
'pk': self.test_document.pk
}
)
def test_document_delete_no_permissions(self):
def test_document_delete_get_view_no_permissions(self):
self.test_document.delete()
self.assertEqual(Document.objects.count(), 0)
self.assertEqual(DeletedDocument.objects.count(), 1)
response = self._request_document_delete_view()
self.assertEqual(response.status_code, 302)
trashed_document_count = DeletedDocument.objects.count()
self.assertEqual(Document.objects.count(), 0)
self.assertEqual(DeletedDocument.objects.count(), 1)
response = self._request_document_delete_get_view()
self.assertEqual(response.status_code, 404)
def test_document_delete_with_access(self):
self.assertEqual(
DeletedDocument.objects.count(), trashed_document_count
)
def test_document_delete_get_view_with_access(self):
self.test_document.delete()
self.assertEqual(Document.objects.count(), 0)
self.assertEqual(DeletedDocument.objects.count(), 1)
@@ -93,7 +156,43 @@ class TrashedDocumentTestCase(GenericDocumentViewTestCase):
obj=self.test_document, permission=permission_document_delete
)
response = self._request_document_delete_view()
trashed_document_count = DeletedDocument.objects.count()
response = self._request_document_delete_get_view()
self.assertEqual(response.status_code, 200)
self.assertEqual(
DeletedDocument.objects.count(), trashed_document_count
)
def _request_document_delete_post_view(self):
return self.post(
viewname='documents:document_delete', kwargs={
'pk': self.test_document.pk
}
)
def test_document_delete_post_view_no_permissions(self):
self.test_document.delete()
self.assertEqual(Document.objects.count(), 0)
self.assertEqual(DeletedDocument.objects.count(), 1)
response = self._request_document_delete_post_view()
self.assertEqual(response.status_code, 404)
self.assertEqual(Document.objects.count(), 0)
self.assertEqual(DeletedDocument.objects.count(), 1)
def test_document_delete_post_view_with_access(self):
self.test_document.delete()
self.assertEqual(Document.objects.count(), 0)
self.assertEqual(DeletedDocument.objects.count(), 1)
self.grant_access(
obj=self.test_document, permission=permission_document_delete
)
response = self._request_document_delete_post_view()
self.assertEqual(response.status_code, 302)
self.assertEqual(DeletedDocument.objects.count(), 0)
@@ -56,7 +56,7 @@ class DocumentPageListView(SingleObjectListView):
'title': _('Pages for document: %s') % self.get_document(),
}
def get_object_list(self):
def get_source_queryset(self):
return self.get_document().pages.all()
@@ -7,11 +7,11 @@ from django.template import RequestContext
from django.urls import reverse, reverse_lazy
from django.utils.translation import ugettext_lazy as _
from mayan.apps.acls.models import AccessControlList
from mayan.apps.common.generics import (
SingleObjectCreateView, SingleObjectDeleteView, SingleObjectEditView,
SingleObjectListView
)
from mayan.apps.common.mixins import ExternalObjectMixin
from ..forms import DocumentTypeFilenameForm_create
from ..icons import (
@@ -133,22 +133,14 @@ class DocumentTypeEditView(SingleObjectEditView):
}
class DocumentTypeFilenameCreateView(SingleObjectCreateView):
class DocumentTypeFilenameCreateView(ExternalObjectMixin, SingleObjectCreateView):
external_object_class = DocumentType
external_object_permission = permission_document_type_edit
external_object_pk_url_kwarg = 'pk'
form_class = DocumentTypeFilenameForm_create
def dispatch(self, request, *args, **kwargs):
AccessControlList.objects.check_access(
obj=self.get_document_type(),
permissions=(permission_document_type_edit,),
user=request.user
)
return super(DocumentTypeFilenameCreateView, self).dispatch(
request, *args, **kwargs
)
def get_document_type(self):
return get_object_or_404(klass=DocumentType, pk=self.kwargs['pk'])
return self.get_external_object()
def get_extra_context(self):
return {
@@ -163,10 +155,37 @@ class DocumentTypeFilenameCreateView(SingleObjectCreateView):
return {'document_type': self.get_document_type()}
class DocumentTypeFilenameDeleteView(SingleObjectDeleteView):
model = DocumentTypeFilename
object_permission = permission_document_type_edit
pk_url_kwarg = 'pk'
def get_extra_context(self):
return {
'document_type': self.get_object().document_type,
'filename': self.get_object(),
'navigation_object_list': ('document_type', 'filename',),
'title': _(
'Delete the quick label: %(label)s, from document type '
'"%(document_type)s"?'
) % {
'document_type': self.get_object().document_type,
'label': self.get_object()
},
}
def get_post_action_redirect(self):
return reverse(
viewname='documents:document_type_filename_list',
kwargs={'pk': self.get_object().document_type.pk}
)
class DocumentTypeFilenameEditView(SingleObjectEditView):
fields = ('enabled', 'filename',)
model = DocumentTypeFilename
object_permission = permission_document_type_edit
pk_url_kwarg = 'pk'
def get_extra_context(self):
document_type_filename = self.get_object()
@@ -186,42 +205,18 @@ class DocumentTypeFilenameEditView(SingleObjectEditView):
def get_post_action_redirect(self):
return reverse(
'documents:document_type_filename_list',
args=(self.get_object().document_type.pk,)
viewname='documents:document_type_filename_list',
kwargs={'pk': self.get_object().document_type.pk}
)
class DocumentTypeFilenameDeleteView(SingleObjectDeleteView):
model = DocumentTypeFilename
object_permission = permission_document_type_edit
def get_extra_context(self):
return {
'document_type': self.get_object().document_type,
'filename': self.get_object(),
'navigation_object_list': ('document_type', 'filename',),
'title': _(
'Delete the quick label: %(label)s, from document type '
'"%(document_type)s"?'
) % {
'document_type': self.get_object().document_type,
'label': self.get_object()
},
}
def get_post_action_redirect(self):
return reverse(
'documents:document_type_filename_list',
args=(self.get_object().document_type.pk,)
)
class DocumentTypeFilenameListView(SingleObjectListView):
access_object_retrieve_method = 'get_document_type'
object_permission = permission_document_type_view
class DocumentTypeFilenameListView(ExternalObjectMixin, SingleObjectListView):
external_object_class = DocumentType
external_object_permission = permission_document_type_view
external_object_pk_url_kwarg = 'pk'
def get_document_type(self):
return get_object_or_404(klass=DocumentType, pk=self.kwargs['pk'])
return self.get_external_object()
def get_extra_context(self):
return {
@@ -251,5 +246,5 @@ class DocumentTypeFilenameListView(SingleObjectListView):
) % self.get_document_type(),
}
def get_object_list(self):
def get_source_queryset(self):
return self.get_document_type().filenames.all()
@@ -10,6 +10,7 @@ from mayan.apps.acls.models import AccessControlList
from mayan.apps.common.generics import (
ConfirmView, SingleObjectDetailView, SingleObjectListView
)
from mayan.apps.common.mixins import ExternalObjectMixin
from ..events import event_document_view
from ..forms import DocumentVersionDownloadForm, DocumentVersionPreviewForm
@@ -22,71 +23,13 @@ from ..permissions import (
from .document_views import DocumentDownloadFormView, DocumentDownloadView
__all__ = (
'DocumentVersionListView', 'DocumentVersionRevertView',
'DocumentVersionDownloadFormView', 'DocumentVersionDownloadView',
'DocumentVersionListView', 'DocumentVersionRevertView',
'DocumentVersionView'
)
logger = logging.getLogger(__name__)
class DocumentVersionListView(SingleObjectListView):
def dispatch(self, request, *args, **kwargs):
AccessControlList.objects.check_access(
obj=self.get_document(),
permissions=(permission_document_version_view,),
user=request.user
)
self.get_document().add_as_recent_document_for_user(request.user)
return super(
DocumentVersionListView, self
).dispatch(request, *args, **kwargs)
def get_document(self):
return get_object_or_404(klass=Document, pk=self.kwargs['pk'])
def get_extra_context(self):
return {
'hide_object': True,
'list_as_items': True,
'object': self.get_document(),
'title': _('Versions of document: %s') % self.get_document(),
}
def get_object_list(self):
return self.get_document().versions.order_by('-timestamp')
class DocumentVersionRevertView(ConfirmView):
object_permission = permission_document_version_revert
object_permission_related = 'document'
def get_extra_context(self):
return {
'message': _(
'All later version after this one will be deleted too.'
),
'object': self.get_object().document,
'title': _('Revert to this version?'),
}
def get_object(self):
return get_object_or_404(klass=DocumentVersion, pk=self.kwargs['pk'])
def view_action(self):
try:
self.get_object().revert(_user=self.request.user)
messages.success(
self.request, _('Document version reverted successfully')
)
except Exception as exception:
messages.error(
self.request,
_('Error reverting document version; %s') % exception
)
class DocumentVersionDownloadFormView(DocumentDownloadFormView):
form_class = DocumentVersionDownloadForm
model = DocumentVersion
@@ -146,6 +89,61 @@ class DocumentVersionDownloadView(DocumentDownloadView):
return self.get_object().mimetype
class DocumentVersionListView(ExternalObjectMixin, SingleObjectListView):
external_object_class = Document
external_object_permission = permission_document_version_view
external_object_pk_url_kwarg = 'pk'
def get_document(self):
document = self.get_external_object()
document.add_as_recent_document_for_user(user=self.request.user)
return document
def get_extra_context(self):
return {
'hide_object': True,
'list_as_items': True,
'object': self.get_document(),
'table_cell_container_classes': 'td-container-thumbnail',
'title': _('Versions of document: %s') % self.get_document(),
}
def get_source_queryset(self):
return self.get_document().versions.order_by('-timestamp')
class DocumentVersionRevertView(ExternalObjectMixin, ConfirmView):
external_object_class = DocumentVersion
external_object_permission = permission_document_version_revert
external_object_pk_url_kwarg = 'pk'
def get_extra_context(self):
return {
'message': _(
'All later version after this one will be deleted too.'
),
'object': self.get_object().document,
'title': _('Revert to this version?'),
}
def get_object(self):
return self.get_external_object()
def view_action(self):
try:
self.get_object().revert(_user=self.request.user)
messages.success(
message=_(
'Document version reverted successfully'
), request=self.request
)
except Exception as exception:
messages.error(
message=_('Error reverting document version; %s') % exception,
request=self.request
)
class DocumentVersionView(SingleObjectDetailView):
form_class = DocumentVersionPreviewForm
model = DocumentVersion
+2 -2
View File
@@ -95,7 +95,7 @@ class DocumentListView(SingleObjectListView):
'title': _('All documents'),
}
def get_object_list(self):
def get_source_queryset(self):
return self.get_document_queryset()
@@ -347,7 +347,7 @@ class DocumentDuplicatesListView(DocumentListView):
)
return context
def get_object_list(self):
def get_source_queryset(self):
try:
return DuplicatedDocument.objects.get(
document=self.get_document()
@@ -41,11 +41,11 @@ class DocumentTrashView(MultipleObjectConfirmActionView):
)
def get_extra_context(self):
queryset = self.get_object_list()
queryset = self.get_queryset()
result = {
'title': ungettext(
single='Move the selected document to the trash?',
singular='Move the selected document to the trash?',
plural='Move the selected documents to the trash?',
number=queryset.count()
)
@@ -72,7 +72,9 @@ class EmptyTrashCanView(ConfirmView):
kwargs={'trashed_document_id': deleted_document.pk}
)
messages.success(self.request, _('Trash emptied successfully'))
messages.success(
message=_('Trash emptied successfully'), request=self.request
)
class TrashedDocumentDeleteView(MultipleObjectConfirmActionView):
@@ -87,11 +89,11 @@ class TrashedDocumentDeleteView(MultipleObjectConfirmActionView):
)
def get_extra_context(self):
queryset = self.get_object_list()
queryset = self.get_queryset()
result = {
'title': ungettext(
single='Delete the selected trashed document?',
singular='Delete the selected trashed document?',
plural='Delete the selected trashed documents?',
number=queryset.count()
)
@@ -147,11 +149,11 @@ class TrashedDocumentRestoreView(MultipleObjectConfirmActionView):
)
def get_extra_context(self):
queryset = self.get_object_list()
queryset = self.get_queryset()
result = {
'title': ungettext(
single='Restore the selected trashed document?',
singular='Restore the selected trashed document?',
plural='Restore the selected trashed documents?',
number=queryset.count()
)