4.6.0

- full admin site implementation

Author: Jesrat

.gitignore

@@ -16,3 +16,4 @@ tests/coverage_html/
 tests/.coverage
 build/
 tests/report/
+.idea/

.idea/.gitignore

@@ -2,6 +2,7 @@
 # Django Process
 
 Its a reusable app for execute scrits in workflows with dependecies
+NEW VERSION 4.6 it allows you to use the complete app from the admin site with the graphics and custom actions
 
 ## Table of Contents
 * [usage](#usage)

README.md

@@ -1,7 +1,7 @@
 __title__ = 'django-process'
 __description__ = 'An app for create process workflows and schedule tasks on django'
 __url__ = 'https://github.com/Jesrat/django-process'
-__version__ = '4.5.7'
+__version__ = '4.6.0'
 __author__ = 'Josue Gomez'
 __author_email__ = 'jgomez@jesrat.com'
 __license__ = 'Apache 2.0'

process/__init__.py

@@ -1,28 +1,113 @@
-from django.contrib import admin
-from .models import Process, Task, TaskDependence, Job, JobTask
+from .exceptions import ProcessException
+from .forms import JobForm, JobTaskForm, TaskForm
+from .models import Job, JobTask, Process, Task, TaskDependence
+from django.contrib import admin, messages
+from django.utils.translation import ngettext
+from django.utils.translation import gettext_lazy as _
 
 
 # Register your models here.
 @admin.register(Process)
 class ProcessAdmin(admin.ModelAdmin):
-    list_display = ('__str__', 'is_active', 'minute', 'hour', 'day_of_month', 'month', 'day_of_week')
+    actions = ['run_on_demand']
+    list_display = ('__str__', 'description', 'is_active', 'recurrence')
+    list_filter = ('is_active',)
+    search_fields = ('name', 'description')
+
+    # noinspection PyMethodMayBeStatic
+    def recurrence(self, process):
+        return '|'.join([process.minute, process.hour, process.day_of_month, process.month, process.day_of_week])
+    recurrence.short_description = 'recurrence'
+
+    def run_on_demand(self, request, queryset):
+        for process in queryset:
+            __, __ = Job.create(process)
+        self.message_user(request, ngettext(
+            '%d process was successfully started.',
+            '%d processes were successfully started.',
+            len(queryset),
+        ) % len(queryset), messages.SUCCESS)
+    run_on_demand.short_description = _('run on demand')
 
 
 @admin.register(Task)
 class TaskAdmin(admin.ModelAdmin):
+    form = TaskForm
     list_display = ('__str__', 'is_active', 'process')
 
-
-@admin.register(TaskDependence)
-class TaskDependenceAdmin(admin.ModelAdmin):
-    list_display = ('__str__', 'task', 'parent')
+    # noinspection PyMethodMayBeStatic,PyUnusedLocal
+    def get_readonly_fields(self, request, obj=None):
+        if obj:
+            return self.readonly_fields + ('process',)
+        return self.readonly_fields
 
 
 @admin.register(Job)
 class JobAdmin(admin.ModelAdmin):
+    form = JobForm
+    actions = ['cancel']
     list_display = ('__str__', 'dt_start', 'dt_end', 'observations')
+    list_filter = ('status',)
+    change_form_template = 'process/admin_change_job.html'
+
+    # noinspection PyMethodMayBeStatic,PyUnusedLocal
+    def get_readonly_fields(self, request, obj=None):
+        if obj and obj.status not in Job.cancelable:
+            return 'process', 'status', 'dt_start', 'dt_end', 'observations'
+        return 'process', 'dt_start', 'dt_end', 'observations'
+
+    def get_queryst(self, request):
+        qs = Job.objects.all().prefetch_related('process')
+        # TODO: this should be handled by some parameter to the ChangeList.
+        ordering = self.get_ordering(request)
+        if ordering:
+            qs = qs.order_by(*ordering)
+        return qs
+
+    # noinspection PyMethodMayBeStatic, PyUnusedLocal
+    def has_add_permission(self, request):
+        return False
+
+    def cancel(self, request, queryset):
+        # check cancelable
+        not_cancelable = [j for j in queryset if j.status not in Job.cancelable]
+        if not_cancelable:
+            self.message_user(
+                request,
+                ngettext(
+                    'following job is not in cancelable status: %(job)s',
+                    'following jobs are not in cancelable status: %(job)s',
+                    len(not_cancelable)
+                ) % {'job': ', '.join([str(job) for job in not_cancelable])},
+                messages.ERROR
+            )
+            return
+        # attempt to cancel
+        try:
+            for job in queryset:
+                job.cancel()
+        except ProcessException as e:
+            self.message_user(_('there was an exception when cancelling jobs %s') % e, messages.ERROR)
+            return
+        # success
+        self.message_user(request, ngettext(
+            '%d job was successfully canceled.',
+            '%d jobs were successfully canceled.',
+            len(queryset),
+        ) % len(queryset), messages.SUCCESS)
+    cancel.short_description = _('cancel')
 
 
 @admin.register(JobTask)
 class JobTaskAdmin(admin.ModelAdmin):
+    form = JobTaskForm
     list_display = ('__str__', 'dt_start', 'dt_end', 'observations')
+
+    def get_readonly_fields(self, request, obj=None):
+        if obj:
+            return self.readonly_fields + ('job', 'task', 'dt_start', 'dt_end', 'observations')
+        return self.readonly_fields
+
+    # noinspection PyMethodMayBeStatic, PyUnusedLocal
+    def has_add_permission(self, request):
+        return False

process/admin.py

@@ -0,0 +1,70 @@
+from .models import Job, JobTask, Task, TaskDependence
+from django import forms
+from django.db.models import Q
+
+
+class JobForm(forms.ModelForm):
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        status = self.instance.status
+        choices = (('cancelled', 'cancelled'), (status, status)) if status in Job.cancelable else []
+        if self.fields.get('status'):
+            self.fields['status'].choices = choices
+
+    class Meta:
+        model = Job
+        fields = '__all__'
+
+    # noinspection PyUnusedLocal,PyAttributeOutsideInit
+    def save(self, **kwargs):
+        self.save_m2m = self._save_m2m
+        if self.instance.status == Job.cancelled:
+            self.instance.refresh_from_db()
+            if self.instance.status in Job.cancelable:
+                self.instance.cancel()
+        return self.instance
+
+
+class TaskForm(forms.ModelForm):
+    parents = forms.ModelMultipleChoiceField(queryset=Task.objects.filter(pk=0), required=False)
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        if self.instance.pk:
+            self.fields['parents'].queryset = self.instance.process.tasks.filter(~Q(pk=self.instance.pk))
+            self.fields['parents'].initial = [d.parent for d in self.instance.parents.all()]
+
+    class Meta:
+        model = Task
+        fields = '__all__'
+
+    def _save_m2m(self):
+        print(f'cleaned_data {self.cleaned_data}')
+        current_queryset = self.instance.parents.all()
+        for current in current_queryset:
+            if current.parent not in self.cleaned_data['parents']:
+                current.delete()
+        for parent in self.cleaned_data['parents']:
+            if parent not in [c.parent for c in current_queryset]:
+                relation = TaskDependence(parent=parent, task=self.instance)
+                relation.save()
+
+
+class JobTaskForm(forms.ModelForm):
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        if self.instance.pk:
+            choices = [(stat, stat) for name, opt_list, stat in JobTask.management if self.instance.status in opt_list]
+            choices.append((self.instance.status, self.instance.status))
+            self.fields['status'].choices = choices
+
+    class Meta:
+        model = JobTask
+        fields = '__all__'
+
+    def save(self, **kwargs):
+        if self.instance.status == JobTask.reopened:
+            self.instance.reopen(main=True)
+        return self.instance

process/forms.py

@@ -0,0 +1,15 @@
+{% extends "admin/change_form.html" %}
+{% load process_diagram i18n admin_urls static admin_modify %}
+{% block extrahead %}
+    {{ block.super }}
+    {% include "process/dj-process.html" %}
+    <style>
+        #container {
+            margin: 0;
+        }
+    </style>
+{% endblock %}
+{% block submit_buttons_bottom %}
+    {{ original|diagram }}
+    {{ block.super }}
+{% endblock %}