From 4ad48626411e9395752821b5e89f532ee0428cef Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Tue, 9 Jul 2024 07:57:07 -0700 Subject: [PATCH] Feature: select custom field type (#7167) --- docs/usage.md | 1 + src-ui/messages.xlf | 91 ++++++++------ .../custom-field-display.component.html | 3 + .../custom-field-display.component.spec.ts | 12 ++ .../custom-field-display.component.ts | 4 + .../custom-field-edit-dialog.component.html | 17 +++ ...custom-field-edit-dialog.component.spec.ts | 62 +++++++++- .../custom-field-edit-dialog.component.ts | 63 +++++++++- .../input/select/select.component.spec.ts | 8 ++ .../common/input/select/select.component.ts | 5 + .../document-detail.component.html | 10 ++ src-ui/src/app/data/custom-field.ts | 8 ++ .../1050_customfield_extra_data_and_more.py | 48 ++++++++ src/documents/models.py | 21 +++- src/documents/serialisers.py | 27 ++++ src/documents/tests/test_api_custom_fields.py | 115 +++++++++++++++++- 16 files changed, 449 insertions(+), 46 deletions(-) create mode 100644 src/documents/migrations/1050_customfield_extra_data_and_more.py diff --git a/docs/usage.md b/docs/usage.md index 0500f8538..d4c82e4e6 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -445,6 +445,7 @@ The following custom field types are supported: - `Number`: float number e.g. 12.3456 - `Monetary`: [ISO 4217 currency code](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) and a number with exactly two decimals, e.g. USD12.30 - `Document Link`: reference(s) to other document(s) displayed as links, automatically creates a symmetrical link in reverse +- `Select`: a pre-defined list of strings from which the user can choose ## Share Links diff --git a/src-ui/messages.xlf b/src-ui/messages.xlf index e6559cb71..2061c9c12 100644 --- a/src-ui/messages.xlf +++ b/src-ui/messages.xlf @@ -525,7 +525,7 @@ src/app/components/document-detail/document-detail.component.html - 337 + 347 @@ -544,7 +544,7 @@ src/app/components/common/edit-dialog/custom-field-edit-dialog/custom-field-edit-dialog.component.html - 19 + 36 src/app/components/common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component.html @@ -584,7 +584,7 @@ src/app/components/document-detail/document-detail.component.html - 329 + 339 src/app/components/document-list/save-view-config-dialog/save-view-config-dialog.component.html @@ -718,7 +718,7 @@ src/app/components/document-detail/document-detail.component.html - 346 + 356 src/app/components/document-list/document-list.component.html @@ -1080,7 +1080,7 @@ src/app/components/document-detail/document-detail.component.html - 305 + 315 src/app/components/document-list/bulk-editor/bulk-editor.component.html @@ -1447,6 +1447,10 @@ src/app/components/admin/users-groups/users-groups.component.html 76 + + src/app/components/common/edit-dialog/custom-field-edit-dialog/custom-field-edit-dialog.component.html + 26 + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts 53 @@ -1624,7 +1628,7 @@ src/app/components/common/edit-dialog/custom-field-edit-dialog/custom-field-edit-dialog.component.html - 18 + 35 src/app/components/common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component.html @@ -3445,18 +3449,25 @@ 14 + + Add option + + src/app/components/common/edit-dialog/custom-field-edit-dialog/custom-field-edit-dialog.component.html + 20 + + Create new custom field src/app/components/common/edit-dialog/custom-field-edit-dialog/custom-field-edit-dialog.component.ts - 36 + 80 Edit custom field src/app/components/common/edit-dialog/custom-field-edit-dialog/custom-field-edit-dialog.component.ts - 40 + 84 @@ -4676,7 +4687,7 @@ src/app/components/common/input/select/select.component.ts - 158 + 163 @@ -4758,7 +4769,7 @@ Private src/app/components/common/input/select/select.component.ts - 57 + 62 src/app/components/common/tag/tag.component.html @@ -4777,7 +4788,7 @@ No items found src/app/components/common/input/select/select.component.ts - 92 + 97 @@ -5101,6 +5112,10 @@ src/app/components/document-list/document-list.component.html 6 + + src/app/data/custom-field.ts + 50 + Please select an object @@ -5844,14 +5859,14 @@ Content src/app/components/document-detail/document-detail.component.html - 201 + 211 Metadata src/app/components/document-detail/document-detail.component.html - 210 + 220 src/app/components/document-detail/metadata-collapse/metadata-collapse.component.ts @@ -5862,119 +5877,119 @@ Date modified src/app/components/document-detail/document-detail.component.html - 217 + 227 Date added src/app/components/document-detail/document-detail.component.html - 221 + 231 Media filename src/app/components/document-detail/document-detail.component.html - 225 + 235 Original filename src/app/components/document-detail/document-detail.component.html - 229 + 239 Original MD5 checksum src/app/components/document-detail/document-detail.component.html - 233 + 243 Original file size src/app/components/document-detail/document-detail.component.html - 237 + 247 Original mime type src/app/components/document-detail/document-detail.component.html - 241 + 251 Archive MD5 checksum src/app/components/document-detail/document-detail.component.html - 246 + 256 Archive file size src/app/components/document-detail/document-detail.component.html - 252 + 262 Original document metadata src/app/components/document-detail/document-detail.component.html - 261 + 271 Archived document metadata src/app/components/document-detail/document-detail.component.html - 264 + 274 Preview src/app/components/document-detail/document-detail.component.html - 271 + 281 Notes src/app/components/document-detail/document-detail.component.html - 283,286 + 293,296 History src/app/components/document-detail/document-detail.component.html - 294 + 304 Save & next src/app/components/document-detail/document-detail.component.html - 331 + 341 Save & close src/app/components/document-detail/document-detail.component.html - 334 + 344 Enter Password src/app/components/document-detail/document-detail.component.html - 385 + 395 @@ -7841,56 +7856,56 @@ Boolean src/app/data/custom-field.ts - 17 + 18 Date src/app/data/custom-field.ts - 21 + 22 Integer src/app/data/custom-field.ts - 25 + 26 Number src/app/data/custom-field.ts - 29 + 30 Monetary src/app/data/custom-field.ts - 33 + 34 Text src/app/data/custom-field.ts - 37 + 38 Url src/app/data/custom-field.ts - 41 + 42 Document Link src/app/data/custom-field.ts - 45 + 46 diff --git a/src-ui/src/app/components/common/custom-field-display/custom-field-display.component.html b/src-ui/src/app/components/common/custom-field-display/custom-field-display.component.html index 812c283e2..b8cd1dd9d 100644 --- a/src-ui/src/app/components/common/custom-field-display/custom-field-display.component.html +++ b/src-ui/src/app/components/common/custom-field-display/custom-field-display.component.html @@ -30,6 +30,9 @@ } + @case (CustomFieldDataType.Select) { + {{getSelectValue(field, value)}} + } @default { {{value}} } diff --git a/src-ui/src/app/components/common/custom-field-display/custom-field-display.component.spec.ts b/src-ui/src/app/components/common/custom-field-display/custom-field-display.component.spec.ts index e347d2189..8706cfac1 100644 --- a/src-ui/src/app/components/common/custom-field-display/custom-field-display.component.spec.ts +++ b/src-ui/src/app/components/common/custom-field-display/custom-field-display.component.spec.ts @@ -12,6 +12,14 @@ const customFields: CustomField[] = [ { id: 1, name: 'Field 1', data_type: CustomFieldDataType.String }, { id: 2, name: 'Field 2', data_type: CustomFieldDataType.Monetary }, { id: 3, name: 'Field 3', data_type: CustomFieldDataType.DocumentLink }, + { + id: 4, + name: 'Field 4', + data_type: CustomFieldDataType.Select, + extra_data: { + select_options: ['Option 1', 'Option 2', 'Option 3'], + }, + }, ] const document: Document = { id: 1, @@ -103,4 +111,8 @@ describe('CustomFieldDisplayComponent', () => { expect(component.currency).toEqual('EUR') expect(component.value).toEqual(100) }) + + it('should show select value', () => { + expect(component.getSelectValue(customFields[3], 2)).toEqual('Option 3') + }) }) diff --git a/src-ui/src/app/components/common/custom-field-display/custom-field-display.component.ts b/src-ui/src/app/components/common/custom-field-display/custom-field-display.component.ts index 086ac217e..7c97c660a 100644 --- a/src-ui/src/app/components/common/custom-field-display/custom-field-display.component.ts +++ b/src-ui/src/app/components/common/custom-field-display/custom-field-display.component.ts @@ -115,6 +115,10 @@ export class CustomFieldDisplayComponent implements OnInit, OnDestroy { return this.docLinkDocuments?.find((d) => d.id === docId)?.title } + public getSelectValue(field: CustomField, index: number): string { + return field.extra_data.select_options[index] + } + ngOnDestroy(): void { this.unsubscribeNotifier.next(true) this.unsubscribeNotifier.complete() diff --git a/src-ui/src/app/components/common/edit-dialog/custom-field-edit-dialog/custom-field-edit-dialog.component.html b/src-ui/src/app/components/common/edit-dialog/custom-field-edit-dialog/custom-field-edit-dialog.component.html index 681f4d8c7..bc893d53a 100644 --- a/src-ui/src/app/components/common/edit-dialog/custom-field-edit-dialog/custom-field-edit-dialog.component.html +++ b/src-ui/src/app/components/common/edit-dialog/custom-field-edit-dialog/custom-field-edit-dialog.component.html @@ -13,6 +13,23 @@ @if (typeFieldDisabled) { Data type cannot be changed after a field is created } +
+ @switch (objectForm.get('data_type').value) { + @case (CustomFieldDataType.Select) { + +
+ @for (option of objectForm.controls.extra_data.controls.select_options.controls; track option; let i = $index) { +
+ + +
+ } +
+ } + } +
diff --git a/src-ui/src/app/components/common/edit-dialog/custom-field-edit-dialog/custom-field-edit-dialog.component.spec.ts b/src-ui/src/app/components/common/edit-dialog/custom-field-edit-dialog/custom-field-edit-dialog.component.spec.ts index 98fe73dc8..2de17577f 100644 --- a/src-ui/src/app/components/common/edit-dialog/custom-field-edit-dialog/custom-field-edit-dialog.component.spec.ts +++ b/src-ui/src/app/components/common/edit-dialog/custom-field-edit-dialog/custom-field-edit-dialog.component.spec.ts @@ -13,6 +13,9 @@ import { SelectComponent } from '../../input/select/select.component' import { TextComponent } from '../../input/text/text.component' import { EditDialogMode } from '../edit-dialog.component' import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http' +import { CustomFieldDataType } from 'src/app/data/custom-field' +import { ElementRef, QueryList } from '@angular/core' +import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons' describe('CustomFieldEditDialogComponent', () => { let component: CustomFieldEditDialogComponent @@ -29,7 +32,13 @@ describe('CustomFieldEditDialogComponent', () => { TextComponent, SafeHtmlPipe, ], - imports: [FormsModule, ReactiveFormsModule, NgSelectModule, NgbModule], + imports: [ + FormsModule, + ReactiveFormsModule, + NgSelectModule, + NgbModule, + NgxBootstrapIconsModule.pick(allIcons), + ], providers: [ NgbActiveModal, provideHttpClient(withInterceptorsFromDi()), @@ -63,4 +72,55 @@ describe('CustomFieldEditDialogComponent', () => { component.ngOnInit() expect(component.objectForm.get('data_type').disabled).toBeTruthy() }) + + it('should initialize select options on edit', () => { + component.dialogMode = EditDialogMode.EDIT + component.object = { + id: 1, + name: 'Field 1', + data_type: CustomFieldDataType.Select, + extra_data: { + select_options: ['Option 1', 'Option 2', 'Option 3'], + }, + } + fixture.detectChanges() + component.ngOnInit() + expect( + component.objectForm.get('extra_data').get('select_options').value.length + ).toBe(3) + }) + + it('should support add / remove select options', () => { + component.dialogMode = EditDialogMode.CREATE + fixture.detectChanges() + component.ngOnInit() + expect( + component.objectForm.get('extra_data').get('select_options').value.length + ).toBe(1) + component.addSelectOption() + expect( + component.objectForm.get('extra_data').get('select_options').value.length + ).toBe(2) + component.addSelectOption() + expect( + component.objectForm.get('extra_data').get('select_options').value.length + ).toBe(3) + component.removeSelectOption(0) + expect( + component.objectForm.get('extra_data').get('select_options').value.length + ).toBe(2) + }) + + it('should focus on last select option input', () => { + const selectOptionInputs = component[ + 'selectOptionInputs' + ] as QueryList + component.dialogMode = EditDialogMode.CREATE + component.objectForm.get('data_type').setValue(CustomFieldDataType.Select) + component.ngOnInit() + component.ngAfterViewInit() + component.addSelectOption() + fixture.detectChanges() + expect(document.activeElement).toBe(selectOptionInputs.last.nativeElement) + }) }) diff --git a/src-ui/src/app/components/common/edit-dialog/custom-field-edit-dialog/custom-field-edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/custom-field-edit-dialog/custom-field-edit-dialog.component.ts index 570b93ae5..db6c7e218 100644 --- a/src-ui/src/app/components/common/edit-dialog/custom-field-edit-dialog/custom-field-edit-dialog.component.ts +++ b/src-ui/src/app/components/common/edit-dialog/custom-field-edit-dialog/custom-field-edit-dialog.component.ts @@ -1,11 +1,24 @@ -import { Component, OnInit } from '@angular/core' -import { FormGroup, FormControl } from '@angular/forms' +import { + AfterViewInit, + Component, + ElementRef, + OnDestroy, + OnInit, + QueryList, + ViewChildren, +} from '@angular/core' +import { FormGroup, FormControl, FormArray } from '@angular/forms' import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap' -import { DATA_TYPE_LABELS, CustomField } from 'src/app/data/custom-field' +import { + DATA_TYPE_LABELS, + CustomField, + CustomFieldDataType, +} from 'src/app/data/custom-field' import { CustomFieldsService } from 'src/app/services/rest/custom-fields.service' import { UserService } from 'src/app/services/rest/user.service' import { SettingsService } from 'src/app/services/settings.service' import { EditDialogComponent, EditDialogMode } from '../edit-dialog.component' +import { Subject, takeUntil } from 'rxjs' @Component({ selector: 'pngx-custom-field-edit-dialog', @@ -14,8 +27,20 @@ import { EditDialogComponent, EditDialogMode } from '../edit-dialog.component' }) export class CustomFieldEditDialogComponent extends EditDialogComponent - implements OnInit + implements OnInit, AfterViewInit, OnDestroy { + CustomFieldDataType = CustomFieldDataType + + @ViewChildren('selectOption') + private selectOptionInputs: QueryList + + private unsubscribeNotifier: Subject = new Subject() + + private get selectOptions(): FormArray { + return (this.objectForm.controls.extra_data as FormGroup).controls + .select_options as FormArray + } + constructor( service: CustomFieldsService, activeModal: NgbActiveModal, @@ -30,6 +55,25 @@ export class CustomFieldEditDialogComponent if (this.typeFieldDisabled) { this.objectForm.get('data_type').disable() } + if (this.object?.data_type === CustomFieldDataType.Select) { + this.selectOptions.clear() + this.object.extra_data.select_options.forEach((option) => + this.selectOptions.push(new FormControl(option)) + ) + } + } + + ngAfterViewInit(): void { + this.selectOptionInputs.changes + .pipe(takeUntil(this.unsubscribeNotifier)) + .subscribe(() => { + this.selectOptionInputs.last.nativeElement.focus() + }) + } + + ngOnDestroy(): void { + this.unsubscribeNotifier.next(true) + this.unsubscribeNotifier.complete() } getCreateTitle() { @@ -44,6 +88,9 @@ export class CustomFieldEditDialogComponent return new FormGroup({ name: new FormControl(null), data_type: new FormControl(null), + extra_data: new FormGroup({ + select_options: new FormArray([new FormControl(null)]), + }), }) } @@ -54,4 +101,12 @@ export class CustomFieldEditDialogComponent get typeFieldDisabled(): boolean { return this.dialogMode === EditDialogMode.EDIT } + + public addSelectOption() { + this.selectOptions.push(new FormControl('')) + } + + public removeSelectOption(index: number) { + this.selectOptions.removeAt(index) + } } diff --git a/src-ui/src/app/components/common/input/select/select.component.spec.ts b/src-ui/src/app/components/common/input/select/select.component.spec.ts index 79eec16e8..2c39035a2 100644 --- a/src-ui/src/app/components/common/input/select/select.component.spec.ts +++ b/src-ui/src/app/components/common/input/select/select.component.spec.ts @@ -132,4 +132,12 @@ describe('SelectComponent', () => { const expectedTitle = `Filter documents with this ${component.title}` expect(component.filterButtonTitle).toEqual(expectedTitle) }) + + it('should support setting items as a plain array', () => { + component.itemsArray = ['foo', 'bar'] + expect(component.items).toEqual([ + { id: 0, name: 'foo' }, + { id: 1, name: 'bar' }, + ]) + }) }) diff --git a/src-ui/src/app/components/common/input/select/select.component.ts b/src-ui/src/app/components/common/input/select/select.component.ts index 19f6375ad..d9976698e 100644 --- a/src-ui/src/app/components/common/input/select/select.component.ts +++ b/src-ui/src/app/components/common/input/select/select.component.ts @@ -34,6 +34,11 @@ export class SelectComponent extends AbstractInputComponent { if (items && this.value) this.checkForPrivateItems(this.value) } + @Input() + set itemsArray(items: any[]) { + this._items = items.map((item, index) => ({ id: index, name: item })) + } + writeValue(newValue: any): void { if (newValue && this._items) { this.checkForPrivateItems(newValue) diff --git a/src-ui/src/app/components/document-detail/document-detail.component.html b/src-ui/src/app/components/document-detail/document-detail.component.html index 8486e1816..d970d93b3 100644 --- a/src-ui/src/app/components/document-detail/document-detail.component.html +++ b/src-ui/src/app/components/document-detail/document-detail.component.html @@ -186,6 +186,16 @@ [horizontal]="true" [error]="getCustomFieldError(i)"> } + @case (CustomFieldDataType.Select) { + + } }
} diff --git a/src-ui/src/app/data/custom-field.ts b/src-ui/src/app/data/custom-field.ts index e858f06be..a60c5ac2a 100644 --- a/src-ui/src/app/data/custom-field.ts +++ b/src-ui/src/app/data/custom-field.ts @@ -9,6 +9,7 @@ export enum CustomFieldDataType { Float = 'float', Monetary = 'monetary', DocumentLink = 'documentlink', + Select = 'select', } export const DATA_TYPE_LABELS = [ @@ -44,10 +45,17 @@ export const DATA_TYPE_LABELS = [ id: CustomFieldDataType.DocumentLink, name: $localize`Document Link`, }, + { + id: CustomFieldDataType.Select, + name: $localize`Select`, + }, ] export interface CustomField extends ObjectWithId { data_type: CustomFieldDataType name: string created?: Date + extra_data?: { + select_options?: string[] + } } diff --git a/src/documents/migrations/1050_customfield_extra_data_and_more.py b/src/documents/migrations/1050_customfield_extra_data_and_more.py new file mode 100644 index 000000000..0c6a77ccc --- /dev/null +++ b/src/documents/migrations/1050_customfield_extra_data_and_more.py @@ -0,0 +1,48 @@ +# Generated by Django 4.2.13 on 2024-07-04 01:02 + +from django.db import migrations +from django.db import models + + +class Migration(migrations.Migration): + dependencies = [ + ("documents", "1049_document_deleted_at_document_restored_at"), + ] + + operations = [ + migrations.AddField( + model_name="customfield", + name="extra_data", + field=models.JSONField( + blank=True, + help_text="Extra data for the custom field, such as select options", + null=True, + verbose_name="extra data", + ), + ), + migrations.AddField( + model_name="customfieldinstance", + name="value_select", + field=models.PositiveSmallIntegerField(null=True), + ), + migrations.AlterField( + model_name="customfield", + name="data_type", + field=models.CharField( + choices=[ + ("string", "String"), + ("url", "URL"), + ("date", "Date"), + ("boolean", "Boolean"), + ("integer", "Integer"), + ("float", "Float"), + ("monetary", "Monetary"), + ("documentlink", "Document Link"), + ("select", "Select"), + ], + editable=False, + max_length=50, + verbose_name="data type", + ), + ), + ] diff --git a/src/documents/models.py b/src/documents/models.py index 8ce038600..0e6de5360 100644 --- a/src/documents/models.py +++ b/src/documents/models.py @@ -808,6 +808,7 @@ class CustomField(models.Model): FLOAT = ("float", _("Float")) MONETARY = ("monetary", _("Monetary")) DOCUMENTLINK = ("documentlink", _("Document Link")) + SELECT = ("select", _("Select")) created = models.DateTimeField( _("created"), @@ -825,6 +826,15 @@ class CustomField(models.Model): editable=False, ) + extra_data = models.JSONField( + _("extra data"), + null=True, + blank=True, + help_text=_( + "Extra data for the custom field, such as select options", + ), + ) + class Meta: ordering = ("created",) verbose_name = _("custom field") @@ -888,6 +898,8 @@ class CustomFieldInstance(models.Model): value_document_ids = models.JSONField(null=True) + value_select = models.PositiveSmallIntegerField(null=True) + class Meta: ordering = ("created",) verbose_name = _("custom field instance") @@ -900,7 +912,12 @@ class CustomFieldInstance(models.Model): ] def __str__(self) -> str: - return str(self.field.name) + f" : {self.value}" + value = ( + self.field.extra_data["select_options"][self.value_select] + if self.field.data_type == CustomField.FieldDataType.SELECT + else self.value + ) + return str(self.field.name) + f" : {value}" @property def value(self): @@ -924,6 +941,8 @@ class CustomFieldInstance(models.Model): return self.value_monetary elif self.field.data_type == CustomField.FieldDataType.DOCUMENTLINK: return self.value_document_ids + elif self.field.data_type == CustomField.FieldDataType.SELECT: + return self.value_select raise NotImplementedError(self.field.data_type) diff --git a/src/documents/serialisers.py b/src/documents/serialisers.py index 546a8d8e7..2f6a19f49 100644 --- a/src/documents/serialisers.py +++ b/src/documents/serialisers.py @@ -455,6 +455,7 @@ class CustomFieldSerializer(serializers.ModelSerializer): "id", "name", "data_type", + "extra_data", ] def validate(self, attrs): @@ -476,6 +477,23 @@ class CustomFieldSerializer(serializers.ModelSerializer): raise serializers.ValidationError( {"error": "Object violates name unique constraint"}, ) + if ( + "data_type" in attrs + and attrs["data_type"] == CustomField.FieldDataType.SELECT + and ( + "extra_data" not in attrs + or "select_options" not in attrs["extra_data"] + or not isinstance(attrs["extra_data"]["select_options"], list) + or len(attrs["extra_data"]["select_options"]) == 0 + or not all( + isinstance(option, str) and len(option) > 0 + for option in attrs["extra_data"]["select_options"] + ) + ) + ): + raise serializers.ValidationError( + {"error": "extra_data.select_options must be a valid list"}, + ) return super().validate(attrs) @@ -507,6 +525,7 @@ class CustomFieldInstanceSerializer(serializers.ModelSerializer): CustomField.FieldDataType.FLOAT: "value_float", CustomField.FieldDataType.MONETARY: "value_monetary", CustomField.FieldDataType.DOCUMENTLINK: "value_document_ids", + CustomField.FieldDataType.SELECT: "value_select", } # An instance is attached to a document document: Document = validated_data["document"] @@ -563,6 +582,14 @@ class CustomFieldInstanceSerializer(serializers.ModelSerializer): )(data["value"]) elif field.data_type == CustomField.FieldDataType.STRING: MaxLengthValidator(limit_value=128)(data["value"]) + elif field.data_type == CustomField.FieldDataType.SELECT: + select_options = field.extra_data["select_options"] + try: + select_options[data["value"]] + except Exception: + raise serializers.ValidationError( + f"Value must be index of an element in {select_options}", + ) return data diff --git a/src/documents/tests/test_api_custom_fields.py b/src/documents/tests/test_api_custom_fields.py index 0b2f99b35..edebf7f3c 100644 --- a/src/documents/tests/test_api_custom_fields.py +++ b/src/documents/tests/test_api_custom_fields.py @@ -1,3 +1,4 @@ +import json from datetime import date from django.contrib.auth.models import User @@ -49,10 +50,31 @@ class TestCustomFieldsAPI(DirectoriesMixin, APITestCase): data = resp.json() - self.assertEqual(len(data), 3) self.assertEqual(data["name"], name) self.assertEqual(data["data_type"], field_type) + resp = self.client.post( + self.ENDPOINT, + json.dumps( + { + "data_type": "select", + "name": "Select Field", + "extra_data": { + "select_options": ["Option 1", "Option 2"], + }, + }, + ), + content_type="application/json", + ) + self.assertEqual(resp.status_code, status.HTTP_201_CREATED) + + data = resp.json() + + self.assertCountEqual( + data["extra_data"]["select_options"], + ["Option 1", "Option 2"], + ) + def test_create_custom_field_nonunique_name(self): """ GIVEN: @@ -76,6 +98,45 @@ class TestCustomFieldsAPI(DirectoriesMixin, APITestCase): ) self.assertEqual(resp.status_code, status.HTTP_400_BAD_REQUEST) + def test_create_custom_field_select_invalid_options(self): + """ + GIVEN: + - Custom field does not exist + WHEN: + - API request to create custom field with invalid select options + THEN: + - HTTP 400 is returned + """ + + # Not a list + resp = self.client.post( + self.ENDPOINT, + json.dumps( + { + "data_type": "select", + "name": "Select Field", + "extra_data": { + "select_options": "not a list", + }, + }, + ), + content_type="application/json", + ) + self.assertEqual(resp.status_code, status.HTTP_400_BAD_REQUEST) + + # No options + resp = self.client.post( + self.ENDPOINT, + json.dumps( + { + "data_type": "select", + "name": "Select Field", + }, + ), + content_type="application/json", + ) + self.assertEqual(resp.status_code, status.HTTP_400_BAD_REQUEST) + def test_create_custom_field_instance(self): """ GIVEN: @@ -135,6 +196,13 @@ class TestCustomFieldsAPI(DirectoriesMixin, APITestCase): name="Test Custom Field Doc Link", data_type=CustomField.FieldDataType.DOCUMENTLINK, ) + custom_field_select = CustomField.objects.create( + name="Test Custom Field Select", + data_type=CustomField.FieldDataType.SELECT, + extra_data={ + "select_options": ["Option 1", "Option 2"], + }, + ) date_value = date.today() @@ -178,6 +246,10 @@ class TestCustomFieldsAPI(DirectoriesMixin, APITestCase): "field": custom_field_documentlink.id, "value": [doc2.id], }, + { + "field": custom_field_select.id, + "value": 0, + }, ], }, format="json", @@ -199,11 +271,12 @@ class TestCustomFieldsAPI(DirectoriesMixin, APITestCase): {"field": custom_field_monetary.id, "value": "EUR11.10"}, {"field": custom_field_monetary2.id, "value": "11.1"}, {"field": custom_field_documentlink.id, "value": [doc2.id]}, + {"field": custom_field_select.id, "value": 0}, ], ) doc.refresh_from_db() - self.assertEqual(len(doc.custom_fields.all()), 9) + self.assertEqual(len(doc.custom_fields.all()), 10) def test_change_custom_field_instance_value(self): """ @@ -568,6 +641,44 @@ class TestCustomFieldsAPI(DirectoriesMixin, APITestCase): self.assertEqual(CustomFieldInstance.objects.count(), 0) self.assertEqual(len(doc.custom_fields.all()), 0) + def test_custom_field_value_select_validation(self): + """ + GIVEN: + - Document & custom field exist + WHEN: + - API request to set a field value to something not in the select options + THEN: + - HTTP 400 is returned + - No field instance is created or attached to the document + """ + doc = Document.objects.create( + title="WOW", + content="the content", + checksum="123", + mime_type="application/pdf", + ) + custom_field_select = CustomField.objects.create( + name="Test Custom Field SELECT", + data_type=CustomField.FieldDataType.SELECT, + extra_data={ + "select_options": ["Option 1", "Option 2"], + }, + ) + + resp = self.client.patch( + f"/api/documents/{doc.id}/", + data={ + "custom_fields": [ + {"field": custom_field_select.id, "value": 3}, + ], + }, + format="json", + ) + + self.assertEqual(resp.status_code, status.HTTP_400_BAD_REQUEST) + self.assertEqual(CustomFieldInstance.objects.count(), 0) + self.assertEqual(len(doc.custom_fields.all()), 0) + def test_custom_field_not_null(self): """ GIVEN: