Commit: f7608093601b06e33accab594840260433a9dfe2 - medialist-cli (git)

CLI interface to medialist (fossil mirror)

Commit MetaInfo

• Revision: f7608093601b06e33accab594840260433a9dfe2 (tree)
• Time: 2022-01-18 19:19:47
• Author: mio <stigma@disr...>
• Commiter: mio

Log Message

replace "handle_show" with ml_fetch_all and some manually handling.

FossilOrigin-Name: d18348bffba05ffe429f7a23e698ccfdc04539a8be35e65cbb9f789d94f31f66

Change Summary

• modified: Makefile
• modified: main.d
• modified: medialist.d
• delete: show.d
• modified: unittests.d

Incremental Difference

--- a/Makefile
+++ b/Makefile
@@ -27,15 +27,13 @@ endif
 
 all: medialist-cli
 
-medialist-cli: configparser.o main.o medialist.o show.o update.o \
-		util.o xdg.o
+medialist-cli: configparser.o main.o medialist.o update.o util.o xdg.o
 	$(DC) $(__dof__) medialist-cli configparser.o main.o medialist.o \
-		show.o update.o util.o xdg.o
+		update.o util.o xdg.o
 
 configparser.o: configparser.d
 main.o: main.d
 medialist.o: medialist.d
-show.o: show.d
 update.o: update.d
 util.o: util.d
 xdg.o: xdg.d
@@ -52,8 +50,8 @@ uninstall:
 	rm -f $(DESTDIR)$(bindir)/medialist-cli
 	rm -f $(DESTDIR)$(man1dir)/medialist-cli.1.gz
 
-unittest: configparser-u.o medialist-u.o \
-		show-u.o tap-u.o update-u.o util-u.o xdg-u.o unittests-u.o
+unittest: configparser-u.o medialist-u.o tap-u.o update-u.o util-u.o \
+		xdg-u.o unittests-u.o
 	$(DC) $(DTESTFLAGS) $(__dof__) medialist-cli-unittest $^
 
 configparser-u.o: configparser.d
@@ -62,9 +60,6 @@ configparser-u.o: configparser.d
 medialist-u.o: medialist.d
 	$(DC) $(DTESTFLAGS) -c $(__dof__) $@ $<
 
-show-u.o: show.d
-	$(DC) $(DTESTFLAGS) -c $(__dof__) $@ $<
-
 tap-u.o: tap.d
 	$(DC) $(DTESTFLAGS) -c $(__dof__) $@ $<
 

--- a/main.d
+++ b/main.d
@@ -18,6 +18,7 @@
  */
 import core.stdc.stdlib : EXIT_FAILURE, EXIT_SUCCESS;
 
+import std.algorithm.searching;
 import std.file;
 import std.path;
 import std.stdio;
@@ -25,7 +26,6 @@ import std.string;
 
 import configparser : ConfigParser;
 import medialist;
-import show : handle_show;
 import update : handle_update;
 import util : expandEnvironmentVariables;
 import xdg;
