Commit: d2ebf9357a59a42265e146622ddc98aae711acca - medialist-cli (git)

CLI interface to medialist (fossil mirror)

Commit MetaInfo

• Révision: d2ebf9357a59a42265e146622ddc98aae711acca (tree)
• l'heure: 2022-01-20 14:45:53
• Auteur: mio <stigma@disr...>
• Commiter: mio

Message de Log

add an implementation for "update" command.
also changes the MediaListItem structure a little.

FossilOrigin-Name: 71855bed5d0d00b82f77be0aea3dacf6e66506778b4c80df5117499840f6734c

Change Summary

• modified: medialist.d

Modification

--- a/medialist.d
+++ b/medialist.d
@@ -40,10 +40,9 @@ struct MediaListItem
     string title;
     string progress;
     string status;
-    /* start_date */
-    /* end_date */
-    /* last_updated */
-    bool isValid;
+    string startDate;
+    string endDate;
+    string lastUpdated;
 }
 
 struct MediaListHeader
@@ -69,6 +68,18 @@ enum MLCommand
      * Args: ["(Optional) Item ID", ...(repeat for the amount of ids needed)]
      */
     delete_,
+    /**
+     * Update an item on a list.
+     * 
+     * Args: ["Item ID", "field::value", "field::value", ...]
+     * 
+     * For example: ml_send_command(list, MLCommand.update, ["1", "status:READING"]);
+     * The "field" is automatically converted to lowercase, while the value is kept
+     * as-is.
+     * 
+     * To update the start and end date of an item, use "start_date" and
+     * "end_date" respectively.
+     */
     update,
 }
 
@@ -212,6 +223,9 @@ MLError ml_fetch_item(MediaList* list, size_t id, MediaListItem* item)
     size_t titleIndex = 0;
     size_t progressIndex = 0;
     size_t statusIndex = 0;
+    size_t startIndex = 0;
+    size_t endIndex = 0;
+    size_t lastIndex = 0;
 
     foreach(size_t idx, int[2] header; headerPositions) {
         switch(header[0]) {
@@ -224,13 +238,23 @@ MLError ml_fetch_item(MediaList* list, size_t id, MediaListItem* item)
         case MLHeaders.status:
             statusIndex = header[1];
             break;
+        case MLHeaders.startDate:
+            startIndex = header[1];
+            break;
+        case MLHeaders.endDate:
+            endIndex = header[1];
+            break;
+        case MLHeaders.lastUpdated:
+            lastIndex = header[1];
+            break;
         default:
             break;
         }
     }
 
     MediaListItem newItem = MediaListItem(sections[titleIndex],
-        sections[progressIndex], sections[statusIndex], true);
+        sections[progressIndex], sections[statusIndex], sections[startIndex],
+        sections[endIndex], sections[lastIndex]);
 
     *item = newItem;
 
@@ -252,12 +276,15 @@ MediaListItem[] ml_fetch_items(MediaList* list, size_t[] ids ...)
     bool pastHeader = false;
     MediaListItem[] items;
 
+    int[2][6] headerPositions = _ml_get_header_positions(list);
     size_t titleIndex = 0;
     size_t progressIndex = 0;
     size_t statusIndex = 0;
-    int[2][6] headerPositions = _ml_get_header_positions(list);
+    size_t startIndex = 0;
+    size_t endIndex = 0;
+    size_t lastIndex = 0;
 
