Add <$testcase> widget

core/modules/widgets/data.js

@@ -0,0 +1,139 @@
+/*\
+title: $:/core/modules/widgets/data.js
+type: application/javascript
+module-type: widget
+
+Widget to represent a single item of data
+
+\*/
+(function(){
+
+/*jslint node: true, browser: true */
+/*global $tw: false */
+"use strict";
+
+var Widget = require("$:/core/modules/widgets/widget.js").widget;
+
+var DataWidget = function(parseTreeNode,options) {
+	this.dataWidgetTag = parseTreeNode.type;
+	this.initialise(parseTreeNode,options);
+};
+
+/*
+Inherit from the base widget class
+*/
+DataWidget.prototype = new Widget();
+
+/*
+Render this widget into the DOM
+*/
+DataWidget.prototype.render = function(parent,nextSibling) {
+	this.parentDomNode = parent;
+	this.computeAttributes();
+	this.execute();
+	this.renderChildren(parent,nextSibling);
+};
+
+/*
+Compute the internal state of the widget
+*/
+DataWidget.prototype.execute = function() {
+	// Construct the child widgets
+	this.makeChildWidgets();
+};
+
+/*
+Read the tiddler value(s) from a data widget – must be called after the .render() method
+*/
+DataWidget.prototype.readDataTiddlerValues = function() {
+	var self = this;
+	// Start with a blank object
+	var item = Object.create(null);
+	// Read any attributes not prefixed with $
+	$tw.utils.each(this.attributes,function(value,name) {
+		if(name.charAt(0) !== "$") {
+			item[name] = value;	
+		}
+	});
+	item = new $tw.Tiddler(item);
+	// Deal with $tiddler, $filter or $compound-tiddler attributes
+	var tiddlers = [],title;
+	if(this.hasAttribute("$tiddler")) {
+		title = this.getAttribute("$tiddler");
+		if(title) {
+			tiddlers.push(this.wiki.getTiddler(title));
+		}
+	}
+	if(this.hasAttribute("$filter")) {
+		var filter = this.getAttribute("$filter");
+		if(filter) {
+			var titles = this.wiki.filterTiddlers(filter);
+			$tw.utils.each(titles,function(title) {
+				var tiddler = self.wiki.getTiddler(title);
+				tiddlers.push(tiddler);
+			});
+		}
+	}
+	if(this.hasAttribute("$compound-tiddler")) {
+		title = this.getAttribute("$compound-tiddler");
+		if(title) {
+			tiddlers.push.apply(tiddlers,this.extractCompoundTiddler(title));
+		}
+	}
+	// Convert the literal item to field strings
+	item = item.getFieldStrings();
+	if(tiddlers.length === 0) {
+		if(Object.keys(item).length > 0 && !!item.title) {
+			return [item];
+		} else {
+			return [];
+		}
+	} else {
+		var results = [];
+		$tw.utils.each(tiddlers,function(tiddler,index) {
+			var fields = tiddler.getFieldStrings();
+			results.push($tw.utils.extend({},fields,item));
+		});
+		return results;	
+	}
+};
+
+/*
+Helper to extract tiddlers from text/vnd.tiddlywiki-multiple tiddlers
+*/
+DataWidget.prototype.extractCompoundTiddler = function(title) {
+	var tiddler = this.wiki.getTiddler(title);
+	if(tiddler && tiddler.fields.type === "text/vnd.tiddlywiki-multiple") {
+		var text = tiddler.fields.text || "",
+			rawTiddlers = text.split(/\r?\n\+\r?\n/),
+			tiddlers = [];
+		$tw.utils.each(rawTiddlers,function(rawTiddler) {
+			var fields = Object.create(null),
+				split = rawTiddler.split(/\r?\n\r?\n/mg);
+			if(split.length >= 1) {
+				fields = $tw.utils.parseFields(split[0],fields);
+			}
+			if(split.length >= 2) {
+				fields.text = split.slice(1).join("\n\n");
+			}
+			tiddlers.push(new $tw.Tiddler(fields));
+		});
+		return tiddlers;
+	} else {
+		return [];
+	}
+};
+
+/*
+Selectively refreshes the widget if needed. Returns true if the widget or any of its children needed re-rendering
+*/
+DataWidget.prototype.refresh = function(changedTiddlers) {
+	// Refresh our attributes
+	var changedAttributes = this.computeAttributes();
+	// Refresh our children, and indicate that we refreshed if any of our attribute values have changed
+	return this.refreshChildren(changedTiddlers) || $tw.utils.count(changedAttributes) > 0;
+};
+
+exports.data = DataWidget;
+
+})();

core/modules/widgets/testcase.js

