test: add group sort order tests (#2024)

* test: test showing current urgency group order

* test:  test showing current status group order

* test: test showing current tag group order

* test: BacklinkField group order

* test: StatusTypeField group order

* test: collect sample tasks in one class

* test: fix tag order (bad cherry pick from another branch

* test: FilenameField group order

* test: FolderField group order

* test: HeadingField group order

* test: PathField group order

* test: fix wrong function rename

* test: StartDateField group order

* test: DoneDateField group order

* test: CreatedDateField group order

* test: ScheduledDateField group order

* test: HappensDateField group order

* test: rename method to include roots

* test: RootField group order

* test: Recurrence field group order

* test: RecurringField group order

Author: ilandikov

tests/Query/Filter/BacklinkField.test.ts

@@ -1,5 +1,5 @@
 import { BacklinkField } from '../../../src/Query/Filter/BacklinkField';
-import { fromLine } from '../../TestHelpers';
+import { SampleTasks, fromLine } from '../../TestHelpers';
 
 describe('backlink', () => {
     it('should provide the backlink', () => {
@@ -65,4 +65,20 @@ describe('grouping by backlink', () => {
             expect(grouper(fromLine({ line: t, path: path, precedingHeader: heading }))).toEqual(groups);
         },
     );
+
+    it('should sort groups for BacklinkField', () => {
+        // Arrange
+        const tasks = SampleTasks.withAllRootsPathsHeadings();
+        const grouper = new BacklinkField().createNormalGrouper();
+
+        // Assert
+        expect({ grouper, tasks }).groupHeadingsToBe([
+            '\\_c\\_',
+            '\\_c\\_ > heading _italic text_',
+            'a\\_b\\_c',
+            'c',
+            'c > heading',
+            'Unknown Location',
+        ]);
+    });
 });

tests/Query/Filter/CreatedDateField.test.ts

@@ -11,6 +11,7 @@ import {
     expectTaskComparesBefore,
     expectTaskComparesEqual,
 } from '../../CustomMatchers/CustomMatchersForSorting';
+import { SampleTasks } from '../../TestHelpers';
 
 window.moment = moment;
 
@@ -105,4 +106,17 @@ describe('grouping by created date', () => {
         expect(grouper.grouper(taskWithDate)).toEqual(['1970-01-01 Thursday']);
         expect(grouper.grouper(taskWithoutDate)).toEqual(['No created date']);
     });
+
+    it('should sort groups for CreatedDateField', () => {
+        const grouper = new CreatedDateField().createNormalGrouper();
+        const tasks = SampleTasks.withAllRepresentativeCreatedDates();
+
+        expect({ grouper, tasks }).groupHeadingsToBe([
+            '2023-05-30 Tuesday',
+            '2023-05-31 Wednesday',
+            '2023-06-01 Thursday',
+            'Invalid date',
+            'No created date',
+        ]);
+    });
 });

tests/Query/Filter/DoneDateField.test.ts

@@ -7,6 +7,7 @@ import type { FilterOrErrorMessage } from '../../../src/Query/Filter/Filter';
 import { TaskBuilder } from '../../TestingTools/TaskBuilder';
 import { testFilter } from '../../TestingTools/FilterTestHelpers';
 import { expectTaskComparesAfter, expectTaskComparesBefore } from '../../CustomMatchers/CustomMatchersForSorting';
+import { SampleTasks } from '../../TestHelpers';
 
 window.moment = moment;
 
@@ -102,4 +103,17 @@ describe('grouping by done date', () => {
         expect(grouper.grouper(taskWithDate)).toEqual(['1970-01-01 Thursday']);
         expect(grouper.grouper(taskWithoutDate)).toEqual(['No done date']);
     });
+
+    it('should sort groups for DoneDateField', () => {
+        const grouper = new DoneDateField().createNormalGrouper();
+        const tasks = SampleTasks.withAllRepresentativeDoneDates();
+
+        expect({ grouper, tasks }).groupHeadingsToBe([
+            '2023-05-30 Tuesday',
+            '2023-05-31 Wednesday',
+            '2023-06-01 Thursday',
+            'Invalid date',
+            'No done date',
+        ]);
+    });
 });

tests/Query/Filter/DueDateField.test.ts

@@ -2,7 +2,6 @@
  * @jest-environment jsdom
  */
 import moment from 'moment';
-import type { Task } from 'Task';
 import { DueDateField } from '../../../src/Query/Filter/DueDateField';
 import type { FilterOrErrorMessage } from '../../../src/Query/Filter/Filter';
 import { TaskBuilder } from '../../TestingTools/TaskBuilder';
