Merge remote-tracking branch 'origin/master' into feature/cbr/load-defer

boot/boot.css

@@ -1,6 +1,3 @@
-title: $:/boot/boot.css
-type: text/css
-
 /*
 Basic styles used before we boot up the parsing engine
 */

boot/boot.js

@@ -142,15 +142,15 @@ $tw.utils.each = function(object,callback) {
 	var next,f,length;
 	if(object) {
 		if(Object.prototype.toString.call(object) == "[object Array]") {
-			for (f=0, length=object.length; f<length; f++) {
+			for(f=0, length=object.length; f<length; f++) {
 				next = callback(object[f],f,object);
 				if(next === false) {
 					break;
 				}
-		    }
+			}
 		} else {
 			var keys = Object.keys(object);
-			for (f=0, length=keys.length; f<length; f++) {
+			for(f=0, length=keys.length; f<length; f++) {
 				var key = keys[f];
 				next = callback(object[key],key,object);
 				if(next === false) {
@@ -275,7 +275,7 @@ Extend an object with the properties from a list of source objects
 $tw.utils.extend = function(object /*, sourceObjectList */) {
 	$tw.utils.each(Array.prototype.slice.call(arguments,1),function(source) {
 		if(source) {
-			for (var p in source) {
+			for(var p in source) {
 				object[p] = source[p];
 			}
 		}
@@ -289,7 +289,7 @@ Fill in any null or undefined properties of an object with the properties from a
 $tw.utils.deepDefaults = function(object /*, sourceObjectList */) {
 	$tw.utils.each(Array.prototype.slice.call(arguments,1),function(source) {
 		if(source) {
-			for (var p in source) {
+			for(var p in source) {
 				if(object[p] === null || object[p] === undefined) {
 					object[p] = source[p];
 				}
@@ -913,8 +913,8 @@ $tw.modules.execute = function(moduleName,moduleRoot) {
 	} else {
 		/*
 		CommonJS optional require.main property:
-		 In a browser we offer a fake main module which points back to the boot function
-		 (Theoretically, this may allow TW to eventually load itself as a module in the browser)
+			In a browser we offer a fake main module which points back to the boot function
+			(Theoretically, this may allow TW to eventually load itself as a module in the browser)
 		*/
 		Object.defineProperty(sandbox.require, "main", {
 			value: (typeof(require) !== "undefined") ? require.main : {TiddlyWiki: _boot},
@@ -956,9 +956,9 @@ $tw.modules.execute = function(moduleName,moduleRoot) {
 				moduleInfo.exports = moduleInfo.definition;
 			}
 		} catch(e) {
-			if (e instanceof SyntaxError) {
+			if(e instanceof SyntaxError) {
 				var line = e.lineNumber || e.line; // Firefox || Safari
-				if (typeof(line) != "undefined" && line !== null) {
+				if(typeof(line) != "undefined" && line !== null) {
 					$tw.utils.error("Syntax error in boot module " + name + ":" + line + ":\n" + e.stack);
 				} else if(!$tw.browser) {
 					// this is the only way to get node.js to display the line at which the syntax error appeared,
@@ -1553,7 +1553,7 @@ Define all modules stored in ordinary tiddlers
 $tw.Wiki.prototype.defineTiddlerModules = function() {
 	this.each(function(tiddler,title) {
 		if(tiddler.hasField("module-type")) {
-			switch (tiddler.fields.type) {
+			switch(tiddler.fields.type) {
 				case "application/javascript":
 					// We only define modules that haven't already been defined, because in the browser modules in system tiddlers are defined in inline script
 					if(!$tw.utils.hop($tw.modules.titles,tiddler.fields.title)) {
@@ -2090,7 +2090,7 @@ $tw.loadTiddlersFromSpecification = function(filepath,excludeRegExp,options) {
 		arrayOfFiles = arrayOfFiles || [];
 		var files = fs.readdirSync(dirPath);
 		files.forEach(function(file) {
-			if (recurse && fs.statSync(dirPath + path.sep + file).isDirectory()) {
+			if(recurse && fs.statSync(dirPath + path.sep + file).isDirectory()) {
 				arrayOfFiles = getAllFiles(dirPath + path.sep + file, recurse, arrayOfFiles);
 			} else if(fs.statSync(dirPath + path.sep + file).isFile()){
 				arrayOfFiles.push(path.join(dirPath, path.sep, file));
@@ -2259,13 +2259,16 @@ Returns an array of search paths
 */
 $tw.getLibraryItemSearchPaths = function(libraryPath,envVar) {
 	var pluginPaths = [path.resolve($tw.boot.corePath,libraryPath)],
+		env;
+	if(envVar) {
 		env = process.env[envVar];
-	if(env) {
-		env.split(path.delimiter).map(function(item) {
-			if(item) {
-				pluginPaths.push(item);
-			}
-		});
+		if(env) {
+			env.split(path.delimiter).map(function(item) {
+				if(item) {
+					pluginPaths.push(item);
+				}
+			});
+		}
 	}
 	return pluginPaths;
 };
@@ -2351,7 +2354,7 @@ $tw.loadWikiTiddlers = function(wikiPath,options) {
 		}
 		$tw.wiki.addTiddlers(tiddlerFile.tiddlers);
 	});
-	if ($tw.boot.wikiPath == wikiPath) {
+	if($tw.boot.wikiPath == wikiPath) {
 		// Save the original tiddler file locations if requested
 		var output = {}, relativePath, fileInfo;
 		for(var title in $tw.boot.files) {
@@ -2706,14 +2709,14 @@ $tw.boot.doesTaskMatchPlatform = function(taskModule) {
 	var platforms = taskModule.platforms;
 	if(platforms) {
 		for(var t=0; t<platforms.length; t++) {
-			switch (platforms[t]) {
+			switch(platforms[t]) {
 				case "browser":
-					if ($tw.browser) {
+					if($tw.browser) {
 						return true;
 					}
 					break;
 				case "node":
-					if ($tw.node) {
+					if($tw.node) {
 						return true;
 					}
 					break;
@@ -2796,7 +2799,7 @@ Invoke the hook by key
 $tw.hooks.invokeHook = function(hookName /*, value,... */) {
 	var args = Array.prototype.slice.call(arguments,1);
 	if($tw.utils.hop($tw.hooks.names,hookName)) {
-		for (var i = 0; i < $tw.hooks.names[hookName].length; i++) {
+		for(var i = 0; i < $tw.hooks.names[hookName].length; i++) {
 			args[0] = $tw.hooks.names[hookName][i].apply(null,args);
 		}
 	}

boot/sjcl.js.meta

@@ -1,3 +0,0 @@
-title: $:/library/sjcl.js
-type: application/javascript
-library: yes

boot/tiddlywiki.files

@@ -0,0 +1,35 @@
+{
+	"tiddlers": [
+		{
+			"file": "sjcl.js",
+			"fields": {
+				"title": "$:/library/sjcl.js",
+				"type": "application/javascript",
+				"library": "yes"
+			},
+			"prefix": "(function(define) {\n",
+			"suffix": "\n})(function (_,defined){window.sjcl = defined()})\n"
+		},
+		{
+			"file": "boot.js",
+			"fields": {
+				"title": "$:/boot/boot.js",
+				"type": "application/javascript"
+			}
+		},
+		{
+			"file": "bootprefix.js",
+			"fields": {
+				"title": "$:/boot/bootprefix.js",
+				"type": "application/javascript"
+			}
+		},
+		{
+			"file": "boot.css",
+			"fields": {
+				"title": "$:/boot/boot.css",
+				"type": "text/css"
+			}
+		}
+	]
+}

core/modules/utils/errors.js

@@ -0,0 +1,23 @@
+/*\
+title: $:/core/modules/utils/errors.js
+type: application/javascript
+module-type: utils
+
+Custom errors for TiddlyWiki.
+
+\*/
+(function(){
+
+function TranscludeRecursionError() {
+	Error.apply(this,arguments);
+	this.signatures = Object.create(null);
+};
+
+/* Maximum permitted depth of the widget tree for recursion detection */
+TranscludeRecursionError.MAX_WIDGET_TREE_DEPTH = 1000;
+
+TranscludeRecursionError.prototype = Object.create(Error);
+
+exports.TranscludeRecursionError = TranscludeRecursionError;
+
+})();

core/modules/utils/repository.js

@@ -14,8 +14,12 @@ Utilities for working with the TiddlyWiki repository file structure
 
 /*
 Get an object containing all the plugins as a hashmap by title of the JSON representation of the plugin
+Options:
+
+ignoreEnvironmentVariables: defaults to false
 */
-exports.getAllPlugins = function() {
+exports.getAllPlugins = function(options) {
+	options = options || {};
 	var fs = require("fs"),
 		path = require("path"),
 		tiddlers = {};
@@ -39,9 +43,9 @@ exports.getAllPlugins = function() {
 				}
 			}
 		};
-	$tw.utils.each($tw.getLibraryItemSearchPaths($tw.config.pluginsPath,$tw.config.pluginsEnvVar),collectPublisherPlugins);
-	$tw.utils.each($tw.getLibraryItemSearchPaths($tw.config.themesPath,$tw.config.themesEnvVar),collectPublisherPlugins);
-	$tw.utils.each($tw.getLibraryItemSearchPaths($tw.config.languagesPath,$tw.config.languagesEnvVar),collectPlugins);
+	$tw.utils.each($tw.getLibraryItemSearchPaths($tw.config.pluginsPath,options.ignoreEnvironmentVariables ? undefined : $tw.config.pluginsEnvVar),collectPublisherPlugins);
+	$tw.utils.each($tw.getLibraryItemSearchPaths($tw.config.themesPath,options.ignoreEnvironmentVariables ? undefined : $tw.config.themesEnvVar),collectPublisherPlugins);
+	$tw.utils.each($tw.getLibraryItemSearchPaths($tw.config.languagesPath,options.ignoreEnvironmentVariables ? undefined : $tw.config.languagesEnvVar),collectPlugins);
 	return tiddlers;
 };
 

core/modules/utils/utils.js

@@ -825,7 +825,7 @@ options.length .. number of characters returned defaults to 64
 */
 exports.sha256 = function(str, options) {
 	options = options || {}
-	return sjcl.codec.hex.fromBits(sjcl.hash.sha256.hash(str)).substr(0,options.length || 64);
+	return $tw.sjcl.codec.hex.fromBits($tw.sjcl.hash.sha256.hash(str)).substr(0,options.length || 64);
 }
 
 /*

core/modules/widgets/testcase.js

@@ -77,8 +77,13 @@ TestCaseWidget.prototype.render = function(parent,nextSibling) {
 	this.setVariable("transclusion",$tw.utils.hashString(jsonPayload));
 	// Generate a `payloadTiddlers` variable that contains the payload in JSON format
 	this.setVariable("payloadTiddlers",jsonPayload);
+	// Only run the tests if the testcase output and expected results were specified, and those tiddlers actually exist in the wiki
+	var shouldRunTests = false;
+	if(this.testcaseTestOutput && this.testcaseWiki.tiddlerExists(this.testcaseTestOutput) && this.testcaseTestExpectedResult && this.testcaseWiki.tiddlerExists(this.testcaseTestExpectedResult)) {
+		shouldRunTests = true;
+	}
 	// Render the test rendering if required
-	if(this.testcaseTestOutput && this.testcaseTestExpectedResult) {
+	if(shouldRunTests) {
 		var testcaseOutputContainer = $tw.fakeDocument.createElement("div");
 		var testcaseOutputWidget = this.testcaseWiki.makeTranscludeWidget(this.testcaseTestOutput,{
 			document: $tw.fakeDocument,
@@ -101,7 +106,7 @@ TestCaseWidget.prototype.render = function(parent,nextSibling) {
 	var testResult = "",
 		outputHTML = "",
 		expectedHTML = "";
-	if(this.testcaseTestOutput && this.testcaseTestExpectedResult) {
+	if(shouldRunTests) {
 		outputHTML = testcaseOutputContainer.children[0].innerHTML;
 		expectedHTML = this.testcaseWiki.getTiddlerText(this.testcaseTestExpectedResult);
 		if(outputHTML === expectedHTML) {

core/modules/widgets/transclude.js

@@ -30,7 +30,30 @@ TranscludeWidget.prototype.render = function(parent,nextSibling) {
 	this.parentDomNode = parent;
 	this.computeAttributes();
 	this.execute();
-	this.renderChildren(parent,nextSibling);
+	try {
+		this.renderChildren(parent,nextSibling);
+	} catch(error) {
+		if(error instanceof $tw.utils.TranscludeRecursionError) {
+			// We were infinite looping.
+			// We need to try and abort as much of the loop as we can, so we will keep "throwing" upward until we find a transclusion that has a different signature.
+			// Hopefully that will land us just outside where the loop began. That's where we want to issue an error.
+			// Rendering widgets beneath this point may result in a freezing browser if they explode exponentially.
+			var transcludeSignature = this.getVariable("transclusion");
+			if(this.getAncestorCount() > $tw.utils.TranscludeRecursionError.MAX_WIDGET_TREE_DEPTH - 50) {
+				// For the first fifty transcludes we climb up, we simply collect signatures.
+				// We're assuming that those first 50 will likely include all transcludes involved in the loop.
+				error.signatures[transcludeSignature] = true;
+			} else if(!error.signatures[transcludeSignature]) {
+				// Now that we're past the first 50, let's look for the first signature that wasn't in the loop. That'll be where we print the error and resume rendering.
+				this.children = [this.makeChildWidget({type: "error", attributes: {
+					"$message": {type: "string", value: $tw.language.getString("Error/RecursiveTransclusion")}
+				}})];
+				this.renderChildren(parent,nextSibling);
+				return;
+			}
+		}
+		throw error;
+	}
 };
 
 /*

core/modules/widgets/widget.js

@@ -12,9 +12,6 @@ Widget base class
 /*global $tw: false */
 "use strict";
 
-/* Maximum permitted depth of the widget tree for recursion detection */
-var MAX_WIDGET_TREE_DEPTH = 1000;
-
 /*
 Create a widget object for a parse tree node
 	parseTreeNode: reference to the parse tree node to be rendered
@@ -494,10 +491,8 @@ Widget.prototype.makeChildWidgets = function(parseTreeNodes,options) {
 	this.children = [];
 	var self = this;
 	// Check for too much recursion
-	if(this.getAncestorCount() > MAX_WIDGET_TREE_DEPTH) {
-		this.children.push(this.makeChildWidget({type: "error", attributes: {
-			"$message": {type: "string", value: $tw.language.getString("Error/RecursiveTransclusion")}
-		}}));
+	if(this.getAncestorCount() > $tw.utils.TranscludeRecursionError.MAX_WIDGET_TREE_DEPTH) {
+		throw new $tw.utils.TranscludeRecursionError();
 	} else {
 		// Create set variable widgets for each variable
 		$tw.utils.each(options.variables,function(value,name) {

core/ui/TestCaseTemplate.tid

@@ -5,6 +5,7 @@ title: $:/core/ui/TestCaseTemplate
 <$let
 	linkTarget="yes"
 	displayFormat={{!!display-format}}
+	testcaseTiddler=<<currentTiddler>>
 >
 	<$testcase
 		testOutput="Output"

core/ui/TestCases/DefaultTemplate.tid

@@ -15,7 +15,7 @@ title: $:/core/ui/testcases/DefaultTemplate
 	<div class="tc-test-case-wrapper">
 		<div class="tc-test-case-header">
 			<h2>
-				<$genesis $type={{{ [<linkTarget>!match[]then[$link]else[div]] }}}>
+				<$genesis $type={{{ [<linkTarget>!match[]then[$link]else[div]] }}} to=<<testcaseTiddler>>>
 					<%if [<testResult>!match[]] %>
 						<span class={{{ tc-test-case-result-icon [<testResult>!match[fail]then[tc-test-case-result-icon-pass]] [<testResult>match[fail]then[tc-test-case-result-icon-fail]] +[join[ ]] }}}>
 							<%if [<testResult>!match[fail]] %>
@@ -55,7 +55,9 @@ title: $:/core/ui/testcases/DefaultTemplate
 					<pre><$view tiddler="Output" format="plainwikified" mode="block"/></pre>
 				<%else%>
 					<$linkcatcher actions=<<linkcatcherActions>>>
-						<$transclude $tiddler="Output" $mode="block"/>
+						<$tiddler tiddler="Output">
+							<$transclude $tiddler="Output" $mode="block"/>
+						</$tiddler>
 					</$linkcatcher>
 				<%endif%>
 			</div>

editions/test/tiddlers/tests/data/transclude/Recursion.tid

@@ -7,7 +7,8 @@ title: Output
 
 \whitespace trim
 <$transclude $tiddler="Output"/>
+
 +
 title: ExpectedResult
 
-<p><span class="tc-error">Recursive transclusion error in transclude widget</span></p>
+<span class="tc-error">Recursive transclusion error in transclude widget</span>

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

@@ -17,7 +17,7 @@ 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();
+		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);

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

editions/tw5.com/tiddlers/concepts/TestCaseTiddlers.tid

@@ -23,5 +23,4 @@ Some payload tiddlers are set aside for special purposes:
 |''Narrative'' |Narrative description of the test, intended to explain the purpose and operation of the test |
 |''Output'' |The tiddler that produces the test output |
 |''~ExpectedResult'' |HTML of expected result of rendering the ''Output'' tiddler |
-
-
+|''Description'' |Set to the text of the <<.field description>> field |

editions/tw5.com/tiddlers/testcases/TestCaseWidget/FailingTest.tid

@@ -5,7 +5,7 @@ description: An example of a failing test
 
 title: Narrative
 
-This test case intentionally fails to show how failures are displayed.
+This test case intentionally fails (in order to show how failures are displayed)
 +
 title: Output
 

editions/tw5.com/tiddlers/testcases/TestCaseWidget/NoExpectedResults.tid

@@ -0,0 +1,12 @@
+title: TestCases/TestCaseWidget/NoExpectedResults
+type: text/vnd.tiddlywiki-multiple
+tags: [[$:/tags/wiki-test-spec]]
+description: A testcase that does not specify expected results
+
+title: Narrative
+
+This testcase will display without the pass/fail icons because it does not include an `ExpectedResults` tiddler, and so will only be rendered, and not be executed as a test
++
+title: Output
+
+This is the output

editions/tw5.com/tiddlers/widgets/TestCaseWidget.tid

@@ -75,7 +75,7 @@ The test case wiki will inherit variables that are visible to the <<.wid testcas
 
 A custom template can be specified for special purposes. For example, the provided template $:/core/ui/testcases/RawJSONTemplate just displays the payload tiddlers in JSON, which can be used for debugging purposes.
 
-! Test Czase Template Variables
+! Test Case Template Variables
 
 The <<.wid testcase>> widget makes the following variables available within the rendered template:
 

languages/zh-Hans/Fields.multids

@@ -30,6 +30,7 @@ name: 具可读性的插件条目的名称
 parent-plugin: 对于一个插件，指定其为哪个插件的子插件
 plugin-priority: 插件条目的优先级数值
 plugin-type: 插件条目的类型
+stability: 插件的开发状态：已弃用、实验性、稳定或旧版
 released: TiddlyWiki 的发布日期
 revision: 条目存放于服务器中的修订版本
 source: 条目的网址

languages/zh-Hant/Fields.multids

@@ -30,6 +30,7 @@ name: 具可讀性的套件條目的名稱
 parent-plugin: 對於一個插件，指定其為哪個插件的子插件
 plugin-priority: 套件條目的優先級數值
 plugin-type: 套件條目的類型
+stability: 插件的開發狀態：已棄用、實驗性、穩定或舊版
 released: TiddlyWiki 的釋出日期
 revision: 條目存放於伺服器中的修訂版本
 source: 條目的網址

plugins/tiddlywiki/jasmine/run-wiki-based-tests.js

@@ -34,23 +34,22 @@ describe("Wiki-based tests", function() {
 			if(!wiki.tiddlerExists("Output")) {
 				throw "Missing 'Output' tiddler";
 			}
-			if(!wiki.tiddlerExists("ExpectedResult")) {
-				throw "Missing 'ExpectedResult' tiddler";
+			if(wiki.tiddlerExists("ExpectedResult")) {
+				// Construct the widget node
+				var text = "{{Output}}\n\n";
+				var widgetNode = createWidgetNode(parseText(text,wiki),wiki);
+				// Render the widget node to the DOM
+				var wrapper = renderWidgetNode(widgetNode);
+				// Clear changes queue
+				wiki.clearTiddlerEventQueue();
+				// Run the actions if provided
+				if(wiki.tiddlerExists("Actions")) {
+					widgetNode.invokeActionString(wiki.getTiddlerText("Actions"));
+					refreshWidgetNode(widgetNode,wrapper);
+				}
+				// Test the rendering
+				expect(wrapper.innerHTML).toBe(wiki.getTiddlerText("ExpectedResult"));
 			}
-			// Construct the widget node
-			var text = "{{Output}}\n\n";
-			var widgetNode = createWidgetNode(parseText(text,wiki),wiki);
-			// Render the widget node to the DOM
-			var wrapper = renderWidgetNode(widgetNode);
-			// Clear changes queue
-			wiki.clearTiddlerEventQueue();
-			// Run the actions if provided
-			if(wiki.tiddlerExists("Actions")) {
-				widgetNode.invokeActionString(wiki.getTiddlerText("Actions"));
-				refreshWidgetNode(widgetNode,wrapper);
-			}
-			// Test the rendering
-			expect(wrapper.innerHTML).toBe(wiki.getTiddlerText("ExpectedResult"));
 		});
 	});