feat: add file as property of the task for quering

docs/queries-x/index.md

@@ -27,6 +27,7 @@ The following columns are available to be used in the WHERE clauses.
 | status->nextStatusIndicator | The next indicator to be used when clicked on.  ('x', ' ', '/', etc)                |      |
 | description                 | The description of the task.                                                        |      |
 | path                        | The path to the note the task is in.                                                |      |
+| file                        | The TFile object in Obsidian.                                                       |      |
 | precedingHeader             | The heading that the task is under                                                  |      |
 | priority                    | The priority of the task. This has to be treated like a string ('1', '2', '3', '4') |      |
 
@@ -60,6 +61,18 @@ WHERE ((dueDate->getUTCFullYear() = 2021 AND status->indicator = 'x') OR (dueDat
 
 Look at the [SQL Compatibility](https://github.com/AlaSQL/alasql/wiki/SQL%20keywords) table to see what SQL commands are supported.
 
+### Queries using file
+
+basename is the name of the page
+
+`WHERE status->indicator = '!' AND file->basename = '2021-10-13'`
+
+You can also now query based on the creation date of the note the task is in.
+
+`WHERE status->indicator = ' ' AND moment(file->stat->ctime)->month() = 3`
+
+you can use `mtime` to access the modified time.
+
 ### Object Properties & Functions
 
 Object property

src/Cache.ts

@@ -273,6 +273,7 @@ export class Cache {
                 const task = Task.fromLine({
                     line,
                     path: file.path,
+                    file,
                     sectionStart: currentSection.position.start.line,
                     sectionIndex,
                     precedingHeader: this.getPrecedingHeader({

src/Commands/CreateOrEdit.ts

@@ -42,6 +42,7 @@ const taskFromLine = ({ line, path }: { line: string; path: string }): Task => {
     const task = Task.fromLine({
         line,
         path,
+        file: null,
         sectionStart: 0, // We don't need this to toggle it here in the editor.
         sectionIndex: 0, // We don't need this to toggle it here in the editor.
         precedingHeader: null, // We don't need this to toggle it here in the editor.
@@ -62,6 +63,7 @@ const taskFromLine = ({ line, path }: { line: string; path: string }): Task => {
             status: Status.TODO,
             description: '',
             path,
+            file: null,
             indentation: '',
             priority: Priority.None,
             startDate: null,
@@ -94,6 +96,7 @@ const taskFromLine = ({ line, path }: { line: string; path: string }): Task => {
         status,
         description,
         path,
+        file: null,
         indentation,
         blockLink,
         priority: Priority.None,

src/Commands/ToggleDone.ts

@@ -52,6 +52,7 @@ const toggleLine = ({ line, path }: { line: string; path: string }): string => {
     const task = Task.fromLine({
         line,
         path,
+        file: null,
         sectionStart: 0, // We don't need this to toggle it here in the editor.
         sectionIndex: 0, // We don't need this to toggle it here in the editor.
         precedingHeader: null, // We don't need this to toggle it here in the editor.

src/InlineRenderer.ts

@@ -67,6 +67,7 @@ export class InlineRenderer {
             const task = Task.fromLine({
                 line,
                 path,
+                file: null,
                 sectionStart: section.lineStart,
                 sectionIndex,
                 precedingHeader: null, // We don't need the preceding header for in-line rendering.

src/LivePreviewExtension.ts

@@ -37,6 +37,7 @@ class LivePreviewExtension implements PluginValue {
             // The task is created, toggled, and written back to the CM6 document,
             // replacing the old task in-place.
             path: '',
+            file: null,
             sectionStart: 0,
             sectionIndex: 0,
             precedingHeader: null,

src/Task.ts

@@ -1,5 +1,5 @@
 import type { Moment } from 'moment';
-import { Component, MarkdownRenderer } from 'obsidian';
+import { Component, MarkdownRenderer, TFile } from 'obsidian';
 import moment from 'moment';
 
 import { StatusRegistry } from './StatusRegistry';
@@ -29,6 +29,7 @@ export type TaskRecord = {
     status: Status;
     description: string;
     path: string;
+    file: TFile | null;
     indentation: string;
     sectionStart: number;
     sectionIndex: number;
@@ -87,6 +88,8 @@ export class Task {
     public readonly status: Status;
     public readonly description: string;
     public readonly path: string;
+    public readonly file: TFile | null;
+
     public readonly indentation: string;
     /** Line number where the section starts that contains this task. */
     public readonly sectionStart: number;
@@ -113,6 +116,7 @@ export class Task {
         status,
         description,
         path,
+        file,
         indentation,
         sectionStart,
         sectionIndex,
@@ -129,6 +133,7 @@ export class Task {
         status: Status;
         description: string;
         path: string;
+        file: TFile | null;
         indentation: string;
         sectionStart: number;
         sectionIndex: number;
@@ -145,6 +150,7 @@ export class Task {
         this.status = status;
         this.description = description;
         this.path = path;
+        this.file = file;
         this.indentation = indentation;
         this.sectionStart = sectionStart;
         this.sectionIndex = sectionIndex;
@@ -185,6 +191,7 @@ export class Task {
             status: record.status,
             description: record.description,
             path: record.path,
+            file: record.file,
             indentation: record.indentation,
             sectionStart: record.sectionStart,
             sectionIndex: record.sectionIndex,
@@ -215,12 +222,14 @@ export class Task {
     public static fromLine({
         line,
         path,
+        file,
         sectionStart,
         sectionIndex,
         precedingHeader,
     }: {
         line: string;
         path: string;
+        file: TFile | null;
         sectionStart: number;
         sectionIndex: number;
         precedingHeader: string | null;
@@ -355,6 +364,7 @@ export class Task {
             status,
             description,
             path,
+            file,
             indentation,
             sectionStart,
             sectionIndex,
@@ -578,6 +588,7 @@ export class Task {
             status: this.status,
             description: this.description,
             path: this.path,
+            file: this.file,
             indentation: this.indentation,
             sectionStart: this.sectionStart,
             sectionIndex: this.sectionIndex,

tests/Query.test.ts

@@ -19,6 +19,7 @@ describe('Query', () => {
                     status: Status.TODO,
                     description: 'description',
                     path: 'Ab/C D',
+                    file: null,
                     indentation: '',
                     sectionStart: 0,
                     sectionIndex: 0,
@@ -36,6 +37,7 @@ describe('Query', () => {
                     status: Status.TODO,
                     description: 'description',
                     path: 'FF/C D',
+                    file: null,
                     indentation: '',
                     sectionStart: 0,
                     sectionIndex: 0,

tests/QueryX.test.ts

@@ -118,6 +118,7 @@ describe('QuerySql', () => {
                     status: Status.TODO,
                     description: 'description',
                     path: 'Ab/C D',
+                    file: null,
                     indentation: '',
                     sectionStart: 0,
                     sectionIndex: 0,
@@ -135,6 +136,7 @@ describe('QuerySql', () => {
                     status: Status.TODO,
                     description: 'description',
                     path: 'FF/C D',
+                    file: null,
                     indentation: '',
                     sectionStart: 0,
                     sectionIndex: 0,
@@ -166,6 +168,7 @@ describe('QuerySql', () => {
                     status: Status.TODO,
                     description: 'description',
                     path: 'Ab/C D',
+                    file: null,
                     indentation: '',
                     sectionStart: 0,
                     sectionIndex: 0,
@@ -183,6 +186,7 @@ describe('QuerySql', () => {
                     status: Status.DONE,
                     description: 'description',
                     path: 'FF/C D',
+                    file: null,
                     indentation: '',
                     sectionStart: 0,
                     sectionIndex: 0,

tests/StatusRegistry.test.ts

@@ -38,6 +38,7 @@ describe('StatusRegistry', () => {
         const task = Task.fromLine({
             line,
             path,
+            file: null,
             sectionStart,
             sectionIndex,
             precedingHeader,
@@ -71,6 +72,7 @@ describe('StatusRegistry', () => {
         const task = Task.fromLine({
             line,
             path,
+            file: null,
             sectionStart,
             sectionIndex,
             precedingHeader,
@@ -128,6 +130,7 @@ describe('StatusRegistry', () => {
         const task = Task.fromLine({
             line,
             path,
+            file: null,
             sectionStart,
             sectionIndex,
             precedingHeader,

tests/Task.test.ts

@@ -32,6 +32,7 @@ describe('parsing', () => {
         const task = Task.fromLine({
             line,
             path,
+            file: null,
             sectionStart,
             sectionIndex,
             precedingHeader,
@@ -61,6 +62,7 @@ describe('parsing', () => {
         const task = Task.fromLine({
             line,
             path,
+            file: null,
             sectionStart,
             sectionIndex,
             precedingHeader,
@@ -85,6 +87,7 @@ describe('parsing', () => {
         const task = Task.fromLine({
             line,
             path,
+            file: null,
             sectionStart,
             sectionIndex,
             precedingHeader,
@@ -112,6 +115,7 @@ describe('parsing', () => {
         const task = Task.fromLine({
             line,
             path,
+            file: null,
             sectionStart,
             sectionIndex,
             precedingHeader,
@@ -140,6 +144,7 @@ function constructTaskFromLine(line: string) {
     const task = Task.fromLine({
         line,
         path: 'file.md',
+        file: null,
         sectionStart: 0,
         sectionIndex: 0,
         precedingHeader: '',
@@ -267,6 +272,7 @@ describe('to string', () => {
         const task: Task = Task.fromLine({
             line,
             path: '',
+            file: null,
             sectionStart: 0,
             sectionIndex: 0,
             precedingHeader: '',
@@ -285,6 +291,7 @@ describe('to string', () => {
         const task: Task = Task.fromLine({
             line,
             path: '',
+            file: null,
             sectionStart: 0,
             sectionIndex: 0,
             precedingHeader: '',
@@ -360,6 +367,7 @@ describe('toggle done', () => {
         const task: Task = Task.fromLine({
             line,
             path: '',
+            file: null,
             sectionStart: 0,
             sectionIndex: 0,
             precedingHeader: '',
@@ -609,6 +617,7 @@ describe('toggle done', () => {
             const task = Task.fromLine({
                 line,
                 path: '',
+                file: null,
                 precedingHeader: '',
                 sectionStart: 0,
                 sectionIndex: 0,

tests/TestHelpers.ts

@@ -12,6 +12,7 @@ export function fromLine({
     return Task.fromLine({
         line,
         path,
+        file: null,
         precedingHeader,
         sectionIndex: 0,
         sectionStart: 0,
@@ -25,6 +26,7 @@ export function createTasksFromMarkdown(tasksAsMarkdown: string, path: string, p
         const task = Task.fromLine({
             line: line,
             path: path,
+            file: null,
             precedingHeader: precedingHeader,
             sectionIndex: 0,
             sectionStart: 0,

tests/TestingTools/FilterTestHelpers.ts

@@ -64,6 +64,7 @@ export function shouldSupportFiltering(
                 sectionStart: 0,
                 sectionIndex: 0,
                 path: '',
+                file: null,
                 precedingHeader: '',
             }) as Task,
     );

tests/TestingTools/TaskBuilder.ts

@@ -1,5 +1,6 @@
 // Builder
 import type { Moment } from 'moment';
+import type { TFile } from 'obsidian';
 import { StatusRegistry } from '../../src/StatusRegistry';
 import { Priority, Task } from '../../src/Task';
 import type { Recurrence } from '../../src/Recurrence';
@@ -22,6 +23,7 @@ export class TaskBuilder {
     private _status: Status = Status.TODO;
     private _description: string = 'my description';
     private _path: string = '';
+    private _file: TFile | null = null;
     private _indentation: string = '';
 
     private _sectionStart: number = 0;
@@ -64,6 +66,7 @@ export class TaskBuilder {
             status: this._status,
             description: this._description,
             path: this._path,
+            file: this._file,
             indentation: this._indentation,
             sectionStart: this._sectionStart,
             sectionIndex: this._sectionIndex,
@@ -98,6 +101,11 @@ export class TaskBuilder {
         return this;
     }
 
+    public file(file: TFile | null): TaskBuilder {
+        this._file = file;
+        return this;
+    }
+
     public indentation(indentation: string): TaskBuilder {
         this._indentation = indentation;
         return this;