@@ -85,7 +85,7 @@ private MLError verifyDelete(MediaList* ml, string[] args)
     if (0 == args.length) {
         writef("Are you sure you want to delete the list \"%s\"? ([yes]/no) ",
             ml.listName);
-        string res = io.readln().strip().toLower();
+        string res = readln().strip().toLower();
 
         if ("" == res || "yes" == res) {
             response = ml_send_command(ml, MLCommand.delete_, []);
@@ -119,6 +119,68 @@ private MLError verifyDelete(MediaList* ml, string[] args)
     return response;
 }
 
+bool showList(MediaList* list, string[] args)
+{
+    bool numbered = false;
+    bool showHeaders = false;
+    
+    foreach(ref arg; args) {
+        if ("-n" == arg || "--numbered" == arg)
+            numbered = true;
+        
+        if ("--show-headers" == arg)
+            showHeaders = true;
+    }
+    
+    if (true == showHeaders) {
+        MediaListHeader[] headers = ml_fetch_headers(list);
+        string title;
+        string progress;
+        string status;
+        
+        foreach(size_t idx, const ref header; headers) {
+            switch(header.tsvName.toLower) {
+            case "title":
+                title = (header.humanFriendlyName == "")
+                        ? header.tsvName
+                        : header.humanFriendlyName;
+                break;
+            case "progress":
+                progress = (header.humanFriendlyName is null)
+                        ? header.tsvName
+                        : header.humanFriendlyName;
+                break;
+            case "status":
+                status = (header.humanFriendlyName is null)
+                        ? header.tsvName
+                        : header.humanFriendlyName;
+                break;
+            default:
+                break;
+            }
+        }
+        
+        writefln("%s => %s => %s", title, status, progress);
+        /* 8 = " => " * 2 */
+        size_t lineLength = title.length + status.length + progress.length + 8;
+        for (size_t i = 0; i < lineLength; i++) {
+            write("=");
+        }
+        write("\n");
+        stdout.flush();
+    }
+    
+    MediaListItem[] items = ml_fetch_all(list);
+    foreach(size_t idx, const ref item; items) {
+        if (true == numbered)
+            writef("%d: ", idx + 1);
+        
+        writefln("%s => %s => %s", item.title, item.status, item.progress);
+    }
+
+    return true;
+}
+
 int main(string[] args) {
     string config_dir = buildPath(configDir(), "medialist");
     string data_dir = buildPath(dataDir(), "medialist");
@@ -225,8 +287,8 @@ version(appimage) {
         }
         success = (res == MLError.success);
         break;
-    case "show": // CLI: <list> [--numbered] [--show-headers]
-        success = handle_show(program_name, args[2..$], data_dir);
+    case "show": // CLI: [--numbered] [--show-headers]
+        success = showList(ml, args[3..$]);
         break;
     case "delete": // CLI: <list> [<id...>]
         if (shouldVerifyDelete)

--- a/medialist.d
+++ b/medialist.d
@@ -34,6 +34,26 @@ struct MediaList
     bool isOpen = false;
 }
 
+struct MediaListItem
+{
+    string title;
+    string progress;
+    string status;
+    /* start_date */
+    /* end_date */
+    /* last_updated */
+    bool isValid;
+}
+
+struct MediaListHeader
+{
+    string tsvName = null;
+    string humanFriendlyName = null;
+    size_t column;
+}
+
+MediaListItem[] ml_fetch_items(MediaList *list, int ids...);
+
 enum MLCommand
 {
     /**
@@ -59,6 +79,7 @@ enum MLError
     invalidArgs,
     fileDoesNotExist,
     fileAlreadyOpen,
+    itemNotFound,
 }
 
 MediaList* ml_open_list(string filePath)
@@ -99,6 +120,182 @@ void ml_free_list(MediaList* list)
     GC.free(list);
 }
 
+MediaListHeader[] ml_fetch_headers(MediaList* list)
+{
+    if (true == list.isOpen)
+        throw new Exception("List '" ~ list.listName ~ "' is already open for modification");
+    
+    File listFile = File(list.filePath);
+    
+    list.isOpen = true;
+    scope(exit) list.isOpen = false;
+    
+    MediaListHeader[] headers;
+    string[string] configurations;
+    
+    string line;
+    
+    while ((line = listFile.readln()) !is null) {
+        if (line.length == 0)
+            continue;
+        
+        /* Header line, which we will parse now */
+        if ('#' != line[0])
+            break;
+        
+        /*
+         * The minimum mTSV configuration line is:
+         * #k=v
+         */
+        if (line.length < 4)
+            continue;
+        
+        /* mTSV configuration requires there to be NO space */
+        if (' ' != line[1])
+            continue;
+        
+        string[] sections = line[1..$].strip().split("=");
+
+        /* XXX: Should we error here? */
+        if (sections.length < 2)
+            continue;
+
+        configurations[sections[0]] = sections[1];
+    }
+    
+    if (line is null)
+        throw new Exception("No header line found");
+
+    string[] sections = line.strip().split("\t");
+    foreach(size_t idx, ref string section; sections) {
+        if (section in configurations)
+            headers ~= MediaListHeader(section, configurations[section], idx);
+        else
+            headers ~= MediaListHeader(section, null, idx);
+    }
+    
+    return headers;
+}
+
+MLError ml_fetch_item(MediaList* list, size_t id, MediaListItem* item)
+{
+    if (true == list.isOpen)
+        return MLError.fileAlreadyOpen;
+
+    list.isOpen = true;
+
+    File listFile = File(list.filePath);
+
+    string line;
+    size_t currentLine = 0;
+    bool found = false;
+
+    while ((line = listFile.readln()) !is null) {
+        if (0 >= line.length)
+            continue;
+
+        if ('#' == line[0])
+            continue;
+
+        if (id == currentLine) {
+            found = true;
+            break;
+        }
+        currentLine += 1;
+    }
+
+    if (false == found)
+        return MLError.itemNotFound;
+
+    int[2][6] headerPositions = _ml_get_header_positions(list);
+
+    string[] sections = line.strip().split("\t");
+    size_t titleIndex = 0;
+    size_t progressIndex = 0;
+    size_t statusIndex = 0;
+
+    foreach(size_t idx, int[2] 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;
+        default:
+            break;
+        }
+    }
+
+    MediaListItem newItem = MediaListItem(sections[titleIndex],
+        sections[progressIndex], sections[statusIndex], true);
+    
+    *item = newItem;
+
+    list.isOpen = false;
+
+    return MLError.success;
+}
+
+MediaListItem[] ml_fetch_all(MediaList* list)
+{
+    if (list.isOpen)
+        return null;
+
+    File listFile = File(list.filePath);
+    list.isOpen = true;
+    
+    string line;
+    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;
+    
+    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;
+        default:
+            break;
+        }
+    }
+
+    while ((line = listFile.readln()) !is null) {
+        if (line.length == 0)
+            continue;
+        
+        if (line[0] == '#')
+            continue;
+        
+        if (false == pastHeader) {
+            pastHeader = true;
+            continue;
+        }
+        
+        string[] sections = line.strip().split("\t");
+        
+        items ~= MediaListItem(sections[titleIndex], sections[progressIndex],
+            sections[statusIndex], true);
+    }
+    
+    list.isOpen = false;
+    
+    return items;
+}
+
 MLError ml_send_command(MediaList* list, MLCommand command, string[] args)
 {
     MLError res;
@@ -379,6 +576,10 @@ public void runMediaListUnitTests()
         "Can add a new item with status but no progress.");
     ok(unittest_addNewItemWithProgressWithStatus(),
         "Can add a new item with progress and status.");
