generated from obsidianmd/obsidian-sample-plugin
-
-
Notifications
You must be signed in to change notification settings - Fork 243
/
Copy pathTask.test.ts
1307 lines (1187 loc) · 46 KB
/
Task.test.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* @jest-environment jsdom
*/
import moment from 'moment';
import type { Moment } from 'moment';
import { Status } from '../src/Status';
import { Priority, Task } from '../src/Task';
import { resetSettings, updateSettings } from '../src/Config/Settings';
import type { StatusCollection } from '../src/StatusCollection';
import { StatusRegistry } from '../src/StatusRegistry';
import { TaskLocation } from '../src/TaskLocation';
import { fromLine } from './TestHelpers';
import { TaskBuilder } from './TestingTools/TaskBuilder';
import { RecurrenceBuilder } from './TestingTools/RecurrenceBuilder';
jest.mock('obsidian');
window.moment = moment;
describe('parsing', () => {
it('parses a task from a line starting with hyphen', () => {
// Arrange
const line = '- [x] this is a done task 🗓 2021-09-12 ✅ 2021-06-20';
// Act
const task = fromLine({
line,
});
// Assert
expect(task).not.toBeNull();
expect(task!.listMarker).toEqual('-');
expect(task!.description).toEqual('this is a done task');
expect(task!.status).toStrictEqual(Status.DONE);
expect(task!.dueDate).not.toBeNull();
expect(task!.dueDate!.isSame(moment('2021-09-12', 'YYYY-MM-DD'))).toStrictEqual(true);
expect(task!.doneDate).not.toBeNull();
expect(task!.doneDate!.isSame(moment('2021-06-20', 'YYYY-MM-DD'))).toStrictEqual(true);
expect(task!.originalMarkdown).toStrictEqual(line);
expect(task!.lineNumber).toEqual(0);
});
it('parses a task from a line starting with asterisk', () => {
// Arrange
const line = '* [ ] this is a task in asterisk list';
// Act
const task = fromLine({
line,
});
// Assert
expect(task).not.toBeNull();
expect(task!.listMarker).toEqual('*');
expect(task!.originalMarkdown).toStrictEqual(line);
});
it('parses a task from a line (numbered)', () => {
// Arrange
const line = '1. [x] this is a done task';
// Act
const task = fromLine({
line,
});
// Assert
expect(task).not.toBeNull();
expect(task!.listMarker).toEqual('1.');
expect(task!.description).toEqual('this is a done task');
expect(task!.status).toStrictEqual(Status.DONE);
expect(task!.originalMarkdown).toStrictEqual(line);
});
it('parses a task from a line (big number)', () => {
// Arrange
const line = '909999. [ ] this is a todo task';
// Act
const task = fromLine({
line,
});
// Assert
expect(task).not.toBeNull();
expect(task!.listMarker).toEqual('909999.');
expect(task!.description).toEqual('this is a todo task');
expect(task!.status).toStrictEqual(Status.TODO);
expect(task!.originalMarkdown).toStrictEqual(line);
});
it('returns null when task does not have global filter', () => {
// Arrange
updateSettings({ globalFilter: '#task' });
const line = '- [x] this is a done task 🗓 2021-09-12 ✅ 2021-06-20';
// Act
const task = fromLine({
line,
});
// Assert
expect(task).toBeNull();
// Cleanup
resetSettings();
});
it('supports capitalised status characters', () => {
// See https://github.com/obsidian-tasks-group/obsidian-tasks/issues/520
// "In combination with SlrVb's S-Checkbox CSS, Task Plugin breaks that style"
// Act
const task = fromLine({ line: '- [D] this is a deferred task' });
// Assert
expect(task!.status.symbol).toStrictEqual('D');
});
it('allows signifier emojis as part of the description', () => {
// Arrange
const line = '- [x] this is a ✅ done task 🗓 2021-09-12 ✅ 2021-06-20';
// Act
const task = fromLine({
line,
});
// Assert
expect(task).not.toBeNull();
expect(task!.description).toEqual('this is a ✅ done task');
expect(task!.status).toStrictEqual(Status.DONE);
expect(task!.dueDate).not.toBeNull();
expect(task!.dueDate!.isSame(moment('2021-09-12', 'YYYY-MM-DD'))).toStrictEqual(true);
expect(task!.doneDate).not.toBeNull();
expect(task!.doneDate!.isSame(moment('2021-06-20', 'YYYY-MM-DD'))).toStrictEqual(true);
});
it('also works with block links and trailing spaces', () => {
// Arrange
const line = '- [x] this is a ✅ done task 🗓 2021-09-12 ✅ 2021-06-20 ^my-precious ';
// Act
const task = fromLine({
line,
});
// Assert
expect(task).not.toBeNull();
expect(task!.description).toEqual('this is a ✅ done task');
expect(task!.status).toStrictEqual(Status.DONE);
expect(task!.dueDate).not.toBeNull();
expect(task!.dueDate!.isSame(moment('2021-09-12', 'YYYY-MM-DD'))).toStrictEqual(true);
expect(task!.doneDate).not.toBeNull();
expect(task!.doneDate!.isSame(moment('2021-06-20', 'YYYY-MM-DD'))).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);
});
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',
]);
});
it('supports parsing of emojis with multiple spaces', () => {
// Arrange
const lines = [
'- [ ] Wobble ✅2022-07-01 📅2022-07-02 ⏳2022-07-03 🛫2022-07-04 🔁every day',
'- [ ] Wobble ✅ 2022-07-01 📅 2022-07-02 ⏳ 2022-07-03 🛫 2022-07-04 🔁 every day',
'- [ ] Wobble ✅ 2022-07-01 📅 2022-07-02 ⏳ 2022-07-03 🛫 2022-07-04 🔁 every day',
];
// Act
for (const line of lines) {
const task = fromLine({
line,
});
// Assert
expect({
_input: line, // Line is included, so it is shown in any failure output
description: task.description,
done: task.doneDate?.format('YYYY-MM-DD'),
due: task.dueDate?.format('YYYY-MM-DD'),
scheduled: task.scheduledDate?.format('YYYY-MM-DD'),
start: task.startDate?.format('YYYY-MM-DD'),
priority: task.priority,
recurrence: task.recurrence?.toText(),
}).toMatchObject({
_input: line,
description: 'Wobble',
done: '2022-07-01',
due: '2022-07-02',
scheduled: '2022-07-03',
start: '2022-07-04',
priority: '3',
recurrence: 'every day',
});
}
});
it('supports parsing of tasks inside blockquotes or callouts', () => {
// Arrange
const lines = [
'> - [ ] Task inside a blockquote or callout 📅2022-07-29',
'>>> - [ ] Task inside a blockquote or callout 📅2022-07-29',
'> > > * [ ] Task inside a blockquote or callout 📅2022-07-29',
];
// Act
for (const line of lines) {
const task = fromLine({
line,
});
// Assert
expect({
_input: line, // Line is included, so it is shown in any failure output
description: task.description,
due: task.dueDate?.format('YYYY-MM-DD'),
indentation: task.indentation,
}).toMatchObject({
_input: line,
description: 'Task inside a blockquote or callout',
due: '2022-07-29',
indentation: line.split(/[-*]/)[0],
});
}
});
});
type TagParsingExpectations = {
markdownTask: string;
expectedDescription: string;
extractedTags: string[];
globalFilter: string;
};
function constructTaskFromLine(line: string, path: string = 'file.md', fallbackDate: Moment | null = null) {
return Task.fromLine({
line,
taskLocation: TaskLocation.fromUnknownPosition(path),
fallbackDate,
});
}
describe('parsing tags', () => {
test.each<TagParsingExpectations>([
{
markdownTask: '- [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: '',
},
{
markdownTask: '- [x] this is a done task #tagone #tagtwo 🗓 2021-09-12 ✅ 2021-06-20',
expectedDescription: 'this is a done task #tagone #tagtwo',
extractedTags: ['#tagone', '#tagtwo'],
globalFilter: '',
},
{
markdownTask: '- [ ] this is a normal task #tagone 🗓 2021-09-12 ✅ 2021-06-20',
expectedDescription: 'this is a normal task #tagone',
extractedTags: ['#tagone'],
globalFilter: '',
},
{
markdownTask: '- [ ] this is a normal task #tagone #tagtwo 🗓 2021-09-12 ✅ 2021-06-20',
expectedDescription: 'this is a normal task #tagone #tagtwo',
extractedTags: ['#tagone', '#tagtwo'],
globalFilter: '',
},
{
markdownTask: '- [ ] this is a normal task #tagone #tag/with/depth #tagtwo 🗓 2021-09-12 ✅ 2021-06-20',
expectedDescription: 'this is a normal task #tagone #tag/with/depth #tagtwo',
extractedTags: ['#tagone', '#tag/with/depth', '#tagtwo'],
globalFilter: '',
},
{
markdownTask: '- [x] #someglobaltasktag this is a done task #tagone 🗓 2021-09-12 ✅ 2021-06-20',
expectedDescription: '#someglobaltasktag this is a done task #tagone',
extractedTags: ['#tagone'],
globalFilter: '#someglobaltasktag',
},
{
markdownTask: '- [x] #someglobaltasktag this is a done task #tagone #tagtwo 🗓 2021-09-12 ✅ 2021-06-20',
expectedDescription: '#someglobaltasktag this is a done task #tagone #tagtwo',
extractedTags: ['#tagone', '#tagtwo'],
globalFilter: '#someglobaltasktag',
},
{
markdownTask: '- [ ] #someglobaltasktag this is a normal task #tagone 🗓 2021-09-12 ✅ 2021-06-20',
expectedDescription: '#someglobaltasktag this is a normal task #tagone',
extractedTags: ['#tagone'],
globalFilter: '#someglobaltasktag',
},
{
markdownTask:
'- [ ] #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 #tagthree #tagfour',
extractedTags: ['#tagone', '#tagtwo', '#tagthree', '#tagfour'],
globalFilter: '#someglobaltasktag',
},
{
markdownTask:
'- [ ] #someglobaltasktag this is a normal task #tagone #tag/with/depth #tagtwo 🗓 2021-09-12 ✅ 2021-06-20',
expectedDescription: '#someglobaltasktag this is a normal task #tagone #tag/with/depth #tagtwo',
extractedTags: ['#tagone', '#tag/with/depth', '#tagtwo'],
globalFilter: '#someglobaltasktag',
},
{
markdownTask:
'* [ ] Export [Cloud Feedly feeds](https://cloud.feedly.com/#opml) #context/pc_clare 🔁 every 4 weeks on Sunday ⏳ 2022-05-15 #context/more_context',
expectedDescription:
'Export [Cloud Feedly feeds](https://cloud.feedly.com/#opml) #context/pc_clare #context/more_context',
extractedTags: ['#context/pc_clare', '#context/more_context'],
globalFilter: '',
},
{
markdownTask:
'- [ ] Export [Cloud Feedly feeds](https://cloud.feedly.com/#opml) #context/pc_clare ⏳ 2022-05-15 🔁 every 4 weeks on Sunday #context/more_context',
expectedDescription:
'Export [Cloud Feedly feeds](https://cloud.feedly.com/#opml) #context/pc_clare #context/more_context',
extractedTags: ['#context/pc_clare', '#context/more_context'],
globalFilter: '',
},
{
markdownTask:
'- [ ] Review [savings accounts and interest rates](https://www.moneysavingexpert.com/tips/2022/04/20/#hiya) #context/pc_clare ⏳ 2022-05-06',
expectedDescription:
'Review [savings accounts and interest rates](https://www.moneysavingexpert.com/tips/2022/04/20/#hiya) #context/pc_clare',
extractedTags: ['#context/pc_clare'],
globalFilter: '',
},
{
markdownTask: '> - [ ] Task inside a blockquote or callout #tagone',
expectedDescription: 'Task inside a blockquote or callout #tagone',
extractedTags: ['#tagone'],
globalFilter: '',
},
{
markdownTask: '>>> * [ ] Task inside a nested blockquote or callout #tagone',
expectedDescription: 'Task inside a nested blockquote or callout #tagone',
extractedTags: ['#tagone'],
globalFilter: '',
},
])(
'should parse "$markdownTask" and extract "$extractedTags"',
({ markdownTask, expectedDescription, extractedTags, globalFilter }) => {
// Arrange
if (globalFilter != '') {
updateSettings({ globalFilter: globalFilter });
}
// Act
const task = constructTaskFromLine(markdownTask);
// Assert
expect(task).not.toBeNull();
expect(task!.description).toEqual(expectedDescription);
expect(task!.tags).toStrictEqual(extractedTags);
// Cleanup
if (globalFilter != '') {
resetSettings();
}
},
);
});
describe('to string', () => {
it('retains the indentation', () => {
const line = '> > > - [ ] Task inside a nested blockquote or callout';
// Act
const task: Task = fromLine({
line,
}) as Task;
// Assert
expect(task).not.toBeNull();
expect(task.toFileLineString()).toStrictEqual(line);
});
it('retains the asterisk', () => {
const task = new TaskBuilder().listMarker('*').build();
expect(task.toFileLineString()).toStrictEqual('* [ ] my description');
});
it('retains the block link', () => {
// Arrange
const line = '- [ ] this is a task 📅 2021-09-12 ^my-precious';
// Act
const task: Task = fromLine({
line,
}) as Task;
// Assert
expect(task).not.toBeNull();
expect(task.toFileLineString()).toStrictEqual(line);
});
it('retains the tags', () => {
// Arrange
const line = '- [x] this is a done task #tagone 📅 2021-09-12 ✅ 2021-06-20 #journal/daily';
// Act
const task: Task = fromLine({
line,
}) as Task;
// Assert
const expectedLine = '- [x] this is a done task #tagone #journal/daily 📅 2021-09-12 ✅ 2021-06-20';
expect(task.toFileLineString()).toStrictEqual(expectedLine);
});
});
describe('toggle done', () => {
beforeAll(() => {
const statuses: StatusCollection = [
// A custom set of 3 statuses that form a cycle.
// The last one has a conventional symbol, 'X' that is recognised as DONE.fix
['!', 'Important', 'D', 'TODO'],
['D', 'Doing - Important', 'X', 'IN_PROGRESS'],
['X', 'Done - Important', '!', 'DONE'],
// A set that uses an unconventional symbol for DONE
['1', 'Status 1', '2', 'TODO'],
['2', 'Status 2', '3', 'IN_PROGRESS'],
['3', 'Status 3', '1', 'DONE'],
// A set where the DONE task goes to an unknown symbol
['a', 'Status a', 'b', 'TODO'],
['b', 'Status b', 'c', 'DONE'], // c is not known
];
statuses.forEach((s) => {
StatusRegistry.getInstance().add(Status.createFromImportedValue(s));
});
});
afterAll(() => {
StatusRegistry.getInstance().resetToDefaultStatuses();
});
it('retains the block link', () => {
// Arrange
const line = '- [ ] this is a task 📅 2021-09-12 ^my-precious';
// Act
const task: Task = fromLine({
line,
}) as Task;
const tasks = task.toggle();
expect(tasks.length).toEqual(1);
const toggled: Task = tasks[0];
// Assert
expect(toggled).not.toBeNull();
expect(toggled!.status).toStrictEqual(Status.DONE);
expect(toggled!.doneDate).not.toBeNull();
expect(toggled!.status.symbol).toStrictEqual('x');
expect(toggled!.blockLink).toEqual(' ^my-precious');
});
it('removes done date after untoggle', () => {
// Arrange
const line = '- [x] I thought I finished ✅ 2021-09-12';
// Act
const task: Task = fromLine({
line,
}) as Task;
const tasks = task.toggle();
expect(tasks.length).toEqual(1);
const toggled: Task = tasks[0];
// Assert
expect(toggled).not.toBeNull();
expect(toggled!.status).toStrictEqual(Status.TODO);
expect(toggled!.status.symbol).toStrictEqual(' ');
expect(toggled!.doneDate).toBeNull();
});
type RecurrenceCase = {
// inputs:
interval: string;
symbol?: string;
due?: string;
scheduled?: string;
start?: string;
today?: string;
// results:
doneSymbol?: string; // the symbol of the completed task
nextSymbol?: string; // the symbol of the recurrence
nextDue?: string;
nextScheduled?: string;
nextStart?: string;
nextInterval?: string; // for when rrule re-words the recurrence interval, to simplify it
};
const recurrenceCases: Array<RecurrenceCase> = [
{
interval: 'every 7 days',
due: '2021-02-21',
nextDue: '2021-02-28',
},
{
interval: 'every 7 days when done',
due: '2021-02-21',
today: '2021-02-18',
nextDue: '2021-02-25',
},
{
interval: 'every 7 days when done',
due: '2021-02-21',
today: '2021-02-22',
nextDue: '2021-03-01',
},
{
interval: 'every day',
due: '2021-02-21',
nextDue: '2021-02-22',
},
{
interval: 'every day when done',
due: '2021-02-21',
today: '2022-01-04',
nextDue: '2022-01-05',
},
{
interval: 'every 4 weeks',
due: '2021-10-15',
nextDue: '2021-11-12',
},
{
interval: 'every 4 weeks',
due: '2021-10-12',
nextDue: '2021-11-09',
},
{
interval: 'every 4 weeks',
due: '2022-10-12',
nextDue: '2022-11-09',
},
{
interval: 'every 4 weeks',
due: '2033-10-12',
nextDue: '2033-11-09',
},
{
interval: 'every 3 weeks when done',
due: '2022-01-10',
today: '2021-01-14',
nextDue: '2021-02-04',
},
{
interval: 'every month',
due: '2021-10-15',
nextDue: '2021-11-15',
},
{
interval: 'every month',
due: '2021-10-18',
nextDue: '2021-11-18',
},
{
interval: 'every month when done',
due: '2021-10-18',
today: '2021-10-16',
nextDue: '2021-11-16',
},
{
interval: 'every month when done',
due: '2021-10-18',
today: '2021-10-24',
nextDue: '2021-11-24',
},
{
interval: 'every month on the 2nd Wednesday',
due: '2021-09-08',
nextDue: '2021-10-13',
},
{
interval: 'every month on the 2nd Wednesday when done',
due: '2021-09-08',
today: '2021-09-15',
nextDue: '2021-10-13',
},
{
interval: 'every month on the 2nd Wednesday when done',
due: '2021-09-08',
today: '2021-10-12',
nextDue: '2021-10-13',
},
{
interval: 'every month on the 2nd Wednesday when done',
due: '2021-09-08',
today: '2021-10-13',
nextDue: '2021-11-10',
},
{
interval: 'every 3 months on the 3rd Thursday',
due: '2021-04-15',
nextDue: '2021-07-15',
},
{
interval: 'every 3 months on the 3rd Thursday',
due: '2021-08-19',
nextDue: '2021-11-18',
},
{
interval: 'every 3 months on the 3rd Thursday',
due: '2021-09-16',
nextDue: '2021-12-16',
},
{
interval: 'every week on Monday, Wednesday, Friday',
due: '2022-01-24',
nextDue: '2022-01-26',
},
{
interval: 'every week on Monday, Wednesday, Friday when done',
due: '2022-01-24',
today: '2022-01-25',
nextDue: '2022-01-26',
},
{
interval: 'every week on Monday, Wednesday, Friday when done',
due: '2022-01-24',
today: '2022-01-26',
nextDue: '2022-01-28',
},
{
interval: 'every 5 days',
start: '2021-10-10',
nextStart: '2021-10-15',
},
{
interval: 'every 5 days',
scheduled: '2021-10-10',
nextScheduled: '2021-10-15',
},
{
interval: 'every 5 days',
start: '2021-10-10',
due: '2021-10-11',
nextStart: '2021-10-15',
nextDue: '2021-10-16',
},
{
interval: 'every 5 days',
scheduled: '2021-10-10',
due: '2021-10-11',
nextScheduled: '2021-10-15',
nextDue: '2021-10-16',
},
{
interval: 'every 5 days',
start: '2021-10-09',
scheduled: '2021-10-10',
due: '2021-10-11',
nextStart: '2021-10-14',
nextScheduled: '2021-10-15',
nextDue: '2021-10-16',
},
{
interval: 'every 10 days when done',
start: '2021-10-05',
scheduled: '2021-10-07',
due: '2021-10-09',
today: '2021-10-04',
nextStart: '2021-10-10',
nextScheduled: '2021-10-12',
nextDue: '2021-10-14',
},
{
interval: 'every 10 days when done',
start: '2021-10-05',
scheduled: '2021-10-07',
due: '2021-10-09',
today: '2021-10-06',
nextStart: '2021-10-12',
nextScheduled: '2021-10-14',
nextDue: '2021-10-16',
},
{
interval: 'every 10 days when done',
start: '2021-10-05',
scheduled: '2021-10-07',
due: '2021-10-09',
today: '2021-10-08',
nextStart: '2021-10-14',
nextScheduled: '2021-10-16',
nextDue: '2021-10-18',
},
{
interval: 'every 10 days when done',
start: '2021-10-05',
scheduled: '2021-10-07',
due: '2021-10-09',
today: '2021-10-10',
nextStart: '2021-10-16',
nextScheduled: '2021-10-18',
nextDue: '2021-10-20',
},
{
// every month - due 31 March, and so 31 April would not exist: it used to skip forward 2 months
interval: 'every month',
due: '2021-03-31',
nextDue: '2021-04-30',
},
{
// every month - due 29 January, and so 29 February would not exist: it used to skip forward 2 months
interval: 'every month',
due: '2021-01-29',
nextDue: '2021-02-28',
},
{
// every month - skips invalid dates if the recurrence rule states exact date, like 31st
interval: 'every month on the 31st',
due: '2021-01-31',
nextDue: '2021-03-31', // skips '2021-02-31'
},
{
// every year - skips invalid dates if the recurrence rule states exact date, like 31st.
// We thought that 'every year' might need special-case code for when ' on ' is
// used. This test was intended to prove that we did need special case code
// for 'every year on', but instead it shows that it works OK.
interval: 'every year on February the 29th',
due: '2021-01-01',
nextDue: '2024-02-29', // skips all 28th February
nextInterval: 'every February on the 29th',
},
// Testing yearly repetition around leap days
{
// yearly, due on leap day 29th February: it used to skip forward 4 years
interval: 'every year',
due: '2020-02-29',
nextDue: '2021-02-28',
},
// Testing 'when done' does not skip when next occurrence is a non-existent date
{
interval: 'every month when done',
scheduled: '1999-01-23',
today: '2021-08-31',
nextScheduled: '2021-09-30',
},
{
interval: 'every 2 years when done',
start: '1999-01-23',
today: '2020-02-29', // is a leap year
nextStart: '2022-02-28',
},
// ==================================
// Test toggling with custom statuses.
// See the available statuses, which were set up in the beforeAll() function above.
// ==================================
{
interval: 'every day',
symbol: 'D',
due: '2023-01-19',
doneSymbol: 'X',
nextSymbol: '!',
nextDue: '2023-01-20',
},
{
interval: 'every day',
symbol: '2',
doneSymbol: '3', // 2 toggles to 3
nextSymbol: '1', // and the new task should be 1
},
{
interval: 'every day',
symbol: 'a',
doneSymbol: 'b', // a toggles to b
nextSymbol: 'c', // b says it toggles to c: , but c does not exist: check that it has been chosen anyway
},
];
// This was calling test.concurrent.each() to run the tests in parallel, but I couldn't
// get it to run beforeAll() before running the tests.
// https://github.com/facebook/jest/issues/7997#issuecomment-796965078
test.each<RecurrenceCase>(recurrenceCases)(
'recurs correctly (%j)',
({
// inputs:
interval,
symbol,
due,
scheduled,
start,
today,
// results:
doneSymbol,
nextSymbol,
nextDue,
nextScheduled,
nextStart,
nextInterval,
}) => {
const todaySpy = jest.spyOn(Date, 'now').mockReturnValue(moment(today).valueOf());
// If this test fails, the RecurrenceCase had no expected new dates set, and so
// is accidentally not doing any testing.
const atLeaseOneExpectationSupplied =
nextStart !== undefined ||
nextDue !== undefined ||
nextScheduled !== undefined ||
nextSymbol !== undefined ||
doneSymbol !== undefined;
expect(atLeaseOneExpectationSupplied).toStrictEqual(true);
const line = [
`- [${symbol ?? ' '}] I am task`,
`🔁 ${interval}`,
!!scheduled && `⏳ ${scheduled}`,
!!due && `📅 ${due}`,
!!start && `🛫 ${start}`,
]
.filter(Boolean)
.join(' ');
const task = fromLine({
line,
});
const tasks = task!.toggle();
expect(tasks.length).toEqual(2);
const doneTask: Task = tasks[1];
const nextTask: Task = tasks[0];
expect(doneTask.status.symbol).toEqual(doneSymbol ?? 'x');
expect(nextTask.status.symbol).toEqual(nextSymbol ?? ' ');
expect({
nextDue: nextTask.dueDate?.format('YYYY-MM-DD'),
nextScheduled: nextTask.scheduledDate?.format('YYYY-MM-DD'),
nextStart: nextTask.startDate?.format('YYYY-MM-DD'),
}).toMatchObject({
nextDue,
nextScheduled,
nextStart,
});
if (nextInterval) {
expect(nextTask.recurrence?.toText()).toBe(nextInterval);
} else {
expect(nextTask.recurrence?.toText()).toBe(interval);
}
todaySpy.mockClear();
},
);
it('supports recurrence rule after a due date', () => {
// Arrange
const line = '- [ ] this is a task 🗓 2021-09-12 🔁 every day';
// Act
const task = fromLine({
line,
});
// Assert
expect(task).not.toBeNull();
expect(task!.dueDate).not.toBeNull();
expect(task!.dueDate!.isSame(moment('2021-09-12', 'YYYY-MM-DD'))).toStrictEqual(true);
const tasks = task!.toggle();
expect(tasks.length).toEqual(2);
const nextTask: Task = tasks[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,
});
});
});
declare global {
namespace jest {
interface Matchers<R> {
toBeIdenticalTo(builder2: TaskBuilder): R;
}
interface Expect {
toBeIdenticalTo(builder2: TaskBuilder): any;
}
interface InverseAsymmetricMatchers {
toBeIdenticalTo(builder2: TaskBuilder): any;
}
}
}
export function toBeIdenticalTo(builder1: TaskBuilder, builder2: TaskBuilder) {
const task1 = builder1.build();
const task2 = builder2.build();
const pass = task1.identicalTo(task2);
if (pass) {
return {
message: () => 'Tasks treated as identical, but should be different',
pass: true,
};
}
return {
message: () => {
return 'Tasks should be identical, but are treated as different';
},
pass: false,
};
}
expect.extend({
toBeIdenticalTo,
});
describe('identicalTo', () => {
it('should check status', () => {
const lhs = new TaskBuilder().status(Status.TODO);
expect(lhs).toBeIdenticalTo(new TaskBuilder().status(Status.TODO));
expect(lhs).not.toBeIdenticalTo(new TaskBuilder().status(Status.DONE));
});
it('should check description', () => {
const lhs = new TaskBuilder().description('same long initial text');
expect(lhs).toBeIdenticalTo(new TaskBuilder().description('same long initial text'));
expect(lhs).not.toBeIdenticalTo(new TaskBuilder().description('different text'));
});
it('should check path', () => {
const lhs = new TaskBuilder().path('same test file.md');
expect(lhs).toBeIdenticalTo(new TaskBuilder().path('same test file.md'));
// Check it is case-sensitive
expect(lhs).not.toBeIdenticalTo(new TaskBuilder().path('Same Test File.md'));
expect(lhs).not.toBeIdenticalTo(new TaskBuilder().path('different text.md'));
});
it('should check indentation', () => {
const lhs = new TaskBuilder().indentation('');
expect(lhs).toBeIdenticalTo(new TaskBuilder().indentation(''));
expect(lhs).not.toBeIdenticalTo(new TaskBuilder().indentation(' '));
});
it('should check listMarker', () => {
const lhs = new TaskBuilder().listMarker('*');
expect(lhs).toBeIdenticalTo(new TaskBuilder().listMarker('*'));
expect(lhs).not.toBeIdenticalTo(new TaskBuilder().listMarker('-'));
});
it('should check lineNumber', () => {
const lhs = new TaskBuilder().lineNumber(0);
expect(lhs).toBeIdenticalTo(new TaskBuilder().lineNumber(0));