django-viewflow 2.2.7__tar.gz → 2.2.8__tar.gz

{django_viewflow-2.2.7/django_viewflow.egg-info → django-viewflow-2.2.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-viewflow
-Version: 2.2.7
+Version: 2.2.8
 Summary: Reusable library to build business applications fast
 Author: Mikhail Podgurskiy
 Author-email: kmmbvnr@gmail.com
@@ -26,8 +26,6 @@ Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or l
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: Django>=4.2
-Requires-Dist: django-filter>=2.3.0
 
 # Viewflow
 
@@ -218,6 +216,47 @@ modifications of Viewflow. You can find the commercial license terms in
 
 ## Changelog
 
+### 2.2.8 2024-10-04
+
+- Prevent exceptions from being raised by Process/Task models when a flow class
+  is deleted but still referenced in the database.
+- Fix serialization issue with jsonstore.DecimalField.
+- Add missing 'index' view for celery.Task node.
+- Enable recovery of flow.Subprocess and flow.NSubprocess nodes from error state.
+- Correct invalid typing for FSM conditions.
+- Allow setting permission=None in the FSM @transition decorator to explicitly bypass permission checks.
+- Add support for MultiValueField and django-money fields form rendering
+
+
+### 2.2.7 2024-08-16
+
+- Added compatibility fix for Python 3.8.
+- Extend documentation with data management explanation - https://docs.viewflow.io/workflow/data_flow.html
+- Expanded documentation to cover permission management - https://docs.viewflow.io/workflow/permissions.html
+- Introduced an experimental JSONEditorWidget.
+- Fixed issue with saving the state of revived tasks.
+- Enabled the option to cancel If tasks.
+- Updated default FSM state change in FlowViewsMixin to now use transaction.atomic.
+- Added support for using DependentModelSelect in formsets.
+- Enabled AjaxModelSelect to function as a dependency for DependentModelSelect
+- Corrected typo in the deletion success message.
+- Test under django 5.1
+
+### 2.2.6 2024-08-04
+
+- Resolved the flow.If condition's this reference during class construction.
+- Improved error handling when a Celery task finishes.
+- Fixed an issue where errors occurring in a task after a successful celery.Job
+  task incorrectly prevented the job task from being marked as completed, with
+  the errored task correctly put into an error state.
+- Redirect to the next process task now will take into account tasks in the ERROR state
+- Add ability to revive flow.Function and flow.SplitFirst
+- Fixed an error that occurred when a deleted process.artifact was referenced in
+  the process field data listing within templates.
+- Allow to cancel Subprocess tasks
+- Allow to cancel Function tasks
+- Allow custom task models inherited from AbstactTask have no .seed and .data fields
+
 ### 2.2.5 2024-07-17
 
 - The 'pattern' widget attribute is now passed to the underlying form input.

{django_viewflow-2.2.7 → django-viewflow-2.2.8}/README.md

@@ -187,6 +187,47 @@ modifications of Viewflow. You can find the commercial license terms in
 
 ## Changelog
 
+### 2.2.8 2024-10-04
+
+- Prevent exceptions from being raised by Process/Task models when a flow class
+  is deleted but still referenced in the database.
+- Fix serialization issue with jsonstore.DecimalField.
+- Add missing 'index' view for celery.Task node.
+- Enable recovery of flow.Subprocess and flow.NSubprocess nodes from error state.
+- Correct invalid typing for FSM conditions.
+- Allow setting permission=None in the FSM @transition decorator to explicitly bypass permission checks.
+- Add support for MultiValueField and django-money fields form rendering
+
+
+### 2.2.7 2024-08-16
+
+- Added compatibility fix for Python 3.8.
+- Extend documentation with data management explanation - https://docs.viewflow.io/workflow/data_flow.html
+- Expanded documentation to cover permission management - https://docs.viewflow.io/workflow/permissions.html
+- Introduced an experimental JSONEditorWidget.
+- Fixed issue with saving the state of revived tasks.
+- Enabled the option to cancel If tasks.
+- Updated default FSM state change in FlowViewsMixin to now use transaction.atomic.
+- Added support for using DependentModelSelect in formsets.
+- Enabled AjaxModelSelect to function as a dependency for DependentModelSelect
+- Corrected typo in the deletion success message.
+- Test under django 5.1
+
+### 2.2.6 2024-08-04
+
+- Resolved the flow.If condition's this reference during class construction.
+- Improved error handling when a Celery task finishes.
+- Fixed an issue where errors occurring in a task after a successful celery.Job
+  task incorrectly prevented the job task from being marked as completed, with
+  the errored task correctly put into an error state.
+- Redirect to the next process task now will take into account tasks in the ERROR state
+- Add ability to revive flow.Function and flow.SplitFirst
+- Fixed an error that occurred when a deleted process.artifact was referenced in
+  the process field data listing within templates.
+- Allow to cancel Subprocess tasks
+- Allow to cancel Function tasks
+- Allow custom task models inherited from AbstactTask have no .seed and .data fields
+
 ### 2.2.5 2024-07-17
 
 - The 'pattern' widget attribute is now passed to the underlying form input.

{django_viewflow-2.2.7 → django-viewflow-2.2.8/django_viewflow.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-viewflow
-Version: 2.2.7
+Version: 2.2.8
 Summary: Reusable library to build business applications fast
 Author: Mikhail Podgurskiy
 Author-email: kmmbvnr@gmail.com
@@ -26,8 +26,6 @@ Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or l
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: Django>=4.2
-Requires-Dist: django-filter>=2.3.0
 
 # Viewflow
 
@@ -218,6 +216,47 @@ modifications of Viewflow. You can find the commercial license terms in
 
 ## Changelog
 
+### 2.2.8 2024-10-04
+
+- Prevent exceptions from being raised by Process/Task models when a flow class
+  is deleted but still referenced in the database.
+- Fix serialization issue with jsonstore.DecimalField.
+- Add missing 'index' view for celery.Task node.
+- Enable recovery of flow.Subprocess and flow.NSubprocess nodes from error state.
+- Correct invalid typing for FSM conditions.
+- Allow setting permission=None in the FSM @transition decorator to explicitly bypass permission checks.
+- Add support for MultiValueField and django-money fields form rendering
+
+
+### 2.2.7 2024-08-16
+
+- Added compatibility fix for Python 3.8.
+- Extend documentation with data management explanation - https://docs.viewflow.io/workflow/data_flow.html
+- Expanded documentation to cover permission management - https://docs.viewflow.io/workflow/permissions.html
+- Introduced an experimental JSONEditorWidget.
+- Fixed issue with saving the state of revived tasks.
+- Enabled the option to cancel If tasks.
+- Updated default FSM state change in FlowViewsMixin to now use transaction.atomic.
+- Added support for using DependentModelSelect in formsets.
+- Enabled AjaxModelSelect to function as a dependency for DependentModelSelect
+- Corrected typo in the deletion success message.
+- Test under django 5.1
+
+### 2.2.6 2024-08-04
+
+- Resolved the flow.If condition's this reference during class construction.
+- Improved error handling when a Celery task finishes.
+- Fixed an issue where errors occurring in a task after a successful celery.Job
+  task incorrectly prevented the job task from being marked as completed, with
+  the errored task correctly put into an error state.
+- Redirect to the next process task now will take into account tasks in the ERROR state
+- Add ability to revive flow.Function and flow.SplitFirst
+- Fixed an error that occurred when a deleted process.artifact was referenced in
+  the process field data listing within templates.
+- Allow to cancel Subprocess tasks
+- Allow to cancel Function tasks
+- Allow custom task models inherited from AbstactTask have no .seed and .data fields
+
 ### 2.2.5 2024-07-17
 
 - The 'pattern' widget attribute is now passed to the underlying form input.

{django_viewflow-2.2.7 → django-viewflow-2.2.8}/setup.py

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

{django_viewflow-2.2.7 → django-viewflow-2.2.8}/viewflow/fsm/base.py

@@ -12,7 +12,7 @@ from __future__ import annotations
 import inspect
 from typing import Any, Dict, Mapping, Iterable, List, Type, Optional
 from viewflow.this_object import ThisObject
-from viewflow.utils import MARKER
+from viewflow.utils import DEFAULT, MARKER
 from .typing import (
     UserModel,
     Condition,
@@ -39,7 +39,7 @@ class Transition:
         target: Optional[StateValue],
         label: Optional[str] = None,
         conditions: Optional[List[Condition]] = None,
-        permission: Optional[Permission] = None,
+        permission: Optional[Permission] = DEFAULT,
         custom: Optional[Dict] = None,
     ):  # noqa D102
         self.func = func
@@ -86,8 +86,10 @@ class Transition:
 
     def has_perm(self, instance: object, user: UserModel) -> bool:
         """Checks if the given user has permission to perform this transition."""
+        if self.permission is DEFAULT:
+            return False  # Protected by default
         if self.permission is None:
-            return False  # No permission required
+            return True  # Explicitly allowed to any
         elif callable(self.permission):
             return self.permission(instance, user)
         elif isinstance(self.permission, ThisObject):
@@ -410,7 +412,7 @@ class State:
         target: Optional[StateValue] = None,
         label: Optional[str] = None,
         conditions: Optional[List[Condition]] = None,
-        permission: Optional[Permission] = None,
+        permission: Optional[Permission] = DEFAULT,
         custom: Optional[Dict] = None,
     ) -> Any:
         """Decorator to mark a method as a state transition."""

{django_viewflow-2.2.7 → django-viewflow-2.2.8}/viewflow/fsm/typing.py

@@ -13,7 +13,7 @@ if TYPE_CHECKING:
 
 UserModel = Any
 StateValue = Any
-Condition = Union[ThisObject, Callable[[object, object], bool]]
+Condition = Union[ThisObject, Callable[[object], bool]]
 Permission = Union[ThisObject, Callable[[object, Any], bool]]
 StateTransitions = Mapping["TransitionMethod", List["Transition"]]
 TransitionFunction = Callable[..., Any]

{django_viewflow-2.2.7 → django-viewflow-2.2.8}/viewflow/jsonstore.py

@@ -8,6 +8,7 @@
 import copy
 import json
 from datetime import date, datetime
+from decimal import Decimal
 from functools import partialmethod
 
 from django.core.exceptions import FieldError
@@ -190,7 +191,13 @@ class DateTimeField(JSONFieldMixin, fields.DateTimeField):
 
 
 class DecimalField(JSONFieldMixin, fields.DecimalField):
-    pass
+    def to_json(self, value):
+        if value is not None:
+            return str(value)
+
+    def from_json(self, value):
+        if value is not None:
+            return Decimal(value)
 
 
 class EmailField(JSONFieldMixin, fields.EmailField):

{django_viewflow-2.2.7 → django-viewflow-2.2.8}/viewflow/urls/base.py

@@ -8,10 +8,9 @@ import copy
 import types
 import warnings
 from collections import namedtuple, OrderedDict
-from typing import Optional, Dict, Any, List, Union
-
+from typing import Optional, Dict, Any, List
 from django.views.generic import RedirectView
-from django.urls import URLPattern, URLResolver, include, path, reverse
+from django.urls import ResolverMatch, URLPattern, URLResolver, include, path, reverse
 from django.urls.resolvers import RoutePattern
 
 from viewflow.utils import (
@@ -40,7 +39,7 @@ class _URLResolver(URLResolver):
         self.extra = kwargs.pop("extra", {})
         super(_URLResolver, self).__init__(*args, **kwargs)
 
-    def resolve(self, *args, **kwargs) -> str:
+    def resolve(self, *args, **kwargs) -> ResolverMatch:
         result = super(_URLResolver, self).resolve(*args, **kwargs)
         if not isinstance(result.url_name, _UrlName):
             result.url_name = _UrlName(result.url_name)

{django_viewflow-2.2.7 → django-viewflow-2.2.8}/viewflow/urls/sites.py

@@ -17,7 +17,7 @@ class AppMenuMixin:
     """A route that can be listed in an Application menu."""
 
     title = None
-    icon = Icon("view_carousel")
+    icon: Icon | str = Icon("view_carousel")
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
@@ -47,7 +47,7 @@ class AppMenuMixin:
 
 class Application(IndexViewMixin, Viewset):
     title = ""
-    icon = Icon("view_module")
+    icon: Icon | str = Icon("view_module")
     menu_template_name = "viewflow/includes/app_menu.html"
     base_template_name = "viewflow/base_page.html"
     permission = None

{django_viewflow-2.2.7 → django-viewflow-2.2.8}/viewflow/utils.py

@@ -230,6 +230,7 @@ def get_object_data(obj: models.Model) -> Iterator[Tuple[models.Field, str, Any]
 
     if (
         hasattr(obj, "artifact_object_id")
+        and hasattr(obj, "artifact")
         and obj.artifact_object_id
         and obj.artifact is not None
     ):

{django_viewflow-2.2.7 → django-viewflow-2.2.8}/viewflow/views/base.py

@@ -5,6 +5,7 @@
 # LICENSE_EXCEPTION and the Commercial licence defined in file 'COMM_LICENSE',
 # which is part of this source code package.
 
+from typing import Any, List, Union
 from django import forms
 from viewflow.utils import viewprop
 from viewflow.forms import Span
@@ -29,7 +30,7 @@ class FormLayoutMixin(object):
     Mixin for FormView to infer View.fields definition from form Layout.
     """
 
-    form_class = None
+    form_class: Any = None
 
     @viewprop
     def layout(self):
@@ -37,7 +38,7 @@ class FormLayoutMixin(object):
             return self.form_class.layout
 
     @viewprop
-    def fields(self):
+    def fields(self) -> Any:
         if self.form_class is None:
             if self.layout is not None:
                 return _collect_elements(self.layout)

{django_viewflow-2.2.7 → django-viewflow-2.2.8}/viewflow/workflow/fields.py

@@ -94,6 +94,8 @@ class FlowReferenceField(models.CharField):
             return import_flow_by_ref(value)
         except LookupError:
             return None
+        except ImportError:
+            return None
 
     def get_prep_value(self, value):  # noqa D1o2
         if value and not isinstance(value, str):
@@ -118,7 +120,11 @@ class TaskReferenceField(models.CharField):
     def from_db_value(self, value, expression, connection):
         if value is None:
             return value
-        return import_task_by_ref(value)
+
+        try:
+            return import_task_by_ref(value)
+        except ImportError:
+            return None
 
     def get_prep_value(self, value):  # noqa D102
         if value and not isinstance(value, str):

{django_viewflow-2.2.7 → django-viewflow-2.2.8}/viewflow/workflow/flow/mixins.py

@@ -1,3 +1,5 @@
+from typing import Type, Optional
+from django.views import View
 from django.urls import path
 from viewflow import viewprop
 from viewflow.urls import ViewsetMeta
@@ -7,7 +9,7 @@ from . import utils
 class NodeDetailMixin(metaclass=ViewsetMeta):
     """Task detail view."""
 
-    index_view_class = None
+    index_view_class: Optional[Type[View]] = None
 
     @viewprop
     def index_view(self):
@@ -24,7 +26,7 @@ class NodeDetailMixin(metaclass=ViewsetMeta):
                 name="index",
             )
 
-    detail_view_class = None
+    detail_view_class: Optional[Type[View]] = None
 
     @viewprop
     def detail_view(self):
@@ -49,7 +51,7 @@ class NodeDetailMixin(metaclass=ViewsetMeta):
 class NodeExecuteMixin(metaclass=ViewsetMeta):
     """Re-execute a gate manually."""
 
-    execute_view_class = None
+    execute_view_class: Optional[Type[View]] = None
 
     @viewprop
     def execute_view(self):
@@ -70,7 +72,7 @@ class NodeExecuteMixin(metaclass=ViewsetMeta):
 class NodeUndoMixin(metaclass=ViewsetMeta):
     """Allow to undo a completed task."""
 
-    undo_view_class = None
+    undo_view_class: Optional[Type[View]] = None
 
     @viewprop
     def undo_view(self):
@@ -94,7 +96,7 @@ class NodeUndoMixin(metaclass=ViewsetMeta):
 class NodeCancelMixin(metaclass=ViewsetMeta):
     """Cancel a task action."""
 
-    cancel_view_class = None
+    cancel_view_class: Optional[Type[View]] = None
 
     @viewprop
     def cancel_view(self):
@@ -120,7 +122,7 @@ class NodeCancelMixin(metaclass=ViewsetMeta):
 class NodeReviveMixin(metaclass=ViewsetMeta):
     """Review a canceled task"""
 
-    revive_view_class = None
+    revive_view_class: Optional[Type[View]] = None
 
     @viewprop
     def revive_view(self):

{django_viewflow-2.2.7 → django-viewflow-2.2.8}/viewflow/workflow/flow/nodes.py

@@ -420,6 +420,7 @@ try:
         mixins.NodeDetailMixin,
         mixins.NodeCancelMixin,
         mixins.NodeUndoMixin,
+        mixins.NodeReviveMixin,
         nodes.Subprocess,
     ):
         """
@@ -452,11 +453,13 @@ try:
         detail_view_class = views.DetailTaskView
         cancel_view_class = views.CancelTaskView
         undo_view_class = views.UndoTaskView
+        revive_view_class = views.ReviveTaskView
 
     class NSubprocess(
         mixins.NodeDetailMixin,
         mixins.NodeCancelMixin,
         mixins.NodeUndoMixin,
+        mixins.NodeReviveMixin,
         nodes.NSubprocess,
     ):
         """
@@ -491,6 +494,7 @@ try:
         detail_view_class = views.DetailTaskView
         cancel_view_class = views.CancelTaskView
         undo_view_class = views.UndoTaskView
+        revive_view_class = views.ReviveTaskView
 
 except AttributeError:
     """Pro-only functionality"""
@@ -504,6 +508,22 @@ class Switch(
     mixins.NodeReviveMixin,
     nodes.Switch,
 ):
+    """
+    Gateway that selects one of the outgoing node.
+
+    Activates first node with matched condition.
+
+    Example::
+
+        select_responsible_person = (
+            flow.Switch()
+            .Case(this.dean_approval, lambda act: a.process.need_dean)
+            .Case(this.head_approval, lambda act: a.process.need_head)
+            .Default(this.supervisor_approval)
+        )
+
+    """
+
     index_view_class = views.IndexTaskView
     detail_view_class = views.DetailTaskView
     cancel_view_class = views.CancelTaskView

{django_viewflow-2.2.7 → django-viewflow-2.2.8}/viewflow/workflow/models.py

@@ -43,6 +43,9 @@ class AbstractProcess(models.Model):
     @property
     def brief(self):
         """Quick textual process state representation for end user."""
+        if self.flow_class is None:
+            return None
+
         template_content = ""
 
         if self.finished:
@@ -175,6 +178,9 @@ class AbstractTask(models.Model):
 
     @property
     def title(self):
+        if self.flow_task is None:
+            return None
+
         if self.flow_task.task_title:
             return self.flow_task.task_title
         return _(str(self.flow_task))