django-viewflow 2.1.2__tar.gz → 2.2.4__tar.gz

{django-viewflow-2.1.2 → django_viewflow-2.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-viewflow
-Version: 2.1.2
+Version: 2.2.4
 Summary: Reusable library to build business applications fast
 Author: Mikhail Podgurskiy
 Author-email: kmmbvnr@gmail.com
@@ -25,3 +25,5 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
 Requires-Python: >=3.8
 License-File: LICENSE
+Requires-Dist: Django>=4.2
+Requires-Dist: django-filter>=2.3.0

{django-viewflow-2.1.2 → django_viewflow-2.2.4}/README.md

@@ -185,24 +185,61 @@ modifications of Viewflow. You can find the commercial license terms in
 
 ## Changelog
 
-### 2.1.2 2024-06-24
-
-- Allow cancelling Celery tasks from the ERROR state.
-- Hotfix: Fix broken Join when no other nodes are created by Split.
-- Allow using this references to flow static methods as Celery tasks.
-- Allow cancelling Celery jobs from the ERROR status.
-- Add missing permission check before adding a new item to the list.
-- Allow Admin() viewset to be used as a sub-item in an Application viewset.
-
-### 2.1.1 2024-06-06
-
-- Hotfix broken task creation
-
-
-### 2.1.0 2024-06-16
-
-- Allow to assign additional custom data to viewflow.fsm transitions
-- Added `data_source` parameter to `Split.Next()` method, allowing dynamic creation of multiple node instances based on a list of data items.
+### 2.2.4 2024-07-12
+
+- Clone data, seed, and artifacts from canceled tasks to revived tasks.
+- Enhance error handling for celery.Job.
+- Improve the process cancellation template.
+- Redirect to the task detail page after canceling or undoing actions, instead
+  of redirecting to the process detail page.
+- Added links to parent subprocess and parent task on the subprocess process and
+  task details pages.
+- Updated the Process.parent_task field to use related_name='subprocess',
+  allowing access to subprocesses via task.subprocess
+- Enhanced CreateProcessView and UpdateProcessView to set process_seed and
+  artifact_generic_foreign_key fields based on form.cleaned_data, as Django
+  model forms do not handle this automatically.
+- Added tasks with an ERROR status to the process dashboard for better visibility and tracking.
+- Added tooltip hover titles to nodes without text labels in the SVG workflow graph.
+- Marked StartHandler nodes as BPMN Start Message events on the SVG graph.
+- Fixed rendering of hidden field errors in forms.
+
+
+### 2.2.3 2024-07-09
+
+- Fixed issue with Split/Join operations when an immediate split to join
+  connection occurs.
+- Improved redirect functionality for "Execute and Continue." Now redirects to
+  the process details if the process has finished.
+- Enabled the Undo action for End() nodes.
+
+
+### 2.2.2 2024-07-05
+
+- Introduced new parameters for .If().Then(.., task_data=, task_seed) and
+  .Else(...)
+- Include {{ form.media }} into default workflow/task.html template
+
+
+### 2.2.1 2024-07-03
+
+- Introduced a new parameter for .Next(..., task_seed=) that allows the
+  instantiation of new tasks with additional initialized .seed generic foreign key
+- Introduced a new parameter for .Split(..., task_seed_source=) same as task_data_source,
+  prodices outgoing tasks with initializaed .seed value
+- Introduced a new parameter for flow.Subprocess(process_data=, process_seed=,
+  task_data=, task_seed=) allows to provide data nad seed for newly created
+  process and/or start task
+
+### 2.2.0 2024-06-28
+
+- Introduced a new parameter for .Next(..., task_data=) that allows the
+  instantiation of new tasks with additional initialized .data, enabling data to
+  be passed from task to task.
+- Added process.seed and task.seed generic foreign keys to the default workflow
+  models. Along with process.artifact and task.artifact, these additions enable
+  tracking of business process results from start to finish.
+- Renamed Split.Next(data_source=) to task_data_source=.
 
 
 [build]: https://img.shields.io/github/actions/workflow/status/viewflow/viewflow/django.yml?branch=main

{django-viewflow-2.1.2 → django_viewflow-2.2.4}/django_viewflow.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-viewflow
-Version: 2.1.2
+Version: 2.2.4
 Summary: Reusable library to build business applications fast
 Author: Mikhail Podgurskiy
 Author-email: kmmbvnr@gmail.com
@@ -25,3 +25,5 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
 Requires-Python: >=3.8
 License-File: LICENSE
+Requires-Dist: Django>=4.2
+Requires-Dist: django-filter>=2.3.0

{django-viewflow-2.1.2 → django_viewflow-2.2.4}/django_viewflow.egg-info/SOURCES.txt

@@ -1,5 +1,4 @@
 LICENSE
-LICENSE.django
 LICENSE_EXCEPTION
 MANIFEST.in
 README.md
@@ -306,6 +305,8 @@ viewflow/workflow/migrations/0009_merge.py
 viewflow/workflow/migrations/0010_viewflow20.py
 viewflow/workflow/migrations/0011_alter_task_created_and_more.py
 viewflow/workflow/migrations/0012_alter_process_data_alter_task_data.py
+viewflow/workflow/migrations/0013_process_seed_content_type_process_seed_object_id_and_more.py
+viewflow/workflow/migrations/0014_alter_process_parent_task.py
 viewflow/workflow/migrations/__init__.py
 viewflow/workflow/nodes/__init__.py
 viewflow/workflow/nodes/end.py
@@ -318,6 +319,5 @@ viewflow/workflow/nodes/mixins.py
 viewflow/workflow/nodes/obsolete.py
 viewflow/workflow/nodes/split.py
 viewflow/workflow/nodes/start.py
-viewflow/workflow/nodes/subprocess.py
 viewflow/workflow/nodes/switch.py
 viewflow/workflow/nodes/view.py

{django-viewflow-2.1.2 → django_viewflow-2.2.4}/setup.py

@@ -4,7 +4,7 @@ README = open("README.md", "r", encoding="utf-8").read()
 
 setuptools.setup(
     name="django-viewflow",
-    version="2.1.2",
+    version="2.2.4",
     author_email="kmmbvnr@gmail.com",
     author="Mikhail Podgurskiy",
     description="Reusable library to build business applications fast",

{django-viewflow-2.1.2 → django_viewflow-2.2.4}/viewflow/forms/renderers.py

@@ -510,9 +510,10 @@ class FormLayout:
     def append_non_field_errors(self, form: forms.Form, root: ElementTree.Element):
         errors = form.non_field_errors()
         errors.extend(
-            form.error_class(bound_field.errors)
+            error
             for bound_field in form.hidden_fields()
             if bound_field.errors
+            for error in bound_field.errors
         )
 
         if errors:

{django-viewflow-2.1.2 → django_viewflow-2.2.4}/viewflow/templates/viewflow/workflow/graph.svg

@@ -81,7 +81,7 @@
     
         circle.event,
         path.event {
-            fill: none;
+            fill: transparent;
             stroke: #000;
         }
 
@@ -90,12 +90,12 @@
         }
 
         path.event-marker {
-            fill: none;
+            fill: transparent;
             stroke: #000;
         }
 
         path.gateway {
-            fill: none;
+            fill: transparent;
             stroke: #000;
             stroke-width: 1.1;
         }
@@ -108,7 +108,7 @@
         }
 
         rect.task {
-            fill: none;
+            fill: transparent;
             stroke: #000;
             stroke-width: 1.1;
         }
