django-viewflow 2.0.2__tar.gz → 2.1.0__tar.gz

{django-viewflow-2.0.2 → django-viewflow-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-viewflow
-Version: 2.0.2
+Version: 2.1.0
 Summary: Reusable library to build business applications fast
 Author: Mikhail Podgurskiy
 Author-email: kmmbvnr@gmail.com

{django-viewflow-2.0.2 → django-viewflow-2.1.0}/README.md

@@ -183,26 +183,10 @@ modifications of Viewflow. You can find the commercial license terms in
 
 ## Changelog
 
-### 2.0.2 2024-04-19
+### 2.1.0 2024-06-16
 
-- Fix logout link
-- Change admin user autocomplete field to readonly
-
-
-### 2.0.1 2024-04-17
-
-- Fix for AjaxModelSelect in m2m relations
-
-
-### 2.0.0 2024-04-09
-
-- Added support for Django 5.0+
-- Updated to Material Components Web 1.4.0
-- Improved help text styles
-- Fixed default app_name configuration for Viewsets
-- List View initial filter values support
-- Enhanced localization support
-- Corrected object permission checks for delete actions
+- 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.
 
 
 [build]: https://img.shields.io/github/actions/workflow/status/viewflow/viewflow/django.yml?branch=main

{django-viewflow-2.0.2 → django-viewflow-2.1.0}/django_viewflow.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-viewflow
-Version: 2.0.2
+Version: 2.1.0
 Summary: Reusable library to build business applications fast
 Author: Mikhail Podgurskiy
 Author-email: kmmbvnr@gmail.com

{django-viewflow-2.0.2 → django-viewflow-2.1.0}/setup.py

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

{django-viewflow-2.0.2 → django-viewflow-2.1.0}/viewflow/fsm/base.py

@@ -40,6 +40,7 @@ class Transition:
         label: Optional[str] = None,
         conditions: Optional[List[Condition]] = None,
         permission: Optional[Permission] = None,
+        custom: Optional[Dict] = None,
     ):  # noqa D102
         self.func = func
         self.source = source
@@ -47,6 +48,7 @@ class Transition:
         self._label = label
         self.permission = permission
         self.conditions = conditions if conditions else []
+        self.custom = custom if custom is not None else {}
 
     def __repr__(self) -> str:
         return f"<Transition({self.label} {self.source} -> {self.target}) object at {id(self)}>"
@@ -409,6 +411,7 @@ class State:
         label: Optional[str] = None,
         conditions: Optional[List[Condition]] = None,
         permission: Optional[Permission] = None,
+        custom: Optional[Dict] = None,
     ) -> Any:
         """Decorator to mark a method as a state transition."""
 
@@ -430,6 +433,7 @@ class State:
                     label=label,
                     conditions=conditions,
                     permission=permission,
+                    custom=custom,
                 )
                 descriptor.add_transition(transition)
 

{django-viewflow-2.0.2 → django-viewflow-2.1.0}/viewflow/templates/registration/profile.html

@@ -34,8 +34,10 @@
       <div class="mdc-layout-grid__cell mdc-layout-grid__cell--span-10">
         <div class="mdc-card vf-page-profile__detail">
           <section class="vf-page-profile__detail-header">
-            <h1 class="mdc-typography--headline6">John Doe</h1>
-            <h2 class="mdc-typography--subtitle2">admin@admin.com</h2>
+            {% block form-header-title %}
+            <h1 class="mdc-typography--headline6">{{view.request.user.get_username.title }}</h1>
+            {% endblock %}
+            {% block form-header-subtitle %}{% endblock %}
           </section>
           <section>
             <table class="vf-list__table">

{django-viewflow-2.0.2 → django-viewflow-2.1.0}/viewflow/templates/viewflow/workflow/task.html

@@ -11,7 +11,7 @@
             <section class="vf-card__header">
               {% block form-header-title %}
                 <h1 class="vf-card__title">
-                  {{ request.activation.task.flow_task }}
+                  {{ request.activation.task.flow_task.task_title }}
                 </h1>
               {% endblock %}
               {% block form-header-subtitle %}

{django-viewflow-2.0.2 → django-viewflow-2.1.0}/viewflow/templates/viewflow/workflow/task_detail.html