@@ -0,0 +1,113 @@
+/*\
+title: $:/core/modules/widgets/testcase.js
+type: application/javascript
+module-type: widget
+
+Widget to display a test case
+
+\*/
+(function(){
+
+/*jslint node: true, browser: true */
+/*global $tw: false */
+"use strict";
+
+var Widget = require("$:/core/modules/widgets/widget.js").widget;
+
+var TestCaseWidget = function(parseTreeNode,options) {
+	this.initialise(parseTreeNode,options);
+};
+
+/*
+Inherit from the base widget class
+*/
+TestCaseWidget.prototype = new Widget();
+
+/*
+Render this widget into the DOM
+*/
+TestCaseWidget.prototype.render = function(parent,nextSibling) {
+	var self = this;
+	this.parentDomNode = parent;
+	this.computeAttributes();
+	this.execute();
+	// Create container DOM node
+	var domNode = this.document.createElement("div");
+	this.domNodes.push(domNode);
+	parent.insertBefore(domNode,nextSibling);
+	// Render the children into a hidden DOM node
+	var parser = {
+		tree: [{
+			type: "widget",
+			attributes: {},
+			orderedAttributes: [],
+			children: this.parseTreeNode.children || []
+		}]
+	};
+	this.contentRoot = this.wiki.makeWidget(parser,{
+		document: $tw.fakeDocument,
+		parentWidget: this
+	});
+	this.contentContainer = $tw.fakeDocument.createElement("div");
+	this.contentRoot.render(this.contentContainer,null);
+	// Create a wiki
+	this.testcaseWiki = new $tw.Wiki();
+	// Always load the core plugin
+	var loadTiddler = function(title) {
+		var tiddler = self.wiki.getTiddler(title);
+		if(tiddler) {
+			self.testcaseWiki.addTiddler(tiddler);
+		}
+	}
+	loadTiddler("$:/core");
+	loadTiddler("$:/plugins/tiddlywiki/codemirror");
+	// Load the test case template
+	// loadTiddler(this.testcaseTemplate);
+	// Load tiddlers from child data widgets
+	var tiddlers = [];
+	this.findChildrenDataWidgets(this.contentRoot.children,"data",function(widget) {
+		Array.prototype.push.apply(tiddlers,widget.readDataTiddlerValues());
+	});
+	var jsonPayload = JSON.stringify(tiddlers);
+	this.testcaseWiki.addTiddlers(tiddlers);
+	// Unpack plugin tiddlers
+	this.testcaseWiki.readPluginInfo();
+	this.testcaseWiki.registerPluginTiddlers("plugin");
+	this.testcaseWiki.unpackPluginTiddlers();
+	this.testcaseWiki.addIndexersToWiki();
+	// Generate a `transclusion` variable that depends on the values of the payload tiddlers so that the template can easily make unique state tiddlers
+	this.setVariable("transclusion",$tw.utils.hashString(jsonPayload));
+	// Generate a `payloadTiddlers` variable that contains the payload in JSON format
+	this.setVariable("payloadTiddlers",jsonPayload);
+	// Render the page root template of the subwiki
+	var rootWidget = this.testcaseWiki.makeTranscludeWidget(this.testcaseTemplate,{document: this.document, parseAsInline: false, parentWidget: this});
+	rootWidget.render(domNode);
+	// Trap changes in the wiki and refresh the rendering
+	this.testcaseWiki.addEventListener("change",function(changes) {
+		rootWidget.refresh(changes,domNode);
+	});
+};
+
+/*
+Compute the internal state of the widget
+*/
+TestCaseWidget.prototype.execute = function() {
+	this.testcaseTemplate = this.getAttribute("template","$:/core/ui/testcases/DefaultTemplate");
+};
+
+/*
+Selectively refreshes the widget if needed. Returns true if the widget or any of its children needed re-rendering
+*/
+TestCaseWidget.prototype.refresh = function(changedTiddlers) {
+	var changedAttributes = this.computeAttributes();
+	if($tw.utils.count(changedAttributes) > 0) {
+		this.refreshSelf();
+		return true;
+	} else {
+		return this.contentRoot.refresh(changedTiddlers);
+	}
+};
+
+exports["testcase"] = TestCaseWidget;
+
+})();

core/modules/widgets/widget.js

@@ -797,6 +797,21 @@ Widget.prototype.allowActionPropagation = function() {
 	return true;
 };
 
+/*
+Find child <$data> widgets recursively. The tag name allows aliased versions of the widget to be found too
+*/
+Widget.prototype.findChildrenDataWidgets = function(children,tag,callback) {
+	var self = this;
+	$tw.utils.each(children,function(child) {
+		if(child.dataWidgetTag === tag) {
+			callback(child);
+		}
+		if(child.children) {
+			self.findChildrenDataWidgets(child.children,tag,callback);
+		}
+	});
+};
+
 /*
 Evaluate a variable with parameters. This is a static convenience method that attempts to evaluate a variable as a function, returning an array of strings
 */