@@ -120,7 +120,7 @@
         }
 
         path.task-marker {
-            fill: none;
+            fill: transparent;
             stroke: #000;
             stroke-width: 1.1;
         }
@@ -128,14 +128,14 @@
     </style>
     {% for cell in cells %}
     <g id="{{ cell.node.name }}" transform="translate({{ cell.shape.x }}, {{ cell.shape.y }})"{% if cell.status %} class="{{ cell.status|lower }}"{% endif %}>
-        {% if cell.status %}<title>{{ cell.status }}</title>{% endif %}
+        {% if cell.title %}<title>{{ cell.title }}</title>{% endif %}
         {{ cell.shape.svg|safe }}
         {% for text, class, font_size, x, y in cell.shape.text %}
         <text class="{{ class }}" font-size="{{ font_size }}px" x="{{ x }}" y="{{ y }}">{% if forloop.first %}{{ text|title }}{% else %}{{ text }}{% endif %}</text>
         {% endfor %}
     </g>
     {% endfor %}{% for edge in edges %}
-    <path fill="none" stroke="#000000" stroke-width="2" id="{{ edge.src.name}}__{{ edge.dst.name }}" marker-end="url(#end-marker)"
+    <path fill="transparent" stroke="#000000" stroke-width="2" id="{{ edge.src.name}}__{{ edge.dst.name }}" marker-end="url(#end-marker)"
           d="{% for x,y in edge.segments %}{% if forloop.first %}M{% else %} L{% endif %}{{ x }}, {{ y }}{% endfor %}"/>
 
     {% endfor %}