@@ -4,7 +4,7 @@
 {% block breadcrumbs_items %}
   <a href="{% reverse viewset 'index' %}">{{ process.flow_class.process_title }}</a>
   <a href="{% reverse viewset 'process_detail' process.pk %}">#{{ process.pk }}</a>
-  <a>{{ task.flow_task }} #{{ task.pk}}</a>
+  <a>{{ task.flow_task.task_title }} #{{ task.pk}}</a>
 {% endblock %}
 
 {% block task_content %}
@@ -21,7 +21,7 @@
     <h4 class="mdc-typography mdc-typography--headline5" style="margin-bottom:10px">{% trans "Previous tasks" %}</h4>
     <div>
       {% for prev_task in task.previous.all %}
-        <a class="mdc-typography mdc-typography--subtitle1" href="{% reverse prev_task.flow_task 'index' process.pk prev_task.pk %}">{{ prev_task.flow_task.task_description|default:prev_task.flow_task }}</a>{% if not forloop.last %}, {% endif %}
+        <a class="mdc-typography mdc-typography--subtitle1" href="{% reverse prev_task.flow_task 'index' process.pk prev_task.pk %}">{{ prev_task.flow_task.task_description|default:prev_task.flow_task.task_title }}</a>{% if not forloop.last %}, {% endif %}
       {% empty %}
         <span class="mdc-typography mdc-typography--subtitle1" style="color:grey">{% trans "No previous tasks" %}</span>
       {% endfor %}
@@ -31,7 +31,7 @@
     <h4 class="mdc-typography mdc-typography--headline5"  style="margin-bottom:10px">{% trans "Next tasks" %}</h4>
     <div>
       {% for next_task in task.leading.all %}
-        <a class="mdc-typography mdc-typography--subtitle1" href="{% reverse next_task.flow_task 'index' process.pk next_task.pk %}">{{ prev_task.next_task.task_description|default:next_task.flow_task }}</a>{% if not forloop.last %}, {% endif %}
+        <a class="mdc-typography mdc-typography--subtitle1" href="{% reverse next_task.flow_task 'index' process.pk next_task.pk %}">{{ next_task.task_description|default:next_task.flow_task.task_title }}</a>{% if not forloop.last %}, {% endif %}
       {% empty %}
         <span class="mdc-typography mdc-typography--subtitle1" style="color:grey">{% trans "No next tasks" %}</span>
       {% endfor %}

{django-viewflow-2.0.2 → django-viewflow-2.1.0}/viewflow/views/filters.py

@@ -38,7 +38,10 @@ class FilterableViewMixin(object):
                 data = data.copy()
                 for key, value in self.filterset_initial.items():
                     if key not in data:
