From 25a4d613914d47b35a50c25c5fcca97549a6bcd5 Mon Sep 17 00:00:00 2001
From: Trenton H <797416+stumpylog@users.noreply.github.com>
Date: Wed, 2 Oct 2024 10:52:59 -0700
Subject: [PATCH] Tests and documentation for custom field usage

---
 docs/advanced_usage.md                    | 13 ++++++
 src/documents/tests/test_file_handling.py | 48 +++++++++++++++++++++++
 2 files changed, 61 insertions(+)

diff --git a/docs/advanced_usage.md b/docs/advanced_usage.md
index e3111109a..2fe5c540f 100644
--- a/docs/advanced_usage.md
+++ b/docs/advanced_usage.md
@@ -473,6 +473,19 @@ a document with an ASN of 355 would be placed in `somepath/asn-201-400/asn-3xx/T
 
 For a PDF document, it would result in `pdfs/Title.pdf`, but for a PNG document, the path would be `pngs/Title.pdf`.
 
+To use custom fields:
+
+```django
+{% if \"Invoice\" in custom_fields %}
+  invoices/{{ custom_fields.Invoice.value\ }}
+{% else %}
+  not-invoices/{{ title }}
+{% endif %}
+```
+
+If the document has a custom field named "Invoice" with a value of 123, it would be filed into the `invoices/123.pdf`, but a document without the custom field
+would be filed to `not-invoices/Title.pdf`
+
 ## Automatic recovery of invalid PDFs {#pdf-recovery}
 
 Paperless will attempt to "clean" certain invalid PDFs with `qpdf` before processing if, for example, the mime_type
diff --git a/src/documents/tests/test_file_handling.py b/src/documents/tests/test_file_handling.py
index b3f2f75e7..f2f847c1b 100644
--- a/src/documents/tests/test_file_handling.py
+++ b/src/documents/tests/test_file_handling.py
@@ -17,6 +17,8 @@ from documents.file_handling import create_source_path_directory
 from documents.file_handling import delete_empty_directories
 from documents.file_handling import generate_filename
 from documents.models import Correspondent
+from documents.models import CustomField
+from documents.models import CustomFieldInstance
 from documents.models import Document
 from documents.models import DocumentType
 from documents.models import StoragePath
@@ -1241,3 +1243,49 @@ class TestFilenameGeneration(DirectoriesMixin, TestCase):
                 capture.output[1],
                 "ERROR:paperless.filehandling:  Variable 'creation_date' was undefined",
             )
+
+    def test_template_with_custom_fields(self):
+        sp = StoragePath.objects.create(
+            name="sp1",
+            path="""
+                 {% if "Invoice" in custom_fields %}
+                   invoices/{{ custom_fields.Invoice.value }}
+                 {% else %}
+                   not-invoices/{{ title }}
+                 {% endif %}
+                 """,
+        )
+
+        doc_a = Document.objects.create(
+            title="Some Title",
+            created=timezone.make_aware(datetime.datetime(2020, 6, 25, 7, 36, 51, 153)),
+            added=timezone.make_aware(datetime.datetime(2024, 10, 1, 7, 36, 51, 153)),
+            mime_type="application/pdf",
+            pk=2,
+            checksum="2",
+            archive_serial_number=25,
+            storage_path=sp,
+        )
+
+        cf = CustomField.objects.create(
+            name="Invoice",
+            data_type=CustomField.FieldDataType.INT,
+        )
+
+        cfi = CustomFieldInstance.objects.create(
+            document=doc_a,
+            field=cf,
+            value_int=1234,
+        )
+
+        self.assertEqual(
+            generate_filename(doc_a),
+            "invoices/1234.pdf",
+        )
+
+        cfi.delete()
+
+        self.assertEqual(
+            generate_filename(doc_a),
+            "not-invoices/Some Title.pdf",
+        )