adding new type of as query to woql

Author: kevinchekovfeeney

dist/terminus-client.min.js

@@ -109,8 +109,15 @@ function WOQLQuery(query){
  * Takes an array of variables, an optional array of column names
  */
 WOQLQuery.prototype.get = function(arr1, arr2, target){
-	var map = this.buildAsClauses(arr1, arr2); 
+	if(arr1.json){
+		var map = arr1.json();
+		target = arr2;
+	}
+	else {
+		var map = this.buildAsClauses(arr1, arr2); 
+	}
 	if(target){
+		if(target.json) target = target.json();
 		this.cursor['get'] = [map, target];
 	}
 	else {
@@ -122,18 +129,18 @@ WOQLQuery.prototype.get = function(arr1, arr2, target){
 
 WOQLQuery.prototype.buildAsClauses = function(vars, cols){
 	var clauses = [];
-	if(vars){
+	if(vars && typeof vars == "object" && vars.length){
 		for(var i = 0; i<vars.length; i++){
 			var v = vars[i];
-			if(cols){
+			if(cols && typeof cols == "object" && cols.length){
 				var c = cols[i];
 				if(typeof c == "string"){
 					c = {"@value": c};
 				}
 				clauses.push({as: [c, v]});
 			}
 			else {
-				clauses.push({as: [v]});
+				v.as ? clauses.push(v) : clauses.push({as: [v]});
 			}
 		}
 	}
@@ -549,9 +556,15 @@ WOQLQuery.prototype.deleteProperty = function(p, graph){
  * Language elements that cannot be invoked from the top level and therefore are not exposed in the WOQL api
  */
 WOQLQuery.prototype.as = function(a, b){
+	if(!a || !b) return;
+	if(!this.asArray){
+		this.asArray = true;
+		this.query = [];
+	}
 	b = (b.indexOf(":") == -1 ? "v:" + b : b);
-	this.cursor['as'] = [{ "@value" : a}, b];
-	return this.lastUpdate();		
+	var val = (typeof a == "object" ? a : { "@value" : a});
+	this.query.push({as: [val, b]});
+	return this;		
 }
 
 /**
@@ -1086,52 +1099,67 @@ WOQLQuery.prototype.prettyPrint = function(indent, show_context, q, fluent){
 	q = (q ? q : this.query);
 	var str = "";
 	const newlining_operators = ["get", "from", "into"];
-	const non_chaining_operators = ["and", "or"];
 	for(var operator in q){
 		//ignore context in pretty print
 		if(operator == "@context") {
 			if( show_context){
 				var c = this.getContext();
-				if(c) str += "@context: " + JSON.stringify(c);
+				if(c) str += "@context: " + JSON.stringify(c) + "\n";
 			}
 			continue;
 		}
-		if(operator == "true"){
-			str += "true";
-			continue;
-		}
-		if(operator == "false"){
-			str += "false";
-			continue;
-		}
-		if(fluent){
-			str += "." + operator;
-		}
-		else {
-			var inline = indent - this.indent;
-			if(inline){
-				str += "\n" + nspaces(inline);
-			}
-			str += "WOQL." + operator;
-		}
+		//statement starts differently depending on indent and whether it is fluent style or regular function style
+		str += this.getWOQLPrelude(operator, fluent, indent - this.indent);
 		var val = q[operator];
-		if(typeof val[val.length-1] == "object" && typeof val[val.length-1]['@value'] == "undefined"  && typeof val[val.length-1]['@type'] == "undefined"  && typeof val[val.length-1]['value'] == "undefined" && non_chaining_operators.indexOf(operator) == -1){
+		if(this.chainable(operator, val[val.length-1])){
+			//all arguments up until the last are regular function arguments 
 			str += this.uncleanArguments(operator,  val.slice(0, val.length-1), indent, show_context);
 			if(newlining_operators.indexOf(operator) !== -1){
+				//some fluent function calls demand a linebreak..
 				str += "\n" + nspaces(indent-this.indent);
 			}
+			//recursive call to query included in tail
 			str += this.prettyPrint(indent, show_context, val[val.length-1], true);
 		}
 		else {
+			//non chainable operators all live inside the function call parameters
 			str += this.uncleanArguments(operator,  val, indent, show_context);
 		}
 	}
+	//remove any trailing dots in the chain (only exist in incompletely specified queries)
 	if(str.substring(str.length-1) == "."){
 		str = str.substring(0, str.length-1);
 	}
 	return str;
 }
 
+/**
+ * Gets the starting characters for a WOQL query - varies depending on how the query is invoked and how indented it is
+ */
+WOQLQuery.prototype.getWOQLPrelude = function(operator, fluent, inline){
+	if(operator === "true" || operator === "false"){
+		return operator;
+	}
+	if(fluent){
+		return "." + operator;
+	}
+	return (inline ? "\n" + nspaces(inline) : "") + "WOQL." + operator;		
+}
+
+/**
+ * Determines whether a given operator can have a chained query as its last argument
+ */
+WOQLQuery.prototype.chainable = function(operator, lastArg){
+	const non_chaining_operators = ["and", "or"];
+	if(typeof lastArg == "object" && typeof lastArg['@value'] == "undefined"  && typeof lastArg['@type'] == "undefined"  && typeof lastArg['value'] == "undefined" && non_chaining_operators.indexOf(operator) == -1){
+		return true;
+	}
+	return false;
+}
+
+/**
+ * Transforms arguments to WOQL functions from the internal (clean) version, to the WOQL.js human-friendly version
+ */
 WOQLQuery.prototype.uncleanArguments = function(operator, args, indent, show_context){
 	str = '('; 
 	const args_take_newlines = ["and", "or"];
@@ -1143,8 +1171,29 @@ WOQLQuery.prototype.uncleanArguments = function(operator, args, indent, show_con
 			if(this.argIsSubQuery(operator, args[i], i)){
 				str += this.prettyPrint(indent + this.indent, show_context, args[i], false);
 			}
+			else if(operator == "get" && i == 0){ // weird one, needs special casing
+				str += "\n" + nspaces(indent-this.indent) + "WOQL";
+				for(var j = 0; j < args[0].length; j++){
+					var myas = (args[0][j].as ? args[0][j].as : args[0][j]);
+					var lhs = myas[0];
+					var rhs = myas[1];
+					if(typeof lhs == "object" && lhs['@value']){
+						lhs = lhs['@value'];
+					}
+					if(typeof lhs == "object") {
+						lhs = JSON.stringify(lhs);
+					}
+					else {
+						lhs = '"' + lhs + '"'
+					}
+					str += '.as(' + lhs;
+					if(rhs) str += ', "' + rhs + '"';
+					str += ")";
+					str += "\n" + nspaces(indent);
+				}
+			}	
 			else {
-				str += this.uncleanArgument(operator, args[i], i);
+				str += this.uncleanArgument(operator, args[i], i, args);
 			}
 			if(i < args.length -1) str +=  ',';
 		}
@@ -1156,7 +1205,13 @@ WOQLQuery.prototype.uncleanArguments = function(operator, args, indent, show_con
 	return str;
 }
 
-WOQLQuery.prototype.uncleanArgument = function(operator, val, index){
+
+/**
+ * Passed as arguments: 1) the operator (and, triple, not, opt, etc)
+ * 2) the value of the argument
+ * 3) the index (position) of the argument. 
+ */
+WOQLQuery.prototype.uncleanArgument = function(operator, val, index, allArgs){
 	//numeric values go out untouched... 
 	const numeric_operators = ["limit", "start", "eval", "plus", "minus", "times", "divide", "exp"];
 	if(operator == "isa"){
@@ -1165,35 +1220,9 @@ WOQLQuery.prototype.uncleanArgument = function(operator, val, index){
 	else if(operator == "sub"){
 		val = this.unclean(val, 'class');
 	}
-	else if(operator == "get" && index == 0){
-		var lhs = [];
-		var rhs = [];
-		for(var i = 0; i< val.length; i++){
-			var entry = val[i].as;
-			if(entry.length == 2){
-				var colname = entry[0]['@value'];
-				if(colname)	lhs.push(colname);
-				var varname = entry[1];
-				if(varname.indexOf(":") == -1) varname = "v:" + varname;
-				rhs.push(varname);
-			} 
-			else {
-				var varname = entry[0];
-				if(varname.indexOf(":") == -1) varname = "v:" + varname;
-				rhs.push(varname);
-			}
-		}
-		if(lhs.length){
-			val = nspaces(this.index) + JSON.stringify(rhs) + ",\n" + nspaces(this.index) + JSON.stringify(lhs);
-		}
-		else {
-			val = JSON.stringify(rhs);
-		}
-		return val;
-	}
 	else if(["select"].indexOf(operator) != -1){
 		if(val.substring(0, 2) == "v:") val = val.substring(2);
-	}	
+	}
 	else if(["quad", "add_quad", "delete_quad", "add_triple", "delete_triple", "triple"].indexOf(operator) != -1){
 		switch(index){
 			case 0: val = this.unclean(val, "subject"); break;
@@ -1224,6 +1253,8 @@ WOQLQuery.prototype.uncleanArgument = function(operator, val, index){
 	return '"' + val + '"';
 }
 
+
+
 WOQLQuery.prototype.uncleanObjectArgument = function(operator, val, index){
 	if(val['@value'] && (val['@language'] || (val['@type'] && val['@type'] == "xsd:string"))) return '"' + val['@value'] + '"';
 	if(val['@value'] && (val['@type'] && val['@type'] == "xsd:integer")) return val['@value'];
@@ -1259,12 +1290,13 @@ WOQLQuery.prototype.unclean = function(s, part){
 	if(s.indexOf(":") == -1) return s;
 	if(s.substring(0,4) == "http") return s;
 	var suff = s.split(":")[1];
-	if(this.vocab && this.vocab[suff]){
+	if(this.vocab && this.vocab[suff] && this.vocab[suff] == s){
 		return suff;
 	}
 	if(!part) return s;
 	if(part == "subject" && (s.split(":")[0] == "doc")) return suff;
 	if(part == "class" && (s.split(":")[0] == "scm")) return suff;
+	if(part == "predicate" && (s.split(":")[0] == "scm")) return suff;
 	if(part == "type" && (s.split(":")[0] == "scm")) return suff;
 	if(part == "graph" && (s.split(":")[0] == "db")) return suff;
 	return s;
@@ -1281,7 +1313,6 @@ WOQLQuery.prototype.getShortcut = function(operator, args, indent, show_context)
 
 
 
-
 function nspaces(n){
 	let spaces = "";
 	for(var i = 0; i<n; i++){
@@ -1351,23 +1382,35 @@ function TripleBuilder(type, cursor, s){
 
 TripleBuilder.prototype.label = function(l, lang){
 	lang = (lang ? lang : "en");
-	var x = this.addPO('rdfs:label', {"@value": l, "@language": lang });
+	if(l.substring(0, 2) == "v:"){
+		var d = {"value": l, "@language": lang }
+	}
+	else {
+		var d = {"@value": l, "@language": lang }
+	}
+	var x = this.addPO('rdfs:label', d);
 	return x;
 }
 
 TripleBuilder.prototype.comment = function(c, lang){
 	lang = (lang ? lang : "en");
-	return this.addPO('rdfs:comment', {"@value": c, "@language": lang});
+	if(c.substring(0, 2) == "v:"){
+		var d = {"value": l, "@language": lang }
+	}
+	else {
+		var d = {"@value": l, "@language": lang }
+	}
+	return this.addPO('rdfs:comment', d);
 }
 
 TripleBuilder.prototype.addPO = function(p, o, g){ 
 	if(this.type){
 		var ttype = (this.type == "isa" || this.type == "sub" ? "triple" : this.type);
 	}
 	else var ttype = "triple";
-	var evstr = ttype + "('" + this.subject + "', '" + p + "', ";
+	var evstr = ttype + '("' + this.subject + '", "' + p + '", ';
 	if(typeof o == "string"){
-		evstr += "'" + o + "'";
+		evstr += "'" + o + "'";		
 	} 
 	else if(typeof o == "object"){
 		evstr += JSON.stringify(o);
@@ -1377,7 +1420,7 @@ TripleBuilder.prototype.addPO = function(p, o, g){
 	}
 	if(ttype.substring(ttype.length-4) == "quad" || this.g){
 		var g = (g ? g : (this.g ? this.g : "db:schema"));
-		evstr += ", '" + g + "'"; 
+		evstr += ', "' + g + '"'; 
 	}
 	evstr += ")";
 	try {