tiddlywiki 5.3.3 → 5.3.4

package/editions/test/tiddlers/tests/test-backtranscludes.js

@@ -0,0 +1,241 @@
+/*\
+title: test-backtranscludes.js
+type: application/javascript
+tags: $:/tags/test-spec
+
+Tests the backtranscludes mechanism.
+
+\*/
+(function(){
+/*jslint node: true, browser: true */
+/*global $tw: false */
+"use strict";
+
+describe('Backtranscludes and transclude filter tests', function() {
+	describe('a tiddler with no transcludes to it', function() {
+		var wiki = new $tw.Wiki();
+
+		wiki.addTiddler({
+			title: 'TestIncoming',
+			text: ''});
+
+		it('should have no backtranscludes', function() {
+			expect(wiki.filterTiddlers('TestIncoming +[backtranscludes[]]').join(',')).toBe('');
+		});
+		it('should have no transcludes', function() {
+			expect(wiki.filterTiddlers('TestIncoming +[transcludes[]]').join(',')).toBe('');
+		});
+	});
+
+	describe('A tiddler added to the wiki with a transclude to it', function() {
+		var wiki = new $tw.Wiki();
+
+		wiki.addTiddler({
+			title: 'TestIncoming',
+			text: 'something'});
+
+		wiki.addTiddler({
+			title: 'TestOutgoing',
+			text: 'A transclude to {{TestIncoming}}'});
+
+		it('should have a backtransclude', function() {
+			expect(wiki.filterTiddlers('TestIncoming +[backtranscludes[]]').join(',')).toBe('TestOutgoing');
+		});
+		it('should have a transclude', function() {
+			expect(wiki.filterTiddlers('TestOutgoing +[transcludes[]]').join(',')).toBe('TestIncoming');
+		});
+	});
+
+	describe('A tiddler transclude with template will still use the tiddler as result.', function() {
+		var wiki = new $tw.Wiki();
+
+		wiki.addTiddler({
+			title: 'TestIncoming',
+			text: 'something'});
+
+		wiki.addTiddler({
+			title: 'TestOutgoing',
+			text: 'A transclude to {{TestIncoming||$:/core/ui/TagTemplate}}'});
+
+		it('should have a backtransclude', function() {
+			expect(wiki.filterTiddlers('TestIncoming +[backtranscludes[]]').join(',')).toBe('TestOutgoing');
+		});
+	});
+
+	describe('A data tiddler transclude will still use the tiddler as result.', function() {
+		var wiki = new $tw.Wiki();
+
+		wiki.addTiddler({
+			title: 'TestIncoming',
+			type: 'application/x-tiddler-dictionary',
+			text: 'name: value'});
+
+		wiki.addTiddler({
+			title: 'TestOutgoing',
+			text: 'A transclude to {{TestIncoming##name}}'});
+
+		it('should have a backtransclude', function() {
+			expect(wiki.filterTiddlers('TestIncoming +[backtranscludes[]]').join(',')).toBe('TestOutgoing');
+		});
+		it('should have a transclude', function() {
+			expect(wiki.filterTiddlers('TestOutgoing +[transcludes[]]').join(',')).toBe('TestIncoming');
+		});
+	});
+
+	describe('A tiddler that has a transclude added to it later', function() {
+		it('should have an additional backtransclude', function() {
+			var wiki = new $tw.Wiki();
+
+			wiki.addTiddler({
+				title: 'TestIncoming',
+				text: ''});
+
+			wiki.addTiddler({
+				title: 'TestOutgoing',
+				text: 'A transclude to {{TestIncoming}}'});
+
+			wiki.addTiddler({
+				title: 'TestOutgoing2',
+				text: 'Nothing yet!'});
+
+			expect(wiki.filterTiddlers('TestIncoming +[backtranscludes[]]').join(',')).toBe('TestOutgoing');
+
+			wiki.addTiddler({
+				title: 'TestOutgoing2',
+				text: 'Updated with transclude to {{TestIncoming}}'});
+
+			expect(wiki.filterTiddlers('TestIncoming +[backtranscludes[]]').join(',')).toBe('TestOutgoing,TestOutgoing2');
+		});
+	});
+
+	describe('A tiddler that has a transclude remove from it later', function() {
+		var wiki = new $tw.Wiki();
+
+		wiki.addTiddler({
+			title: 'TestIncoming',
+			text: ''});
+
+		wiki.addTiddler({
+			title: 'TestOutgoing',
+			text: 'A transclude to {{TestIncoming}}'});
+
+		it('should have one fewer backtransclude', function() {
+			expect(wiki.filterTiddlers('TestIncoming +[backtranscludes[]]').join(',')).toBe('TestOutgoing');
+
+			wiki.addTiddler({
+				title: 'TestOutgoing',
+				text: 'No transclude to ~TestIncoming'});
+
+			expect(wiki.filterTiddlers('TestIncoming +[backtranscludes[]]').join(',')).toBe('');
+		});
+	});
+
+	describe('A tiddler transcludeing to another that gets renamed', function() {
+		var wiki = new $tw.Wiki();
+
+		wiki.addTiddler({
+			title: 'TestIncoming',
+			text: ''});
+
+		wiki.addTiddler({
+			title: 'TestOutgoing',
+			text: 'A transclude to {{TestIncoming}}'});
+
+		it('should have its name changed in the backtranscludes', function() {
+			expect(wiki.filterTiddlers('TestIncoming +[backtranscludes[]]').join(',')).toBe('TestOutgoing');
+
+			wiki.renameTiddler('TestOutgoing', 'TestExtroverted');
+
+			expect(wiki.filterTiddlers('TestIncoming +[backtranscludes[]]').join(',')).toBe('TestExtroverted');
+		});
+	});
+
+	describe('A tiddler transcludeing to another that gets deleted', function() {
+		var wiki = new $tw.Wiki();
+
+		wiki.addTiddler({
+			title: 'TestIncoming',
+			text: ''});
+
+		wiki.addTiddler({
+			title: 'TestOutgoing',
+			text: 'A transclude to {{TestIncoming}}'});
+
+		it('should be removed from backtranscludes', function() {
+			expect(wiki.filterTiddlers('TestIncoming +[backtranscludes[]]').join(',')).toBe('TestOutgoing');
+
+			wiki.deleteTiddler('TestOutgoing');
+
+			expect(wiki.filterTiddlers('TestIncoming +[backtranscludes[]]').join(',')).toBe('');
+		});
+	});
+
+	describe('a tiddler with some transcludes on it in order', function() {
+		var wiki = new $tw.Wiki();
+
+		wiki.addTiddler({
+			title: 'TestOutgoing',
+			text: "{{New Tiddler!!created}}\n\nA transclude to {{TestIncoming}}"
+		});
+
+		it('should have a transclude', function() {
+			expect(wiki.filterTiddlers('TestOutgoing +[transcludes[]]').join(',')).toBe('New Tiddler,TestIncoming');
+		});
+
+		it('should have a back transclude', function() {
+			expect(wiki.filterTiddlers('TestIncoming +[backtranscludes[]]').join(',')).toBe('TestOutgoing');
+			expect(wiki.filterTiddlers('[[New Tiddler]] +[backtranscludes[]]').join(',')).toBe('TestOutgoing');
+		});
+	});
+
+	describe('include implicit self transclusion', function() {
+		var wiki = new $tw.Wiki();
+
+		wiki.addTiddler({
+			title: 'TestOutgoing',
+			text: "{{!!created}}\n\nAn implicit self-referential transclude to <$transclude $field='created'/> and <$transclude field='created'/>"});
+
+		it('should have no transclude', function() {
+			expect(wiki.filterTiddlers('TestOutgoing +[transcludes[]]').join(',')).toBe('TestOutgoing');
+		});
+
+		it('should have no back transcludes', function() {
+			expect(wiki.filterTiddlers('TestOutgoing +[backtranscludes[]]').join(',')).toBe('TestOutgoing');
+		});
+	});
+
+	describe('include explicit self transclusion', function() {
+		var wiki = new $tw.Wiki();
+
+		wiki.addTiddler({
+			title: 'TestOutgoing',
+			text: "{{TestOutgoing!!created}}\n\n<$transclude $tiddler='TestOutgoing' $field='created'/> and <$transclude tiddler='TestOutgoing' field='created'/>"});
+
+			it('should have no transclude', function() {
+			expect(wiki.filterTiddlers('TestOutgoing +[transcludes[]]').join(',')).toBe('TestOutgoing');
+		});
+
+		it('should have no back transcludes', function() {
+			expect(wiki.filterTiddlers('TestOutgoing +[backtranscludes[]]').join(',')).toBe('TestOutgoing');
+		});
+	});
+
+	describe('recognize transclusion defined by widget', function() {
+		var wiki = new $tw.Wiki();
+
+		wiki.addTiddler({
+			title: 'TestOutgoing',
+			text: "<$tiddler tiddler='TestIncoming'><$transclude $tiddler /></$tiddler>\n\n<$transclude tiddler='TiddlyWiki Pre-release'/>"});
+
+		it('should have a transclude', function() {
+			expect(wiki.filterTiddlers('TestOutgoing +[transcludes[]]').join(',')).toBe('TestIncoming,TiddlyWiki Pre-release');
+		});
+
+		it('should have a back transclude', function() {
+			expect(wiki.filterTiddlers('TestIncoming +[backtranscludes[]]').join(',')).toBe('TestOutgoing');
+			expect(wiki.filterTiddlers('[[TiddlyWiki Pre-release]] +[backtranscludes[]]').join(',')).toBe('TestOutgoing');
+		});
+	});
+});
+
+})();

