Feature: Dynamic document storage pathes (#916)

* Added devcontainer

* Add feature storage pathes

* Exclude tests and add versioning

* Check escaping

* Check escaping

* Check quoting

* Echo

* Escape

* Escape :

* Double escape \

* Escaping

* Remove if

* Escape colon

* Missing \

* Esacpe :

* Escape all

* test

* Remove sed

* Fix exclude

* Remove SED command

* Add LD_LIBRARY_PATH

* Adjusted to v1.7

* Updated test-cases

* Remove devcontainer

* Removed internal build-file

* Run pre-commit

* Corrected flak8 error

* Adjusted to v1.7

* Updated test-cases

* Corrected flak8 error

* Adjusted to new plural translations

* Small adjustments due to code-review backend

* Adjusted line-break

* Removed PAPERLESS prefix from settings variables

* Corrected style change due to search+replace

* First documentation draft

* Revert changes to Pipfile

* Add sphinx-autobuild with keep-outdated

* Revert merge error that results in wrong storage path is evaluated

* Adjust styles of generated files ...

* Adds additional testing to cover dynamic storage path functionality

* Remove unnecessary condition

* Add hint to edit storage path dialog

* Correct spelling of pathes to paths

* Minor documentation tweaks

* Minor typo

* improving wrapping of filter editor buttons with new storage path button

* Update .gitignore

* Fix select border radius in non input-groups

* Better storage path edit hint

* Add note to edit storage path dialog re document_renamer

* Add note to bulk edit storage path re document_renamer

* Rename FILTER_STORAGE_DIRECTORY to PATH

* Fix broken filter rule parsing

* Show default storage if unspecified

* Remove note re storage path on bulk edit

* Add basic validation of filename variables

Co-authored-by: Markus Kling <markus@markus-kling.net>
Co-authored-by: Trenton Holmes <holmes.trenton@gmail.com>
Co-authored-by: Michael Shamoon <4887959+shamoon@users.noreply.github.com>
Co-authored-by: Quinn Casey <quinn@quinncasey.com>

src/documents/tests/test_classifier.py

@@ -13,6 +13,7 @@ from documents.classifier import load_classifier
 from documents.models import Correspondent
 from documents.models import Document
 from documents.models import DocumentType
+from documents.models import StoragePath
 from documents.models import Tag
 from documents.tests.utils import DirectoriesMixin
 
@@ -56,6 +57,16 @@ class TestClassifier(DirectoriesMixin, TestCase):
             name="dt2",
             matching_algorithm=DocumentType.MATCH_AUTO,
         )
+        self.sp1 = StoragePath.objects.create(
+            name="sp1",
+            path="path1",
+            matching_algorithm=DocumentType.MATCH_AUTO,
+        )
+        self.sp2 = StoragePath.objects.create(
+            name="sp2",
+            path="path2",
+            matching_algorithm=DocumentType.MATCH_AUTO,
+        )
 
         self.doc1 = Document.objects.create(
             title="doc1",
@@ -64,12 +75,14 @@ class TestClassifier(DirectoriesMixin, TestCase):
             checksum="A",
             document_type=self.dt,
         )
+
         self.doc2 = Document.objects.create(
             title="doc1",
             content="this is another document, but from c2",
             correspondent=self.c2,
             checksum="B",
         )
+
         self.doc_inbox = Document.objects.create(
             title="doc235",
             content="aa",
@@ -81,6 +94,8 @@ class TestClassifier(DirectoriesMixin, TestCase):
         self.doc2.tags.add(self.t3)
         self.doc_inbox.tags.add(self.t2)
 
+        self.doc1.storage_path = self.sp1
+
     def testNoTrainingData(self):
         try:
             self.classifier.train()
@@ -177,6 +192,14 @@ class TestClassifier(DirectoriesMixin, TestCase):
         new_classifier.load()
         self.assertFalse(new_classifier.train())
 
+    # @override_settings(
+    #     MODEL_FILE=os.path.join(os.path.dirname(__file__), "data", "model.pickle"),
+    # )
+    # def test_create_test_load_and_classify(self):
+    #     self.generate_test_data()
+    #     self.classifier.train()
+    #     self.classifier.save()
+
     @override_settings(
         MODEL_FILE=os.path.join(os.path.dirname(__file__), "data", "model.pickle"),
     )
@@ -263,6 +286,45 @@ class TestClassifier(DirectoriesMixin, TestCase):
         self.assertEqual(self.classifier.predict_document_type(doc1.content), dt.pk)
         self.assertIsNone(self.classifier.predict_document_type(doc2.content))
 
+    def test_one_path_predict(self):
+        sp = StoragePath.objects.create(
+            name="sp",
+            matching_algorithm=StoragePath.MATCH_AUTO,
+        )
+
+        doc1 = Document.objects.create(
+            title="doc1",
+            content="this is a document from c1",
+            checksum="A",
+            storage_path=sp,
+        )
+
+        self.classifier.train()
+        self.assertEqual(self.classifier.predict_storage_path(doc1.content), sp.pk)
+
+    def test_one_path_predict_manydocs(self):
+        sp = StoragePath.objects.create(
+            name="sp",
+            matching_algorithm=StoragePath.MATCH_AUTO,
+        )
+
+        doc1 = Document.objects.create(
+            title="doc1",
+            content="this is a document from c1",
+            checksum="A",
+            storage_path=sp,
+        )
+
+        doc2 = Document.objects.create(
+            title="doc1",
+            content="this is a document from c2",
+            checksum="B",
+        )
+
+        self.classifier.train()
+        self.assertEqual(self.classifier.predict_storage_path(doc1.content), sp.pk)
+        self.assertIsNone(self.classifier.predict_storage_path(doc2.content))
+
     def test_one_tag_predict(self):
         t1 = Tag.objects.create(name="t1", matching_algorithm=Tag.MATCH_AUTO, pk=12)