feat: Allow task components (due, priority etc) and tags in almost any order (#850)

* Allow loose order: tags, recurrence and other task components can now be in an arbitrary order

* Code Review fixes

Author: esm7

src/Task.ts

@@ -109,6 +109,9 @@ export class Task {
     // description: '#dog #car http://www/ddd#ere #house'
     // matches: #dog, #car, #house
     public static readonly hashTags = /(^|\s)#[^ !@#$%^&*(),.?":{}|<>]*/g;
+    public static readonly hashTagsFromEnd = new RegExp(
+        this.hashTags.source + '$',
+    );
 
     private _urgency: number | null = null;
 
@@ -242,10 +245,16 @@ export class Task {
         let scheduledDate: Moment | null = null;
         let dueDate: Moment | null = null;
         let doneDate: Moment | null = null;
+        let recurrenceRule: string = '';
         let recurrence: Recurrence | null = null;
         let tags: any = [];
+        // Tags that are removed from the end while parsing, but we want to add them back for being part of the description.
+        // In the original task description they are possibly mixed with other components
+        // (e.g. #tag1 <due date> #tag2), they do not have to all trail all task components,
+        // but eventually we want to paste them back to the task description at the end
+        let trailingTags = '';
         // Add a "max runs" failsafe to never end in an endless loop:
-        const maxRuns = 7;
+        const maxRuns = 20;
         let runs = 0;
         do {
             matched = false;
@@ -310,22 +319,51 @@ export class Task {
 
             const recurrenceMatch = description.match(Task.recurrenceRegex);
             if (recurrenceMatch !== null) {
-                recurrence = Recurrence.fromText({
-                    recurrenceRuleText: recurrenceMatch[1].trim(),
-                    startDate,
-                    scheduledDate,
-                    dueDate,
-                });
-
+                // Save the recurrence rule, but *do not parse it yet*.
+                // Creating the Recurrence object requires a reference date (e.g. a due date),
+                // and it might appear in the next (earlier in the line) tokens to parse
+                recurrenceRule = recurrenceMatch[1].trim();
                 description = description
                     .replace(Task.recurrenceRegex, '')
                     .trim();
                 matched = true;
             }
 
+            // Match tags from the end to allow users to mix the various task components with
+            // tags. These tags will be added back to the description below
+            const tagsMatch = description.match(Task.hashTagsFromEnd);
+            if (tagsMatch != null) {
+                description = description
+                    .replace(Task.hashTagsFromEnd, '')
+                    .trim();
+                matched = true;
+                const tagName = tagsMatch[0].trim();
+                // Adding to the left because the matching is done right-to-left
+                trailingTags =
+                    trailingTags.length > 0
+                        ? [tagName, trailingTags].join(' ')
+                        : tagName;
+            }
+
             runs++;
         } while (matched && runs <= maxRuns);
 
+        // Now that we have all the task details, parse the recurrence rule if we found any
+        if (recurrenceRule.length > 0) {
+            recurrence = Recurrence.fromText({
+                recurrenceRuleText: recurrenceRule,
+                startDate,
+                scheduledDate,
+                dueDate,
+            });
+        }
+
+        // Add back any trailing tags to the description. We removed them so we can parse the rest of the
+        // components but now we want them back.
+        // The goal is for a task of them form 'Do something #tag1 (due) tomorrow #tag2 (start) today'
+        // to actually have the description 'Do something #tag1 #tag2'
+        if (trailingTags.length > 0) description += ' ' + trailingTags;
+
         // Tags are found in the string and pulled out but not removed,
         // so when returning the entire task it will match what the user
         // entered.

tests/Task.test.ts

@@ -2,8 +2,9 @@
  * @jest-environment jsdom
  */
 import moment from 'moment';
-import { Status, Task } from '../src/Task';
+import { Priority, Status, Task } from '../src/Task';
 import { getSettings, updateSettings } from '../src/config/Settings';
+import { fromLine } from './TestHelpers';
 
 jest.mock('obsidian');
 window.moment = moment;
@@ -129,6 +130,30 @@ describe('parsing', () => {
         ).toStrictEqual(true);
         expect(task!.blockLink).toEqual(' ^my-precious');
     });
+
+    it('supports tag anywhere in the description and separates them correctly from signifier emojis', () => {
+        // Arrange
+        const line =
+            '- [ ] this is a task due 📅 2021-09-12 #inside_tag ⏫ #some/tags_with_underscore';
+
+        // Act
+        const task = fromLine({
+            line,
+        });
+
+        // Assert
+        expect(task).not.toBeNull();
+        expect(task!.description).toEqual(
+            'this is a task due #inside_tag #some/tags_with_underscore',
+        );
+        expect(task!.tags).toEqual([
+            '#inside_tag',
+            '#some/tags_with_underscore',
+        ]);
+        expect(task!.dueDate).not.toBeNull();
+        expect(task!.dueDate!.isSame(moment('2021-09-12', 'YYYY-MM-DD')));
+        expect(task!.priority == Priority.High);
+    });
 });
 
 type TagParsingExpectations = {
@@ -153,9 +178,10 @@ describe('parsing tags', () => {
     test.each<TagParsingExpectations>([
         {
             markdownTask:
-                '- [x] this is a done task #tagone 🗓 2021-09-12 ✅ 2021-06-20',
-            expectedDescription: 'this is a done task #tagone',
-            extractedTags: ['#tagone'],
+                '- [x] this is a done task #tagone 🗓 2021-09-12 #another-tag ✅ 2021-06-20 #and_another',
+            expectedDescription:
+                'this is a done task #tagone #another-tag #and_another',
+            extractedTags: ['#tagone', '#another-tag', '#and_another'],
             globalFilter: '',
         },
         {
@@ -214,10 +240,10 @@ describe('parsing tags', () => {
         },
         {
             markdownTask:
-                '- [ ] #someglobaltasktag this is a normal task #tagone #tagtwo 🗓 2021-09-12 ✅ 2021-06-20',
+                '- [ ] #someglobaltasktag this is a normal task #tagone #tagtwo 🗓 2021-09-12 #tagthree ✅ 2021-06-20 #tagfour',
             expectedDescription:
-                '#someglobaltasktag this is a normal task #tagone #tagtwo',
-            extractedTags: ['#tagone', '#tagtwo'],
+                '#someglobaltasktag this is a normal task #tagone #tagtwo #tagthree #tagfour',
+            extractedTags: ['#tagone', '#tagtwo', '#tagthree', '#tagfour'],
             globalFilter: '#someglobaltasktag',
         },
         {
@@ -230,10 +256,18 @@ describe('parsing tags', () => {
         },
         {
             markdownTask:
-                '- [ ] Export [Cloud Feedly feeds](http://cloud.feedly.com/#opml) #context/pc_clare 🔁 every 4 weeks on Sunday ⏳ 2022-05-15',
+                '- [ ] Export [Cloud Feedly feeds](http://cloud.feedly.com/#opml) #context/pc_clare 🔁 every 4 weeks on Sunday ⏳ 2022-05-15 #context/more_context',
             expectedDescription:
-                'Export [Cloud Feedly feeds](http://cloud.feedly.com/#opml) #context/pc_clare',
-            extractedTags: ['#context/pc_clare'],
+                'Export [Cloud Feedly feeds](http://cloud.feedly.com/#opml) #context/pc_clare #context/more_context',
+            extractedTags: ['#context/pc_clare', '#context/more_context'],
+            globalFilter: '',
+        },
+        {
+            markdownTask:
+                '- [ ] Export [Cloud Feedly feeds](http://cloud.feedly.com/#opml) #context/pc_clare ⏳ 2022-05-15 🔁 every 4 weeks on Sunday #context/more_context',
+            expectedDescription:
+                'Export [Cloud Feedly feeds](http://cloud.feedly.com/#opml) #context/pc_clare #context/more_context',
+            extractedTags: ['#context/pc_clare', '#context/more_context'],
             globalFilter: '',
         },
         {
@@ -296,7 +330,7 @@ describe('to string', () => {
     it('retains the tags', () => {
         // Arrange
         const line =
-            '- [x] this is a done task #tagone #journal/daily 📅 2021-09-12 ✅ 2021-06-20';
+            '- [x] this is a done task #tagone 📅 2021-09-12 ✅ 2021-06-20 #journal/daily';
 
         // Act
         const task: Task = Task.fromLine({
@@ -308,7 +342,9 @@ describe('to string', () => {
         }) as Task;
 
         // Assert
-        expect(task.toFileLineString()).toStrictEqual(line);
+        const expectedLine =
+            '- [x] this is a done task #tagone #journal/daily 📅 2021-09-12 ✅ 2021-06-20';
+        expect(task.toFileLineString()).toStrictEqual(expectedLine);
     });
 });
 
@@ -603,4 +639,74 @@ describe('toggle done', () => {
             todaySpy.mockClear();
         },
     );
+
+    it('supports recurrence rule after a due date', () => {
+        // Arrange
+        const line = '- [ ] this is a task 🗓 2021-09-12 🔁 every day';
+        const path = 'this/is a path/to a/file.md';
+        const sectionStart = 1337;
+        const sectionIndex = 1209;
+        const precedingHeader = 'Eloquent Section';
+
+        // Act
+        const task = Task.fromLine({
+            line,
+            path,
+            sectionStart,
+            sectionIndex,
+            precedingHeader,
+        });
+
+        // Assert
+        expect(task).not.toBeNull();
+        expect(task!.dueDate).not.toBeNull();
+        expect(
+            task!.dueDate!.isSame(moment('2021-09-12', 'YYYY-MM-DD')),
+        ).toStrictEqual(true);
+
+        const nextTask: Task = task!.toggle()[0];
+        expect({
+            nextDue: nextTask.dueDate?.format('YYYY-MM-DD'),
+            nextScheduled: nextTask.scheduledDate?.format('YYYY-MM-DD'),
+            nextStart: nextTask.startDate?.format('YYYY-MM-DD'),
+        }).toMatchObject({
+            nextDue: '2021-09-13',
+            nextScheduled: undefined,
+            nextStart: undefined,
+        });
+    });
+
+    it('supports parsing large number of values', () => {
+        // Arrange
+        const line =
+            '- [ ] Wobble ⏫  #tag1 ✅ 2022-07-02 #tag2  📅 2022-07-02 #tag3 ⏳ 2022-07-02 #tag4 🛫 2022-07-02 #tag5  🔁 every day  #tag6 #tag7 #tag8 #tag9 #tag10';
+
+        // Act
+        const task = fromLine({
+            line,
+        });
+
+        // Assert
+        expect(task).not.toBeNull();
+        expect(task!.description).toEqual(
+            'Wobble #tag1 #tag2 #tag3 #tag4 #tag5 #tag6 #tag7 #tag8 #tag9 #tag10',
+        );
+        expect(task!.dueDate!.isSame(moment('022-07-02', 'YYYY-MM-DD')));
+        expect(task!.doneDate!.isSame(moment('022-07-02', 'YYYY-MM-DD')));
+        expect(task!.startDate!.isSame(moment('022-07-02', 'YYYY-MM-DD')));
+        expect(task!.scheduledDate!.isSame(moment('022-07-02', 'YYYY-MM-DD')));
+        expect(task!.priority == Priority.High);
+        expect(task!.tags).toStrictEqual([
+            '#tag1',
+            '#tag2',
+            '#tag3',
+            '#tag4',
+            '#tag5',
+            '#tag6',
+            '#tag7',
+            '#tag8',
+            '#tag9',
+            '#tag10',
+        ]);
+    });
 });