feat: Add text searching of id field

Author: claremacrae

src/Query/Filter/IdField.ts

@@ -1,9 +1,9 @@
 import type { Task } from '../../Task/Task';
-import { Field } from './Field';
-import { FilterOrErrorMessage } from './FilterOrErrorMessage';
+import type { FilterOrErrorMessage } from './FilterOrErrorMessage';
 import { FilterInstructions } from './FilterInstructions';
+import { TextField } from './TextField';
 
-export class IdField extends Field {
+export class IdField extends TextField {
     private readonly filterInstructions: FilterInstructions = new FilterInstructions();
 
     constructor() {
@@ -26,14 +26,14 @@ export class IdField extends Field {
             return filterResult;
         }
 
-        return FilterOrErrorMessage.fromError(line, 'Unknown instruction');
+        return super.createFilterOrErrorMessage(line);
     }
 
     public fieldName(): string {
         return 'id';
     }
 
-    protected filterRegExp(): RegExp | null {
-        return null;
+    public value(task: Task): string {
+        return task.id;
     }
 }

tests/Query/Filter/IdField.test.ts

@@ -30,4 +30,42 @@ describe('id', () => {
         testFilter(filter, new TaskBuilder().id(''), true);
         testFilter(filter, new TaskBuilder().id('abcdef'), false);
     });
+
+    it('by id (includes)', () => {
+        // Arrange
+        const filter = new IdField().createFilterOrErrorMessage('id includes DEF');
+
+        // Assert
+        testFilter(filter, new TaskBuilder().id(''), false);
+        testFilter(filter, new TaskBuilder().id('abcdef'), true);
+    });
+
+    it('by id (does not include)', () => {
+        // Arrange
+        const filter = new IdField().createFilterOrErrorMessage('id does not include def');
+
+        // Assert
+        testFilter(filter, new TaskBuilder().id(''), true);
+        testFilter(filter, new TaskBuilder().id('abcdef'), false);
+    });
+
+    it('by id (regex matches)', () => {
+        // Arrange
+        const filter = new IdField().createFilterOrErrorMessage(String.raw`id regex matches /\d/`);
+
+        // Assert
+        testFilter(filter, new TaskBuilder().id(''), false);
+        testFilter(filter, new TaskBuilder().id('a1'), true);
+        testFilter(filter, new TaskBuilder().id('bc'), false);
+    });
+
+    it('by id (regex does not match)', () => {
+        // Arrange
+        const filter = new IdField().createFilterOrErrorMessage(String.raw`id regex does not match /\d/`);
+
+        // Assert
+        testFilter(filter, new TaskBuilder().id(''), true);
+        testFilter(filter, new TaskBuilder().id('a1'), false);
+        testFilter(filter, new TaskBuilder().id('bc'), true);
+    });
 });

tests/Query/Query.test.ts

@@ -95,6 +95,9 @@ describe('Query parsing', () => {
         'heading does not include wibble',
         'heading includes AND', // Verify Query doesn't confuse this with a boolean query
         'heading includes wibble',
+        'id does not include abc123',
+        'id includes abc123',
+        'id includes AND', // Verify Query doesn't confuse this with a boolean query
         'is blocking',
         'is not blocked',
         'is not recurring',