{django-viewflow-2.1.2 → django_viewflow-2.2.4}/viewflow/templates/viewflow/workflow/process_cancel.html

@@ -3,8 +3,8 @@
 
 {% block content %}
   <div class="mdc-layout-grid vf-page__grid">
-    <div class="mdc-layout-grid__inner">
-      <div class="mdc-layout-grid__cell mdc-layout-grid__cell--span-9-desktop mdc-layout-grid__cell--span-8-tablet mdc-layout-grid__cell--span-4-phone">
+    <div class="mdc-layout-grid__inner vf-page__grid-inner">
+      <div class="mdc-layout-grid__cell mdc-layout-grid__cell--span-8-desktop mdc-layout-grid__cell--span-8-tablet mdc-layout-grid__cell--span-4-phone">
         <div class="mdc-card vf-card">
           <section class="vf-card__header">
             <h1 class="vf-card__title">
@@ -90,7 +90,7 @@
         </div>
       </div>
       {% block panel-cell %}
-        <div class="mdc-layout-grid__cell {% block panel-cell-span %}mdc-layout-grid__cell--span-3-desktop mdc-layout-grid__cell--span-8-tablet mdc-layout-grid__cell--span-4-phone{% endblock %}">
+        <div class="mdc-layout-grid__cell {% block panel-cell-span %}mdc-layout-grid__cell--span-4-desktop mdc-layout-grid__cell--span-8-tablet mdc-layout-grid__cell--span-4-phone{% endblock %}">
           {% include_process_data process %}
         </div>
       {% endblock panel-cell %}

{django-viewflow-2.1.2 → django_viewflow-2.2.4}/viewflow/templates/viewflow/workflow/process_data.html

@@ -1,4 +1,4 @@
-{% load viewflow %}
+{% load viewflow i18n %}
 <div class="mdc-card vf-card">
   <section class="vf-card__header">
     <h1 class="vf-card__title">{{ process }}</h1>
@@ -20,13 +20,33 @@
           </td>
         </tr>
         {% for field, field_name, value in process_data %}
-          {% if field.name != 'data' and field.name != 'flow_class' and field.name != 'artifact_object_id' and field.name != 'artifact_content_type'%}
+          {% if field.name != 'parent_task' and field.name != 'data' and field.name != 'flow_class' and field.name != 'artifact_object_id' and field.name != 'artifact_content_type' and field.name != 'seed_object_id' and field.name != 'seed_content_type'%}
             <tr>
               <th class="vf-list__table-header vf-list__table-header-text">{{ field_name }}</th>
               <td>{{ value }}</td>
             </tr>
           {% endif %}
         {% endfor %}
