refactor: - Rename Task.blockedBy to Task.dependsOn

This is to separate out the concepts of dependency and blocking.

Author: claremacrae

resources/sample_vaults/Tasks-Demo/Manual Testing/Dependencies Samples.md

@@ -7,7 +7,8 @@
 - [ ] #task Craft a conclusion 🆔 0wigip ⛔️ mvplec
 - [ ] #task Proofread and edit 🆔 5ti6bf ⛔️ 0wigip
 - [ ] #task Publish the article ⛔️ 5ti6bf
-- [ ] #task Do something on a different project
+- [ ] #task Do something on a different project 🆔 g2q2hg
+- [ ] #task sadfadfa ⛔️ g2q2hg
 
 ---
 

src/Commands/CreateOrEditTaskParser.ts

@@ -91,7 +91,7 @@ export const taskFromLine = ({ line, path }: { line: string; path: string }): Ta
             doneDate: null,
             cancelledDate: null,
             recurrence: null,
-            blockedBy: [],
+            dependsOn: [],
             id: '',
             blockLink: '',
             tags: [],
@@ -136,6 +136,6 @@ export const taskFromLine = ({ line, path }: { line: string; path: string }): Ta
         // Not needed since the inferred status is always re-computed after submitting.
         scheduledDateIsInferred: false,
         id: '',
-        blockedBy: [],
+        dependsOn: [],
     });
 };

src/Layout/TaskLayoutOptions.ts

