Refactor states/status

InvenTree/InvenTree/api.py

@@ -306,47 +306,6 @@ def post(self, request, *args, **kwargs):
         return Response(results)
 
 
-class StatusView(APIView):
-    """Generic API endpoint for discovering information on 'status codes' for a particular model.
-
-    This class should be implemented as a subclass for each type of status.
-    For example, the API endpoint /stock/status/ will have information about
-    all available 'StockStatus' codes
-    """
-
-    permission_classes = [
-        permissions.IsAuthenticated,
-    ]
-
-    # Override status_class for implementing subclass
-    MODEL_REF = 'statusmodel'
-
-    def get_status_model(self, *args, **kwargs):
-        """Return the StatusCode moedl based on extra parameters passed to the view"""
-
-        status_model = self.kwargs.get(self.MODEL_REF, None)
-
-        if status_model is None:
-            raise ValidationError(f"StatusView view called without '{self.MODEL_REF}' parameter")
-
-        return status_model
-
-    def get(self, request, *args, **kwargs):
-        """Perform a GET request to learn information about status codes"""
-
-        status_class = self.get_status_model()
-
-        if not status_class:
-            raise NotImplementedError("status_class not defined for this endpoint")
-
-        data = {
-            'class': status_class.__name__,
-            'values': status_class.dict(),
-        }
-
-        return Response(data)
-
-
 class MetadataView(RetrieveUpdateAPI):
     """Generic API endpoint for reading and editing metadata for a model"""
 

InvenTree/InvenTree/context.py

@@ -3,10 +3,8 @@
 """Provides extra global data to all templates."""
 
 import InvenTree.status
-from InvenTree.status_codes import (BuildStatus, PurchaseOrderStatus,
-                                    ReturnOrderLineStatus, ReturnOrderStatus,
-                                    SalesOrderStatus, StockHistoryCode,
-                                    StockStatus)
+from generic.states import StatusCode
+from InvenTree.helpers import inheritors
 from users.models import RuleSet, check_user_role
 
 
@@ -57,16 +55,8 @@ def status_codes(request):
 
     request._inventree_status_codes = True
 
-    return {
-        # Expose the StatusCode classes to the templates
-        'ReturnOrderStatus': ReturnOrderStatus,
-        'ReturnOrderLineStatus': ReturnOrderLineStatus,
-        'SalesOrderStatus': SalesOrderStatus,
-        'PurchaseOrderStatus': PurchaseOrderStatus,
-        'BuildStatus': BuildStatus,
-        'StockStatus': StockStatus,
-        'StockHistoryCode': StockHistoryCode,
-    }
+    classes = inheritors(StatusCode)
+    return {cls.__name__: cls for cls in classes}
 
 
 def user_roles(request):

InvenTree/InvenTree/helpers.py

@@ -1018,6 +1018,12 @@ def inheritors(cls):
     return subcls
 
 
