Refactor to UiSettings

src/documents/migrations/1019_uisettings.py

@@ -14,7 +14,7 @@ class Migration(migrations.Migration):
 
     operations = [
         migrations.CreateModel(
-            name="FrontendSettings",
+            name="UiSettings",
             fields=[
                 (
                     "id",
@@ -30,7 +30,7 @@ class Migration(migrations.Migration):
                     "user",
                     models.OneToOneField(
                         on_delete=django.db.models.deletion.CASCADE,
-                        related_name="frontend_settings",
+                        related_name="ui_settings",
                         to=settings.AUTH_USER_MODEL,
                     ),
                 ),

src/documents/models.py

@@ -470,12 +470,12 @@ class FileInfo:
 
 
 # Extending User Model Using a One-To-One Link
-class FrontendSettings(models.Model):
+class UiSettings(models.Model):
 
     user = models.OneToOneField(
         User,
         on_delete=models.CASCADE,
-        related_name="frontend_settings",
+        related_name="ui_settings",
     )
     settings = models.JSONField(null=True)
 
@@ -484,6 +484,6 @@ class FrontendSettings(models.Model):
 
 
 @receiver(post_save, sender=User)
-def create_user_frontend_settings(sender, instance, created, **kwargs):
+def create_user_ui_settings(sender, instance, created, **kwargs):
     if created:
-        FrontendSettings.objects.create(user=instance)
+        UiSettings.objects.create(user=instance)

src/documents/serialisers.py

@@ -11,11 +11,11 @@ from . import bulk_edit
 from .models import Correspondent
 from .models import Document
 from .models import DocumentType
-from .models import FrontendSettings
 from .models import MatchingModel
 from .models import SavedView
 from .models import SavedViewFilterRule
 from .models import Tag
+from .models import UiSettings
 from .parsers import is_mime_type_supported
 
 
@@ -501,9 +501,9 @@ class BulkDownloadSerializer(DocumentListSerializer):
         }[compression]
 
 
-class FrontendSettingsViewSerializer(serializers.ModelSerializer):
+class UiSettingsViewSerializer(serializers.ModelSerializer):
     class Meta:
-        model = FrontendSettings
+        model = UiSettings
         depth = 1
         fields = [
             "id",
@@ -511,12 +511,12 @@ class FrontendSettingsViewSerializer(serializers.ModelSerializer):
         ]
 
     def update(self, instance, validated_data):
-        super(FrontendSettingsViewSerializer, self).update(instance, validated_data)
+        super(UiSettingsViewSerializer, self).update(instance, validated_data)
         return instance
 
     def create(self, validated_data):
-        frontend_settings = FrontendSettings.objects.update_or_create(
+        ui_settings = UiSettings.objects.update_or_create(
             user=validated_data.get("user"),
             defaults={"settings": validated_data.get("settings", None)},
         )
-        return frontend_settings
+        return ui_settings

src/documents/views.py

@@ -71,11 +71,11 @@ from .serialisers import CorrespondentSerializer
 from .serialisers import DocumentListSerializer
 from .serialisers import DocumentSerializer
 from .serialisers import DocumentTypeSerializer
-from .serialisers import FrontendSettingsViewSerializer
 from .serialisers import PostDocumentSerializer
 from .serialisers import SavedViewSerializer
 from .serialisers import TagSerializer
 from .serialisers import TagSerializerVersion1
+from .serialisers import UiSettingsViewSerializer
 
 logger = logging.getLogger("paperless.api")
 
@@ -719,10 +719,10 @@ class RemoteVersionView(GenericAPIView):
         )
 
 
-class FrontendSettingsView(GenericAPIView):
+class UiSettingsView(GenericAPIView):
 
     permission_classes = (IsAuthenticated,)
-    serializer_class = FrontendSettingsViewSerializer
+    serializer_class = UiSettingsViewSerializer
 
     def get(self, request, format=None):
         serializer = self.get_serializer(data=request.data)
@@ -730,8 +730,8 @@ class FrontendSettingsView(GenericAPIView):
 
         user = User.objects.get(pk=request.user.id)
         settings = []
-        if hasattr(user, "frontend_settings"):
-            settings = user.frontend_settings.settings
+        if hasattr(user, "ui_settings"):
+            settings = user.ui_settings.settings
         return Response(
             {
                 "user_id": user.id,