Update document states app

Change the app view namespace from 'document_states' to 'workflows'. Add missing icons. Improve view names. Split views into 3 modules: workflows views, runtime proxy views and instance views. Update views to comply with new MERCs 5 and 6. Fix failing tests. Signed-off-by: Roberto Rosario <Roberto.Rosario@mayan-edms.com>
2019-01-22 03:19:30 -04:00
parent 55356c4781
commit c7bd2ee8f2
10 changed files with 829 additions and 751 deletions
@@ -0,0 +1,142 @@
+from __future__ import absolute_import, unicode_literals
+
+from django.contrib import messages
+from django.http import HttpResponseRedirect
+from django.shortcuts import get_object_or_404
+from django.utils.translation import ugettext_lazy as _
+
+from mayan.apps.acls.models import AccessControlList
+from mayan.apps.common.mixins import ExternalObjectMixin
+from mayan.apps.common.views import FormView, SingleObjectListView
+from mayan.apps.documents.models import Document
+
+from ..forms import WorkflowInstanceTransitionForm
+from ..icons import icon_workflow_list
+from ..models import WorkflowInstance
+from ..permissions import (
+    permission_workflow_transition, permission_workflow_view
+)
+
+__all__ = (
+    'DocumentWorkflowInstanceListView', 'WorkflowInstanceDetailView',
+    'WorkflowInstanceTransitionView'
+)
+
+
+class DocumentWorkflowInstanceListView(SingleObjectListView):
+    def dispatch(self, request, *args, **kwargs):
+        AccessControlList.objects.check_access(
+            permissions=permission_workflow_view, user=request.user,
+            obj=self.get_document()
+        )
+
+        return super(
+            DocumentWorkflowInstanceListView, self
+        ).dispatch(request, *args, **kwargs)
+
+    def get_document(self):
+        return get_object_or_404(
+            klass=Document, pk=self.kwargs['document_id']
+        )
+
+    def get_extra_context(self):
+        return {
+            'hide_object': True,
+            'no_results_icon': icon_workflow_list,
+            'no_results_text': _(
+                'Assign workflows to the document type of this document '
+                'to have this document execute those workflows. '
+            ),
+            'no_results_title': _(
+                'There are no workflow for this document'
+            ),
+            'object': self.get_document(),
+            'title': _(
+                'Workflows for document: %s'
+            ) % self.get_document(),
+        }
+
+    def get_object_list(self):
+        return self.get_document().workflows.all()
+
+
+class WorkflowInstanceDetailView(SingleObjectListView):
+    def dispatch(self, request, *args, **kwargs):
+        AccessControlList.objects.check_access(
+            permissions=permission_workflow_view, user=request.user,
+            obj=self.get_workflow_instance().document
+        )
+
+        return super(
+            WorkflowInstanceDetailView, self
+        ).dispatch(request, *args, **kwargs)
+
+    def get_extra_context(self):
+        return {
+            'hide_object': True,
+            'navigation_object_list': ('object', 'workflow_instance'),
+            'no_results_text': _(
+                'This view will show the states changed as a workflow '
+                'instance is transitioned.'
+            ),
+            'no_results_title': _(
+                'There are no details for this workflow instance'
+            ),
+            'object': self.get_workflow_instance().document,
+            'title': _('Detail of workflow: %(workflow)s') % {
+                'workflow': self.get_workflow_instance()
+            },
+            'workflow_instance': self.get_workflow_instance(),
+        }
+
+    def get_object_list(self):
+        return self.get_workflow_instance().log_entries.order_by('-datetime')
+
+    def get_workflow_instance(self):
+        return get_object_or_404(
+            klass=WorkflowInstance, pk=self.kwargs['workflow_instance_id']
+        )
+
+
+class WorkflowInstanceTransitionView(ExternalObjectMixin, FormView):
+    external_object_class = WorkflowInstance
+    external_object_permission = permission_workflow_transition
+    external_object_pk_url_kwarg = 'workflow_instance_id'
+    form_class = WorkflowInstanceTransitionForm
+    template_name = 'appearance/generic_form.html'
+
+    def form_valid(self, form):
+        self.get_workflow_instance().do_transition(
+            comment=form.cleaned_data['comment'],
+            transition=form.cleaned_data['transition'], user=self.request.user
+        )
+        messages.success(
+            message=_(
+                'Document "%s" transitioned successfully'
+            ) % self.get_workflow_instance().document,
+            request=self.request
+        )
+        return HttpResponseRedirect(redirect_to=self.get_success_url())
+
+    def get_extra_context(self):
+        return {
+            'navigation_object_list': ('object', 'workflow_instance'),
+            'object': self.get_workflow_instance().document,
+            'submit_label': _('Submit'),
+            'title': _(
+                'Do transition for workflow: %s'
+            ) % self.get_workflow_instance(),
+            'workflow_instance': self.get_workflow_instance(),
+        }
+
+    def get_form_extra_kwargs(self):
+        return {
+            'user': self.request.user,
+            'workflow_instance': self.get_workflow_instance()
+        }
+
+    def get_success_url(self):
+        return self.get_workflow_instance().get_absolute_url()
+
+    def get_workflow_instance(self):
+        return self.get_external_object()