package/editions/test/tiddlers/tests/test-fakedom.js

@@ -0,0 +1,27 @@
+/*\
+title: test-fakedom.js
+type: application/javascript
+tags: [[$:/tags/test-spec]]
+
+Tests the fakedom that Tiddlywiki occasionally uses.
+
+\*/
+(function(){
+
+/*jslint node: true, browser: true */
+/*global $tw: false */
+"use strict";
+
+describe("fakedom tests", function() {
+
+	it("properly assigns nodeType based on DOM standards", function() {
+		// According to MDN, ELEMENT_NODE == 1 && TEXT_NODE == 3
+		// There are others, but currently they're not implemented in fakedom
+		expect($tw.fakeDocument.createElement("div").nodeType).toBe(1);
+		expect($tw.fakeDocument.createElement("div").ELEMENT_NODE).toBe(1);
+		expect($tw.fakeDocument.createTextNode("text").nodeType).toBe(3);
+		expect($tw.fakeDocument.createTextNode("text").TEXT_NODE).toBe(3);
+	});
+});
+
+})();

package/editions/test/tiddlers/tests/test-plugins.js

@@ -0,0 +1,55 @@
+/*\
+title: test-plugins.js
+type: application/javascript
+tags: [[$:/tags/test-spec]]
+
+Tests for integrity of the core plugins, languages, themes and editions
+
+\*/
+(function(){
+
+/*jslint node: true, browser: true */
+/*global $tw: false */
+"use strict";
+
+if($tw.node) {
+
+	describe("Plugin tests", function() {
+
+		// Get all the plugins as a hashmap by title of a JSON string with the plugin content
+		var tiddlers = $tw.utils.getAllPlugins({ignoreEnvironmentVariables: true});
+		// console.log(JSON.stringify(Object.keys(tiddlers),null,4));
+		describe("every plugin should have the required standard fields", function() {
+			var titles = Object.keys(tiddlers);
+			$tw.utils.each(titles,function(title) {
+				var fields = tiddlers[title];
+				it("plugin should have a recognised plugin-type field",function() {
+					expect(["plugin","language","theme"].indexOf(fields["plugin-type"]) !== -1).toEqual(true);
+				});
+				switch(fields["plugin-type"]) {
+					case "plugin":
+						it("plugin " + title + " should have name, description and list fields",function() {
+							expect(!!(fields.name && fields.description && fields.list)).toBe(true);
+						});
+						it("plugin " + title + " should have a valid stability field",function() {
+							expect(["STABILITY_0_DEPRECATED","STABILITY_1_EXPERIMENTAL","STABILITY_2_STABLE","STABILITY_3_LEGACY"].indexOf(fields.stability) !== -1).toBe(true);
+						});
+						break;
+					case "language":
+						it("language " + title + " should have name and description fields",function() {
+							expect(!!(fields.name && fields.description)).toEqual(true);
+						});
+						break;
+					case "theme":
+						it("theme " + title + " should have name and description fields",function() {
+							expect(!!(fields.name && fields.description)).toEqual(true);
+						});
+						break;
+				}
+			});
+		});
+	});
+}
+
+
+})();

