Merge pull request #3165 from ilandikov/refactor-priority-tools

refactor: add `PriorityTools.priorityValue()`

Author: claremacrae

src/TaskSerializer/DataviewTaskSerializer.ts

@@ -1,5 +1,6 @@
 import { TaskLayoutComponent } from '../Layout/TaskLayoutOptions';
-import { Priority } from '../Task/Priority';
+import { PriorityTools } from '../lib/PriorityTools';
+import type { Priority } from '../Task/Priority';
 import type { Task } from '../Task/Task';
 import { DefaultTaskSerializer, taskIdRegex, taskIdSequenceRegex } from './DefaultTaskSerializer';
 
@@ -103,20 +104,7 @@ export class DataviewTaskSerializer extends DefaultTaskSerializer {
     }
 
     protected parsePriority(p: string): Priority {
-        switch (p) {
-            case 'highest':
-                return Priority.Highest;
-            case 'high':
-                return Priority.High;
-            case 'medium':
-                return Priority.Medium;
-            case 'low':
-                return Priority.Low;
-            case 'lowest':
-                return Priority.Lowest;
-            default:
-                return Priority.None;
-        }
+        return PriorityTools.priorityValue(p);
     }
 
     public componentToString(task: Task, shortMode: boolean, component: TaskLayoutComponent) {

src/lib/PriorityTools.ts

@@ -39,4 +39,30 @@ export class PriorityTools {
     public static priorityNameUsingNormal(priority: Priority) {
         return PriorityTools.priorityNameUsingNone(priority).replace('None', 'Normal');
     }
+
+    /**
+     * Get the {@link Priority} value from a string. The algorithm is case-insensitive.
+     *
+     * In case the value was not recognised, {@link Priority.None} will be returned.
+     *
+     * @param priority - a string containing a name of one the supported {@link Priority} values.
+     *                   Capitalisation is ignored.
+     * @see priorityNameUsingNormal
+     */
+    public static priorityValue(priority: string): Priority {
+        switch (priority.toLowerCase()) {
+            case 'lowest':
+                return Priority.Lowest;
+            case 'low':
+                return Priority.Low;
+            case 'medium':
+                return Priority.Medium;
+            case 'high':
+                return Priority.High;
+            case 'highest':
+                return Priority.Highest;
+            default:
+                return Priority.None;
+        }
+    }
 }

src/ui/EditableTask.ts

@@ -1,5 +1,6 @@
 import { GlobalFilter } from '../Config/GlobalFilter';
 import { parseTypedDateForSaving } from '../DateTime/DateTools';
+import { PriorityTools } from '../lib/PriorityTools';
 import { replaceTaskWithTasks } from '../Obsidian/File';
 import type { Status } from '../Statuses/Status';
 import type { OnCompletion } from '../Task/OnCompletion';
@@ -10,8 +11,6 @@ import { Task } from '../Task/Task';
 import { addDependencyToParent, ensureTaskHasId, generateUniqueId, removeDependency } from '../Task/TaskDependency';
 import { StatusType } from '../Statuses/StatusConfiguration';
 
-type EditableTaskPriority = 'none' | 'lowest' | 'low' | 'medium' | 'high' | 'highest';
-
 /**
  * {@link Task} objects are immutable. This class allows to create a mutable object from a {@link Task}, apply the edits,
  * and get the resulting task(s).
@@ -24,7 +23,7 @@ export class EditableTask {
     // NEW_TASK_FIELD_EDIT_REQUIRED
     description: string;
     status: Status;
-    priority: EditableTaskPriority;
+    priority: string;
     recurrenceRule: string;
     onCompletion: OnCompletion;
     createdDate: string;
@@ -44,7 +43,7 @@ export class EditableTask {
         // NEW_TASK_FIELD_EDIT_REQUIRED
         description: string;
         status: Status;
-        priority: EditableTaskPriority;
+        priority: string;
         onCompletion: OnCompletion;
         recurrenceRule: string;
         createdDate: string;
@@ -90,7 +89,7 @@ export class EditableTask {
         const addGlobalFilterOnSave =
             description != task.description || !GlobalFilter.getInstance().includedIn(task.description);
 
-        let priority: EditableTaskPriority = 'none';
+        let priority = 'none';
         if (task.priority === Priority.Lowest) {
             priority = 'lowest';
         } else if (task.priority === Priority.Low) {
@@ -168,27 +167,6 @@ export class EditableTask {
             });
         }
 
-        let parsedPriority: Priority;
-        switch (this.priority) {
-            case 'lowest':
-                parsedPriority = Priority.Lowest;
-                break;
-            case 'low':
-                parsedPriority = Priority.Low;
-                break;
-            case 'medium':
-                parsedPriority = Priority.Medium;
-                break;
-            case 'high':
-                parsedPriority = Priority.High;
-                break;
-            case 'highest':
-                parsedPriority = Priority.Highest;
-                break;
-            default:
-                parsedPriority = Priority.None;
-        }
-
         const parsedOnCompletion: OnCompletion = this.onCompletion;
 
         const blockedByWithIds = [];
@@ -218,7 +196,7 @@ export class EditableTask {
             ...task,
             description,
             status: task.status,
-            priority: parsedPriority,
+            priority: PriorityTools.priorityValue(this.priority),
             onCompletion: parsedOnCompletion,
             recurrence,
             startDate,

tests/lib/PriorityTools.test.ts

@@ -12,4 +12,25 @@ describe('priority naming', () => {
         expect(PriorityTools.priorityNameUsingNone(none)).toEqual('None');
         expect(PriorityTools.priorityNameUsingNormal(none)).toEqual('Normal');
     });
+
+    it.each([
+        // Normal cases
+        ['highest', Priority.Highest],
+        ['high', Priority.High],
+        ['medium', Priority.Medium],
+        ['none', Priority.None],
+        ['normal', Priority.None],
+        ['low', Priority.Low],
+        ['lowest', Priority.Lowest],
+
+        // Erroneous cases
+        ['', Priority.None],
+        ['invalid_priority_string!', Priority.None],
+
+        // Priority search is case-insensitive
+        ['Highest', Priority.Highest],
+        ['highEst', Priority.Highest],
+    ])('should get priority value for "%s"', (str, value) => {
+        expect(PriorityTools.priorityValue(str)).toEqual(value);
+    });
 });