feat: Support 'sort by id' and 'sort by id reverse'

Author: claremacrae

src/Query/Filter/IdField.ts

@@ -12,6 +12,10 @@ export class IdField extends TextField {
         this.filterInstructions.add('no id', (task: Task) => task.id.length === 0);
     }
 
+    // -----------------------------------------------------------------------------------------------------------------
+    // Filtering
+    // -----------------------------------------------------------------------------------------------------------------
+
     public canCreateFilterForLine(line: string): boolean {
         if (this.filterInstructions.canCreateFilterForLine(line)) {
             return true;
@@ -36,4 +40,12 @@ export class IdField extends TextField {
     public value(task: Task): string {
         return task.id;
     }
+
+    // -----------------------------------------------------------------------------------------------------------------
+    // Sorting
+    // -----------------------------------------------------------------------------------------------------------------
+
+    public supportsSorting(): boolean {
+        return true;
+    }
 }

tests/Query/Filter/IdField.test.ts

@@ -1,6 +1,11 @@
 import { testFilter } from '../../TestingTools/FilterTestHelpers';
 import { TaskBuilder } from '../../TestingTools/TaskBuilder';
 import { IdField } from '../../../src/Query/Filter/IdField';
+import {
+    expectTaskComparesAfter,
+    expectTaskComparesBefore,
+    expectTaskComparesEqual,
+} from '../../CustomMatchers/CustomMatchersForSorting';
 
 describe('id', () => {
     const idField = new IdField();
@@ -69,3 +74,35 @@ describe('id', () => {
         testFilter(filter, new TaskBuilder().id('bc'), true);
     });
 });
+
+describe('sorting by id', () => {
+    it('supports Field sorting methods correctly', () => {
+        const field = new IdField();
+        expect(field.supportsSorting()).toEqual(true);
+    });
+
+    // Helper function to create a task with a given id
+    function with_id(id: string) {
+        return new TaskBuilder().id(id).build();
+    }
+
+    it('sort by id', () => {
+        // Arrange
+        const sorter = new IdField().createNormalSorter();
+
+        // Assert
+        expectTaskComparesEqual(sorter, with_id('mvplec'), with_id('mvplec'));
+        expectTaskComparesBefore(sorter, with_id('g7317o'), with_id('rot7gb'));
+
+        // Beginning with numbers
+        expectTaskComparesBefore(sorter, with_id('1'), with_id('9'));
+        expectTaskComparesBefore(sorter, with_id('9'), with_id('11'));
+    });
+
+    it('sort by id reverse', () => {
+        // Single example just to prove reverse works.
+        // (There's no need to repeat all the examples above)
+        const sorter = new IdField().createReverseSorter();
+        expectTaskComparesAfter(sorter, with_id('bbb'), with_id('ddd'));
+    });
+});

tests/Query/Query.test.ts

@@ -256,6 +256,8 @@ describe('Query parsing', () => {
             'sort by happens reverse',
             'sort by heading',
             'sort by heading reverse',
+            'sort by id',
+            'sort by id reverse',
             'sort by path',
             'sort by path reverse',
             'sort by priority',