-    foreach(ref header; headerPositions) {
+    foreach(size_t idx, int[2] header; headerPositions) {
         switch(header[0]) {
         case MLHeaders.title:
             titleIndex = header[1];
@@ -268,6 +295,15 @@ MediaListItem[] ml_fetch_items(MediaList* list, size_t[] ids ...)
         case MLHeaders.status:
             statusIndex = header[1];
             break;
+        case MLHeaders.startDate:
+            startIndex = header[1];
+            break;
+        case MLHeaders.endDate:
+            endIndex = header[1];
+            break;
+        case MLHeaders.lastUpdated:
+            lastIndex = header[1];
+            break;
         default:
             break;
         }
@@ -287,8 +323,9 @@ MediaListItem[] ml_fetch_items(MediaList* list, size_t[] ids ...)
 
         if (true == canFind(ids, currentID)) {
             string[] sections = line.strip().split("\t");
-            items ~= MediaListItem(sections[titleIndex], sections[progressIndex],
-                sections[statusIndex], true);
+            items ~= MediaListItem(sections[titleIndex],
+                sections[progressIndex], sections[statusIndex], sections[startIndex],
+                sections[endIndex], sections[lastIndex]);
         }
 
         currentID += 1;
@@ -313,9 +350,12 @@ MediaListItem[] ml_fetch_all(MediaList* list)
     size_t titleIndex = 0;
     size_t progressIndex = 0;
     size_t statusIndex = 0;
+    size_t startIndex = 0;
+    size_t endIndex = 0;
+    size_t lastIndex = 0;
 
-    foreach(ref header; headerPositions) {
-        switch (header[0]) {
+    foreach(size_t idx, int[2] header; headerPositions) {
+        switch(header[0]) {
         case MLHeaders.title:
             titleIndex = header[1];
             break;
@@ -325,6 +365,15 @@ MediaListItem[] ml_fetch_all(MediaList* list)
         case MLHeaders.status:
             statusIndex = header[1];
             break;
+        case MLHeaders.startDate:
+            startIndex = header[1];
+            break;
+        case MLHeaders.endDate:
+            endIndex = header[1];
+            break;
+        case MLHeaders.lastUpdated:
+            lastIndex = header[1];
+            break;
         default:
             break;
         }
@@ -344,8 +393,9 @@ MediaListItem[] ml_fetch_all(MediaList* list)
 
         string[] sections = line.strip().split("\t");
 
-        items ~= MediaListItem(sections[titleIndex], sections[progressIndex],
-            sections[statusIndex], true);
+        items ~= MediaListItem(sections[titleIndex],
+            sections[progressIndex], sections[statusIndex], sections[startIndex],
+            sections[endIndex], sections[lastIndex]);
     }
 
     list.isOpen = false;
@@ -366,6 +416,7 @@ MLError ml_send_command(MediaList* list, MLCommand command, string[] args)
         res = _ml_delete(list, args);
         break;
     case MLCommand.update:
+        res = _ml_update(list, args);
         break;
     default:
         break;
@@ -534,6 +585,182 @@ private MLError _ml_delete(MediaList* list, string[] args)
     return MLError.success;
 }
 
+private MLError _ml_update(MediaList* list, string[] args)
+{
+    if (list.isOpen)
+        return MLError.fileAlreadyOpen;
+
+    if (2 > args.length)
+        return MLError.invalidArgs;
+    
+    string title = null;
+    string progress = null;
+    string status = null;
+    string startDate = "";
+    string endDate = "";
+    
+    size_t id;
+    
+    try {
+        id = to!size_t(args[0]);
+    } catch (Exception e) {
+        return MLError.invalidArgs;
+    }
+    
+    foreach(string arg; args) {
+        string[] kv = arg.split("::");
+
+        if (2 > kv.length)
+            continue;
+        
+        string k = kv[0].toLower();
+        string v = kv[1];
+        
+        switch (k) {
+        case "title":
+            title = v;
+            break;
+        case "status":
+            status = v;
+            break;
+        case "progress":
+            progress = v;
+            break;
+        case "start_date":
+            startDate = v;
+            break;
+        case "end_date":
+            endDate = v;
+            break;
+        default:
+            break;
+        }
+    }
+    
+    string tempFilePath = buildPath(tempDir, "ml_temp.tsv");
+    File tempFile = File(tempFilePath, "w+");
+    scope(exit) remove(tempFilePath);
+    
+    int[2][6] headerPositions = _ml_get_header_positions(list);
+    size_t titleIndex = 0;
+    size_t progressIndex = 0;
+    size_t statusIndex = 0;
+    size_t startDateIndex = 0;
+    size_t endDateIndex = 0;
+    size_t lastUpdatedIndex = 0;
+    
+    foreach (ref header; headerPositions) {
+        switch (header[0]) {
+            case MLHeaders.title:
+                titleIndex = header[1];
+                break;
+            case MLHeaders.progress:
+                progressIndex = header[1];
+                break;
+            case MLHeaders.status:
+                statusIndex = header[1];
+                break;
+            case MLHeaders.startDate:
+                startDateIndex = header[1];
+                break;
+            case MLHeaders.endDate:
+                endDateIndex = header[1];
+                break;
+            case MLHeaders.lastUpdated:
+                lastUpdatedIndex = header[1];
+                break;
+            default:
+                break;
+        }
+    }
+    
+    File listFile = File(list.filePath, "r");
+    list.isOpen = true;
+    
+    string line;
+    bool pastHeader;
+    size_t currentIndex = 1;
+    
+    while ((line = listFile.readln()) !is null) {
+        if (line.length == 0)
+            continue;
+        
+        if (line[0] == '#') {
+            tempFile.write(line);
+            continue;
+        }
+        
+        if (false == pastHeader) {
+            pastHeader = true;
+            tempFile.write(line);
+            continue;
+        }
+        
+        if (currentIndex == id) {
+            string[] sections = line.strip().split("\t");
+            if (title !is null)
+                sections[titleIndex] = title;
+            if (progress !is null)
+                sections[progressIndex] = progress;
+
+            if (status !is null) {
+                string oldStatus = sections[statusIndex];
+                
+                if ((oldStatus.toLower == "plan-to-read" && status == "reading") ||
+                    (oldStatus.toLower == "plan-to-watch" && status == "watching")) {
+                    
+                    if (startDate == "") {
+                        Date date = cast(Date)Clock.currTime;
+                        startDate = format!"%d-%02d-%02d"(date.year, date.month, date.day);
+                        sections[startDateIndex] = startDate;
+                    }
+                }
+                
+                if ((oldStatus.toLower == "reading" && status == "complete") ||
+                    (oldStatus.toLower == "watching" && status == "complete")) {
+                    
+                    if (endDate == "") {
+                        Date date = cast(Date)Clock.currTime;
+                        endDate = format!"%d-%02d-%02d"(date.year, date.month, date.day);
+                        sections[endDateIndex] = endDate;
+                    }
+                }
+
+                sections[statusIndex] = status;
+            }
+
+            if (startDate !is null)
+                sections[startDateIndex] = startDate;
+            if (endDate !is null)
+                sections[endDateIndex] = endDate;
+            
+            Date date = cast(Date)Clock.currTime();
+            sections[lastUpdatedIndex] = format!"%d-%02d-%02d"(date.year, date.month, date.day);
+            tempFile.writeln(join(sections, "\t"));
+        } else {
+            tempFile.write(line);
+        }
+        
+        currentIndex += 1;
+    }
+    
+    listFile.close();
+    tempFile.flush();
+    tempFile.close();
+    
+    tempFile = File(tempFilePath, "r");
+    listFile = File(list.filePath, "w+");
+    
+    while ((line = tempFile.readln()) !is null) {
+        listFile.write(line);
+    }
+    listFile.flush();
+    
+    list.isOpen = false;
+
+    return MLError.success;
+}
+
 private enum MLHeaders
 {
     title = 0,
@@ -639,6 +866,14 @@ public void runMediaListUnitTests()
         "Check header position variance and case-insensitivity.");
     ok(unittest_fetchItems124(),
         "Can fetch multiple items by ID (1, 4, and 2).");
+    ok(unittest_updateItemTitle(),
+        "Can update an item's title.");
+    ok(unittest_updateItemStatus(),
+        "Can update an item's status.");
+    ok(unittest_updateItemProgress(),
+        "Can update an item's progress.");
+    ok(unittest_updateItemAll(),
+        "Can update all aspects of an item.");
 }
 
 private bool unittest_createNewList()
@@ -1152,3 +1387,217 @@ private bool unittest_fetchItems124()
 
     return true;
 }
+
+private bool unittest_updateItemTitle()
+{
+    enum listName = __FUNCTION__;
+    enum fileName = listName ~ ".tsv";
+    
+    MediaList* list = ml_open_list(fileName);
+    if (list is null) {
+        diag("ml_open_list returned null.");
+        return false;
+    }
+    
+    scope(exit) {
+        ml_send_command(list, MLCommand.delete_, []);
+        ml_free_list(list);
+    }
+    
+    MLError res;
+    
+    res = ml_send_command(list, MLCommand.add, ["Ietm 1"]);
+    if (MLError.success != res) {
+        diag("ml_send_command(list, add, [Ietm 1]) failed.");
+        return false;
+    }
+    
+    res = ml_send_command(list, MLCommand.update, ["1", "title::Item 1"]);
+    if (MLError.success != res) {
+        diag("Failed to send UPDATE command [1, title::Item 1].");
+        return false;
+    }
+    
+    MediaListItem item;
+    res = ml_fetch_item(list, 1, &item);
+    if (MLError.success != res) {
+        diag("Failed to fetch item 1 from list.");
+        return false;
+    }
+    
+    if ("Item 1" != item.title) {
+        diag("Failed to update title from 'Ietm 1' to 'Item 1'.");
+        return false;
+    }
+
+    return true;
+}
+
+private bool unittest_updateItemStatus()
+{
+    enum listName = __FUNCTION__;
+    enum fileName = listName ~ ".tsv";
+    
+    MediaList* list = ml_open_list(fileName);
+    if (list is null) {
+        diag("ml_open_list returned null.");
+        return false;
+    }
+    
+    scope(exit) {
+        ml_send_command(list, MLCommand.delete_, []);
+        ml_free_list(list);
+    }
+    
+    MLError res;
+    
+    res = ml_send_command(list, MLCommand.add, ["Item 1", null, "PLAN-TO-READ"]);
+    if (MLError.success != res) {
+        diag("ml_send_command(list, add, [Item 1, null, PLAN-TO-READ]) failed.");
+        return false;
+    }
+    
+    res = ml_send_command(list, MLCommand.update, ["1", "status::READING"]);
+    if (MLError.success != res) {
+        diag("Failed to send UPDATE command [1, status::READING].");
+        return false;
+    }
+    
+    MediaListItem item;
+    res = ml_fetch_item(list, 1, &item);
+    if (MLError.success != res) {
+        diag("Failed to fetch item 1 from list.");
+        return false;
+    }
+    
+    if ("READING" != item.status) {
+        diag("Failed to update status from 'PLAN-TO-READ' to 'READING'.");
+        return false;
+    }
+
+    return true;
+}
+
+private bool unittest_updateItemProgress()
+{
+    enum listName = __FUNCTION__;
+    enum fileName = listName ~ ".tsv";
+    
+    MediaList* list = ml_open_list(fileName);
+    if (list is null) {
+        diag("ml_open_list returned null.");
+        return false;
+    }
+    
+    scope(exit) {
+        ml_send_command(list, MLCommand.delete_, []);
+        ml_free_list(list);
+    }
+    
+    MLError res;
+    
+    res = ml_send_command(list, MLCommand.add, ["Item 1"]);
+    if (MLError.success != res) {
+        diag("ml_send_command(list, add, [Item 1]) failed.");
+        return false;
+    }
+    
+    res = ml_send_command(list, MLCommand.update, ["1", "progress::10/10"]);
+    if (MLError.success != res) {
+        diag("Failed to send UPDATE command [1, progress::10/10].");
+        return false;
+    }
+    
+    MediaListItem item;
+    res = ml_fetch_item(list, 1, &item);
+    if (MLError.success != res) {
+        diag("Failed to fetch item 1 from list.");
+        return false;
+    }
+    
+    if ("10/10" != item.progress) {
+        diag("Failed to update progress from '-/-' to '10/10'.");
+        return false;
+    }
+
+    return true;
+}
+
+private bool unittest_updateItemAll()
+{
+    enum listName = __FUNCTION__;
+    enum fileName = listName ~ ".tsv";
+    
+    MediaList* list = ml_open_list(fileName);
+    if (list is null) {
+        diag("ml_open_list returned null.");
+        return false;
+    }
+    
+    scope(exit) {
+        ml_send_command(list, MLCommand.delete_, []);
+        ml_free_list(list);
+    }
+    
+    MLError res;
+    
+    res = ml_send_command(list, MLCommand.add, ["Ietm 1"]);
+    if (MLError.success != res) {
+        diag("ml_send_command(list, add, [Ietm 1]) failed.");
+        return false;
+    }
+    
+    res = ml_send_command(list, MLCommand.update,
+        ["1",
+        "start_date::2021-02-16",
+        "end_date::2022-01-20",
+        "progress::60/100",
+        "status::READING",
+        "title::MediaList"]
+    );
+    if (MLError.success != res) {
+        diag("Failed to send UPDATE command.");
+        return false;
+    }
+    
+    MediaListItem item;
+    res = ml_fetch_item(list, 1, &item);
+    if (MLError.success != res) {
+        diag("Failed to fetch item 1 from list.");
+        return false;
+    }
+    
+    if ("MediaList" != item.title) {
+        diag("Failed to update item title from 'Ietm 1' to 'MediaList'.");
+        return false;
+    }
+    
+    if ("60/100" != item.progress) {
+        diag("Failed to update progress from '-/-' to '60/100'.");
+        return false;
+    }
+    
+    if ("READING" != item.status) {
+        diag("Failed to update status from 'UNKNOWN' to 'READING'.");
+        return false;
+    }
+
+    if ("2021-02-16" != item.startDate) {
+        diag("Failed to update start_date from '' to '2021-02-16'.");
+        return false;
+    }
+    
+    if ("2022-01-20" != item.endDate) {
+        diag("Failed to update end_date from '' to '2022-01-20'.");
+        return false;
+    }
+    
+    Date date = cast(Date)Clock.currTime;
+    string currentDate = format!"%d-%02d-%02d"(date.year, date.month, date.day);
+    if (currentDate != item.lastUpdated) {
+        diag("Failed to update last_update when running the UPDATE command.");
+        return false;
+    }
+
+    return true;
+}