User defined states (#7862)

* Add custom user defined states

* make tests more reliable

* fix list options

* Adapt version

* do not engage if rebuilding

* remove unneeded attr

* remove unneeded attr

* fix enum imports

* adapt cove target

* Add status_custom_key to all other serializers

* fix serializer method

* simplify branching

* remove unneeded imports

* inherit read_only status from leader field

* Add more tests

* fix tests

* add test for function

* refactor for easier testing

* move test to seperate class

* Add options testing

* extend serializer

* add test for all states and refactor to reuse already build functions

* use custom field in PUI too

* reset diff

* style fix

* fix comparison

* Add test for str

* test color exceptions too

* remove user state from tracking

* Add intro from model fields too

* update docs

* simplify implementation

* update tests

* fix name

* rename test

* simplify tags and test fully

* extend test to machine status

* move logic for response formatting over

* extend api response with machine  status

* ensure only direct subclasses are discovered

* test for length of total respone too

* use new fields on PUI too

* fix test assertion with plugins enabled

* also observe rendering in filters

* Add managment endpoints and APIs

* Add contenttypes to PUI renderes

* use filteres instead

* fix import order

* fix api route definition

* move status choices to serializer

* fix lookup

* fix filtering

* remove admin integration

* cleanup migration

* fix migration change

* cleanup code location

* fix imports

* Add docs for custom states

* add links to custom status

docs/docs/concepts/custom_states.md

@@ -0,0 +1,15 @@
+---
+title: Custom States
+---
+
+## Custom States
+
+Several models within InvenTree support the use of custom states. The custom states are display only - the business logic is not affected by the state.
+
+States can be added in the Admin Center under the "Custom States" section. Each state has a name, label and a color that are used to display the state in the user interface. Changes to these settings will only be reflected in the user interface after a full reload of the interface.
+
+States need to be assigned to a model, state (for example status on a StockItem) and a logical key - that will be used for business logic. These 3 values combined need to be unique throughout the system.
+
+Custom states can be used in the following models:
+- StockItem
+- Orders (PurchaseOrder, SalesOrder, ReturnOrder, ReturnOrderLine)

docs/docs/extend/machines/overview.md

@@ -47,6 +47,8 @@ If you want to create your own machine type, please also take a look at the alre
 
 ```py
 from django.utils.translation import gettext_lazy as _
+
+from generic.states import ColorEnum
 from plugin.machine import BaseDriver, BaseMachineType, MachineStatus
 
 class ABCBaseDriver(BaseDriver):
@@ -72,9 +74,9 @@ class ABCMachine(BaseMachineType):
     base_driver = ABCBaseDriver
 
     class ABCStatus(MachineStatus):
-        CONNECTED = 100, _('Connected'), 'success'
-        STANDBY = 101, _('Standby'), 'success'
-        PRINTING = 110, _('Printing'), 'primary'
+        CONNECTED = 100, _('Connected'), ColorEnum.success
+        STANDBY = 101, _('Standby'), ColorEnum.success
+        PRINTING = 110, _('Printing'), ColorEnum.primary
 
     MACHINE_STATUS = ABCStatus
     default_machine_status = ABCStatus.DISCONNECTED

docs/docs/order/purchase_order.md

@@ -38,6 +38,8 @@ Refer to the source code for the Purchase Order status codes:
         show_source: True
         members: []
 
+Purchase Order Status supports [custom states](../concepts/custom_states.md).
+
 ### Purchase Order Currency
 
 The currency code can be specified for an individual purchase order. If not specified, the default currency specified against the [supplier](./company.md#suppliers) will be used.

docs/docs/order/return_order.md

@@ -61,6 +61,8 @@ Refer to the source code for the Return Order status codes:
         show_source: True
         members: []
 
+Return Order Status supports [custom states](../concepts/custom_states.md).
+
 ## Create a Return Order
 
 From the Return Order index, click on <span class='badge inventree add'><span class='fas fa-plus-circle'></span> New Return Order</span> which opens the "Create Return Order" form.

docs/docs/order/sales_order.md

@@ -39,6 +39,8 @@ Refer to the source code for the Sales Order status codes:
         show_source: True
         members: []
 
+Sales Order Status supports [custom states](../concepts/custom_states.md).
+
 ### Sales Order Currency
 
 The currency code can be specified for an individual sales order. If not specified, the default currency specified against the [customer](./company.md#customers) will be used.

docs/docs/stock/status.md

@@ -10,7 +10,7 @@ Certain stock item status codes will restrict the availability of the stock item
 
 Below is the list of available stock status codes and their meaning:
 
-| Status      | Description | Available |
+| Status | Description | Available |
 | ----------- | ----------- | --- |
 | <span class='badge inventree success'>OK</span> | Stock item is healthy, nothing wrong to report | <span class='badge inventree success'>Yes</span> |
 | <span class='badge inventree warning'>Attention needed</span> | Stock item hasn't been checked or tested yet | <span class='badge inventree success'>Yes</span> |
@@ -38,6 +38,8 @@ Refer to the source code for the Stock status codes:
         show_source: True
         members: []
 
+Stock Status supports [custom states](../concepts/custom_states.md).
+
 ### Default Status Code
 
 The default status code for any newly created Stock Item is <span class='badge inventree success'>OK</span>

docs/mkdocs.yml

@@ -77,6 +77,7 @@ nav:
     - Core Concepts:
       - Terminology: concepts/terminology.md
       - Physical Units: concepts/units.md
+      - Custom States: concepts/custom_states.md
     - Development:
       - Contributing: develop/contributing.md
       - Devcontainer: develop/devcontainer.md