A workflow solution for django applications, based on django-workflows core.
Optimized method to get the allowed transitions.
Fixed workflow model save method, capturing possible errors when the model is saved.
Changed workflow implementation to avoid load django models in the decorator's declaration.
Returning a default value for WorkflowBase states method.
Fixed importing error.
Added history method to workflow base.
Adding current_state attribute to the workflow class, only if this attribute is not created.
Fixed WorkflowBase class.
Fix workflow roles creation.
Added a param (user) to the transition check methods. Added useful classmethods to the workflow class.
Added convenient methods to workflow enabled models managers, to filter instances by specific current state. Added test application.
Fix do_transition method.
Fix some details to run successfully using unit test.
Fix - Natural keys implementation for Workflow.
Natural keys implementation for Workflow.
Based on django-workflows core, some common methods are added to the workflow enabled models, in order to decrease the implementation time of each workflow. A model to save historical workflow transitions is also added. In order to make workflow configuration easier, in this version you can configure workflows by the declaring a dict in django settings and workflows will be automatically created.
PENDING...
Run
python setup.py installto install.Modify your Django settings to use
permissionsandworkflows:- Add the decorator
workflow_enabledto the models that will have workflow behavior. When you run the project this decorator will add some common methods: transitions methods and the methods to check current workflow state. An attribute
current_statewill also be added.
- Add the decorator
- Configure the workflows:
Define a
WORKFLOWSsetting for each application containing aworkflow_enabledmodel. This setting must be a dictionary with following format:- Each workflow inside the dict will be identified by the corresponding workflow enabled model path, in the
value of that dictionary key, will be the rest of the workflow configuration.
- The rest of the workflow configuration will be represented by:
- name: Workflow Name
- roles: The name of the roles related to the workflow
- permissions: The permissions related to the workflow
- initial_state: The workflow initial state
- states: The rest of the workflow states
- transitions: The workflow transitions
- state_transitions: The allowed transitions for each state
- user_roles: The relation between users and roles. Each user would be specified by a workflow attribute or
some workflow method defined in the related workflow enabled model.
Example: # WORKFLOWS DEFINITIONS WORKFLOWS = {
- 'test.models.Publication': {
'name': 'PUBLICATION_WORKFLOW', 'roles': ['Owner', 'Closer', 'Admin'], 'permissions': [
- {
'name': 'Make Private Permission', 'codename': 'MAKE_PRIVATE_PERM',
}, {
'name': 'Make Public Permission', 'codename': 'MAKE_PUBLIC_PERM',
}, {
'name': 'End Permission', 'codename': 'END_PERM',
}
], 'initial_state': {
'name': 'Private State', # StatePermissionRelation 'state_perm_relation': [
- {
'role': 'Owner', 'permission': 'MAKE_PUBLIC_PERM',
}, {
'role': 'Admin', 'permission': 'MAKE_PUBLIC_PERM',
}, {
'role': 'Admin', 'permission': 'END_PERM',
}, {
'role': 'Closer', 'permission': 'END_PERM',
}
]
}, 'states': [
- {
'name': 'Public State', # StatePermissionRelation 'state_perm_relation': [
- {
'role': 'Owner', 'permission': 'MAKE_PRIVATE_PERM',
}, {
'role': 'Admin', 'permission': 'MAKE_PRIVATE_PERM',
}, {
'role': 'Admin', 'permission': 'END_PERM',
}, {
'role': 'Closer', 'permission': 'END_PERM',
}
]
}, {
'name': 'End State', # StatePermissionRelation 'state_perm_relation': []
},
], 'transitions': [
- {
'name': 'Make Public Transition', 'destination': 'Public State', 'permission': 'MAKE_PUBLIC_PERM', 'description': 'Make Public Transition',
}, {
'name': 'Make Private Transition', 'destination': 'Private State', 'permission': 'MAKE_PRIVATE_PERM', 'description': 'Make Private Transition',
}, {
'name': 'End Transition', 'destination': 'End State', 'permission': 'END_PERM', 'description': 'End Transition', 'condition': 'condition_transition',
},
], 'state_transitions': {
'Private State': ['Make Public Transition', 'End Transition'], 'Public State': ['Make Private Transition', 'End Transition'],
}, 'user_roles': [
# for each item will try to find the user value as an attribute or method of the related workflow model # you can specify attributes of the attributes {
'user_path': 'owner', 'role': 'Owner'
}, {
'user_path': 'item.creator', 'role': 'Closer'
}, {
'user_path': 'administrators', 'role': 'Admin'
}
]
}
}
- Add the workflow setting to the project settings.
Example: # APPLICATION WORKFLOWS workflows = getattr(settings, 'WORKFLOWS', {}) workflows.update(WORKFLOWS) setattr(settings, 'WORKFLOWS', workflows)
- Workflow facilities:
For each model workflow, convenient methods are automatically added. + Transitions
- You can execute each transition using the transition name:
Example: instance.do_make_public(user, comment): For a transition named "Make public"
Each transition method called by the transition name, as explained above, will call a checker method if this method exist. In this method you can check anything and the transition method will be executed if this method exist and returns True. If the checker method does not exit, then, the transition method will be executed normally.
Example: check_make_public() : Is called, if exist, when the method do_make_public(user, comment) is executed.
- Current State
- You can ask if the instance workflow has an specific state, using the state name:
- Example: is_public() : For an state named "Public"
- Managers
- Convenient methods are added to workflow enabled models managers, to filter instances by specific current state.
- Example: Publication.objects.public(): return all Publication instances with a current state of "Public" (Assuming that Publication is workflow enabled model)