Massive overhauls to the test suite - it is now generated dynamically, along with the documentation.

This commit is contained in:
John Resig 2006-08-14 01:46:05 +00:00
parent 61aab47bcf
commit 7448c61ee2
10 changed files with 467 additions and 132 deletions

View file

@ -1,83 +1,6 @@
load("build/js/json.js", "build/js/xml.js", "build/js/writeFile.js");
var types = {
jQuery: "A jQuery object.",
Object: "A simple Javascript object. For example, it could be a String or a Number.",
String: "A string of characters.",
Number: "A numeric valid.",
Element: "The Javascript object representation of a DOM Element.",
Hash: "A Javascript object that contains key/value pairs in the form of properties and values.",
"Array<Element>": "An Array of DOM Elements.",
"Array<String>": "An Array of strings.",
Function: "A reference to a Javascript function."
};
var f = readFile(arguments[0]);
var c = [], bm, m;
var blockMatch = /\/\*\*\s*((.|\n)*?)\s*\*\//g;
var paramMatch = /\@(\S+) *((.|\n)*?)(?=\n\@|!!!)/m;
while ( bm = blockMatch.exec(f) ) {
block = bm[1].replace(/^\s*\* ?/mg,"") + "!!!";
var ret = { params: [], examples: [] };
while ( m = paramMatch.exec( block ) ) {
block = block.replace( paramMatch, "" );
var n = m[1];
var v = m[2]
.replace(/\s*$/g,"")
.replace(/^\s*/g,"")
.replace(/&/g, "&")
.replace(/</g, "&lt;")
.replace(/>/g, "&gt;")
.replace(/\n/g, "<br/>")
/*.replace(/(\s\s+)/g, function(a){
var ret = "";
for ( var i = 0; i < a.length; i++ )
ret += "&nbsp;";
return ret;
})*/ || 1;
if ( n == 'param' || n == 'any' ) {
var args = v.split(/\s+/);
v = args.slice( 2, args.length );
v = { type: args[0], name: args[1], desc: v.join(' ') };
if ( n == 'any' ) v.any = 1;
n = "params";
} else if ( n == 'example' ) {
v = { code: v };
n = "examples";
}
if ( n == 'desc' || n == 'before' || n == 'after' || n == 'result' ) {
ret.examples[ ret.examples.length - 1 ][ n ] = v;
} else {
if ( ret[ n ] ) {
if ( ret[ n ].constructor == Array ) {
ret[ n ].push( v );
} else {
ret[ n ] = [ ret[ n ], v ];
}
} else {
ret[ n ] = v;
}
}
}
ret.desc = block.replace(/\s*!!!$/,"")
.replace(/</g, "&lt;")
.replace(/>/g, "&gt;");
//.replace(/\n\n/g, "<br/><br/>")
//.replace(/\n/g, " ");
var m = /^((.|\n)*?(\.|$))/.exec( ret.desc );
if ( m ) ret['short'] = m[1];
if ( ret.name ) c.push( ret );
}
load("build/js/json.js", "build/js/xml.js", "build/js/writeFile.js", "build/js/parse.js");
var c = parse( readFile(arguments[0]) );
var json = Object.toJSON( c );
writeFile( arguments[1] + "/data/jquery-docs-json.js", json );

View file

