models and tests

src/documents/migrations/1012_custommetadatafield_custommetadatafieldbooleanvalue_custommetadatafieldshorttextvalue_custommetadata.py

@@ -0,0 +1,45 @@
+# Generated by Django 3.1.5 on 2021-01-28 15:14
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('documents', '1011_auto_20210101_2340'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='CustomMetaDataField',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('type_string', models.CharField(max_length=128)),
+            ],
+        ),
+        migrations.CreateModel(
+            name='CustomMetaDataFieldValue',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('document', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='custom_metadata', to='documents.document')),
+                ('field', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='documents.custommetadatafield')),
+            ],
+        ),
+        migrations.CreateModel(
+            name='CustomMetaDataFieldBooleanValue',
+            fields=[
+                ('value', models.BooleanField()),
+                ('parent', models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, parent_link=True, primary_key=True, related_name='boolean', serialize=False, to='documents.custommetadatafieldvalue')),
+            ],
+            bases=('documents.custommetadatafieldvalue',),
+        ),
+        migrations.CreateModel(
+            name='CustomMetaDataFieldShortTextValue',
+            fields=[
+                ('value', models.CharField(max_length=128)),
+                ('parent', models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, parent_link=True, primary_key=True, related_name='shorttext', serialize=False, to='documents.custommetadatafieldvalue')),
+            ],
+            bases=('documents.custommetadatafieldvalue',),
+        ),
+    ]

src/documents/models.py

@@ -307,6 +307,45 @@ class Document(models.Model):
         return open(self.thumbnail_path, "rb")
 
 
+class CustomMetaDataField(models.Model):
+    type_string = models.CharField(max_length=128)
+
+
+class CustomMetaDataFieldValue(models.Model):
+    field = models.ForeignKey(
+        CustomMetaDataField,
+        blank=False,
+        null=False,
+        on_delete=models.CASCADE
+    )
+
+    document = models.ForeignKey(
+        Document,
+        blank=False,
+        null=False,
+        on_delete=models.CASCADE,
+        related_name="custom_metadata"
+    )
+
+
+class CustomMetaDataFieldShortTextValue(CustomMetaDataFieldValue):
+    value = models.CharField(max_length=128)
+    parent = models.OneToOneField(
+        CustomMetaDataFieldValue,
+        on_delete=models.CASCADE,
+        related_name="shorttext",
+        parent_link=True)
+
+
+class CustomMetaDataFieldBooleanValue(CustomMetaDataFieldValue):
+    value = models.BooleanField()
+    parent = models.OneToOneField(
+        CustomMetaDataFieldValue,
+        on_delete=models.CASCADE,
+        related_name="boolean",
+        parent_link=True)
+
+
 class Log(models.Model):
 
     LEVELS = (

src/documents/tests/test_custom_metadata.py

@@ -0,0 +1,55 @@
+from django.test import TestCase
+
+from documents.models import Document, CustomMetaDataField, CustomMetaDataFieldBooleanValue, \
+    CustomMetaDataFieldShortTextValue
+
+
+class CustomMetadataTest(TestCase):
+
+    def test_typing(self):
+
+        doc = Document.objects.create(title="test", checksum="asd")
+
+        field1 = CustomMetaDataField.objects.create(type_string="boolean")
+        field2 = CustomMetaDataField.objects.create(type_string="short_text")
+
+        CustomMetaDataFieldBooleanValue.objects.create(value=True, field=field1, document=doc)
+        CustomMetaDataFieldShortTextValue.objects.create(value="test", field=field2, document=doc)
+
+        self.assertEqual(doc.custom_metadata.all().count(), 2)
+        self.assertEqual(doc.custom_metadata.all()[0].boolean.value, True)
+        self.assertEqual(doc.custom_metadata.all()[1].shorttext.value, "test")
+
+    def test_sorting(self):
+
+        doc1 = Document.objects.create(title="test", checksum="A")
+        doc2 = Document.objects.create(title="test", checksum="B")
+
+        field = CustomMetaDataField.objects.create(type_string="short_text")
+
+        CustomMetaDataFieldShortTextValue.objects.create(value="testA", field=field, document=doc1)
+        CustomMetaDataFieldShortTextValue.objects.create(value="testB", field=field, document=doc2)
+
+        docs1 = list(Document.objects.order_by("custom_metadata__shorttext__value"))
+        docs2 = list(Document.objects.order_by("-custom_metadata__shorttext__value"))
+
+        self.assertListEqual([d.id for d in docs1], [doc1.id, doc2.id])
+        self.assertListEqual([d.id for d in docs2], [doc2.id, doc1.id])
+
+    def test_filtering(self):
+
+        doc1 = Document.objects.create(title="test", checksum="A")
+        doc2 = Document.objects.create(title="test", checksum="B")
+
+        field = CustomMetaDataField.objects.create(type_string="short_text")
+
+        CustomMetaDataFieldShortTextValue.objects.create(value="testA", field=field, document=doc1)
+        CustomMetaDataFieldShortTextValue.objects.create(value="testB", field=field, document=doc2)
+
+        docs1 = list(Document.objects.filter(custom_metadata__shorttext__value__iexact="testa"))
+        docs2 = list(Document.objects.filter(custom_metadata__shorttext__value__exact="testb"))
+        docs3 = list(Document.objects.filter(custom_metadata__shorttext__value__icontains="TEST"))
+
+        self.assertListEqual([d.id for d in docs1], [doc1.id])
+        self.assertListEqual([d.id for d in docs2], [])
+        self.assertCountEqual([d.id for d in docs3], [doc1.id, doc2.id])