From 38657a232368adced318f1cb0d5f6cfa58c2eb66 Mon Sep 17 00:00:00 2001
From: Mario Pietsch <pmariojo@gmail.com>
Date: Fri, 6 Sep 2024 20:46:53 +0200
Subject: [PATCH] tm-new-tiddler - Create empty tags field only if template or
 additionalFields contain a tags-field (#8559)

* create empty tags only if template or additionalFields contain a tags-field

* fix typos

* add tests for tm-new-tiddler message

* tm-new-tiddler add standard test with tags field
---
 core/modules/widgets/navigator.js             | 14 ++--
 .../create-a-new-tiddler-with-a-tag.tid       | 38 +++++++++++
 .../data/messages/tm-new-tiddler/default.tid  | 39 +++++++++++
 .../new-from-template-with-tag.tid            | 44 +++++++++++++
 .../new-from-template-without-tag.tid         | 65 +++++++++++++++++++
 .../messages/tm-new-tiddler/new-with-tag.tid  | 40 ++++++++++++
 6 files changed, 235 insertions(+), 5 deletions(-)
 create mode 100644 editions/test/tiddlers/tests/data/messages/tm-new-tiddler/create-a-new-tiddler-with-a-tag.tid
 create mode 100644 editions/test/tiddlers/tests/data/messages/tm-new-tiddler/default.tid
 create mode 100644 editions/test/tiddlers/tests/data/messages/tm-new-tiddler/new-from-template-with-tag.tid
 create mode 100644 editions/test/tiddlers/tests/data/messages/tm-new-tiddler/new-from-template-without-tag.tid
 create mode 100644 editions/test/tiddlers/tests/data/messages/tm-new-tiddler/new-with-tag.tid

diff --git a/core/modules/widgets/navigator.js b/core/modules/widgets/navigator.js
index efdbba83f..e9bec7682 100755
--- a/core/modules/widgets/navigator.js
+++ b/core/modules/widgets/navigator.js
@@ -184,7 +184,7 @@ NavigatorWidget.prototype.handleCloseOtherTiddlersEvent = function(event) {
 // Place a tiddler in edit mode
 NavigatorWidget.prototype.handleEditTiddlerEvent = function(event) {
 	var editTiddler = $tw.hooks.invokeHook("th-editing-tiddler",event),
-	    win = event.event && event.event.view ? event.event.view : window;
+		win = event.event && event.event.view ? event.event.view : window;
 	if(!editTiddler) {
 		return false;
 	}
@@ -306,7 +306,7 @@ NavigatorWidget.prototype.handleSaveTiddlerEvent = function(event) {
 	var title = event.param || event.tiddlerTitle,
 		tiddler = this.wiki.getTiddler(title),
 		storyList = this.getStoryList(),
-	    	win = event.event && event.event.view ? event.event.view : window;
+		win = event.event && event.event.view ? event.event.view : window;
 	// Replace the original tiddler with the draft
 	if(tiddler) {
 		var draftTitle = (tiddler.fields["draft.title"] || "").trim(),
@@ -412,7 +412,8 @@ NavigatorWidget.prototype.handleNewTiddlerEvent = function(event) {
 	event = $tw.hooks.invokeHook("th-new-tiddler", event);
 	// Get the story details
 	var storyList = this.getStoryList(),
-		templateTiddler, additionalFields, title, draftTitle, existingTiddler;
+		templateTiddler, additionalFields, title, draftTitle, existingTiddler,
+		templateHasTags = false;
 	// Get the template tiddler (if any)
 	if(typeof event.param === "string") {
 		// Get the template tiddler
@@ -457,8 +458,10 @@ NavigatorWidget.prototype.handleNewTiddlerEvent = function(event) {
 		// Merge tags
 		mergedTags = $tw.utils.pushTop(mergedTags,$tw.utils.parseStringArray(additionalFields.tags));
 	}
+	var additionalFieldsHasTags = !!(additionalFields && (additionalFields.tags === ""));
 	if(templateTiddler && templateTiddler.fields.tags) {
 		// Merge tags
+		templateHasTags = true;
 		mergedTags = $tw.utils.pushTop(mergedTags,templateTiddler.fields.tags);
 	}
 	// Save the draft tiddler
@@ -474,7 +477,8 @@ NavigatorWidget.prototype.handleNewTiddlerEvent = function(event) {
 		{
 			title: draftTitle,
 			"draft.of": title,
-			tags: mergedTags
+			// If template or additionalFields have "tags" even if empty a tags field will be created.
+			tags: ((mergedTags.length > 0) || templateHasTags || additionalFieldsHasTags) ? mergedTags : undefined
 		},this.wiki.getModificationFields());
 	this.wiki.addTiddler(draftTiddler);
 	// Update the story to insert the new draft at the top and remove any existing tiddler
@@ -526,7 +530,7 @@ NavigatorWidget.prototype.handleImportTiddlersEvent = function(event) {
 	var systemMessage = $tw.language.getString("Import/Upgrader/Tiddler/Unselected");
 	$tw.utils.each(messages,function(message,title) {
 		newFields["message-" + title] = message;
-		if (message.indexOf(systemMessage) !== -1) {
+		if(message.indexOf(systemMessage) !== -1) {
 			newFields["selection-" + title] = "unchecked";
 		}
 	});
diff --git a/editions/test/tiddlers/tests/data/messages/tm-new-tiddler/create-a-new-tiddler-with-a-tag.tid b/editions/test/tiddlers/tests/data/messages/tm-new-tiddler/create-a-new-tiddler-with-a-tag.tid
new file mode 100644
index 000000000..3f9204da8
--- /dev/null
+++ b/editions/test/tiddlers/tests/data/messages/tm-new-tiddler/create-a-new-tiddler-with-a-tag.tid
@@ -0,0 +1,38 @@
+title: Message/tm-new-tiddler/create-a-new-tiddler-with-a-tag
+description: tm-new-tiddler message will create a new draft tiddler with a tag
+type: text/vnd.tiddlywiki-multiple
+tags: [[$:/tags/wiki-test-spec]]
+
+title: Output
+
+<pre>{{Draft of 'New Tiddler'||output-template}}</pre>
++
+title: Actions
+
+<$navigator story="$:/StoryList">
+
+<$action-sendmessage $message="tm-new-tiddler"
+	text="some text"
+	z-field="a"
+	tags="test [[with spaces]]"
+/>
+
+</$navigator>
+
++
+title: output-template
+
+<!-- This template is used for saving tiddlers in TiddlyWeb *.tid format -->
+<$fields exclude='text bag created modified' template='$name$: $value$
+'></$fields>
+<$view field="text" format="text" />
++
+title: ExpectedResult
+
+<p><pre>draft.of: New Tiddler
+draft.title: New Tiddler
+tags: test [[with spaces]]
+title: Draft of 'New Tiddler'
+z-field: a
+
+some text</pre></p>
\ No newline at end of file
diff --git a/editions/test/tiddlers/tests/data/messages/tm-new-tiddler/default.tid b/editions/test/tiddlers/tests/data/messages/tm-new-tiddler/default.tid
new file mode 100644
index 000000000..cba16f261
--- /dev/null
+++ b/editions/test/tiddlers/tests/data/messages/tm-new-tiddler/default.tid
@@ -0,0 +1,39 @@
+title: Message/tm-new-tiddler/default
+description: tm-new-tiddler message will create a new draft tiddler
+type: text/vnd.tiddlywiki-multiple
+tags: [[$:/tags/wiki-test-spec]]
+
+title: Output
+
+<pre>{{Draft of 'New Tiddler'||output-template}}</pre>
++
+title: Actions
+
+<$navigator story="$:/StoryList">
+
+New in TW v5.3.6
+	Create a draft tiddler which should have __no__ tags field
+
+<$action-sendmessage $message="tm-new-tiddler"
+	text="some text"
+	z-field="a"
+/>
+
+</$navigator>
+
++
+title: output-template
+
+<!-- This template is used for saving tiddlers in TiddlyWeb *.tid format -->
+<$fields exclude='text bag created modified' template='$name$: $value$
+'></$fields>
+<$view field="text" format="text" />
++
+title: ExpectedResult
+
+<p><pre>draft.of: New Tiddler
+draft.title: New Tiddler
+title: Draft of 'New Tiddler'
+z-field: a
+
+some text</pre></p>
\ No newline at end of file
diff --git a/editions/test/tiddlers/tests/data/messages/tm-new-tiddler/new-from-template-with-tag.tid b/editions/test/tiddlers/tests/data/messages/tm-new-tiddler/new-from-template-with-tag.tid
new file mode 100644
index 000000000..aceeffdde
--- /dev/null
+++ b/editions/test/tiddlers/tests/data/messages/tm-new-tiddler/new-from-template-with-tag.tid
@@ -0,0 +1,44 @@
+title: Message/tm-new-tiddler/new-from-template-with-tag
+description: tm-new-tiddler create a draft from a template. Template has an empty tags field
+type: text/vnd.tiddlywiki-multiple
+tags: [[$:/tags/wiki-test-spec]]
+
+title: Output
+
+<pre>{{	Draft of 'new-tiddler-template 1'||output-template}}</pre>
++
+title: Actions
+
+<$navigator story="$:/StoryList">
+
+<$action-sendmessage $message="tm-new-tiddler"
+	$param="new-tiddler-template"
+	text="some text"
+	z-field="a"
+/>
+
+</$navigator>
+
++
+title: new-tiddler-template
+asdf: asdf
+tags:
+
++
+title: output-template
+
+<!-- This template is used for saving tiddlers in TiddlyWeb *.tid format -->
+<$fields exclude='text bag created modified' template='$name$: $value$
+'></$fields>
+<$view field="text" format="text" />
++
+title: ExpectedResult
+
+<p><pre>asdf: asdf
+draft.of: new-tiddler-template 1
+draft.title: new-tiddler-template 1
+tags: 
+title: Draft of 'new-tiddler-template 1'
+z-field: a
+
+some text</pre></p>
\ No newline at end of file
diff --git a/editions/test/tiddlers/tests/data/messages/tm-new-tiddler/new-from-template-without-tag.tid b/editions/test/tiddlers/tests/data/messages/tm-new-tiddler/new-from-template-without-tag.tid
new file mode 100644
index 000000000..dfb815f09
--- /dev/null
+++ b/editions/test/tiddlers/tests/data/messages/tm-new-tiddler/new-from-template-without-tag.tid
@@ -0,0 +1,65 @@
+title: Message/tm-new-tiddler/new-from-template-without-tag
+description: tm-new-tiddler create 2 drafts from a template. Template has no tags field
+type: text/vnd.tiddlywiki-multiple
+tags: [[$:/tags/wiki-test-spec]]
+
+title: Output
+
+<pre>{{	Draft of 'new-tiddler-template 1'||output-template}}</pre>
+<pre>{{	Draft of 'new-tiddler-template 2'||output-template}}</pre>
++
+title: Actions
+
+<$navigator story="$:/StoryList">
+
+New in TW v5.3.6
+	Create a new tiddler from a template, which has no tags field
+	So draft should also have __no__ tags field
+
+<$action-sendmessage $message="tm-new-tiddler"
+	$param="new-tiddler-template"
+	text="some text"
+	z-field="a"
+/>
+
+Create a new tiddler from a template, which has no tag field
+AND __add__ a tags field with the command below
+
+<$action-sendmessage $message="tm-new-tiddler"
+	$param="new-tiddler-template"
+	text="some text"
+	z-field="a"
+	tag=""
+/>
+
+</$navigator>
+
++
+title: new-tiddler-template
+asdf: asdf
+
++
+title: output-template
+
+<!-- This template is used for saving tiddlers in TiddlyWeb *.tid format -->
+<$fields exclude='text bag created modified' template='$name$: $value$
+'></$fields>
+<$view field="text" format="text" />
++
+title: ExpectedResult
+
+<p><pre>asdf: asdf
+draft.of: new-tiddler-template 1
+draft.title: new-tiddler-template 1
+title: Draft of 'new-tiddler-template 1'
+z-field: a
+
+some text</pre>
+<pre>asdf: asdf
+draft.of: new-tiddler-template 2
+draft.title: new-tiddler-template 2
+tag: 
+title: Draft of 'new-tiddler-template 2'
+z-field: a
+
+some text</pre></p>
\ No newline at end of file
diff --git a/editions/test/tiddlers/tests/data/messages/tm-new-tiddler/new-with-tag.tid b/editions/test/tiddlers/tests/data/messages/tm-new-tiddler/new-with-tag.tid
new file mode 100644
index 000000000..9b52e7de1
--- /dev/null
+++ b/editions/test/tiddlers/tests/data/messages/tm-new-tiddler/new-with-tag.tid
@@ -0,0 +1,40 @@
+title: Message/tm-new-tiddler/new-with-tag
+description: tm-new-tiddler message creates a draft tiddler with an empty tag field
+type: text/vnd.tiddlywiki-multiple
+tags: [[$:/tags/wiki-test-spec]]
+
+title: Output
+
+<pre>{{Draft of 'New Tiddler'||output-template}}</pre>
++
+title: Actions
+
+<$navigator story="$:/StoryList">
+
+Create a draft tiddler which __should have a tags field__
+
+<$action-sendmessage $message="tm-new-tiddler"
+	text="some text"
+	z-field="a"
+	tag=""
+/>
+
+</$navigator>
+
++
+title: output-template
+
+<!-- This template is used for saving tiddlers in TiddlyWeb *.tid format -->
+<$fields exclude='text bag created modified' template='$name$: $value$
+'></$fields>
+<$view field="text" format="text" />
++
+title: ExpectedResult
+
+<p><pre>draft.of: New Tiddler
+draft.title: New Tiddler
+tag: 
+title: Draft of 'New Tiddler'
+z-field: a
+
+some text</pre></p>
\ No newline at end of file