@ -11,7 +11,10 @@ var types = {
};
$(document).ready(function(){
$("span.tooltip").ToolTipDemo('#fff');
$("span.tooltip").each(function(){
if ( types[ this.innerHTML ] )
this.title = types[ this.innerHTML ];
}).ToolTipDemo('#fff');
$("a.name").click(function(){
$("div.more,div.short",this.parentNode.parentNode).toggle().find("div.desc",function(){

View file

@ -6,7 +6,7 @@
<head>
<title>jQuery Docs - API</title>
<link rel="stylesheet" href="style/style.css"/>
<script src="../dist/jquery-svn.js"></script>
<script src="../dist/jquery.js"></script>
<script src="js/tooltip.js"></script>
<script src="js/pager.js"></script>
<script src="js/doc.js"></script>
@ -18,13 +18,13 @@
<xsl:sort select="@name"/>
<xsl:sort select="count(params)"/>
<li>
<span class='type'><span title='TYPE' class='tooltip'><xsl:value-of select="@type"/></span></span>
<span class='type'><span class='tooltip'><xsl:value-of select="@type"/></span></span>
<span class='fn'>
<a href='#{@name}' class='name' title=''><xsl:value-of select="@name"/></a>
<xsl:if test="not(@property)">(
<xsl:for-each select="params">
<span class='arg-type tooltip' title='TYPE'><xsl:value-of select="@type"/></span><xsl:text> </xsl:text>
<span class='arg-name tooltip' title='{@desc}'><xsl:value-of select="@name"/></span>
<span class='arg-type tooltip'><xsl:value-of select="@type"/></span><xsl:text> </xsl:text>
<span class='arg-name tooltip' title='{desc}'><xsl:value-of select="@name"/></span>
<xsl:if test="position() != last()">
<xsl:if test="@any"> or </xsl:if>
<xsl:if test="not(@any)">, </xsl:if>
@ -60,6 +60,8 @@
</li>
</xsl:for-each>
</ul>
<p class="raw"><b>Raw Data:</b><xsl:text> </xsl:text><a href="data/jquery-docs-json.js">JSON</a>, <a href="data/jquery-docs-jsonp.js">JSONP</a>, <a href="data/jquery-docs-xml.xml">XML</a></p>
</body>
</html>
</xsl:template>

View file

@ -126,3 +126,15 @@ ul#docs li div.example pre {
padding: 5px;
overflow: auto;
}
p.raw {
font-size: 11px;
color: #FFF;
margin: 5px auto;
width: 600px;
text-align: right;
}
p.raw a {
color: #FFF;
}

69
build/js/parse.js Normal file
View file

@ -0,0 +1,69 @@
function parse( f ) {
var c = [], bm, m;
var blockMatch = /\/\*\*\s*((.|\n)*?)\s*\*\//g;
var paramMatch = /\@(\S+) *((.|\n)*?)(?=\n\@|!!!)/m;
while ( bm = blockMatch.exec(f) ) {
block = bm[1].replace(/^\s*\* ?/mg,"") + "!!!";
var ret = { params: [], examples: [], tests: [] };
while ( m = paramMatch.exec( block ) ) {
block = block.replace( paramMatch, "" );
var n = m[1];
var v = m[2]
.replace(/\s*$/g,"")
.replace(/^\s*/g,"")
.replace(/&/g, "&amp;")
.replace(/</g, "&lt;")
.replace(/>/g, "&gt;")
//.replace(/\n/g, "<br/>")
/*.replace(/(\s\s+)/g, function(a){
var ret = "";
for ( var i = 0; i < a.length; i++ )
ret += "&nbsp;";
return ret;
})*/ || 1;
if ( n == 'param' || n == 'any' ) {
var args = v.split(/\s+/);
v = args.slice( 2, args.length );
v = { type: args[0], name: args[1], desc: v.join(' ') };
if ( n == 'any' ) v.any = 1;
n = "params";
} else if ( n == 'example' ) {
v = { code: v };
n = "examples";
} else if ( n == 'test' ) {
n = "tests";
}
if ( n == 'desc' || n == 'before' || n == 'after' || n == 'result' ) {
ret.examples[ ret.examples.length - 1 ][ n ] = v;
} else {
if ( ret[ n ] ) {
if ( ret[ n ].constructor == Array ) {
ret[ n ].push( v );
} else {
ret[ n ] = [ ret[ n ], v ];
}
} else {
ret[ n ] = v;
}
}
}
ret.desc = block.replace(/\s*!!!$/,"")
.replace(/</g, "&lt;")
.replace(/>/g, "&gt;");
//.replace(/\n\n/g, "<br/><br/>")
//.replace(/\n/g, " ");
var m = /^((.|\n)*?(\.|$))/.exec( ret.desc );
if ( m ) ret['short'] = m[1];
if ( ret.name ) c.push( ret );
}
return c;
}

View file

@ -1,21 +1,55 @@
<html>
<html id="html">
<head>
<script type="text/javascript" src="lib/Test/Harness.js"></script>
<script type="text/javascript" src="lib/Test/Harness/Browser.js"></script>
</head>
<body>
<h1>jQuery - Test Suite</h1>
<script type="text/javascript">
new Test.Harness.Browser().runTests(
"tests/prereq.html",
"tests/css1.html",
"tests/css2.html",
"tests/css3.html",
"tests/xpath.html",
"tests/custom.html",
"tests/basic.html"
);
<script type="text/javascript" src="../dist/jquery.js"></script>
<script type="text/javascript" src="js/test.js"></script>
<script>
$(document).ready(function(){
runTests([{FILES}]);
});
</script>
<style>.pass { color: green; } .fail { color: red; } #tests ol { display: none; }</style>
</head>
<body id="body">
<h1>jQuery - Test Suite</h1>
<!-- Test HTML -->
<dl style="display:none;">
<div id="main" style="display: none;">
<p id="firstp">See <a id="simon1" href="http://simon.incutio.com/archive/2003/03/25/#getElementsBySelector" rel="bookmark">this blog entry</a> for more information.</p>
<p id="ap">
Here are some links in a normal paragraph: <a id="google" href="http://www.google.com/" title="Google!">Google</a>,
<a id="groups" href="http://groups.google.com/">Google Groups</a>.
This link has <code><a href="#" id="anchor1">class="blog"</a></code>:
<a href="http://diveintomark.org/" class="blog" hreflang="en" id="mark">diveintomark</a>
</p>
<div id="foo">
<p id="sndp">Everything inside the red border is inside a div with
<code>id="foo"</code>.</p>
<p lang="en" id="en">This is a normal link:
<a id="yahoo" href="http://www.yahoo.com/" class="blogTest">Yahoo</a></p>
<p id="sap">This link has <code><a href="#2" id="anchor2">class="blog"</a></code>:
<a href="http://simon.incutio.com/" class="blog link" id="simon">Simon Willison's Weblog</a></p>
</div>
<p id="first">Try them out: </p>
<ul id="firstUL"></ul>
<ol id="empty"></ol>
<form id="form">
<input type="text" value="Test" id="text1"/>
<input type="text" value="Test" id="text2" disabled="disabled"/>
<input type="radio" name="radio1" id="radio1"/>
<input type="radio" name="radio2" id="radio2" checked/>
<input type="checkbox" name="check" id="check1" checked/>
<input type="checkbox" name="check" id="check2"/>
<input type="hidden" name="hidden" id="hidden1"/>
<input type="text" style="display:none;" id="hidden2"/>
</form>
</div>
</dl>
<ol id="tests"></ol>
</body>
</html>

115
build/test/js/test.js Normal file
View file

@ -0,0 +1,115 @@
function runTests(files) {
runTest( files, 0 );
}
function runTest( files, num ) {
$.get(files[num],function(js){
js = js.replace(/&lt;/g, "<").replace(/&gt;/g, ">");
try {
eval(js);
} catch(e) {
Test.push( [ false, "Died on test #" + Test.length + ": " + e ] );
}
var good = 0, bad = 0;
var ol = document.createElement("ol");
var li = "", state = "pass";
for ( var i = 0; i < Test.length; i++ ) {
var li = document.createElement("li");
li.className = Test[i][0] ? "pass" : "fail";
li.innerHTML = Test[i][1];
ol.appendChild( li );
if ( !Test[i][0] ) {
state = "fail";
bad++;
} else good++;
}
var li = document.createElement("li");
li.className = state;
var b = document.createElement("b");
b.innerHTML = files[num] + " <b style='color:black;'>(<b class='fail'>" + bad + "</b>, <b class='pass'>" + good + "</b>, " + Test.length + ")</b>";
b.onclick = function(){
var n = this.nextSibling;
if ( jQuery.css( n, "display" ) == "none" )
n.style.display = "block";
else
n.style.display = "none";
};
li.appendChild( b );
li.appendChild( ol );
document.getElementById("tests").appendChild( li );
Test = [];
if ( ++num < files.length ) runTest( files, num );
});
}
var Test = [];
function ok(a, msg) {
Test.push( [ !!a, msg ] );
}
function cmpOK( a, c, b, msg ) {
var res;
eval( "res = (a " + c + " b)" );
Test.push( [ res, msg ] );
}
function isSet(a, b, msg) {
var ret = true;
if ( a && b && a.length == b.length ) {
for ( var i in a )
if ( a[i] != b[i] )
ret = false;
} else
ret = false;
if ( !ret && console )
console.log( msg, a, b );
Test.push( [ ret, msg ] );
}
function q() {
var r = [];
for ( var i = 0; i < arguments.length; i++ )
r.push( document.getElementById( arguments[i] ) );
return r;
}
function t(a,b,c) {
var f = jQuery.find(b);
var s = "";
for ( var i = 0; i < f.length; i++ )
s += (s && ",") + '"' + f[i].id + '"';
isSet(f, q.apply(q,c), a + " (" + b + ")");
}
function o(a) {
var li = document.createElement("li");
li.innerHTML = a;
if ( a.indexOf("#") == 0 )
li.className = "comment";
else if ( a.indexOf("TODO") >= 0 )
li.className = "todo";
else if ( a.indexOf("not ok") == 0 )
li.classname = "fail";
else
li.className = "pass";
document.getElementById("test").appendChild(li);
}
//plan({noPlan: true});