-                        data[key] = value
+                        if isinstance(value, (list, tuple, set)):
+                            data.setlist(key, value)
+                        else:
+                            data[key] = value
 
         return {
             **kwargs,

{django-viewflow-2.0.2 → django-viewflow-2.1.0}/viewflow/workflow/activation.py

@@ -100,11 +100,14 @@ class Activation(object):
         return guard()
 
     @classmethod
-    def create(cls, flow_task, prev_activation, token):
+    def create(cls, flow_task, prev_activation, token, data=None):
         """Instantiate and persist new flow task."""
         flow_class = flow_task.flow_class
         task = flow_class.task_class(
-            process=prev_activation.process, flow_task=flow_task, token=token
+            process=prev_activation.process,
+            flow_task=flow_task,
+            token=token,
+            data=data if data is not None else {},
         )
         task.save()
         task.previous.add(prev_activation.task)

{django-viewflow-2.0.2 → django-viewflow-2.1.0}/viewflow/workflow/base.py

@@ -130,7 +130,7 @@ class Node(Viewset):
         Subclasses can perform additional initialization here.
         """
 
-    def _create(self, prev_activation, token):
+    def _create(self, prev_activation, token, data=None):
         """
         Create a new task instance.
 
@@ -141,7 +141,7 @@ class Node(Viewset):
         :returns: The new activation instance.
         :rtype: Activation
         """
-        return self.activation_class.create(self, prev_activation, token)
+        return self.activation_class.create(self, prev_activation, token, data=data)
 
     def Annotation(
         self, title=None, description=None, summary_template=None, result_template=None

{django-viewflow-2.0.2 → django-viewflow-2.1.0}/viewflow/workflow/flow/nodes.py

@@ -315,6 +315,11 @@ class Split(
     mixins.NodeReviveMixin,
     nodes.Split,
 ):
+    """
+    Parallel split gateway.
+
+    """
+
     index_view_class = views.IndexTaskView
     detail_view_class = views.DetailTaskView
     undo_view_class = views.UndoTaskView

{django-viewflow-2.0.2 → django-viewflow-2.1.0}/viewflow/workflow/nodes/split.py

@@ -22,12 +22,14 @@ class SplitActivation(Activation):
     @Activation.status.super()
     def activate(self):
         """Calculate nodes list to activate."""
-        for node, cond in self.flow_task._branches:
-            if cond:
-                if cond(self):
-                    self.next_tasks.append(node)
+        for node, cond, data_source in self.flow_task._branches:
+            if cond and not cond(self):
+                continue
+            if data_source:
+                for data in data_source(self):
+                    self.next_tasks.append((node, data))
             else:
-                self.next_tasks.append(node)
+                self.next_tasks.append((node, None))
 
         if not self.next_tasks:
             raise FlowRuntimeError(
@@ -44,17 +46,47 @@ class SplitActivation(Activation):
         token_source = Token.split_token_source(self.task.token, self.task.pk)
 
         next_tasks = [
-            task for task in self.next_tasks if not isinstance(task, Join)
-        ] + [task for task in self.next_tasks if isinstance(task, Join)]
+            (task, data) for task, data in self.next_tasks if not isinstance(task, Join)
+        ] + [(task, None) for task in self.next_tasks if isinstance(task, Join)]
 
-        for n, next_task in enumerate(next_tasks, 1):
-            yield next_task._create(prev_activation=self, token=next(token_source))
+        for n, (next_task, data) in enumerate(next_tasks, 1):
+            yield next_task._create(
+                prev_activation=self, token=next(token_source), data=data
+            )
 
 
 class Split(
     Node,
 ):
-    """Parallel split gateway."""
+    """
+    Represents a parallel split gateway in a workflow, allowing branching into multiple parallel paths.
+
+    Methods:
+        - `Next(node, case=None, data_source=None)`: Defines the subsequent node in the workflow.
+          - `node`: The next node to execute.
+          - `case` (optional): A callable that takes an activation and returns `True` if the node should be activated.
+          - `data_source` (optional): A callable that takes an activation and returns a list of data items, creating an instance of the node for each item, with `task.data` set to the item.
+        - `Always(node)`: A shortcut to define a subsequent node that is always executed.
+
+    Example:
+        ```python
+        flow.Split()
+            .Next(
+                this.approve,
+                case=act.process.approved,
+                data_source=lambda activation: [{"sample": "test task 1"}, {"sample": "test task 2"}],
+            )
+            .Always(this.required)
+        ```
+
+    In this example:
+        - The `approve` node is executed multiple times based on the `data_source` list.
+        - The `required` node is always executed unconditionally in parallel.
+
+    Notes:
+        - If `case` is not provided, the node is always activated.
+        - If `data_source` is not provided, the node is created only once.
+    """
 
     activation_class = SplitActivation
 
@@ -76,7 +108,7 @@ class Split(
         self._activate_next = []
 
     def _outgoing(self):
-        for next_node, cond in self._activate_next:
+        for next_node, cond, _ in self._activate_next:
             edge_class = "cond_true" if cond else "default"
             yield Edge(src=self, dst=next_node, edge_class=edge_class)
 
@@ -84,20 +116,25 @@ class Split(
         super()._resolve(instance)
 
         self._activate_next = [
-            (this.resolve(instance, node), cond) for node, cond in self._activate_next
+            (
+                this.resolve(instance, node),
+                this.resolve(instance, cond),
+                this.resolve(instance, data_source),
+            )
+            for node, cond, data_source in self._activate_next
         ]
 
     @property
     def _branches(self):
         return self._activate_next
 
-    def Next(self, node, case=None):
+    def Next(self, node, case=None, data_source=None):
         """Node to activate if condition is true.
 
         :param cond: Callable[activation] -> bool
 
         """
-        self._activate_next.append((node, case))
+        self._activate_next.append((node, case, data_source))
         return self
 
     def Always(self, node):