@@ -8,7 +8,7 @@ export enum TaskLayoutComponent {
     // NEW_TASK_FIELD_EDIT_REQUIRED
     Description = 'description',
     Id = 'id',
-    DependsOn = 'blockedBy',
+    DependsOn = 'dependsOn',
     Priority = 'priority',
     RecurrenceRule = 'recurrenceRule',
     CreatedDate = 'createdDate',

src/Query/Filter/BlockedByField.ts

@@ -8,8 +8,8 @@ export class BlockedByField extends Field {
 
     constructor() {
         super();
-        this.filterInstructions.add('has blocked by', (task: Task) => task.blockedBy.length > 0);
-        this.filterInstructions.add('no blocked by', (task: Task) => task.blockedBy.length === 0);
+        this.filterInstructions.add('has blocked by', (task: Task) => task.dependsOn.length > 0);
+        this.filterInstructions.add('no blocked by', (task: Task) => task.dependsOn.length === 0);
     }
 
     // -----------------------------------------------------------------------------------------------------------------

src/Renderer/TaskFieldRenderer.ts

@@ -167,7 +167,7 @@ const taskFieldHTMLData: { [c in TaskLayoutComponent]: TaskFieldHTMLData } = {
 
     description: createFieldWithoutDataAttributes('task-description'),
     recurrenceRule: createFieldWithoutDataAttributes('task-recurring'),
-    blockedBy: createFieldWithoutDataAttributes('task-blockedBy'),
+    dependsOn: createFieldWithoutDataAttributes('task-blockedBy'),
     id: createFieldWithoutDataAttributes('task-id'),
     blockLink: createFieldWithoutDataAttributes('task-block-link'),
 };

src/Task/Task.ts

@@ -59,7 +59,7 @@ export class Task {
 
     public readonly recurrence: Recurrence | null;
 
-    public readonly blockedBy: string[];
+    public readonly dependsOn: string[];
     public readonly id: string;
 
     /** The blockLink is a "^" annotation after the dates/recurrence rules.
@@ -91,7 +91,7 @@ export class Task {
         doneDate,
         cancelledDate,
         recurrence,
-        blockedBy,
+        dependsOn,
         id,
         blockLink,
         tags,
@@ -112,7 +112,7 @@ export class Task {
         doneDate: moment.Moment | null;
         cancelledDate: moment.Moment | null;
         recurrence: Recurrence | null;
-        blockedBy: string[] | [];
+        dependsOn: string[] | [];
         id: string;
         blockLink: string;
         tags: string[] | [];
@@ -139,7 +139,7 @@ export class Task {
 
         this.recurrence = recurrence;
 
-        this.blockedBy = blockedBy;
+        this.dependsOn = dependsOn;
         this.id = id;
 
         this.blockLink = blockLink;
@@ -458,15 +458,15 @@ export class Task {
      * @param allTasks - all the tasks in the vault. In custom queries, this is available via query.allTasks.
      */
     public isBlocked(allTasks: Readonly<Task[]>) {
-        if (this.blockedBy.length === 0) {
+        if (this.dependsOn.length === 0) {
             return false;
         }
 
         if (this.isDone) {
             return false;
         }
 
-        for (const depId of this.blockedBy) {
+        for (const depId of this.dependsOn) {
             const depTask = allTasks.find((task) => task.id === depId && !task.isDone);
             if (!depTask) {
                 // There is no not-done task with this id.
@@ -481,7 +481,7 @@ export class Task {
     }
 
     /**
-     * A Task is blocking if there is any other not-done task blockedBy value with its id.
+     * A Task is blocking if there is any other not-done task dependsOn value with its id.
      *
      * 'Done' tasks (with status DONE, CANCELLED or NON_TASK) are never blocking.
      * Only direct dependencies are considered.
@@ -501,7 +501,7 @@ export class Task {
                 return false;
             }
 
-            return task.blockedBy.includes(this.id);
+            return task.dependsOn.includes(this.id);
         });
     }
 
@@ -784,7 +784,7 @@ export class Task {
             'blockLink',
             'scheduledDateIsInferred',
             'id',
-            'blockedBy',
+            'dependsOn',
         ];
         for (const el of args) {
             if (this[el]?.toString() !== other[el]?.toString()) return false;
@@ -861,15 +861,15 @@ export class Task {
  * @param allTasks
  */
 export function isBlocked(thisTask: Task, allTasks: Task[]) {
-    if (thisTask.blockedBy.length === 0) {
+    if (thisTask.dependsOn.length === 0) {
         return false;
     }
 
     if (thisTask.isDone) {
         return false;
     }
 
-    for (const depId of thisTask.blockedBy) {
+    for (const depId of thisTask.dependsOn) {
         const depTask = allTasks.find((task) => task.id === depId && !task.isDone);
         if (!depTask) {
             // There is no not-done task with this id.

src/Task/TaskDependency.ts

@@ -28,18 +28,18 @@ export function setDependenciesOnTasksWithIds(parent: Task, childrenWithIds: Tas
         return task.id;
     });
     let newParent = parent;
-    if (parent.blockedBy.toString() !== newBlockedBy.toString()) {
-        newParent = new Task({ ...parent, blockedBy: newBlockedBy });
+    if (parent.dependsOn.toString() !== newBlockedBy.toString()) {
+        newParent = new Task({ ...parent, dependsOn: newBlockedBy });
     }
 
     return newParent;
 }
 
 export function addDependencyToParent(parent: Task, child: Task) {
     let newParent = parent;
-    if (!parent.blockedBy.includes(child.id)) {
-        const newBlockedBy = [...parent.blockedBy, child.id];
-        newParent = new Task({ ...parent, blockedBy: newBlockedBy });
+    if (!parent.dependsOn.includes(child.id)) {
+        const newBlockedBy = [...parent.dependsOn, child.id];
+        newParent = new Task({ ...parent, dependsOn: newBlockedBy });
     }
     return newParent;
 }
@@ -52,9 +52,9 @@ export function addDependency(parent: Task, child: Task, existingIds: string[])
 
 export function removeDependency(parent: Task, child: Task) {
     let newParent = parent;
-    if (parent.blockedBy.includes(child.id)) {
-        const newBlockedBy = parent.blockedBy.filter((blockedBy) => blockedBy !== child.id);
-        newParent = new Task({ ...parent, blockedBy: newBlockedBy });
+    if (parent.dependsOn.includes(child.id)) {
+        const newBlockedBy = parent.dependsOn.filter((blockedBy) => blockedBy !== child.id);
+        newParent = new Task({ ...parent, dependsOn: newBlockedBy });
     }
 
     return newParent;

src/TaskSerializer/DefaultTaskSerializer.ts

@@ -171,8 +171,8 @@ export class DefaultTaskSerializer implements TaskSerializer {
                 if (!task.recurrence) return '';
                 return symbolAndStringValue(shortMode, recurrenceSymbol, task.recurrence.toText());
             case TaskLayoutComponent.DependsOn: {
-                if (task.blockedBy.length === 0) return '';
-                return symbolAndStringValue(shortMode, dependsOnSymbol, task.blockedBy.join(','));
+                if (task.dependsOn.length === 0) return '';
+                return symbolAndStringValue(shortMode, dependsOnSymbol, task.dependsOn.join(','));
             }
             case TaskLayoutComponent.Id:
                 return symbolAndStringValue(shortMode, idSymbol, task.id);
@@ -364,7 +364,7 @@ export class DefaultTaskSerializer implements TaskSerializer {
             cancelledDate,
             recurrence,
             id,
-            blockedBy: dependsOn,
+            dependsOn,
             tags: Task.extractHashtags(line),
         };
     }

src/TaskSerializer/index.ts

@@ -21,7 +21,7 @@ export type TaskDetails = Writeable<
         | 'doneDate'
         | 'cancelledDate'
         | 'recurrence'
-        | 'blockedBy'
+        | 'dependsOn'
         | 'id'
         | 'tags'
     >

src/ui/EditTask.svelte

@@ -301,15 +301,15 @@
 
         const blockedBy: Task[] = [];
 
-        for (const taskId of task.blockedBy) {
+        for (const taskId of task.dependsOn) {
             const depTask = allTasks.find(cacheTask => cacheTask.id === taskId);
 
             if (!depTask) continue;
 
             blockedBy.push(depTask);
         }
 
-        originalBlocking = allTasks.filter(cacheTask => cacheTask.blockedBy.includes(task.id));
+        originalBlocking = allTasks.filter(cacheTask => cacheTask.dependsOn.includes(task.id));
 
         editableTask = {
             // NEW_TASK_FIELD_EDIT_REQUIRED
@@ -443,7 +443,7 @@
             doneDate,
             createdDate,
             cancelledDate,
-            blockedBy: blockedByWithIds.map(task => task.id),
+            dependsOn: blockedByWithIds.map(task => task.id),
             id
         });