+    ok(unittest_fetchItem2(),
+        "Can fetch a singular item by ID (2).");
+    ok(unittest_checkPre02MLFileHeaderOrder(),
+        "Check header position variance and case-insensitivity.");
 }
 
 private bool unittest_createNewList()
@@ -719,3 +920,105 @@ private bool unittest_addNewItemWithProgressWithStatus()
 
     return true;
 }
+
+private bool unittest_fetchItem2()
+{
+    MediaList *list = ml_open_list(buildPath(getcwd(), "unittest_fetchItem2.tsv"));
+
+    if (null is list)
+        return false;
+
+    scope(exit) {
+        ml_send_command(list, MLCommand.delete_, []);
+        ml_free_list(list);
+    }
+
+    MLError ec;
+
+    ec = ml_send_command(list, MLCommand.add, ["Item 1"]);
+    if (MLError.success != ec) {
+        diag("Failed to send add command [Item 1].");
+        return false;
+    }
+
+    ec = ml_send_command(list, MLCommand.add, ["Item 2", "1/-", "READING"]);
+    if (MLError.success != ec) {
+        diag("Failed to send add command [Item 2, 1/-, READING]");
+        return false;
+    }
+
+    MediaListItem item2;
+    
+    ec = ml_fetch_item(list, 2, &item2);
+    if (MLError.success != ec) {
+        diag(`Failed to fetch item 2 (ec = ` ~ to!string(ec) ~ `)`);
+        return false;
+    }
+
+    if ("Item 2" != item2.title) {
+        diag(`ml_fetch_item(2).title != "Item 2". (got: ` ~ item2.title ~ ")");
+        return false;
+    }
+
+    if ("1/-" != item2.progress) {
+        diag(`ml_fetch_item(2).progress != "1/-". (got: ` ~ item2.progress ~ ")");
+        return false;
+    }
+
+    if ("READING" != item2.status) {
+        diag(`ml_fetch_item(2).status != "READING". (got: ` ~ item2.status ~ ")");
+        return false;
+    }
+
+    return true;
+}
+
+/*
+ * Emulate pre-0.2 medialist files to confirm that headers can be in any order
+ * and that it is case-insensitive.
+ */
+private bool unittest_checkPre02MLFileHeaderOrder()
+{    
+    enum listName = "checkPre02MLFileHeaderOrder";
+    enum fileName = listName ~ ".tsv";
+
+    /* case-insensitive */
+    auto listFile = File(fileName, "w+");
+    listFile.writeln("TITLE\tPROGRESS\tSTATUS");
+    listFile.writeln("Item 1\t??/??\tUNKNOWN");
+    listFile.close();
+    
+    MediaList *list = ml_open_list(fileName);
+    
+    /* shouldn't crash */
+    MediaListHeader[] headers = ml_fetch_headers(list);
+    if (headers.length != 3) {
+        diag("headers.length != 3 (case IS sensitive)");
+        return false;
+    }
+    
+    /* shouldn't crash */
+    MediaListItem[] items = ml_fetch_all(list);
+    
+    ml_send_command(list, MLCommand.delete_, []);
+    ml_free_list(list);
+    
+    listFile = File(fileName, "w+");
+    listFile.writeln ("PROGRESS\tTItLE\tstatus");
+    listFile.writeln ("??/??\tItem 1\tUNKNOWN");
+    listFile.close();
+    
+    list = ml_open_list(fileName);
+    items = ml_fetch_all(list);
+    
+    headers = ml_fetch_headers(list);
+    if (headers.length != 3) {
+        diag("headers.length != 3 (order IS hard-coded)");
+        return false;
+    }
+    
+    ml_send_command(list, MLCommand.delete_, []);
+    ml_free_list(list);
+    
+    return true;
+}

