Commit: 7645bcaf4f5391ffb2694b8e15240ae12dff85fc - medialist-cli (git)

CLI interface to medialist (fossil mirror)

Commit MetaInfo

• Revision: 7645bcaf4f5391ffb2694b8e15240ae12dff85fc (tree)
• Zeit: 2021-11-21 19:09:36
• Autor: mio <stigma@disr...>
• Commiter: mio

Log Message

Share the code for adding missing headers between add.d and update.d (now located in util.d). These are the only places where the code should be required.

FossilOrigin-Name: 46ca890bccd96877f1e48144414e435bf8ea446de1e032f133b38df6312fb958

Ändern Zusammenfassung

• modified: add.d
• modified: update.d
• modified: util.d

Diff

--- a/add.d
+++ b/add.d
@@ -59,16 +59,16 @@ import util;
 		_log("list '" ~ listName ~ "' doesn't exist.", true);
 		return false;
 	}
-  
+
 	// no status or progress.
 	if (args.length < 3)
 	{
 		return addItem(listFilePath, title);
 	}
-  
+
 	string status = "UNKNOWN";
 	string progress = "??/??";
-  
+
 	getopt(args,
 		"status|s", "Set the initial status for the new item", &status,
 		"progress|p", "Set the initial progress for the new item", &progress);
@@ -78,7 +78,7 @@ import util;
 		writefln("Added %s to %s (status: %s, progress: %s)", title, listName, status, progress);
 		return true;
 	}
-	
+
 	return false;
 }
 