+def inheritors_attr(cls, attr):
+    """Return the attribute from each inheriting class."""
+    classes = inheritors(cls)
+    return {getattr(cls, attr): cls for cls in classes}
+
+
 def notify_responsible(instance, sender, content: NotificationBody = InvenTreeNotificationBodies.NewOrder, exclude=None):
     """Notify all responsible parties of a change in an instance.
 

InvenTree/InvenTree/settings.py

@@ -196,6 +196,7 @@
     'stock.apps.StockConfig',
     'users.apps.UsersConfig',
     'plugin.apps.PluginAppConfig',
+    'generic',
     'InvenTree.apps.InvenTreeConfig',       # InvenTree app runs last
 
     # Core django modules

InvenTree/InvenTree/status_codes.py

@@ -2,130 +2,12 @@
 
 from django.utils.translation import gettext_lazy as _
 
-
-class StatusCode:
-    """Base class for representing a set of StatusCodes.
-
-    This is used to map a set of integer values to text.
-    """
-
-    colors = {}
-
-    @classmethod
-    def render(cls, key, large=False):
-        """Render the value as a HTML label."""
-        # If the key cannot be found, pass it back
-        if key not in cls.options.keys():
-            return key
-
-        value = cls.options.get(key, key)
-        color = cls.colors.get(key, 'secondary')
-
-        span_class = f'badge rounded-pill bg-{color}'
-
-        return "<span class='{cl}'>{value}</span>".format(
-            cl=span_class,
-            value=value
-        )
-
-    @classmethod
-    def list(cls):
-        """Return the StatusCode options as a list of mapped key / value items."""
-        return list(cls.dict().values())
-
-    @classmethod
-    def text(cls, key):
-        """Text for supplied status code."""
-        return cls.options.get(key, None)
-
-    @classmethod
-    def items(cls):
-        """All status code items."""
-        return cls.options.items()
-
-    @classmethod
-    def keys(cls):
-        """All status code keys."""
-        return cls.options.keys()
-
-    @classmethod
-    def labels(cls):
-        """All status code labels."""
-        return cls.options.values()
-
-    @classmethod
-    def names(cls):
-        """Return a map of all 'names' of status codes in this class
-
-        Will return a dict object, with the attribute name indexed to the integer value.
-
-        e.g.
-        {
-            'PENDING': 10,
-            'IN_PROGRESS': 20,
-        }
-        """
-        keys = cls.keys()
-        status_names = {}
-
-        for d in dir(cls):
-            if d.startswith('_'):
-                continue
-            if d != d.upper():
-                continue
-
-            value = getattr(cls, d, None)
-
-            if value is None:
-                continue
-            if callable(value):
-                continue
-            if type(value) != int:
-                continue
-            if value not in keys:
-                continue
-
-            status_names[d] = value
-
-        return status_names
-
-    @classmethod
-    def dict(cls):
-        """Return a dict representation containing all required information"""
-        values = {}
-
-        for name, value, in cls.names().items():
-            entry = {
-                'key': value,
-                'name': name,
-                'label': cls.label(value),
-            }
-
-            if hasattr(cls, 'colors'):
-                if color := cls.colors.get(value, None):
-                    entry['color'] = color
-
-            values[name] = entry
-
-        return values
-
-    @classmethod
-    def label(cls, value):
-        """Return the status code label associated with the provided value."""
-        return cls.options.get(value, value)
-
-    @classmethod
-    def value(cls, label):
-        """Return the value associated with the provided label."""
-        for k in cls.options.keys():
-            if cls.options[k].lower() == label.lower():
-                return k
-
-        raise ValueError("Label not found")
+from generic.states import StatusCode
 
 
 class PurchaseOrderStatus(StatusCode):
     """Defines a set of status codes for a PurchaseOrder."""
+    _TAG = 'purchase_order'
 
     # Order status codes
     PENDING = 10  # Order is pending (not yet placed)
@@ -169,6 +51,7 @@ class PurchaseOrderStatus(StatusCode):
 
 class SalesOrderStatus(StatusCode):
     """Defines a set of status codes for a SalesOrder."""
+    _TAG = 'sales_order'
 
     PENDING = 10  # Order is pending
     IN_PROGRESS = 15  # Order has been issued, and is in progress
@@ -209,6 +92,7 @@ class SalesOrderStatus(StatusCode):
 
 class StockStatus(StatusCode):
     """Status codes for Stock."""
+    _TAG = 'stock'
 
     OK = 10  # Item is OK
     ATTENTION = 50  # Item requires attention
@@ -250,6 +134,7 @@ class StockStatus(StatusCode):
 
 class StockHistoryCode(StatusCode):
     """Status codes for StockHistory."""
+    _TAG = 'stock_history'
 
     LEGACY = 0
 
@@ -350,6 +235,7 @@ class StockHistoryCode(StatusCode):
 
 class BuildStatus(StatusCode):
     """Build status codes."""
+    _TAG = 'build'
 
     PENDING = 10  # Build is pending / active
     PRODUCTION = 20  # BuildOrder is in production
@@ -378,6 +264,7 @@ class BuildStatus(StatusCode):
 
 class ReturnOrderStatus(StatusCode):
     """Defines a set of status codes for a ReturnOrder"""
+    _TAG = 'return_order'
 
     # Order is pending, waiting for receipt of items
     PENDING = 10
@@ -410,6 +297,7 @@ class ReturnOrderStatus(StatusCode):
 
 class ReturnOrderLineStatus(StatusCode):
     """Defines a set of status codes for a ReturnOrderLineItem"""
+    _TAG = 'return_order_line'
 
     PENDING = 10
 

InvenTree/build/api.py

@@ -9,7 +9,8 @@
 from django_filters.rest_framework import DjangoFilterBackend
 from django_filters import rest_framework as rest_filters
 
-from InvenTree.api import AttachmentMixin, APIDownloadMixin, ListCreateDestroyAPIView, MetadataView, StatusView
+from InvenTree.api import AttachmentMixin, APIDownloadMixin, ListCreateDestroyAPIView, MetadataView
+from generic.states import StatusView
 from InvenTree.helpers import str2bool, isNull, DownloadFile
 from InvenTree.status_codes import BuildStatus
 from InvenTree.mixins import CreateAPI, RetrieveUpdateDestroyAPI, ListCreateAPI

InvenTree/build/templates/build/build_base.html

@@ -2,7 +2,7 @@
 
 {% load static %}
 {% load i18n %}
-{% load status_codes %}
+{% load generic %}
 {% load inventree_extras %}
 
 {% block page_title %}
@@ -150,7 +150,7 @@
         <td><span class='fas fa-info'></span></td>
         <td>{% trans "Status" %}</td>
         <td>
-            {% build_status_label build.status %}
+            {% status_label 'build' build.status %}
         </td>
     </tr>
     {% if build.target_date %}
@@ -217,7 +217,7 @@
 
 {% block page_data %}
 <h3>
-    {% build_status_label build.status large=True %}
+    {% status_label 'build' build.status large=True %}
     {% if build.is_overdue %}
     <span class='badge rounded-pill bg-danger'>{% trans "Overdue" %}</span>
     {% endif %}

InvenTree/build/templates/build/detail.html

@@ -2,7 +2,7 @@
 {% load static %}
 {% load i18n %}
 {% load inventree_extras %}
-{% load status_codes %}
+{% load generic %}
 
 {% block sidebar %}
 {% include "build/sidebar.html" %}
@@ -60,7 +60,7 @@ <h4>{% trans "Build Details" %}</h4>
                 <tr>
                     <td><span class='fas fa-info'></span></td>
                     <td>{% trans "Status" %}</td>
-                    <td>{% build_status_label build.status %}</td>
+                    <td>{% status_label 'build' build.status %}</td>
                 </tr>
                 <tr>
                     <td><span class='fas fa-check-circle'></span></td>

InvenTree/generic/__init__.py

@@ -0,0 +1,4 @@
+"""The generic module provides high-level functionality that is used in multiple places.
+
+The generic module is split into sub-modules. Each sub-module provides a specific set of functionality. Each sub-module should be 100% tested within the sub-module.
+"""

InvenTree/generic/states/__init__.py

@@ -0,0 +1,15 @@
+"""States are used to track the logical state of an object.
+
+The logic value of a state is stored in the database as an integer. The logic value is used for buisness logic and should not be easily changed therefore.
+There is a rendered state for each state value. The rendered state is used for display purposes and can be changed easily.
+
+States can be extended with custom options for each InvenTree instance - those options are stored in the database and need to link back to state values.
+"""
+
+from .api import StatusView
+from .states import StatusCode
+
+__all__ = [
+    StatusView,
+    StatusCode,
+]