+        {% if process.parent_task %}
+        <tr>
+          <th class="vf-list__table-header vf-list__table-header-text">{% translate 'Parent Task' %}</th>
+          <td>
+            <a href="{% reverse process.parent_task.flow_task 'index' process.parent_task.process_id process.parent_task.pk %}">{{ process.parent_task.flow_task }}</a>
+          </td>
+        </tr>
+        {% endif %}
+        {% if process.seed %}
+        <tr>
+          <th class="vf-list__table-header vf-list__table-header-text">{% translate 'Seed' %}</th>
+          <td>{{ process.seed }}</td>
+        </tr>
+        {% endif %}
+        {% if process.artifact %}
+        <tr>
+          <th class="vf-list__table-header vf-list__table-header-text">{% translate 'Artifact' %}</th>
+          <td>{{ process.artifact }}</td>
+        </tr>
+        {% endif %}
       </tbody>
     </table>
   </section>

{django-viewflow-2.1.2 → django_viewflow-2.2.4}/viewflow/templates/viewflow/workflow/task.html

@@ -1,6 +1,10 @@
 {% extends request.resolver_match.app.base_template_name|default:'viewflow/workflow/base_page.html' %}
 {% load i18n viewflow workflow %}
 
+{% block extrahead %}
+  {{ block.super }}
+  {{ form.media }}
+{% endblock %}
 
 {% block content %}{% with process=request.activation.process task=request.activation.task %}
   <div class="mdc-layout-grid vf-page__grid">

{django-viewflow-2.1.2 → django_viewflow-2.2.4}/viewflow/templates/viewflow/workflow/task_data.html

@@ -20,6 +20,28 @@
 </div>
 {% endif %}
 
+{% if seed_data %}
+<div class="mdc-card vf-card">
+  <section class="vf-card__header">
+    <h1 class="vf-card__title">{{ task.seed }}</h1>
+  </section>
+  <section class="vf-card__body">
+    <table class="vf-list__table">
+      <tbody>
+        {% for field, field_name, value in seed_data %}
+            {% if field.name != 'process' and field.name != 'task' %}
+            <tr>
+              <th class="vf-list__table-header vf-list__table-header-text">{{ field_name }}</th>
+              <td>{{ value }}</td>
+            </tr>
+          {% endif %}
+        {% endfor %}
+      </tbody>
+    </table>
+  </section>
+</div>
+{% endif %}
+
 
 {% if data %}
 {{ data }}

{django-viewflow-2.1.2 → django_viewflow-2.2.4}/viewflow/templates/viewflow/workflow/task_detail.html

@@ -37,6 +37,16 @@
       {% endfor %}
     </div>
   </div>
+  {% with subprocesses=task.subprocesses.all %}{% if subprocesses %}
+  <div class="mdc-layout-grid__cell mdc-layout-grid__cell--span-12">
+    <h4 class="mdc-typography mdc-typography--headline5"  style="margin-bottom:10px">{% trans "Subprocess" %}</h4>
+    <div>
+      {% for subprocess in subprocesses %}
+        <a class="mdc-typography mdc-typography--subtitle1" href="{% reverse subprocess.flow_class 'process_detail' subprocess.pk %}">{{ subprocess }}</a>{% if not forloop.last %}, {% endif %}
+      {% endfor %}
+    </div>
+  </div>
+  {% endif %}{% endwith %}
 {% endblock %}
 
 {% block task_actions %}

{django-viewflow-2.1.2 → django_viewflow-2.2.4}/viewflow/templatetags/workflow.py

@@ -51,6 +51,8 @@ def include_task_data(context, task):
     try:
         if task.artifact_object_id:
             context["artifact_data"] = get_object_data(task.artifact)