@@ -86,115 +86,14 @@ private bool addItem(string listFilePath, string itemName,
 		string status = "UNKNOWN", string progress = "??/??")
 {
 	File listFile = File(listFilePath, "a+");
-	
-	string[] headers = retrieveListHeaders(&listFile);
-	if (headers is null)
-	{
-		return false;
-	}
-	addMissingHeaders(headers, &listFile);
-	auto headersAndPositions = parseMLHeader(headers);
-	writeNewItem(&listFile, headersAndPositions, itemName, status, progress);
-	
-	return true;
-}
-
-private string[] retrieveListHeaders(File* listFile)
-{
-	string line;
-	
-	while ((line = listFile.readln()) !is null)
-	{
-		if ('#' != line[0])
-		{
-			return line.strip().split('\t');
-		}
-	}
-	
-	return null;
-}
-
-private void addMissingHeaders(ref string[] fileHeaders, File* listFile)
-{
-	import std.algorithm.searching : canFind;
-
-	if (false == canFind(fileHeaders, "start_date"))
-	{
-		addHeader(listFile, "start_date");
-		fileHeaders ~= "start_date";
-	}
-
-	if (false == canFind(fileHeaders, "end_date"))
-	{
-		addHeader(listFile, "end_date");
-		fileHeaders ~= "end_date";
-	}
-
-	if (false == canFind(fileHeaders, "last_updated"))
-	{
-		addHeader(listFile, "last_updated");
-		fileHeaders ~= "last_updated";
-	}
-}
-
-private
-void addHeader(File* f, string newHeader) @trusted
-in
-{
-	assert(f.isOpen == true);
-	assert(newHeader !is null);
-}
-out
-{
-	assert(f.isOpen == true);
-}
-do
-{
-	import std.file : rename, remove, tempDir;
-	import std.path : buildPath, baseName;
-
-	immutable origPath = f.name;
-	immutable tempPath = buildPath(tempDir(), baseName(origPath));
-
-	File tempFile = File(tempPath, "w+");
-
-	string line = "";
-	bool pastHeader = false;
-  
-	f.rewind();
-
-	while ((line = f.readln()) !is null)
-	{
-		if (false == pastHeader && '#' != line[0])
-		{
-			pastHeader = true;
-			tempFile.writefln("%s\t%s", line.strip, newHeader);
-		}
-		else
-		{
-			/* line may not have a newline character */
-			tempFile.writeln(line.strip);
-		}
-	}
-
-	f.close();
-
-	remove(origPath);
 
-	/* some operating systems don't like to copy from the tempdir? */
-	f.open(origPath, "a+");
-	tempFile.rewind();
+	string[] headers = retrieveListHeaders (&listFile);
+	addMissingHeaders (headers, &listFile);
 
-	while ((line = tempFile.readln()) !is null)
-	{
-		f.write(line);
-	}
-
-	/* rewind because we need to re-read the headers */
-	f.rewind();
+	auto headersAndPositions = parseMLHeader(headers);
+	writeNewItem(&listFile, headersAndPositions, itemName, status, progress);
 
-	tempFile.close();
-	remove(tempPath);
+	return true;
 }
 
 private void writeNewItem(File* listFile, HeaderPairType[NUMBER_OF_ML_HEADERS] headersAndPositions,
@@ -203,9 +102,9 @@ private void writeNewItem(File* listFile, HeaderPairType[NUMBER_OF_ML_HEADERS] h
 	import std.datetime.date : Date;
 	import std.datetime.systime : Clock;
 	import std.string : toLower;
-	
+
 	size_t previousIndent = 0;
-	
+
 	immutable currentDT = Clock.currTime();
 	immutable currentDateString = Date(currentDT.year, currentDT.month,
 		currentDT.day).toISOExtString();
@@ -215,7 +114,7 @@ private void writeNewItem(File* listFile, HeaderPairType[NUMBER_OF_ML_HEADERS] h
 		/* unset header -- no more headers possible */
 		if (headerPair[0] == 0 && headerPair[1] is null)
 			break;
-			
+
 		listFile.replicateIndent(headerPair, &previousIndent);
 
 		switch (headerPair[1])
@@ -262,7 +161,7 @@ private void replicateIndent(File* listFile, HeaderPairType headerPair, size_t*
 	import core.stdc.stdio : fprintf;
 	import core.stdc.stdio : cstderr = stderr;
 	import core.stdc.stdlib : malloc, free;
-	
+
 	// Can't add NULL byte to D string, so allocate a temp string and free it.
 	char* progname = cast(char*)malloc(char.sizeof * programName.length);
 	scope(exit) free(progname);
@@ -279,3 +178,29 @@ options:
 -p, --progress  the initial progress of the new item (default: ??/??)
 -s, --status    the initial status of the new item (default: UNKNOWN)\n", progname);
 }
+
+
+/* Testing pre-0.2 files with the addHeaders */
+unittest
+{
+	import std.file : remove;
+	import std.stdio : File;
+
+	enum listName = "unittest-add-pre-0.2";
+	string line;
+
+	auto listFile = File (listName ~ ".tsv", "w+");
+	scope (exit) remove(listName ~ ".tsv");
+
+	listFile.writeln("TITLE\tPROGRESS\tSTATUS");
+	listFile.close();
+
+	/* Shouldn't crash */
+	handle_add (listName, [listName, "Item 1", "-p", "??/??", "-s", "PLAN-TO-READ"], ".");
+
+	listFile.open(listName ~ ".tsv", "r");
+	listFile.rewind();
+	line = listFile.readln();
+	assert ("TITLE\tPROGRESS\tSTATUS\tstart_date\tend_date\tlast_updated\n" == line, "'" ~ line ~ "'");
+}
+

--- a/update.d
+++ b/update.d
@@ -110,6 +110,13 @@ handle_update(string program_name, string[] args, string data_dir)
   bool read_header = false;
   Tuple!(size_t, string)[NUMBER_OF_ML_HEADERS] headers;
 
+  /* Add missing headers */
+  {
+    File listFile = File(filename, "a+");
+    string[] headers_ = retrieveListHeaders(&listFile);
+    addMissingHeaders(headers_, &listFile);
+  }
+
   /*
    * line_number represents the line number in file.
    * index initially represents a matching ID number

--- a/util.d
+++ b/util.d
@@ -18,6 +18,7 @@
  */
 module util;
 
+import std.stdio : File;
 import std.typecons : Tuple, tuple;
 
 alias HeaderPairType = Tuple!(size_t, string);
@@ -183,3 +184,118 @@ parseMLHeader(string[] headerSections)
 
 	return sections;
 }
+
+public string[]
+retrieveListHeaders (File* listFile)
+{
+	import std.string : strip, split;
+
+	string line = null;
+	string[] fileHeaders;
+
+	listFile.rewind ();
+
+	while ((line = listFile.readln()) !is null)
+	{
+		if ('#' != line[0])
+		{
+			fileHeaders = line.strip().split('\t');
+			break;
+		}
+	}
+
+	return fileHeaders;
+}
+
+public void
+addMissingHeaders(ref string[] fileHeaders, File* listFile)
+{
+	import core.stdc.stdio : SEEK_END;
+	import std.algorithm.searching : canFind;
+
+	/* Version 0.2 */
+	if (false == canFind(fileHeaders, "start_date"))
+	{
+		addHeader(listFile, "start_date");
+		fileHeaders ~= "start_date";
+	}
+
+	if (false == canFind(fileHeaders, "end_date"))
+	{
+		addHeader(listFile, "end_date");
+		fileHeaders ~= "end_date";
+	}
+
+	if (false == canFind(fileHeaders, "last_updated"))
+	{
+		addHeader(listFile, "last_updated");
+		fileHeaders ~= "last_updated";
+	}
+
+	listFile.seek(0, SEEK_END);
+}
+
+@trusted private void
+addHeader(File* f, string newHeader)
+in
+{
+	assert (f.isOpen == true, "f.isOpen == true (in)");
+	assert (newHeader !is null, "newHeader !is null");
+}
+out
+{
+	assert (f.isOpen == true, "f.isOpen == true (out)");
+}
+do
+{
+	import std.file : remove, tempDir;
+	import std.path : buildPath, baseName;
+	import std.string : strip;
+
+	immutable originalPath = f.name;
+	immutable tempPath = buildPath(tempDir, baseName(originalPath));
+
+	File tempFile = File(tempPath, "w+");
+
+	string line = "";
+	bool pastHeader = false;
+
+	/* Make sure we're at the start of the file. */
+	f.rewind ();
+
+	while ((line = f.readln()) !is null)
+	{
+		if (false == pastHeader && '#' != line[0])
+		{
+			pastHeader = true;
+			tempFile.writefln ("%s\t%s", strip (line), newHeader);
+		}
+		else
+		{
+			/* strip + writeln since the previous one may not have had the newline */
+			tempFile.writeln (strip (line));
+		}
+	}
+
+	f.close ();
+
+	/*
+	 * Since the temporary directory *could* be mounted differently (e.g. remotely)
+	 * some systems don't like to copy from the temporary directory.
+	 */
+	remove (originalPath);
+
+	f.open (originalPath, "w+");
+	tempFile.rewind ();
+
+	while ((line = tempFile.readln()) !is null)
+	{
+		f.write (line);
+	}
+
+	/* Rewind since we need to re-parse the headers */
+	f.rewind ();
+
+	tempFile.close();
+	remove (tempPath);
+}