core/ui/TestCases/DefaultTemplate.tid

@@ -0,0 +1,22 @@
+title: $:/core/ui/testcases/DefaultTemplate
+
+\whitespace trim
+<$let
+	state={{{ [<qualify "$:/state/testcase">] }}}
+>
+<div class="tc-testcase-wrapper">
+<div class="tc-testcase-header">
+<h2><$transclude tiddler="Description" mode="inline"/></h2>
+</div>
+<div class="tc-testcase-panes">
+<div class="tc-testcase-source">
+<$macrocall $name="tabs" tabsList="[all[tiddlers]sort[]] -[prefix<state>] -Description -ExpectedResult -Output Output +[putfirst[]] -[has[plugin-type]]" state=<<state>> default="Output" template="$:/core/ui/testcases/DefaultTemplate/Source"/>
+</div>
+<div class="tc-testcase-divider">
+</div>
+<div class="tc-testcase-output">
+<$transclude tiddler="Output"/>
+</div>
+</div>
+</div>
+</$let>

core/ui/TestCases/DefaultTemplateSource.tid

@@ -0,0 +1,19 @@
+title: $:/core/ui/testcases/DefaultTemplate/Source
+
+<$list filter="[<currentTab>fields[]] -text +[limit[1]]" variable="ignore">
+	<table class="tc-field-table">
+		<tbody>
+			<$list filter="[<currentTab>fields[]sort[]] -text -title title +[putfirst[]]" variable="fieldName">
+				<tr>
+					<td>
+						<$text text=<<fieldName>>/>
+					</td>
+					<td>
+						<$view tiddler=<<currentTab>> field=<<fieldName>>/>
+					</td>
+				</tr>
+			</$list>
+		</tbody>
+	</table>
+</$list>
+<$edit class="tc-edit-texteditor" tiddler=<<currentTab>>/>

core/ui/TestCases/RawJSONTemplate.tid

@@ -0,0 +1,4 @@
+title: $:/core/ui/testcases/RawJSONTemplate
+
+\whitespace trim
+<$text text=<<payloadTiddlers>>/>

editions/prerelease/tiddlywiki.info

@@ -14,7 +14,8 @@
 		"tiddlywiki/dynannotate",
 		"tiddlywiki/codemirror",
 		"tiddlywiki/menubar",
-		"tiddlywiki/jszip"
+		"tiddlywiki/jszip",
+		"tiddlywiki/innerwiki"
 	],
 	"themes": [
 		"tiddlywiki/vanilla",

editions/test/tiddlers/tests/data/data-widget/ImportCompound.tid

@@ -0,0 +1,27 @@
+title: Data/ImportCompound
+type: text/vnd.tiddlywiki-multiple
+tags: [[$:/tags/wiki-test-spec]]
+description: Importing a compound payload tiddler and adding custom fields
+
+title: Description
+text: Importing a compound payload tiddler and adding custom fields
++
+title: Output
+
+\whitespace trim
+<$testcase template="$:/core/ui/testcases/RawJSONTemplate">
+<$data $compound-tiddler="Compound" custom="Alpha"/>
+</$testcase>
++
+title: Compound
+type: text/vnd.tiddlywiki-multiple
+tags: [[$:/tags/wiki-test-spec]]
+
+title: Payload Tiddler
+tags: Alpha Beta Gamma
+
+This is a payload tiddler from a compound tiddler
++
+title: ExpectedResult
+
+<p><div><div>[{"title":"Payload Tiddler","tags":"Alpha Beta Gamma","text":"This is a payload tiddler from a compound tiddler","custom":"Alpha"}]</div></div></p>

editions/test/tiddlers/tests/data/data-widget/ImportFilter.tid

@@ -0,0 +1,28 @@
+title: Data/ImportFilter
+type: text/vnd.tiddlywiki-multiple
+tags: [[$:/tags/wiki-test-spec]]
+description: Importing a payload filter and adding custom fields
+
+title: Description
+text: Importing a payload filter and adding custom fields
++
+title: Output
+
+\whitespace trim
+<$testcase template="$:/core/ui/testcases/RawJSONTemplate">
+<$data $filter="[tag[Definitions]]" custom="Alpha"/>
+</$testcase>
++
+title: HelloThere
+tags: Definitions
+
+This is the tiddler HelloThere
++
+title: AnotherDefinition
+tags: Definitions
+
+This is the tiddler AnotherDefinition
++
+title: ExpectedResult
+
+<p><div><div>[{"title":"AnotherDefinition","tags":"Definitions","text":"This is the tiddler AnotherDefinition","custom":"Alpha"},{"title":"HelloThere","tags":"Definitions","text":"This is the tiddler HelloThere","custom":"Alpha"}]</div></div></p>