Commit: 9e9949aab6d811a10c7cb508db4051b82708548c - medialist-cli (git)

CLI interface to medialist (fossil mirror)

Commit MetaInfo

• Révision: 9e9949aab6d811a10c7cb508db4051b82708548c (tree)
• l'heure: 2022-01-10 10:43:36
• Auteur: mio <stigma@disr...>
• Commiter: mio

Message de Log

add the initial version of medialist.d (the library version of medialist)

FossilOrigin-Name: 89e126b74a95c36ce6a4b7274bdfca8c4688aad5ad8d2e55bde4ece2ddbef649

Change Summary

• add: medialist.d

Modification

--- /dev/null
+++ b/medialist.d
@@ -0,0 +1,512 @@
+module medialist;
+
+import std.datetime.date;
+import std.datetime.systime;
+import std.file;
+import std.stdio;
+import std.string;
+
+struct MediaList
+{
+package:
+    string filePath;
+    bool isOpen = false;
+}
+
+enum MLCommand
+{
+    /**
+     * Args: ["Item Name", "(Optional) Progress", "(Optional) Status".
+     */
+    add,
+    delete_,
+    update,
+}
+
+enum MLError
+{
+    success,
+    invalidArgs,
+    fileDoesNotExist,
+    fileAlreadyOpen,
+}
+
+MediaList* ml_open_list(string filePath)
+{
+    MediaList* ml = new MediaList(filePath);
+
+    if (false == exists(filePath)) {
+        File f = File(filePath, "w+");
+
+        ml.isOpen = true;
+
+        f.writeln("# This file is in the mTSV format.");
+        f.writeln("# For more information about this format,");
+        f.writeln("# please view the website:");
+        f.writeln("# http://yume-neru.neocities.org/p/mtsv.html");
+        f.writeln("title\tprogress\tstatus\tstart_date\tend_date\tlast_updated");
+
+        ml.isOpen = false;
+    }
+
+    return ml;
+}
+
+/**
+ * Finalize and free the resources held by the MediaList structure.
+ *
+ * Params:
+ *   list = The MediaList structure.
+ *
+ * See_Also: ml_open_list
+ */
+void ml_free_list(MediaList* list)
+{
+    import core.memory : GC;
+
+    destroy(list);
+    GC.free(list);
+}
+
+MLError ml_send_command(MediaList* list, MLCommand command, string[] args)
+{
+    MLError res;
+
+    switch (command)
+    {
+    case MLCommand.add:
+        res = _ml_add(list, args);
+        break;
+    case MLCommand.delete_:
+        break;
+    case MLCommand.update:
+        break;
+    default:
+        assert(0);
+    }
+
+    return MLError.success;
+}
+
+private MLError _ml_add(MediaList* list, string[] args)
+{
+    string title;
+    string progress = "-/-";
+    string status = "UNKNOWN";
+
+    DateTime currentDate = cast(DateTime)Clock.currTime;
+
+    if (args.length < 1)
+        return MLError.invalidArgs;
+
+    title = args[0];
+
+    if (args.length >= 2)
+        progress = (args[1] is null) ? "-/-" : args[1];
+
+    if (args.length >= 3)
+        status = (args[2] is null) ? "UNKNOWN" : args[2];
+
+    if (true == list.isOpen)
+        return MLError.fileAlreadyOpen;
+
+    int[2][6] headerPositions = _ml_get_header_positions(list);
+    int currentIndent = 0;
+
+    list.isOpen = true;
+    scope(exit) list.isOpen = false;
+
+    File listFile = File(list.filePath, "a");
+
+    foreach(const ref int[2] headerPosition; headerPositions) {
+        while (currentIndent < headerPosition[1]) {
+            listFile.write("\t");
+            currentIndent += 1;
+        }
+
+        switch(headerPosition[0])
+        {
+        case MLHeaders.title:
+            listFile.write(title);
+            break;
+        case MLHeaders.progress:
+            listFile.write(progress);
+            break;
+        case MLHeaders.status:
+            listFile.write(status);
+            break;
+        case MLHeaders.lastUpdated:
+            listFile.writef("%d-%02d-%02d", currentDate.year, currentDate.month,
+                currentDate.day);
+            break;
+        default:
+            break;
+        }
+    }
+
+    listFile.write("\n");
+
+    return MLError.success;
+}
+
+private enum MLHeaders
+{
+    title = 0,
+    progress = 1,
+    status = 2,
+    startDate = 3,
+    endDate = 4,
+    lastUpdated = 5
+}
+
+private int[2][6] _ml_get_header_positions(MediaList* list)
+{
+    list.isOpen = true;
+    scope(exit) list.isOpen = false;
+
+    File f = File(list.filePath);
+    string line;
+
+    /*
+     * [
+     *   [ MLHeaders, tabIndent ],
+     *   [ MLHeaders, tabIndent ],
+     *   [ MLHeaders, tabIndent ],
+     *   [...]
+     * ]
+     *
+     * We keep the tab indent so we don't mess up any other programs or custom
+     * configurations.
+     */
+    int[2][6] headerPositions = -1;
+    int arrayPosition = 0;
+
+    while ((line = f.readln) !is null) {
+        /* skip configuration and comments */
+        if (line[0] == '#')
+            continue;
+
+        /* first non-comment/non-configuration line is the header */
+        string[] sections = line.strip().split("\t");
+
+        foreach(int idx, ref string section; sections) {
+            switch(section.toLower)
+            {
+            case "title":
+                headerPositions[arrayPosition] = [MLHeaders.title, idx];
+                arrayPosition += 1;
+                break;
+            case "progress":
+                headerPositions[arrayPosition] = [MLHeaders.progress, idx];
+                arrayPosition += 1;
+                break;
+            case "status":
+                headerPositions[arrayPosition] = [MLHeaders.status, idx];
+                arrayPosition += 1;
+                break;
+            case "start_date":
+                headerPositions[arrayPosition] = [MLHeaders.startDate, idx];
+                arrayPosition += 1;
+                break;
+            case "end_date":
+                headerPositions[arrayPosition] = [MLHeaders.endDate, idx];
+                arrayPosition += 1;
+                break;
+            case "last_updated":
+                headerPositions[arrayPosition] = [MLHeaders.lastUpdated, idx];
+                arrayPosition += 1;
+                break;
+            default:
+                break;
+            }
+
+            if (arrayPosition > MLHeaders.max)
+                break;
+        }
+    }
+
+    return headerPositions;
+}
+
+
+/*
+ * The rest of this file consists of unittests.
+ */
+
+version(unittest)
+{
+
+template Tuple(T...)
+{
+    alias Tuple = T;
+}
+
+shared static this()
+{
+    import core.runtime;
+
+    /* Don't run the actual unittests :O */
+    Runtime.moduleUnitTester = { return true; };
+}
+
+void main()
+{
+    alias tests = Tuple!(__traits(getUnitTests, medialist));
+    writefln("1..%d", tests.length);
+
+
+    foreach(i, test; tests) {
+        alias attributes = Tuple!(__traits(getAttributes, tests[i]));
+
+        try {
+            test();
+            writefln("ok %d - %s", i + 1, attributes[0]);
+        } catch (Throwable t) {
+            writefln("not ok %d - %s", i + 1, attributes[0]);
+            auto lines = t.msg.splitLines;
+            foreach(line; lines) {
+                writefln("  %s", line);
+            }
+        }
+    }
+}
+
+}
+
+@("Create a new list")
+unittest
+{
+    import std.conv : to;
+    import std.path : buildPath;
+
+    const listPath = buildPath(tempDir(), "unittest1.tsv");
+    scope(exit) remove(listPath);
+
+    MediaList* list = ml_open_list(listPath);
+    scope(exit) ml_free_list(list);
+
+    assert(null !is list, "Memory allocation failed (list is null)");
+    assert(true == exists(listPath), "A new file wasn't created for the list");
+
+    int[2][6] headerPositions = -1;
+
+    headerPositions = _ml_get_header_positions(list);
+
+    foreach(size_t idx, const ref int[2] headerPosition; headerPositions) {
+        assert(headerPosition[0] != -1,
+            "Empty header type: " ~ to!string(idx));
+        assert(headerPosition[1] != -1,
+            "Empty header position: " ~ to!string(idx));
+    }
+}
+
+@("Can add a new item with no progress or status")
+unittest
+{
+    import std.path : buildPath;
+
+    const listPath = buildPath(tempDir(), "unittest2.tsv");
+    scope(exit) remove(listPath);
+
+    MediaList* list = ml_open_list(listPath);
+    scope(exit) ml_free_list(list);
+
+    MLError res = ml_send_command(list, MLCommand.add, ["Item 1"]);
+    assert(res == MLError.success);
+
+    auto f = File(listPath);
+    string line;
+    bool readHeader = false;
+    string[] sections;
+
+    while ((line = f.readln) !is null) {
+        if (line[0] == '#')
+            continue;
+
+        if (false == readHeader) {
+            readHeader = true;
+            continue;
+        }
+
+        sections = line.strip().split("\t");
+        break;
+    }
+
+    int[2][6] headerPositions = _ml_get_header_positions(list);
+
+    assert(sections.length == MLHeaders.max + 1,
+        "Differing amount of headers in unittest files.");
+
+    assert(sections[headerPositions[MLHeaders.title][1]] == "Item 1",
+        "New item with title 'Item 1' wasn't saved");
+    assert(sections[headerPositions[MLHeaders.progress][1]] == "-/-",
+        "New item with unspecified progress was not \"-/-\"");
+    assert(sections[headerPositions[MLHeaders.status][1]] == "UNKNOWN",
+        "New item with unspecified status was not \"UNKNOWN\"");
+
+    assert(sections[headerPositions[MLHeaders.startDate][1]] == "");
+    assert(sections[headerPositions[MLHeaders.endDate][1]] == "");
+
+    DateTime currentDT = cast(DateTime)Clock.currTime;
+    string currentDS = format!"%d-%02d-%02d"(currentDT.year,
+        currentDT.month, currentDT.day);
+    assert(sections[headerPositions[MLHeaders.lastUpdated][1]] == currentDS);
+}
+
+@("Can add a new item with progress but no status")
+unittest
+{
+    import std.path : buildPath;
+
+    const listPath = buildPath(tempDir(), "unittest3.tsv");
+    scope(exit) remove(listPath);
+
+    MediaList* list = ml_open_list(listPath);
+    scope(exit) ml_free_list(list);
+
+    MLError res = ml_send_command(list, MLCommand.add, ["Item 1", "10/-"]);
+    assert(res == MLError.success);
+
+    auto f = File(listPath);
+    string line;
+    bool readHeader = false;
+    string[] sections;
+
+    while ((line = f.readln) !is null) {
+        if (line[0] == '#')
+            continue;
+
+        if (false == readHeader) {
+            readHeader = true;
+            continue;
+        }
+
+        sections = line.strip().split("\t");
+    }
+
+    assert(sections.length == MLHeaders.max + 1,
+        "Differing amount of headers in unittest files.");
+
+    int[2][6] headerPositions = _ml_get_header_positions(list);
+
+    assert(sections[headerPositions[MLHeaders.title][1]] == "Item 1",
+        "New item with title 'Item 1' wasn't saved");
+    assert(sections[headerPositions[MLHeaders.progress][1]] == "10/-",
+        "New item with progress '10/-' wasn't saved");
+    assert(sections[headerPositions[MLHeaders.status][1]] == "UNKNOWN",
+        "New item with unspecified status was not \"UNKNOWN\"");
+
+    assert(sections[headerPositions[MLHeaders.startDate][1]] == "");
+    assert(sections[headerPositions[MLHeaders.endDate][1]] == "");
+
+    DateTime currentDT = cast(DateTime)Clock.currTime;
+    string currentDS = format!"%d-%02d-%02d"(currentDT.year,
+        currentDT.month, currentDT.day);
+    assert(sections[headerPositions[MLHeaders.lastUpdated][1]] == currentDS);
+}
+
+@("Can add a new item with status but no progress")
+unittest
+{
+    import std.path : buildPath;
+
+    const listPath = buildPath(tempDir(), "unittest3.tsv");
+    scope(exit) remove(listPath);
+
+    MediaList* list = ml_open_list(listPath);
+    scope(exit) ml_free_list(list);
+
+    MLError res = ml_send_command(list, MLCommand.add,
+        ["Item 1", null, "COMPLETE"]);
+    assert(res == MLError.success);
+
+    auto f = File(listPath);
+    string line;
+    bool readHeader = false;
+    string[] sections;
+
+    while ((line = f.readln) !is null) {
+        if (line[0] == '#')
+            continue;
+
+        if (false == readHeader) {
+            readHeader = true;
+            continue;
+        }
+
+        sections = line.strip().split("\t");
+    }
+
+    assert(sections.length == MLHeaders.max + 1,
+        "Differing amount of headers in unittest files.");
+
+    int[2][6] headerPositions = _ml_get_header_positions(list);
+
+    assert(sections[headerPositions[MLHeaders.title][1]] == "Item 1",
+        "New item with title 'Item 1' wasn't saved");
+    assert(sections[headerPositions[MLHeaders.progress][1]] == "-/-",
+        "New item with unspecified progress wasn't \"-/-\"");
+    assert(sections[headerPositions[MLHeaders.status][1]] == "COMPLETE",
+        "New item with progress \"COMPLETE\" wasn't saved");
+
+    assert(sections[headerPositions[MLHeaders.startDate][1]] == "");
+    assert(sections[headerPositions[MLHeaders.endDate][1]] == "");
+
+    DateTime currentDT = cast(DateTime)Clock.currTime;
+    string currentDS = format!"%d-%02d-%02d"(currentDT.year,
+        currentDT.month, currentDT.day);
+    assert(sections[headerPositions[MLHeaders.lastUpdated][1]] == currentDS);
+}
+
+@("Can add a new item with progress and status")
+unittest
+{
+    import std.path : buildPath;
+
+    const listPath = buildPath(tempDir(), "unittest3.tsv");
+    scope(exit) remove(listPath);
+
+    MediaList* list = ml_open_list(listPath);
+    scope(exit) ml_free_list(list);
+
+    MLError res = ml_send_command(list, MLCommand.add,
+        ["Item 1", "10/-", "COMPLETE"]);
+    assert(res == MLError.success);
+
+    auto f = File(listPath);
+    string line;
+    bool readHeader = false;
+    string[] sections;
+
+    while ((line = f.readln) !is null) {
+        if (line[0] == '#')
+            continue;
+
+        if (false == readHeader) {
+            readHeader = true;
+            continue;
+        }
+
+        sections = line.strip().split("\t");
+    }
+
+    assert(sections.length == MLHeaders.max + 1,
+        "Differing amount of headers in unittest files.");
+
+    int[2][6] headerPositions = _ml_get_header_positions(list);
+
+    assert(sections[headerPositions[MLHeaders.title][1]] == "Item 1",
+        "New item with title 'Item 1' wasn't saved");
+    assert(sections[headerPositions[MLHeaders.progress][1]] == "10/-",
+        "New item with progress '10/-' wasn't saved");
+    assert(sections[headerPositions[MLHeaders.status][1]] == "COMPLETE",
+        "New item with progress \"COMPLETE\" wasn't saved");
+
+    assert(sections[headerPositions[MLHeaders.startDate][1]] == "");
+    assert(sections[headerPositions[MLHeaders.endDate][1]] == "");
+
+    DateTime currentDT = cast(DateTime)Clock.currTime;
+    string currentDS = format!"%d-%02d-%02d"(currentDT.year,
+        currentDT.month, currentDT.day);
+    assert(sections[headerPositions[MLHeaders.lastUpdated][1]] == currentDS);
+}