@@ -14,6 +13,7 @@ import {
 } from '../../CustomMatchers/CustomMatchersForSorting';
 import { Query } from '../../../src/Query/Query';
 import { MarkdownTable } from '../../TestingTools/VerifyMarkdownTable';
+import { SampleTasks } from '../../TestHelpers';
 
 window.moment = moment;
 
@@ -535,7 +535,7 @@ describe('grouping by due date', () => {
 
     it('should sort groups for DueDateField', () => {
         const grouper = new DueDateField().createNormalGrouper();
-        const tasks = withAllRepresentativeDueDates();
+        const tasks = SampleTasks.withAllRepresentativeDueDates();
 
         expect({ grouper, tasks }).groupHeadingsToBe([
             '2023-05-30 Tuesday',
@@ -546,13 +546,3 @@ describe('grouping by due date', () => {
         ]);
     });
 });
-
-function withAllRepresentativeDueDates(): Task[] {
-    const dates = ['2023-05-30', '2023-05-31', '2023-06-01', '2023-02-32', null];
-
-    const tasks = dates.map((date) => {
-        return new TaskBuilder().dueDate(date).build();
-    });
-
-    return tasks;
-}

tests/Query/Filter/FilenameField.test.ts

@@ -1,7 +1,7 @@
 import { TaskBuilder } from '../../TestingTools/TaskBuilder';
 import { FilenameField } from '../../../src/Query/Filter/FilenameField';
 import * as CustomMatchersForSorting from '../../CustomMatchers/CustomMatchersForSorting';
-import { fromLine } from '../../TestHelpers';
+import { SampleTasks, fromLine } from '../../TestHelpers';
 
 describe('filename', () => {
     it('should provide access to the file name with extension', () => {
@@ -119,4 +119,13 @@ describe('grouping by filename', () => {
         // Assert
         expect(grouper(fromLine({ line: taskLine, path: path }))).toEqual(groups);
     });
+
+    it('should sort groups for FilenameField', () => {
+        // Arrange
+        const tasks = SampleTasks.withAllRootsPathsHeadings();
+        const grouper = new FilenameField().createNormalGrouper();
+
+        // Assert
+        expect({ grouper, tasks }).groupHeadingsToBe(['[[_c_]]', '[[a_b_c]]', '[[c]]', 'Unknown Location']);
+    });
 });

tests/Query/Filter/FolderField.test.ts

@@ -1,5 +1,5 @@
 import { FolderField } from '../../../src/Query/Filter/FolderField';
-import { fromLine } from '../../TestHelpers';
+import { SampleTasks, fromLine } from '../../TestHelpers';
 
 describe('folder', () => {
     it('should provide access to the folder', () => {
@@ -48,4 +48,13 @@ describe('grouping by folder', () => {
         // Assert
         expect(grouper(fromLine({ line: taskLine, path: path }))).toEqual(groups);
     });
+
+    it('should sort groups for FolderField', () => {
+        // Arrange
+        const tasks = SampleTasks.withAllRootsPathsHeadings();
+        const grouper = new FolderField().createNormalGrouper();
+
+        // Assert
+        expect({ grouper, tasks }).groupHeadingsToBe(['/', 'a/b/', 'a/d/', 'e/d/']);
+    });
 });

tests/Query/Filter/HappensDateField.test.ts

@@ -6,7 +6,7 @@ import { HappensDateField } from '../../../src/Query/Filter/HappensDateField';
 import { TaskBuilder } from '../../TestingTools/TaskBuilder';
 import { testFilter } from '../../TestingTools/FilterTestHelpers';
 import * as CustomMatchersForSorting from '../../CustomMatchers/CustomMatchersForSorting';
-import { fromLine } from '../../TestHelpers';
+import { SampleTasks, fromLine } from '../../TestHelpers';
 
 window.moment = moment;
 
@@ -155,4 +155,21 @@ describe('grouping by happens date', () => {
         // Assert
         expect(grouper.grouper(fromLine({ line: taskLine }))).toEqual(expectedResult);
     });
+
+    it('should sort groups for HappensDateField', () => {
+        const grouper = new HappensDateField().createNormalGrouper();
+        const tasks = [
+            ...SampleTasks.withAllRepresentativeDueDates(),
+            ...SampleTasks.withAllRepresentativeScheduledDates(),
+            ...SampleTasks.withAllRepresentativeStartDates(),
+        ];
+
+        expect({ grouper, tasks }).groupHeadingsToBe([
+            '2023-05-30 Tuesday',
+            '2023-05-31 Wednesday',
+            '2023-06-01 Thursday',
+            'Invalid date',
+            'No happens date',
+        ]);
+    });
 });

tests/Query/Filter/HeadingField.test.ts

@@ -3,7 +3,7 @@ import type { FilterOrErrorMessage } from '../../../src/Query/Filter/Filter';
 import { TaskBuilder } from '../../TestingTools/TaskBuilder';
 import { testFilter } from '../../TestingTools/FilterTestHelpers';
 import * as CustomMatchersForSorting from '../../CustomMatchers/CustomMatchersForSorting';
-import { fromLine } from '../../TestHelpers';
+import { SampleTasks, fromLine } from '../../TestHelpers';
 
 function testTaskFilterForHeading(filter: FilterOrErrorMessage, precedingHeader: string | null, expected: boolean) {
     const builder = new TaskBuilder();
@@ -110,4 +110,19 @@ describe('grouping by heading', () => {
             expect(grouper(fromLine({ line: taskLine, precedingHeader: header }))).toEqual(groups);
         },
     );
+
+    it('should sort groups for HeadingField', () => {
+        // Arrange
+        const tasks = SampleTasks.withAllRootsPathsHeadings();
+        const grouper = new HeadingField().createNormalGrouper();
+
+        // Assert
+        expect({ grouper, tasks }).groupHeadingsToBe([
+            '(No heading)',
+            'a_b_c',
+            'c',
+            'heading',
+            'heading _italic text_',
+        ]);
+    });
 });

tests/Query/Filter/PathField.test.ts

@@ -7,7 +7,7 @@ import {
     expectTaskComparesBefore,
     expectTaskComparesEqual,
 } from '../../CustomMatchers/CustomMatchersForSorting';
-import { fromLine } from '../../TestHelpers';
+import { SampleTasks, fromLine } from '../../TestHelpers';
 
 function testTaskFilterForTaskWithPath(filter: FilterOrErrorMessage, path: string, expected: boolean) {
     const builder = new TaskBuilder();
@@ -163,4 +163,20 @@ describe('grouping by path', () => {
         // Assert
         expect(grouper(fromLine({ line: taskLine, path: path }))).toEqual(groups);
     });
+
+    it('should sort groups for PathField', () => {
+        // Arrange
+        const tasks = SampleTasks.withAllRootsPathsHeadings();
+        const grouper = new PathField().createNormalGrouper();
+
+        // Assert
+        expect({ grouper, tasks }).groupHeadingsToBe([
+            // Why there is no path for empty path?
+            'a/b/\\_c\\_',
+            'a/b/c',
+            'a/d/c',
+            'a\\_b\\_c',
+            'e/d/c',
+        ]);
+    });
 });

tests/Query/Filter/PriorityField.test.ts

@@ -1,8 +1,8 @@
-import { Priority, Task } from '../../../src/Task';
+import { Priority } from '../../../src/Task';
 import { TaskBuilder } from '../../TestingTools/TaskBuilder';
 import { testFilter } from '../../TestingTools/FilterTestHelpers';
 import { PriorityField } from '../../../src/Query/Filter/PriorityField';
-import { fromLine } from '../../TestHelpers';
+import { SampleTasks, fromLine } from '../../TestHelpers';
 
 import {
     expectTaskComparesAfter,
@@ -229,7 +229,7 @@ describe('grouping by priority', () => {
 
     it('should sort groups for PriorityField', () => {
         const grouper = new PriorityField().createNormalGrouper();
-        const tasks = withAllPriorities();
+        const tasks = SampleTasks.withAllPriorities();
 
         expect({ grouper, tasks }).groupHeadingsToBe([
             'Priority 0: Highest',
@@ -241,18 +241,3 @@ describe('grouping by priority', () => {
         ]);
     });
 });
-
-export function withAllPriorities(): Task[] {
-    const tasks: Task[] = [];
-    const allPriorities = Object.values(Priority);
-    allPriorities.forEach((priority) => {
-        // This description is chosen to be useful for including tasks in user docs, so
-        // changing it will change documentation and sample vault content.
-        const priorityName = PriorityField.priorityNameUsingNormal(priority);
-        const description = `#task ${priorityName} priority`;
-
-        const task = new TaskBuilder().priority(priority).description(description).build();
-        tasks.push(task);
-    });
-    return tasks;
-}