Updated the documentation parser to work with categories. Additionally, I updated...
[jquery.git] / src / jquery / jquery.js
index a0146c3..91ac9bc 100644 (file)
@@ -2,8 +2,8 @@
  * jQuery - New Wave Javascript
  *
  * Copyright (c) 2006 John Resig (jquery.com)
- * Licensed under the MIT License:
- *   http://www.opensource.org/licenses/mit-license.php
+ * Dual licensed under the MIT (MIT-LICENSE.txt) 
+ * and GPL (GPL-LICENSE.txt) licenses.
  *
  * $Date$
  * $Rev$
@@ -14,7 +14,18 @@ window.undefined = window.undefined;
 
 /**
  * Create a new jQuery Object
+ *
+ * @test ok( Array.prototype.push, "Array.push()" );
+ * @test ok( Function.prototype.apply, "Function.apply()" );
+ * @test ok( document.getElementById, "getElementById" );
+ * @test ok( document.getElementsByTagName, "getElementsByTagName" );
+ * @test ok( RegExp, "RegExp" );
+ * @test ok( jQuery, "jQuery" );
+ * @test ok( $, "$()" );
+ *
  * @constructor
+ * @private
+ * @name jQuery
  */
 function jQuery(a,c) {
 
@@ -25,7 +36,7 @@ function jQuery(a,c) {
        if ( a && a.constructor == Function && jQuery.fn.ready )
                return jQuery(document).ready(a);
 
-       // Make sure t hat a selection was provided
+       // Make sure that a selection was provided
        a = a || jQuery.context || document;
 
        /*
@@ -49,11 +60,11 @@ function jQuery(a,c) {
 
        // Watch for when a jQuery object is passed as the selector
        if ( a.jquery )
-               return a;
+               return $( jQuery.merge( a, [] ) );
 
        // Watch for when a jQuery object is passed at the context
        if ( c && c.jquery )
-               return jQuery(c.get()).find(a);
+               return $( c ).find(a);
        
        // If the context is global, return a new object
        if ( window == this )
@@ -102,6 +113,8 @@ jQuery.fn = jQuery.prototype = {
         * @before <img src="test1.jpg"/> <img src="test2.jpg"/>
         * @result 2
         *
+        * @test cmpOK( $("div").length, "==", 2, "Get Number of Elements Found" );
+        *
         * @property
         * @name length
         * @type Number
@@ -115,6 +128,8 @@ jQuery.fn = jQuery.prototype = {
         * @before <img src="test1.jpg"/> <img src="test2.jpg"/>
         * @result 2
         *
+        * @test cmpOK( $("div").size(), "==", 2, "Get Number of Elements Found" );
+        *
         * @name size
         * @type Number
         * @cat Core
@@ -132,6 +147,8 @@ jQuery.fn = jQuery.prototype = {
         * @before <img src="test1.jpg"/> <img src="test2.jpg"/>
         * @result [ <img src="test1.jpg"/> <img src="test2.jpg"/> ]
         *
+        * @test isSet( $("div").get(), q("main","foo"), "Get All Elements" );
+        *
         * @name get
         * @type Array<Element>
         * @cat Core
@@ -145,6 +162,8 @@ jQuery.fn = jQuery.prototype = {
         * @before <img src="test1.jpg"/> <img src="test2.jpg"/>
         * @result [ <img src="test1.jpg"/> ]
         *
+        * @test cmpOK( $("div").get(0), "==", document.getElementById("main"), "Get A Single Element" );
+        *
         * @name get
         * @type Element
         * @param Number num Access the element in the Nth position.
@@ -197,6 +216,14 @@ jQuery.fn = jQuery.prototype = {
         * @before <img/> <img/>
         * @result <img src="test.jpg"/> <img src="test.jpg"/>
         *
+        * @test var div = $("div");
+        * div.each(function(){this.foo = 'zoo';});
+        * var pass = true;
+        * for ( var i = 0; i < div.size(); i++ ) {
+        *   if ( div.get(i).foo != "zoo" ) pass = false;
+        * }
+        * ok( pass, "Execute a function, Relative" );
+        *
         * @name each
         * @type jQuery
         * @param Function fn A function to execute
@@ -230,6 +257,14 @@ jQuery.fn = jQuery.prototype = {
         * @before <img/>
         * @result <img src="test.jpg" alt="Test Image"/>
         *
+        * @test var div = $("div");
+        * div.attr({foo: 'baz', zoo: 'ping'});
+        * var pass = true;
+        * for ( var i = 0; i < div.size(); i++ ) {
+        *   if ( div.get(i).foo != "baz" && div.get(i).zoo != "ping" ) pass = false;
+        * }
+        * ok( pass, "Set Multiple Attributes" );
+        *
         * @name attr
         * @type jQuery
         * @param Hash prop A set of key/value pairs to set as object properties.
@@ -243,6 +278,14 @@ jQuery.fn = jQuery.prototype = {
         * @before <img/>
         * @result <img src="test.jpg"/>
         *
+        * @test var div = $("div");
+        * div.attr("foo", "bar");
+        * var pass = true;
+        * for ( var i = 0; i < div.size(); i++ ) {
+        *   if ( div.get(i).foo != "bar" ) pass = false;
+        * }
+        * ok( pass, "Set Attribute" );
+        *
         * @name attr
         * @type jQuery
         * @param String key The name of the property to set.
@@ -273,7 +316,7 @@ jQuery.fn = jQuery.prototype = {
                        // Look for the case where we're accessing a style value
                        jQuery[ type || "attr" ]( this[0], key );
        },
-       
+
        /**
         * Access a style property on the first matched element.
         * This method makes it easy to retreive a style property value
@@ -516,6 +559,12 @@ jQuery.fn = jQuery.prototype = {
                        return jQuery.find(t,a);
                }), arguments );
        },
+
+       clone: function(deep) {
+               return this.pushStack( jQuery.map( this, function(a){
+                       return a.cloneNode( deep != undefined ? deep : true );
+               }), arguments );
+       },
        
        /**
         * Removes all elements from the set of matched elements that do not 
@@ -683,7 +732,7 @@ jQuery.fn = jQuery.prototype = {
                return this.each(function(){
                        var obj = this;
                        
-                       if ( table && this.nodeName == "TABLE" ) {
+                       if ( table && this.nodeName == "TABLE" && a[0].nodeName != "THEAD" ) {
                                var tbody = this.getElementsByTagName("tbody");
 
                                if ( !tbody.length ) {
@@ -742,7 +791,7 @@ jQuery.fn = jQuery.prototype = {
  * Extend one object with another, returning the original,
  * modified, object. This is a great utility for simple inheritance.
  *
- * @name $.extend
+ * @name jQuery.extend
  * @param Object obj The object to extend
  * @param Object prop The object that will be merged into the first.
  * @type Object
@@ -806,7 +855,7 @@ jQuery.extend({
                });
        
                jQuery.each( jQuery.macros.css, function(i,n){
-                       jQuery.fn[ i ] = function(h) {
+                       jQuery.fn[ n ] = function(h) {
                                return h == undefined ?
                                        ( this.length ? jQuery.css( this[0], n ) : null ) :
                                        this.css( n, h );
@@ -819,7 +868,7 @@ jQuery.extend({
         * A generic iterator function, which can be used to seemlessly
         * iterate over both objects and arrays.
         *
-        * @name $.each
+        * @name jQuery.each
         * @param Object obj The object, or array, to iterate over.
         * @param Object fn The function that will be executed on every object.
         * @type Object
@@ -915,30 +964,36 @@ jQuery.extend({
                var r = [];
                for ( var i = 0; i < a.length; i++ ) {
                        if ( a[i].constructor == String ) {
+
+                               var table = "";
        
-                               if ( !a[i].indexOf("<tr") ) {
-                                       var tr = true;
+                               if ( !a[i].indexOf("<thead") || !a[i].indexOf("<tbody") ) {
+                                       table = "thead";
+                                       a[i] = "<table>" + a[i] + "</table>";
+                               } else if ( !a[i].indexOf("<tr") ) {
+                                       table = "tr";
                                        a[i] = "<table>" + a[i] + "</table>";
                                } else if ( !a[i].indexOf("<td") || !a[i].indexOf("<th") ) {
-                                       var td = true;
+                                       table = "td";
                                        a[i] = "<table><tbody><tr>" + a[i] + "</tr></tbody></table>";
                                }
        
                                var div = document.createElement("div");
                                div.innerHTML = a[i];
        
-                               if ( tr || td ) {
-                                       div = div.firstChild.firstChild;
-                                       if ( td ) div = div.firstChild;
+                               if ( table ) {
+                                       div = div.firstChild;
+                                       if ( table != "thead" ) div = div.firstChild;
+                                       if ( table == "td" ) div = div.firstChild;
                                }
        
                                for ( var j = 0; j < div.childNodes.length; j++ )
                                        r.push( div.childNodes[j] );
-                       } else if ( a[i].jquery || a[i].length && !a[i].nodeType )
-                               for ( var k = 0; k < a[i].length; k++ )
-                                       r.push( a[i][k] );
-                       else if ( a[i] !== null )
-                               r.push( a[i].nodeType ? a[i] : document.createTextNode(a[i].toString()) );
+                               } else if ( a[i].jquery || a[i].length && !a[i].nodeType )
+                                       for ( var k = 0; k < a[i].length; k++ )
+                                               r.push( a[i][k] );
+                               else if ( a[i] !== null )
+                                       r.push( a[i].nodeType ? a[i] : document.createTextNode(a[i].toString()) );
                }
                return r;
        },
@@ -976,7 +1031,8 @@ jQuery.extend({
                        // Form elements
                        enabled: "!a.disabled",
                        disabled: "a.disabled",
-                       checked: "a.checked"
+                       checked: "a.checked",
+                       selected: "a.selected"
                },
                ".": "jQuery.className.has(a,m[2])",
                "@": {
@@ -1004,6 +1060,97 @@ jQuery.extend({
                }
        ],
        
+       /**
+        *
+        * @test t( "Element Selector", "div", ["main","foo"] );
+        * @test t( "Element Selector", "body", ["body"] );
+        * @test t( "Element Selector", "html", ["html"] );
+        * @test cmpOK( $("*").size(), ">=", 30, "Element Selector" );
+        * @test t( "Parent Element", "div div", ["foo"] );
+        *
+        * @test t( "ID Selector", "#body", ["body"] );
+        * @test t( "ID Selector w/ Element", "body#body", ["body"] );
+        * @test t( "ID Selector w/ Element", "ul#first", [] );
+        *
+        * @test t( "Class Selector", ".blog", ["mark","simon"] );
+        * @test t( "Class Selector", ".blog.link", ["simon"] );
+        * @test t( "Class Selector w/ Element", "a.blog", ["mark","simon"] );
+        * @test t( "Parent Class Selector", "p .blog", ["mark","simon"] );
+        *
+        * @test t( "Comma Support", "a.blog, div", ["mark","simon","main","foo"] );
+        * @test t( "Comma Support", "a.blog , div", ["mark","simon","main","foo"] );
+        * @test t( "Comma Support", "a.blog ,div", ["mark","simon","main","foo"] );
+        * @test t( "Comma Support", "a.blog,div", ["mark","simon","main","foo"] );
+        *
+        * @test t( "Child", "p > a", ["simon1","google","groups","mark","yahoo","simon"] );
+        * @test t( "Child", "p> a", ["simon1","google","groups","mark","yahoo","simon"] );
+        * @test t( "Child", "p >a", ["simon1","google","groups","mark","yahoo","simon"] );
+        * @test t( "Child", "p>a", ["simon1","google","groups","mark","yahoo","simon"] );
+        * @test t( "Child w/ Class", "p > a.blog", ["mark","simon"] );
+        * @test t( "All Children", "code > *", ["anchor1","anchor2"] );
+        * @test t( "All Grandchildren", "p > * > *", ["anchor1","anchor2"] );
+        * @test t( "Adjacent", "a + a", ["groups"] );
+        * @test t( "Adjacent", "a +a", ["groups"] );
+        * @test t( "Adjacent", "a+ a", ["groups"] );
+        * @test t( "Adjacent", "a+a", ["groups"] );
+        * @test t( "Adjacent", "p + p", ["ap","en","sap"] );
+        * @test t( "Comma, Child, and Adjacent", "a + a, code > a", ["groups","anchor1","anchor2"] );
+        * @test t( "First Child", "p:first-child", ["firstp","sndp"] );
+   * @test t( "Attribute Exists", "a[@title]", ["google"] );
+        * @test t( "Attribute Exists", "*[@title]", ["google"] );
+        * @test t( "Attribute Exists", "[@title]", ["google"] );
+        * @test t( "Attribute Equals", "a[@rel='bookmark']", ["simon1"] );
+        * @test t( "Attribute Equals", 'a[@rel="bookmark"]', ["simon1"] );
+        * @test t( "Attribute Equals", "a[@rel=bookmark]", ["simon1"] );
+        * @test t( "Multiple Attribute Equals", "input[@type='hidden'],input[@type='radio']", ["hidden1","radio1","radio2"] );
+        * @test t( "Multiple Attribute Equals", "input[@type=\"hidden\"],input[@type='radio']", ["hidden1","radio1","radio2"] );
+        * @test t( "Multiple Attribute Equals", "input[@type=hidden],input[@type=radio]", ["hidden1","radio1","radio2"] );
+        *
+        * @test t( "Attribute Begins With", "a[@href ^= 'http://www']", ["google","yahoo"] );
+        * @test t( "Attribute Ends With", "a[@href $= 'org/']", ["mark"] );
+        * @test t( "Attribute Contains", "a[@href *= 'google']", ["google","groups"] );
+        * @test t( "First Child", "p:first-child", ["firstp","sndp"] );
+        * @test t( "Last Child", "p:last-child", ["sap"] );
+        * @test t( "Only Child", "a:only-child", ["simon1","anchor1","yahoo","anchor2"] );
+        * @test t( "Empty", "ul:empty", ["firstUL"] );
+        * @test t( "Enabled UI Element", "input:enabled", ["text1","radio1","radio2","check1","check2","hidden1","hidden2"] );
+        * @test t( "Disabled UI Element", "input:disabled", ["text2"] );
+        * @test t( "Checked UI Element", "input:checked", ["radio2","check1"] );
+        * @test t( "Text Contains", "a:contains('Google')", ["google","groups"] );
+        * @test t( "Text Contains", "a:contains('Google Groups')", ["groups"] );
+        * @test t( "Element Preceded By", "p ~ div", ["foo"] );
+        * @test t( "Not", "a.blog:not(.link)", ["mark"] );
+        *
+        * @test cmpOK( jQuery.find("//*").length, ">=", 30, "All Elements (//*)" );
+        * @test t( "All Div Elements", "//div", ["main","foo"] );
+        * @test t( "Absolute Path", "/html/body", ["body"] );
+        * @test t( "Absolute Path w/ *", "/* /body", ["body"] );
+        * @test t( "Long Absolute Path", "/html/body/dl/div/div/p", ["sndp","en","sap"] );
+        * @test t( "Absolute and Relative Paths", "/html//div", ["main","foo"] );
+        * @test t( "All Children, Explicit", "//code/*", ["anchor1","anchor2"] );
+        * @test t( "All Children, Implicit", "//code/", ["anchor1","anchor2"] );
+        * @test t( "Attribute Exists", "//a[@title]", ["google"] );
+        * @test t( "Attribute Equals", "//a[@rel='bookmark']", ["simon1"] );
+        * @test t( "Parent Axis", "//p/..", ["main","foo"] );
+        * @test t( "Sibling Axis", "//p/../", ["firstp","ap","foo","first","firstUL","empty","form","sndp","en","sap"] );
+        * @test t( "Sibling Axis", "//p/../*", ["firstp","ap","foo","first","firstUL","empty","form","sndp","en","sap"] );
+        * @test t( "Has Children", "//p[a]", ["firstp","ap","en","sap"] );
+        *
+        * @test t( "nth Element", "p:nth(1)", ["ap"] );
+        * @test t( "First Element", "p:first", ["firstp"] );
+        * @test t( "Last Element", "p:last", ["first"] );
+        * @test t( "Even Elements", "p:even", ["firstp","sndp","sap"] );
+        * @test t( "Odd Elements", "p:odd", ["ap","en","first"] );
+        * @test t( "Position Equals", "p:eq(1)", ["ap"] );
+        * @test t( "Position Greater Than", "p:gt(0)", ["ap","sndp","en","sap","first"] );
+        * @test t( "Position Less Than", "p:lt(3)", ["firstp","ap","sndp"] );
+        * @test t( "Is A Parent", "p:parent", ["firstp","ap","sndp","en","sap","first"] );
+        * @test t( "Is Visible", "input:visible", ["text1","text2","radio1","radio2","check1","check2"] );
+        * @test t( "Is Hidden", "input:hidden", ["hidden1","hidden2"] );
+        *
+        * @name jQuery.find
+        * @private
+        */
        find: function( t, context ) {
                // Make sure that the context is a DOM Element
                if ( context && context.nodeType == undefined )
@@ -1155,7 +1302,7 @@ jQuery.extend({
                                        .replace( 'S', "([a-z*_-][a-z0-9_-]*)" )
 
                                        // Look for something (optionally) enclosed with quotes
-                                       .replace( 'Q', " *'?\"?([^'\"]*)'?\"? *" ), "i" );
+                                       .replace( 'Q', " *'?\"?([^'\"]*?)'?\"? *" ), "i" );
 
                                var m = re.exec( t );
 
@@ -1201,7 +1348,7 @@ jQuery.extend({
         * Remove the whitespace from the beginning and end of a string.
         *
         * @private
-        * @name $.trim
+        * @name jQuery.trim
         * @type String
         * @param String str The string to trim.
         */
@@ -1213,7 +1360,7 @@ jQuery.extend({
         * All ancestors of a given element.
         *
         * @private
-        * @name $.parents
+        * @name jQuery.parents
         * @type Array<Element>
         * @param Element elem The element to find the ancestors of.
         */
@@ -1231,7 +1378,7 @@ jQuery.extend({
         * All elements on a specified axis.
         *
         * @private
-        * @name $.sibling
+        * @name jQuery.sibling
         * @type Array
         * @param Element elem The element to find all the siblings of (including itself).
         */
@@ -1258,7 +1405,7 @@ jQuery.extend({
         * Merge two arrays together, removing all duplicates.
         *
         * @private
-        * @name $.merge
+        * @name jQuery.merge
         * @type Array
         * @param Array a The first array to merge.
         * @param Array b The second array to merge.
@@ -1268,22 +1415,22 @@ jQuery.extend({
                
                // Move b over to the new array (this helps to avoid
                // StaticNodeList instances)
-               for ( var k = 0; k < b.length; k++ )
-                       d[k] = b[k];
+               for ( var k = 0; k < a.length; k++ )
+                       d[k] = a[k];
        
                // Now check for duplicates between a and b and only
                // add the unique items
-               for ( var i = 0; i < a.length; i++ ) {
+               for ( var i = 0; i < b.length; i++ ) {
                        var c = true;
                        
                        // The collision-checking process
-                       for ( var j = 0; j < b.length; j++ )
-                               if ( a[i] == b[j] )
+                       for ( var j = 0; j < a.length; j++ )
+                               if ( b[i] == a[j] )
                                        c = false;
                                
                        // If the item is unique, add it
                        if ( c )
-                               d.push( a[i] );
+                               d.push( b[i] );
                }
        
                return d;
@@ -1295,7 +1442,7 @@ jQuery.extend({
         * array item) and 'i' (which is the index of the item in the array).
         *
         * @private
-        * @name $.grep
+        * @name jQuery.grep
         * @type Array
         * @param Array array The Array to find items in.
         * @param Function fn The function to process each item against.
@@ -1327,7 +1474,7 @@ jQuery.extend({
         * be the same size upon completion, as it was when it started.
         *
         * @private
-        * @name $.map
+        * @name jQuery.map
         * @type Array
         * @param Array array The Array to translate.
         * @param Function fn The function to process each item against.
@@ -1346,7 +1493,7 @@ jQuery.extend({
                        var t = f(a[i],i);
                        if ( t !== null && t != undefined ) {
                                if ( t.constructor != Array ) t = [t];
-                               r = jQuery.merge( t, r );
+                               r = jQuery.merge( r, t );
                        }
                }
                return r;
@@ -1846,6 +1993,14 @@ jQuery.macros = {
                 * @before <div><input/></div>
                 * @result <div><b>new stuff</b></div>
                 *
+                * @test var div = $("div");
+                * div.html("<b>test</b>");
+                * var pass = true;
+                * for ( var i = 0; i < div.size(); i++ ) {
+                *   if ( div.get(i).childNodes.length == 0 ) pass = false;
+                * }
+                * ok( pass, "Set HTML" );
+                *
                 * @name html
                 * @type jQuery
                 * @param String val Set the html contents to the specified value.
@@ -2218,6 +2373,11 @@ jQuery.macros = {
        },
 
        each: {
+
+               removeAttr: function( key ) {
+                       this.removeAttribute( key );
+               },
+
                /**
                 * Displays each of the set of matched elements if they are hidden.
                 * 
@@ -2225,6 +2385,12 @@ jQuery.macros = {
                 * @before <p style="display: none">Hello</p>
                 * @result [ <p style="display: block">Hello</p> ]
                 *
+                * @test var pass = true, div = $("div");
+                * div.show().each(function(){
+                *   if ( this.style.display == "none" ) pass = false;
+                * });
+                * ok( pass, "Show" );
+                *
                 * @name show
                 * @type jQuery
                 * @cat Effects
@@ -2242,6 +2408,12 @@ jQuery.macros = {
                 * @before <p>Hello</p>
                 * @result [ <p style="display: none">Hello</p> ]
                 *
+                * var pass = true, div = $("div");
+                * div.hide().each(function(){
+                *   if ( this.style.display != "none" ) pass = false;
+                * });
+                * ok( pass, "Hide" );
+                *
                 * @name hide
                 * @type jQuery
                 * @cat Effects
@@ -2277,6 +2449,14 @@ jQuery.macros = {
                 * @example $("p").addClass("selected")
                 * @before <p>Hello</p>
                 * @result [ <p class="selected">Hello</p> ]
+                *
+                * @test var div = $("div");
+                * div.addClass("test");
+                * var pass = true;
+                * for ( var i = 0; i < div.size(); i++ ) {
+                *  if ( div.get(i).className.indexOf("test") == -1 ) pass = false;
+                * }
+                * ok( pass, "Add Class" );
                 * 
                 * @name addClass
                 * @type jQuery
@@ -2294,6 +2474,14 @@ jQuery.macros = {
                 * @before <p class="selected">Hello</p>
                 * @result [ <p>Hello</p> ]
                 *
+                * @test var div = $("div").addClass("test");
+                * div.removeClass("test");
+                * var pass = true;
+                * for ( var i = 0; i < div.size(); i++ ) {
+                *  if ( div.get(i).className.indexOf("test") != -1 ) pass = false;
+                * }
+                * ok( pass, "Remove Class" );
+                *
                 * @name removeClass
                 * @type jQuery
                 * @param String class A CSS class to remove from the elements