package/editions/test/tiddlers/tests/test-widget-getVariableInfo.js

@@ -0,0 +1,95 @@
+/*\
+title: test-widget-getVariableInfo.js
+type: application/javascript
+tags: [[$:/tags/test-spec]]
+
+Tests the wikitext rendering pipeline end-to-end. We also need tests that individually test parsers, rendertreenodes etc., but this gets us started.
+
+\*/
+(function(){
+
+/*jslint node: true, browser: true */
+/*global $tw: false */
+"use strict";
+
+describe("Widget module", function() {
+
+	var widget = require("$:/core/modules/widgets/widget.js");
+
+	function createWidgetNode(parseTreeNode,wiki) {
+		return new widget.widget(parseTreeNode,{
+				wiki: wiki,
+				document: $tw.fakeDocument
+			});
+	}
+
+	function parseText(text,wiki,options) {
+		var parser = wiki.parseText("text/vnd.tiddlywiki",text,options);
+		return parser ? {type: "widget", children: parser.tree} : undefined;
+	}
+
+	function renderWidgetNode(widgetNode) {
+		$tw.fakeDocument.setSequenceNumber(0);
+		var wrapper = $tw.fakeDocument.createElement("div");
+		widgetNode.render(wrapper,null);
+// console.log(require("util").inspect(wrapper,{depth: 8}));
+		return wrapper;
+	}
+
+	function refreshWidgetNode(widgetNode,wrapper,changes) {
+		var changedTiddlers = {};
+		if(changes) {
+			$tw.utils.each(changes,function(title) {
+				changedTiddlers[title] = true;
+			});
+		}
+		widgetNode.refresh(changedTiddlers,wrapper,null);
+// console.log(require("util").inspect(wrapper,{depth: 8}));
+	}
+
+	it("should make sure that getVariableInfo returns all expected parameters", function() {
+		var wiki = new  $tw.Wiki();
+		wiki.addTiddlers([
+			{title: "A", text: "\\define macro(a:aa) aaa"},
+			{title: "B", text: "\\function fn(f:ff) fff\n\\function x() [<fn>]"},
+			{title: "C", text: "\\procedure proc(p:pp) ppp"},
+			{title: "D", text: "\\widget $my.widget(w:ww) www"}
+		]);
+		var text = "\\import A B C D\n\n<$let abc=def>";
+		var widgetNode = createWidgetNode(parseText(text,wiki),wiki);
+		// Render the widget node to the DOM
+		renderWidgetNode(widgetNode);
+		var childNode = widgetNode;
+		while(childNode.children.length > 0) {
+			childNode = childNode.children[0];
+		}
+
+		expect(childNode.getVariableInfo("macro",{allowSelfAssigned:true}).params).toEqual([{name:"a",value:"aa"}]);
+
+		// function params
+		expect(childNode.getVariableInfo("fn",   {allowSelfAssigned:true}).params).toEqual([{name:"f",value:"ff"}]);
+		// functions have a text and a value
+		expect(childNode.getVariableInfo("x",   {allowSelfAssigned:true}).text).toBe("fff");
+		expect(childNode.getVariableInfo("x",   {allowSelfAssigned:true}).srcVariable.value).toBe("[<fn>]");
+
+		// procedures and widgets failed prior to v5.3.4
+		expect(childNode.getVariableInfo("proc", {allowSelfAssigned:true}).params).toEqual([{name:"p",default:"pp"}]);
+		expect(childNode.getVariableInfo("$my.widget", {allowSelfAssigned:true}).params).toEqual([{name:"w",default:"ww"}]);
+
+		// no params expected
+		expect(childNode.getVariableInfo("abc", {allowSelfAssigned:true})).toEqual({text:"def"});
+
+		// debugger; Find code in browser
+
+		// Find values to be compated to
+		// console.log("macro", childNode.getVariableInfo("macro",{allowSelfAssigned:true}));
+		// console.log("function", childNode.getVariableInfo("fn",{allowSelfAssigned:true}));
+		// console.log("function x", childNode.getVariableInfo("x",{allowSelfAssigned:true}));
+		// console.log("procedure", childNode.getVariableInfo("proc",{allowSelfAssigned:true}));
+		// console.log("widget", childNode.getVariableInfo("$my.widget",{allowSelfAssigned:true}));
+		// console.log("let", childNode.getVariableInfo("abc",{allowSelfAssigned:true}));
+	});
+
+});
+
+})();