--- a/show.d
+++ /dev/null
@@ -1,227 +0,0 @@
-/*
- * Copyright (C) 2021 dawning.
- *
- * This file is part of medialist-cli.
- *
- * medialist-cli is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * medialist-cli is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with medialist-cli.  If not, see <https://www.gnu.org/licenses/>.
- */
-module show;
-
-import util;
-
-import std.array : empty, split;
-import std.file : exists, isFile;
-import std.path : buildPath;
-import std.stdio : File, writef;
-import std.typecons : Tuple;
-
-@trusted bool
-handle_show(string program_name, string[] args, string data_dir)
-{
-	bool print_numbers = false;
-	bool show_headers = false;
-	string list_name = "";
-
-	foreach (arg; args)
-	{
-		switch (arg)
-		{
-		case "-n":
-		case "--numbered":
-			print_numbers = true;
-			break;
-		case "--show-headers":
-			show_headers = true;
-			break;
-		default:
-			if (true == list_name.empty)
-			{
-				list_name = arg;
-			}
-		}
-	}
-
-	immutable list_file = buildPath(data_dir, list_name ~ ".tsv");
-
-	if (false == list_file.exists || false == list_file.isFile)
-	{
-		_log("Couldn't find a list name '" ~ list_name ~ "'.", true);
-		return false;
-	}
-
-	File f = File(list_file, "r");
-
-	bool passed_header = false;
-	Tuple!(size_t, string)[NUMBER_OF_ML_HEADERS] headers;
-
-	size_t index = 1;
-	size_t title_index = 0;
-	size_t status_index = 0;
-	size_t progress_index = 0;
-
-	/* "Human Headers" as (currently not) documented */
-	/*
-	 * To make up for the lack of documentation:
-	 *  An octothorpe (#) followed by a space ( ) is ignored as a comment.
-	 *  An octothorpe followed by anything else is assumed to be a key-value option.
-	 *
-	 * medialist-cli will use the "value" of "keys" which share a name with a header
-	 * as a "Human Friendly" version. The "value" is stripped of whitespace, but not
-	 * of quotation marks.
-	 *
-	 * Example:
-	 *
-	 * #progress = Progress
-	 * #title=Title
-	 * #progress = progress
-	 * # Multiple occurrences of a "key" will result in the last one being used.
-	 */
-	string title = MLHeaders.title;
-	string status = MLHeaders.status;
-	string progress = MLHeaders.progress;
-
-	foreach (line; f.byLine)
-	{
-		if (line.empty)
-			continue;
-		if ("# " == line[0 .. 2])
-			continue;
-
-		if ('#' == line[0] && ' ' != line[1] && false == passed_header)
-		{
-			check_human_headers (line, title, progress, status);
-			continue;
-		}
-
-		auto sections = line.split("\t");
-		if (false == passed_header)
-		{
-			headers = parseMLHeader(cast(string[]) sections);
-			title_index = findHeaderIndex(headers, MLHeaders.title);
-			status_index = findHeaderIndex(headers, MLHeaders.status);
-			progress_index = findHeaderIndex(headers, MLHeaders.progress);
-			passed_header = true;
-			if (true == show_headers)
-			{
-				size_t i = 0;
-				writef ("%s => %s => %s\n", title, status, progress);
-				for (i = 0; i < title.length; i++)
-					writef ("=");
-				for (i = 0; i < progress.length; i++)
-					writef ("=");
-				for (i = 0; i < status.length; i++)
-					writef ("=");
-
-				writef ("========\n");
-			}
-		}
-		else
-		{
-			if (true == print_numbers)
-			{
-				writef("%d: ", index);
-			}
-
-			writef("%s => %s => %s\n", sections[title_index],
-				sections[status_index], sections[progress_index]);
-			index += 1;
-		}
-	}
-
-	return true;
-}
-
-private void
-check_human_headers (in char[] line, ref string title, ref string progress, ref string status)
-{
-	import std.algorithm.mutation : stripLeft;
-	import std.string : strip;
-
-	string key = "";
-	string value = "";
-
-	{
-		auto option = stripLeft(line, '#');
-		auto keyValue = split(option, "=");
-		if (2 > keyValue.length)
-		{
-			return;
-		}
-
-		key = strip(keyValue[0]).dup;
-		value = strip(keyValue[1]).dup;
-	}
-
-	if ("" == key)
-		return;
-
-	switch (key)
-	{
-	case MLHeaders.title:
-		title = value;
-		break;
-	case MLHeaders.progress:
-		progress = value;
-		break;
-	case MLHeaders.status:
-		status = value;
-		break;
-	default:
-		break;
-	}
-}
-
-private @safe size_t
-findHeaderIndex(ref HeaderPairType[NUMBER_OF_ML_HEADERS] headers, string searchHeader)
-{
-	/* reminder: HeaderPairType is Tuple!(size_t, string) */
-	foreach (header; headers)
-	{
-		if (header[1] == searchHeader)
-		{
-			return header[0];
-		}
-	}
-	return 0;
-}
-
-
-/* Emulate pre-0.2 medialist files to confirm that headers can be in any order */
-unittest
-{
-	import std.file : remove;
-	import std.stdio : File;
-
-	enum listName = "unittest-show.d-pre-0.2";
-
-	auto listFile = File(listName ~ ".tsv", "w+");
-	listFile.writeln("TITLE\tPROGRESS\tSTATUS");
-	listFile.writeln("Item 1\t??/??\tUNKNOWN");
-	listFile.close();
-
-	/* Shouldn't crash */
-	handle_show ("medialist-cli-unittest", [listName], ".");
-
-	remove (listName ~ ".tsv");
-
-	listFile = File (listName ~ ".tsv", "w+");
-	listFile.writeln ("PROGRESS\tTItLE\tstatus");
-	listFile.writeln ("??/??\tItem 1\tUNKNOWN");
-	listFile.close();
-
-	/* Also shouldn't crash */
-	handle_show ("medialist-cli-unittest", [listName], ".");
-
-	remove (listName ~ ".tsv");
-}

--- a/unittests.d
+++ b/unittests.d
@@ -24,7 +24,6 @@ import std.string : splitLines;
 
 import medialist;
 import update;
-import show;
 
 import tap;