test: Test heading with regex, and 2 new custom matchers (#1045)

* test: Test regex searches on heading

* refactor: Extract method toMatchTask()

* test: Improve output of toMatchTask() on failure

* test: Simplify remaining custom matchers for filter tests

* test: Export toMatchTask() custom matcher

Author: claremacrae

tests/CustomMatchers/CustomMatchersForFilters.ts

@@ -1,3 +1,4 @@
+import type { Task } from '../../src/Task';
 import type { FilterOrErrorMessage } from '../../src/Query/Filter/Filter';
 import { fromLine } from '../TestHelpers';
 import { TaskBuilder } from '../TestingTools/TaskBuilder';
@@ -56,19 +57,25 @@ declare global {
     namespace jest {
         interface Matchers<R> {
             toBeValid(): R;
+            toMatchTask(task: Task): R;
             toMatchTaskFromLine(line: string): R;
+            toMatchTaskWithHeading(heading: string | null): R;
             toMatchTaskWithPath(path: string): R;
         }
 
         interface Expect {
             toBeValid(): any;
+            toMatchTask(task: Task): any;
             toMatchTaskFromLine(line: string): any;
+            toMatchTaskWithHeading(heading: string | null): any;
             toMatchTaskWithPath(path: string): any;
         }
 
         interface InverseAsymmetricMatchers {
             toBeValid(): any;
+            toMatchTask(task: Task): any;
             toMatchTaskFromLine(line: string): any;
+            toMatchTaskWithHeading(heading: string | null): any;
             toMatchTaskWithPath(path: string): any;
         }
     }
@@ -97,45 +104,47 @@ export function toBeValid(filter: FilterOrErrorMessage) {
     };
 }
 
-export function toMatchTaskFromLine(
-    filter: FilterOrErrorMessage,
-    line: string,
-) {
-    const task = fromLine({
-        line: line,
-    });
-
+export function toMatchTask(filter: FilterOrErrorMessage, task: Task) {
     const matches = filter.filter!(task);
     if (!matches) {
         return {
-            message: () => `unexpected failure to match task: ${line}`,
+            message: () =>
+                `unexpected failure to match task: ${task.toFileLineString()}`,
             pass: false,
         };
     }
 
     return {
-        message: () => `filter should not have matched task: ${line}`,
+        message: () =>
+            `filter should not have matched task: ${task.toFileLineString()}`,
         pass: true,
     };
 }
 
+export function toMatchTaskFromLine(
+    filter: FilterOrErrorMessage,
+    line: string,
+) {
+    const task = fromLine({
+        line: line,
+    });
+    return toMatchTask(filter, task);
+}
+
+export function toMatchTaskWithHeading(
+    filter: FilterOrErrorMessage,
+    heading: string,
+) {
+    const builder = new TaskBuilder();
+    const task = builder.precedingHeader(heading).build();
+    return toMatchTask(filter, task);
+}
+
 export function toMatchTaskWithPath(
     filter: FilterOrErrorMessage,
     path: string,
 ) {
     const builder = new TaskBuilder();
     const task = builder.path(path).build();
-
-    const matches = filter.filter!(task);
-    if (!matches) {
-        return {
-            message: () => `unexpected failure to match task: ${path}`,
-            pass: false,
-        };
-    }
-
-    return {
-        message: () => `filter should not have matched task: ${path}`,
-        pass: true,
-    };
+    return toMatchTask(filter, task);
 }

tests/Query/Filter/HeadingField.test.ts

@@ -2,6 +2,10 @@ import { HeadingField } from '../../../src/Query/Filter/HeadingField';
 import type { FilterOrErrorMessage } from '../../../src/Query/Filter/Filter';
 import { TaskBuilder } from '../../TestingTools/TaskBuilder';
 import { testFilter } from '../../TestingTools/FilterTestHelpers';
+import {
+    toBeValid,
+    toMatchTaskWithHeading,
+} from '../../CustomMatchers/CustomMatchersForFilters';
 
 function testTaskFilterForHeading(
     filter: FilterOrErrorMessage,
@@ -12,6 +16,14 @@ function testTaskFilterForHeading(
     testFilter(filter, builder.precedingHeader(precedingHeader), expected);
 }
 
+expect.extend({
+    toBeValid,
+});
+
+expect.extend({
+    toMatchTaskWithHeading,
+});
+
 describe('heading', () => {
     it('by heading (includes)', () => {
         // Arrange
@@ -36,4 +48,30 @@ describe('heading', () => {
         testTaskFilterForHeading(filter, 'SoMe InteResting HeaDing', false);
         testTaskFilterForHeading(filter, 'Other Heading', true);
     });
+
+    it('by heading (regex matches - case sensitive)', () => {
+        // Arrange
+        const filter = new HeadingField().createFilterOrErrorMessage(
+            'heading regex matches /[Ii]nteresting Head.ng/',
+        );
+
+        // Act, Assert
+        expect(filter).toBeValid();
+        expect(filter).toMatchTaskWithHeading('Interesting Heading');
+        expect(filter).not.toMatchTaskWithHeading(null);
+        expect(filter).not.toMatchTaskWithHeading('SoMe InteResting HeaDing');
+    });
+
+    it('by heading (regex does not match - case in-sensitive)', () => {
+        // Arrange
+        const filter = new HeadingField().createFilterOrErrorMessage(
+            'heading regex does not match /[Ii]nteresting Head.ng/i',
+        );
+
+        // Act, Assert
+        expect(filter).toBeValid();
+        expect(filter).toMatchTaskWithHeading(null);
+        expect(filter).not.toMatchTaskWithHeading('Interesting Heading');
+        expect(filter).not.toMatchTaskWithHeading('SoMe InteResting HeaDing');
+    });
 });