package/editions/test/tiddlers/tests/test-widget.js

@@ -160,6 +160,47 @@ describe("Widget module", function() {
 		expect(wrapper.innerHTML).toBe("<span class=\"tc-error\">Recursive transclusion error in transclude widget</span>");
 	});
 
+	it("should handle single-tiddler recursion with branching nodes", function() {
+		var wiki = new $tw.Wiki();
+		// Add a tiddler
+		wiki.addTiddlers([
+			{title: "TiddlerOne", text: "<$tiddler tiddler='TiddlerOne'><$transclude /> <$transclude /></$tiddler>"},
+		]);
+		// Test parse tree
+		var parseTreeNode = {type: "widget", children: [
+								{type: "transclude", attributes: {
+										"tiddler": {type: "string", value: "TiddlerOne"}
+									}}
+							]};
+		// Construct the widget node
+		var widgetNode = createWidgetNode(parseTreeNode,wiki);
+		// Render the widget node to the DOM
+		var wrapper = renderWidgetNode(widgetNode);
+		// Test the rendering
+		expect(wrapper.innerHTML).toBe("<span class=\"tc-error\">Recursive transclusion error in transclude widget</span> <span class=\"tc-error\">Recursive transclusion error in transclude widget</span>");
+	});
+
+	it("should handle many-tiddler recursion with branching nodes", function() {
+		var wiki = new $tw.Wiki();
+		// Add a tiddler
+		wiki.addTiddlers([
+			{title: "TiddlerOne", text: "<$transclude tiddler='TiddlerTwo'/> <$transclude tiddler='TiddlerTwo'/>"},
+			{title: "TiddlerTwo", text: "<$transclude tiddler='TiddlerOne'/>"}
+		]);
+		// Test parse tree
+		var parseTreeNode = {type: "widget", children: [
+								{type: "transclude", attributes: {
+										"tiddler": {type: "string", value: "TiddlerOne"}
+									}}
+							]};
+		// Construct the widget node
+		var widgetNode = createWidgetNode(parseTreeNode,wiki);
+		// Render the widget node to the DOM
+		var wrapper = renderWidgetNode(widgetNode);
+		// Test the rendering
+		expect(wrapper.innerHTML).toBe("<span class=\"tc-error\">Recursive transclusion error in transclude widget</span>");
+	});
+
 	it("should deal with SVG elements", function() {
 		var wiki = new $tw.Wiki();
 		// Construct the widget node
@@ -775,6 +816,26 @@ describe("Widget module", function() {
 		expect(wrapper.innerHTML).toBe("<p>Bval</p>");
 	});
 
+	it("should use default $parameters if directly rendered", function() {
+		var wiki = new $tw.Wiki();
+		var text = "<$parameters bee=default $$dollar=bill nothing empty=''>bee=<<bee>>, $dollar=<<$dollar>>, nothing=<<nothing>>, empty=<<empty>></$parameters>";
+		var widgetNode = createWidgetNode(parseText(text,wiki),wiki);
+		// Render the widget node to the DOM
+		var wrapper = renderWidgetNode(widgetNode);
+		// nothing = true in this attribute form because valueless attributes always equal true.
+		expect(wrapper.innerHTML).toBe("<p>bee=default, $dollar=bill, nothing=true, empty=</p>");
+	});
+
+	it("should use default \\parameters if directly rendered", function() {
+		var wiki = new $tw.Wiki();
+		var text = "\\parameters(bee:default $$dollar:bill nothing)\nbee=<<bee>>, $$dollar=<<$$dollar>>, nothing=<<nothing>>";
+		var widgetNode = createWidgetNode(parseText(text,wiki),wiki);
+		// Render the widget node to the DOM
+		var wrapper = renderWidgetNode(widgetNode);
+		// nothing = true in this attribute form because valueless attributes always equal true.
+		expect(wrapper.innerHTML).toBe("<p>bee=default, $$dollar=bill, nothing=</p>");
+	});
+
 	it("can have more than one macroDef variable imported", function() {
 		var wiki = new $tw.Wiki();
 		wiki.addTiddlers([