fix: Show tasks completion on document list items (#2342)

Co-authored-by: Tom Moor <tom.moor@gmail.com>

server/models/Document.js

@@ -6,6 +6,7 @@ import Sequelize, { Transaction } from "sequelize";
 import MarkdownSerializer from "slate-md-serializer";
 import isUUID from "validator/lib/isUUID";
 import { MAX_TITLE_LENGTH } from "../../shared/constants";
+import getTasks from "../../shared/utils/getTasks";
 import parseTitle from "../../shared/utils/parseTitle";
 import { SLUG_URL_REGEX } from "../../shared/utils/routeHelpers";
 import unescape from "../../shared/utils/unescape";
@@ -106,6 +107,9 @@ const Document = sequelize.define(
         const slugifiedTitle = slugify(this.title);
         return `/doc/${slugifiedTitle}-${this.urlId}`;
       },
+      tasks: function () {
+        return getTasks(this.text || "");
+      },
     },
   }
 );

server/models/Document.test.js

@@ -430,3 +430,79 @@ describe("#findByPk", () => {
     expect(response.id).toBe(document.id);
   });
 });
+
+describe("tasks", () => {
+  test("should consider all the possible checkTtems", async () => {
+    const document = await buildDocument({
+      text: `- [x] test
+      - [X] test
+      - [ ] test
+      - [-] test
+      - [_] test`,
+    });
+
+    const tasks = document.tasks;
+
+    expect(tasks.completed).toBe(4);
+    expect(tasks.total).toBe(5);
+  });
+
+  test("should return tasks keys set to 0 if checkItems isn't present", async () => {
+    const document = await buildDocument({
+      text: `text`,
+    });
+
+    const tasks = document.tasks;
+
+    expect(tasks.completed).toBe(0);
+    expect(tasks.total).toBe(0);
+  });
+
+  test("should return tasks keys set to 0 if the text contains broken checkItems", async () => {
+    const document = await buildDocument({
+      text: `- [x ] test
+      - [ x ] test
+      - [  ] test`,
+    });
+
+    const tasks = document.tasks;
+
+    expect(tasks.completed).toBe(0);
+    expect(tasks.total).toBe(0);
+  });
+
+  test("should return tasks", async () => {
+    const document = await buildDocument({
+      text: `- [x] list item
+      - [ ] list item`,
+    });
+
+    const tasks = document.tasks;
+
+    expect(tasks.completed).toBe(1);
+    expect(tasks.total).toBe(2);
+  });
+
+  test("should update tasks on save", async () => {
+    const document = await buildDocument({
+      text: `- [x] list item
+      - [ ] list item`,
+    });
+
+    const tasks = document.tasks;
+
+    expect(tasks.completed).toBe(1);
+    expect(tasks.total).toBe(2);
+
+    document.text = `- [x] list item
+    - [ ] list item
+    - [ ] list item`;
+
+    await document.save();
+
+    const newTasks = document.tasks;
+
+    expect(newTasks.completed).toBe(1);
+    expect(newTasks.total).toBe(3);
+  });
+});