+        if task.seed_object_id:
+            context["seed_data"] = get_object_data(task.seed)
         context["data"] = task.data
         context["task"] = task
         return template.render(

django_viewflow-2.2.4/viewflow/this_object.py

@@ -0,0 +1,119 @@
+"""Forward-reference for class-body declarations"""
+
+# Copyright (c) 2017-2020, Mikhail Podgurskiy
+# All Rights Reserved.
+
+# This work is dual-licensed under AGPL defined in file 'LICENSE' with
+# LICENSE_EXCEPTION and the Commercial license defined in file 'COMM_LICENSE',
+# which is part of this source code package.
+from typing import Any, Optional, Union
+
+
+class ThisMethod:
+    """
+    Reference to a method for forward references in class bodies.
+
+    This class is used to defer the resolution of a method reference until the
+    class is fully constructed. This is particularly useful in workflow or state
+    machine implementations where the flow references are declared before the
+    methods are defined.
+    """
+
+    def __init__(self, propname: str, methodname: str):
+        self._propname = propname
+        self._methodname = methodname
+
+    def resolve(self, instance) -> Any:
+        """
+        Resolve the method reference on the given instance.
+
+        Args:
+            instance (object): The instance on which to resolve the method.
+
+        Returns:
+            Any: The result of the resolved method call.
+
+        Raises:
+            AttributeError: If the property or method does not exist on the instance.
+        """
+        prop = getattr(instance, self._propname)
+        method = getattr(instance, f"_this_{self._methodname}")
+        return method(prop)
+
+
+class ThisObject(object):
+    """
+    Helper for forward references to class attributes.
+
+    This class is used to defer the resolution of an attribute reference until
+    the class is fully constructed. This allows for the use of class attributes
+    before they are defined.
+
+    Attributes:
+        name (str): The name of the attribute to resolve.
+    """
+
+    def __init__(self, name: str) -> None:  # noqa D102
+        self.name = name
+
+    def resolve(self, instance: object) -> Any:
+        """
+        Resolve the attribute reference on the given instance.
+
+        Args:
+            instance (object): The instance on which to resolve the attribute.
+
+        Returns:
+            Any: The resolved attribute.
+
+        Raises:
+            AttributeError: If the attribute does not exist on the instance.
+        """
+        return getattr(instance, self.name)
+
+    # def __copy__(self):
+    #     return super().__copy__()
+
+    # def __deepcopy__(self, memo):
+    #     return super().__deepcopy__(memo)
+
+    def __getattr__(self, name):
+        if name.startswith("__"):
+            super().__getattr__(name)
+        return ThisMethod(self.name, name)
+
+
+class This:
+    """
+    Helper for building forward references to class attributes and methods.
+
+    The rationale is the ability to specify references to the class attributes and
+    methods before they are declared. `this` acts similarly to `self`, but for
+    class-level forward references.
+    """
+
+    def resolve(self, instance: object, this_ref: Union[ThisObject, ThisMethod, Any]):
+        """
+        Resolve a forward reference on the given instance.
+
+        Args:
+            instance (object): The instance on which to resolve the reference.
+            this_ref (Union[ThisObject, ThisMethod, Any]): The reference to resolve.
+
+        Returns:
+            Any: The resolved reference.
+
+        Raises:
+            AttributeError: If the reference cannot be resolved.
+        """
+        if isinstance(this_ref, (ThisObject, ThisMethod)):
+            return this_ref.resolve(instance)
+        else:
+            return this_ref
+
+    def __getattr__(self, name):
+        return ThisObject(name)
+
+
+# Instantiate a global `this` object for use in class definitions.
+this = This()

{django-viewflow-2.1.2 → django_viewflow-2.2.4}/viewflow/urls/base.py

@@ -8,6 +8,7 @@ import copy
 import types
 import warnings
 from collections import namedtuple, OrderedDict
+from typing import Optional, Dict, Any, List, Union
 
 from django.views.generic import RedirectView
 from django.urls import URLPattern, URLResolver, include, path, reverse
@@ -29,17 +30,17 @@ class _UrlName(str):
     hierarchy.
     """
 
-    def __init__(self, value):
+    def __init__(self, value) -> None:
         str.__init__(value)
         self.extra = {}
 
 
 class _URLResolver(URLResolver):
-    def __init__(self, *args, **kwargs):
+    def __init__(self, *args, **kwargs) -> None:
         self.extra = kwargs.pop("extra", {})
         super(_URLResolver, self).__init__(*args, **kwargs)
 
-    def resolve(self, *args, **kwargs):
+    def resolve(self, *args, **kwargs) -> str:
         result = super(_URLResolver, self).resolve(*args, **kwargs)
         if not isinstance(result.url_name, _UrlName):
             result.url_name = _UrlName(result.url_name)
@@ -54,7 +55,7 @@ class _URLResolver(URLResolver):
 Route = namedtuple("Route", ["prefix", "viewset"])
 
 
-def route(prefix, viewset):
+def route(prefix, viewset: "BaseViewset") -> Route:
     """A viewset url"""
     if not isinstance(viewset, BaseViewset):
         raise ValueError(
@@ -65,26 +66,48 @@ def route(prefix, viewset):
     return Route(prefix, viewset)
 
 
-class BaseViewset(object):
+class BaseViewset:
     """
-    Class-based django routing configuration
+    Base class for defining a class-based Django routing configuration.
+
+    Attributes:
+        app_name (Optional[str]): The name of the application associated with this viewset.
+        namespace (Optional[str]): The namespace for the URLs of this viewset.
+        parent_namespace (Optional[str]): The namespace of the parent viewset.
+        extra_kwargs (Optional[Dict[str, Any]]): Additional keyword arguments for URL configuration.
     """
 
-    app_name = None
-    namespace = None
-    parent_namespace = None
-    extra_kwargs = None
+    app_name: Optional[str] = None
+    namespace: Optional[str] = None
+    parent_namespace: Optional[str] = None
+    extra_kwargs: Optional[Dict[str, Any]] = None
 
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__()
-        self._parent = None
+        self._parent: Optional[BaseViewset] = None
 
     @property
-    def parent(self):
+    def parent(self) -> Optional["BaseViewset"]:
+        """
+        Get the parent viewset.
+
+        Returns:
+            Optional[BaseViewset]: The parent viewset, if any.
+        """
         return self._parent
 
     @parent.setter
-    def parent(self, value):
+    def parent(self, value: "BaseViewset") -> None:
+        """
+        Set the parent viewset. This can only be set once.
+
+        Args:
+            value (BaseViewset): The viewset to set as the parent.
+
+        Raises:
+            Warning: If the parent is being set more than once or if the viewset
+                     already has an explicit parent namespace.
+        """
         if self._parent is not None:
             warnings.warn(
                 f"Viewset {self.__class__.__name__} parent could be set only once",
@@ -98,11 +121,28 @@ class BaseViewset(object):
         self._parent = value
 
     @property
-    def urls(self):
+    def urls(self) -> List[Any]:
         raise NotImplementedError("Subclass should override this")
 
-    def reverse(self, viewname, args=None, kwargs=None, current_app=None):
-        """Get view url."""
+    def reverse(
+        self,
+        viewname: str,
+        args: Optional[list[Any]] = None,
+        kwargs: Optional[dict[str, Any]] = None,
+        current_app: Optional[str] = None,
+    ) -> str:
+        """
+        Get the URL for a given viewname, including the namespace.
+
+        Args:
+            viewname (str): The name of the view.
+            args (Optional[list[Any]], optional): Positional arguments for the view.
+            kwargs (Optional[dict[str, Any]], optional): Keyword arguments for the view.
+            current_app (Optional[str], optional): The current application namespace.
+
+        Returns:
+            str: The URL for the view with the appropriate namespace
+        """
         view_namespace = ""
 
         current_viewset = self
@@ -121,7 +161,17 @@ class BaseViewset(object):
 
         return reverse(viewname, args=args, kwargs=kwargs, current_app=current_app)
 
-    def has_view_permission(self, user, obj=None):
+    def has_view_permission(self, user: Any, obj: Optional[Any] = None):
+        """
+        Determine if the user has permission to view the viewset.
+
+        Args:
+            user (User): The user to check permissions for.
+            obj (Optional[Any], optional): The object being viewed.
+
+        Returns:
+            bool: True if the user has view permission, False otherwise.
+        """
         return True