diff --git a/docs/underscore.html b/docs/underscore.html index fdcf8166c..726b8976a 100644 --- a/docs/underscore.html +++ b/docs/underscore.html @@ -1,4 +1,4 @@ - underscore.js

underscore.js

Underscore.js 1.1.7
+      underscore.js           

underscore.js

Underscore.js 1.2.0
 (c) 2011 Jeremy Ashkenas, DocumentCloud Inc.
 Underscore is freely distributable under the MIT license.
 Portions of Underscore are inspired or borrowed from Prototype,
@@ -27,7 +27,7 @@
     module.exports = _;
     _._ = _;
   } else {

Exported as a string, for Closure Compiler "advanced" mode.

    root['_'] = _;
-  }

Current version.

  _.VERSION = '1.1.7';

Collection Functions

The cornerstone, an each implementation, aka forEach. + }

Current version.

  _.VERSION = '1.2.0';

Collection Functions

The cornerstone, an each implementation, aka forEach. Handles objects with the built-in forEach, arrays, and raw objects. Delegates to ECMAScript 5's native forEach if available.

  var each = _.each = _.forEach = function(obj, iterator, context) {
     if (obj == null) return;
@@ -145,6 +145,7 @@
     return _.map(obj, function(value){ return value[key]; });
   };

Return the maximum element or (element-based computation).

  _.max = function(obj, iterator, context) {
     if (!iterator && _.isArray(obj)) return Math.max.apply(Math, obj);
+    if (!iterator && _.isEmpty(obj)) return -Infinity;
     var result = {computed : -Infinity};
     each(obj, function(value, index, list) {
       var computed = iterator ? iterator.call(context, value, index, list) : value;
@@ -153,13 +154,26 @@
     return result.value;
   };

Return the minimum element (or element-based computation).

  _.min = function(obj, iterator, context) {
     if (!iterator && _.isArray(obj)) return Math.min.apply(Math, obj);
+    if (!iterator && _.isEmpty(obj)) return Infinity;
     var result = {computed : Infinity};
     each(obj, function(value, index, list) {
       var computed = iterator ? iterator.call(context, value, index, list) : value;
       computed < result.computed && (result = {value : value, computed : computed});
     });
     return result.value;
-  };

Sort the object's values by a criterion produced by an iterator.

  _.sortBy = function(obj, iterator, context) {
+  };

Shuffle an array.

  _.shuffle = function(obj) {
+    var shuffled = [], rand;
+    each(obj, function(value, index, list) {
+      if (index == 0) {
+        shuffled[0] = value;
+      } else {
+        rand = Math.floor(Math.random() * (index + 1));
+        shuffled[index] = shuffled[rand];
+        shuffled[rand] = value;
+      }
+    });
+    return shuffled;
+  };

Sort the object's values by a criterion produced by an iterator.

  _.sortBy = function(obj, iterator, context) {
     return _.pluck(_.map(obj, function(value, index, list) {
       return {
         value : value,
@@ -169,14 +183,14 @@
       var a = left.criteria, b = right.criteria;
       return a < b ? -1 : a > b ? 1 : 0;
     }), 'value');
-  };

Groups the object's values by a criterion produced by an iterator

  _.groupBy = function(obj, iterator) {
+  };

Groups the object's values by a criterion produced by an iterator

  _.groupBy = function(obj, iterator) {
     var result = {};
     each(obj, function(value, index) {
       var key = iterator(value, index);
       (result[key] || (result[key] = [])).push(value);
     });
     return result;
-  };

Use a comparator function to figure out at what index an object should + };

Use a comparator function to figure out at what index an object should be inserted so as to maintain order. Uses binary search.

  _.sortedIndex = function(array, obj, iterator) {
     iterator || (iterator = _.identity);
     var low = 0, high = array.length;
@@ -185,46 +199,58 @@
       iterator(array[mid]) < iterator(obj) ? low = mid + 1 : high = mid;
     }
     return low;
-  };

Safely convert anything iterable into a real, live array.

  _.toArray = function(iterable) {
+  };

Safely convert anything iterable into a real, live array.

  _.toArray = function(iterable) {
     if (!iterable)                return [];
     if (iterable.toArray)         return iterable.toArray();
     if (_.isArray(iterable))      return slice.call(iterable);
     if (_.isArguments(iterable))  return slice.call(iterable);
     return _.values(iterable);
-  };

Return the number of elements in an object.

  _.size = function(obj) {
+  };

Return the number of elements in an object.

  _.size = function(obj) {
     return _.toArray(obj).length;
-  };

Array Functions

Get the first element of an array. Passing n will return the first N + };

Array Functions

Get the first element of an array. Passing n will return the first N values in the array. Aliased as head. The guard check allows it to work with _.map.

  _.first = _.head = function(array, n, guard) {
     return (n != null) && !guard ? slice.call(array, 0, n) : array[0];
-  };

Returns everything but the first entry of the array. Aliased as tail. + };

Returns everything but the last entry of the array. Especcialy useful on +the arguments object. Passing n will return all the values in +the array, excluding the last N. The guard check allows it to work with +_.map.

  _.initial = function(array, n, guard) {
+    return slice.call(array, 0, array.length - ((n == null) || guard ? 1 : n));
+  };

Get the last element of an array. Passing n will return the last N +values in the array. The guard check allows it to work with _.map.

  _.last = function(array, n, guard) {
+    return (n != null) && !guard ? slice.call(array, array.length - n) : array[array.length - 1];
+  };

Returns everything but the first entry of the array. Aliased as tail. Especially useful on the arguments object. Passing an index will return the rest of the values in the array from that index onward. The guard check allows it to work with _.map.

  _.rest = _.tail = function(array, index, guard) {
     return slice.call(array, (index == null) || guard ? 1 : index);
-  };

Get the last element of an array.

  _.last = function(array) {
-    return array[array.length - 1];
-  };

Trim out all falsy values from an array.

  _.compact = function(array) {
+  };

Trim out all falsy values from an array.

  _.compact = function(array) {
     return _.filter(array, function(value){ return !!value; });
-  };

Return a completely flattened version of an array.

  _.flatten = function(array) {
+  };

Return a completely flattened version of an array.

  _.flatten = function(array) {
     return _.reduce(array, function(memo, value) {
       if (_.isArray(value)) return memo.concat(_.flatten(value));
       memo[memo.length] = value;
       return memo;
     }, []);
-  };

Return a version of the array that does not contain the specified value(s).

  _.without = function(array) {
+  };

Return a version of the array that does not contain the specified value(s).

  _.without = function(array) {
     return _.difference(array, slice.call(arguments, 1));
-  };

Produce a duplicate-free version of the array. If the array has already + };

Produce a duplicate-free version of the array. If the array has already been sorted, you have the option of using a faster algorithm. -Aliased as unique.

  _.uniq = _.unique = function(array, isSorted) {
-    return _.reduce(array, function(memo, el, i) {
-      if (0 == i || (isSorted === true ? _.last(memo) != el : !_.include(memo, el))) memo[memo.length] = el;
+Aliased as unique.

  _.uniq = _.unique = function(array, isSorted, iterator) {
+    var initial = iterator ? _.map(array, iterator) : array;
+    var result = [];
+    _.reduce(initial, function(memo, el, i) {
+      if (0 == i || (isSorted === true ? _.last(memo) != el : !_.include(memo, el))) {
+        memo[memo.length] = el;
+        result[result.length] = array[i];
+      }
       return memo;
     }, []);
-  };

Produce an array that contains the union: each distinct element from all of + return result; + };

Produce an array that contains the union: each distinct element from all of the passed-in arrays.

  _.union = function() {
     return _.uniq(_.flatten(arguments));
-  };

Produce an array that contains every item shared between all the + };

Produce an array that contains every item shared between all the passed-in arrays. (Aliased as "intersect" for back-compat.)

  _.intersection = _.intersect = function(array) {
     var rest = slice.call(arguments, 1);
     return _.filter(_.uniq(array), function(item) {
@@ -232,17 +258,17 @@
         return _.indexOf(other, item) >= 0;
       });
     });
-  };

Take the difference between one array and another. + };

Take the difference between one array and another. Only the elements present in just the first array will remain.

  _.difference = function(array, other) {
     return _.filter(array, function(value){ return !_.include(other, value); });
-  };

Zip together multiple lists into a single array -- elements that share + };

Zip together multiple lists into a single array -- elements that share an index go together.

  _.zip = function() {
     var args = slice.call(arguments);
     var length = _.max(_.pluck(args, 'length'));
     var results = new Array(length);
     for (var i = 0; i < length; i++) results[i] = _.pluck(args, "" + i);
     return results;
-  };

If the browser doesn't supply us with indexOf (I'm looking at you, MSIE), + };

If the browser doesn't supply us with indexOf (I'm looking at you, MSIE), we need this function. Return the position of the first occurrence of an item in an array, or -1 if the item is not included in the array. Delegates to ECMAScript 5's native indexOf if available. @@ -257,13 +283,13 @@ if (nativeIndexOf && array.indexOf === nativeIndexOf) return array.indexOf(item); for (i = 0, l = array.length; i < l; i++) if (array[i] === item) return i; return -1; - };

Delegates to ECMAScript 5's native lastIndexOf if available.

  _.lastIndexOf = function(array, item) {
+  };

Delegates to ECMAScript 5's native lastIndexOf if available.

  _.lastIndexOf = function(array, item) {
     if (array == null) return -1;
     if (nativeLastIndexOf && array.lastIndexOf === nativeLastIndexOf) return array.lastIndexOf(item);
     var i = array.length;
     while (i--) if (array[i] === item) return i;
     return -1;
-  };

Generate an integer Array containing an arithmetic progression. A port of + };

Generate an integer Array containing an arithmetic progression. A port of the native Python range() function. See the Python documentation.

  _.range = function(start, stop, step) {
     if (arguments.length <= 1) {
@@ -282,7 +308,7 @@
     }
 
     return range;
-  };

Function (ahem) Functions

Create a function bound to a given object (assigning this, and arguments, + };

Function (ahem) Functions

Create a function bound to a given object (assigning this, and arguments, optionally). Binding with arguments is also known as curry. Delegates to ECMAScript 5's native Function.bind if available. We check for func.bind first, to fail fast when func is undefined.

  _.bind = function(func, obj) {
@@ -291,27 +317,27 @@
     return function() {
       return func.apply(obj, args.concat(slice.call(arguments)));
     };
-  };

Bind all of an object's methods to that object. Useful for ensuring that + };

Bind all of an object's methods to that object. Useful for ensuring that all callbacks defined on an object belong to it.

  _.bindAll = function(obj) {
     var funcs = slice.call(arguments, 1);
     if (funcs.length == 0) funcs = _.functions(obj);
     each(funcs, function(f) { obj[f] = _.bind(obj[f], obj); });
     return obj;
-  };

Memoize an expensive function by storing its results.

  _.memoize = function(func, hasher) {
+  };

Memoize an expensive function by storing its results.

  _.memoize = function(func, hasher) {
     var memo = {};
     hasher || (hasher = _.identity);
     return function() {
       var key = hasher.apply(this, arguments);
       return hasOwnProperty.call(memo, key) ? memo[key] : (memo[key] = func.apply(this, arguments));
     };
-  };

Delays a function for the given number of milliseconds, and then calls + };

Delays a function for the given number of milliseconds, and then calls it with the arguments supplied.

  _.delay = function(func, wait) {
     var args = slice.call(arguments, 2);
     return setTimeout(function(){ return func.apply(func, args); }, wait);
-  };

Defers a function, scheduling it to run after the current call stack has + };

Defers a function, scheduling it to run after the current call stack has cleared.

  _.defer = function(func) {
     return _.delay.apply(_, [func, 1].concat(slice.call(arguments, 1)));
-  };

Internal function used to implement _.throttle and _.debounce.

  var limit = function(func, wait, debounce) {
+  };

Internal function used to implement _.throttle and _.debounce.

  var limit = function(func, wait, debounce) {
     var timeout;
     return function() {
       var context = this, args = arguments;
@@ -322,14 +348,14 @@
       if (debounce) clearTimeout(timeout);
       if (debounce || !timeout) timeout = setTimeout(throttler, wait);
     };
-  };

Returns a function, that, when invoked, will only be triggered at most once + };

Returns a function, that, when invoked, will only be triggered at most once during a given window of time.

  _.throttle = function(func, wait) {
     return limit(func, wait, false);
-  };

Returns a function, that, as long as it continues to be invoked, will not + };

Returns a function, that, as long as it continues to be invoked, will not be triggered. The function will be called after it stops being called for N milliseconds.

  _.debounce = function(func, wait) {
     return limit(func, wait, true);
-  };

Returns a function that will be executed at most one time, no matter how + };

Returns a function that will be executed at most one time, no matter how often you call it. Useful for lazy initialization.

  _.once = function(func) {
     var ran = false, memo;
     return function() {
@@ -337,14 +363,14 @@
       ran = true;
       return memo = func.apply(this, arguments);
     };
-  };

Returns the first function passed as an argument to the second, + };

Returns the first function passed as an argument to the second, allowing you to adjust arguments, run code before and after, and conditionally execute the original function.

  _.wrap = function(func, wrapper) {
     return function() {
       var args = [func].concat(slice.call(arguments));
       return wrapper.apply(this, args);
     };
-  };

Returns a function that is the composition of a list of functions, each + };

Returns a function that is the composition of a list of functions, each consuming the return value of the function that follows.

  _.compose = function() {
     var funcs = slice.call(arguments);
     return function() {
@@ -354,110 +380,141 @@
       }
       return args[0];
     };
-  };

Returns a function that will only be executed after being called N times.

  _.after = function(times, func) {
+  };

Returns a function that will only be executed after being called N times.

  _.after = function(times, func) {
     return function() {
       if (--times < 1) { return func.apply(this, arguments); }
     };
-  };

Object Functions

Retrieve the names of an object's properties. + };

Object Functions

Retrieve the names of an object's properties. Delegates to ECMAScript 5's native Object.keys

  _.keys = nativeKeys || function(obj) {
     if (obj !== Object(obj)) throw new TypeError('Invalid object');
     var keys = [];
     for (var key in obj) if (hasOwnProperty.call(obj, key)) keys[keys.length] = key;
     return keys;
-  };

Retrieve the values of an object's properties.

  _.values = function(obj) {
+  };

Retrieve the values of an object's properties.

  _.values = function(obj) {
     return _.map(obj, _.identity);
-  };

Return a sorted list of the function names available on the object. + };

Return a sorted list of the function names available on the object. Aliased as methods

  _.functions = _.methods = function(obj) {
     var names = [];
     for (var key in obj) {
       if (_.isFunction(obj[key])) names.push(key);
     }
     return names.sort();
-  };

Extend a given object with all the properties in passed-in object(s).

  _.extend = function(obj) {
+  };

Extend a given object with all the properties in passed-in object(s).

  _.extend = function(obj) {
     each(slice.call(arguments, 1), function(source) {
       for (var prop in source) {
         if (source[prop] !== void 0) obj[prop] = source[prop];
       }
     });
     return obj;
-  };

Fill in a given object with default properties.

  _.defaults = function(obj) {
+  };

Fill in a given object with default properties.

  _.defaults = function(obj) {
     each(slice.call(arguments, 1), function(source) {
       for (var prop in source) {
         if (obj[prop] == null) obj[prop] = source[prop];
       }
     });
     return obj;
-  };

Create a (shallow-cloned) duplicate of an object.

  _.clone = function(obj) {
+  };

Create a (shallow-cloned) duplicate of an object.

  _.clone = function(obj) {
     return _.isArray(obj) ? obj.slice() : _.extend({}, obj);
-  };

Invokes interceptor with the obj, and then returns obj. + };

Invokes interceptor with the obj, and then returns obj. The primary purpose of this method is to "tap into" a method chain, in order to perform operations on intermediate results within the chain.

  _.tap = function(obj, interceptor) {
     interceptor(obj);
     return obj;
-  };

Perform a deep comparison to check if two objects are equal.

  _.isEqual = function(a, b) {

Check object identity.

    if (a === b) return true;

Different types?

    var atype = typeof(a), btype = typeof(b);
-    if (atype != btype) return false;

Basic equality test (watch out for coercions).

    if (a == b) return true;

One is falsy and the other truthy.

    if ((!a && b) || (a && !b)) return false;

Unwrap any wrapped objects.

    if (a._chain) a = a._wrapped;
-    if (b._chain) b = b._wrapped;

One of them implements an isEqual()?

    if (a.isEqual) return a.isEqual(b);
-    if (b.isEqual) return b.isEqual(a);

Check dates' integer values.

    if (_.isDate(a) && _.isDate(b)) return a.getTime() === b.getTime();

Both are NaN?

    if (_.isNaN(a) && _.isNaN(b)) return false;

Compare regular expressions.

    if (_.isRegExp(a) && _.isRegExp(b))
-      return a.source     === b.source &&
-             a.global     === b.global &&
-             a.ignoreCase === b.ignoreCase &&
-             a.multiline  === b.multiline;

If a is not an object by this point, we can't handle it.

    if (atype !== 'object') return false;

Check for different array lengths before comparing contents.

    if (a.length && (a.length !== b.length)) return false;

Nothing else worked, deep compare the contents.

    var aKeys = _.keys(a), bKeys = _.keys(b);

Different object sizes?

    if (aKeys.length != bKeys.length) return false;

Recursive comparison of contents.

    for (var key in a) if (!(key in b) || !_.isEqual(a[key], b[key])) return false;
-    return true;
-  };

Is a given array or object empty?

  _.isEmpty = function(obj) {
+  };

Internal recursive comparison function.

  function eq(a, b, stack) {

Identical objects are equal. 0 === -0, but they aren't identical. +See the Harmony egal proposal: http://wiki.ecmascript.org/doku.php?id=harmony:egal.

    if (a === b) return a !== 0 || 1 / a == 1 / b;

A strict comparison is necessary because null == undefined.

    if (a == null) return a === b;

Compare object types.

    var typeA = typeof a;
+    if (typeA != typeof b) return false;

Optimization; ensure that both values are truthy or falsy.

    if (!a != !b) return false;

NaN values are equal.

    if (_.isNaN(a)) return _.isNaN(b);

Compare string objects by value.

    var isStringA = _.isString(a), isStringB = _.isString(b);
+    if (isStringA || isStringB) return isStringA && isStringB && String(a) == String(b);

Compare number objects by value.

    var isNumberA = _.isNumber(a), isNumberB = _.isNumber(b);
+    if (isNumberA || isNumberB) return isNumberA && isNumberB && +a == +b;

Compare boolean objects by value. The value of true is 1; the value of false is 0.

    var isBooleanA = _.isBoolean(a), isBooleanB = _.isBoolean(b);
+    if (isBooleanA || isBooleanB) return isBooleanA && isBooleanB && +a == +b;

Compare dates by their millisecond values.

    var isDateA = _.isDate(a), isDateB = _.isDate(b);
+    if (isDateA || isDateB) return isDateA && isDateB && a.getTime() == b.getTime();

Compare RegExps by their source patterns and flags.

    var isRegExpA = _.isRegExp(a), isRegExpB = _.isRegExp(b);
+    if (isRegExpA || isRegExpB) {

Ensure commutative equality for RegExps.

      return isRegExpA && isRegExpB &&
+             a.source == b.source &&
+             a.global == b.global &&
+             a.multiline == b.multiline &&
+             a.ignoreCase == b.ignoreCase;
+    }

Ensure that both values are objects.

    if (typeA != 'object') return false;

Unwrap any wrapped objects.

    if (a._chain) a = a._wrapped;
+    if (b._chain) b = b._wrapped;

Invoke a custom isEqual method if one is provided.

    if (_.isFunction(a.isEqual)) return a.isEqual(b);

Assume equality for cyclic structures. The algorithm for detecting cyclic structures is +adapted from ES 5.1 section 15.12.3, abstract operation JO.

    var length = stack.length;
+    while (length--) {

Linear search. Performance is inversely proportional to the number of unique nested +structures.

      if (stack[length] == a) return true;
+    }

Add the first object to the stack of traversed objects.

    stack.push(a);
+    var size = 0, result = true;
+    if (a.length === +a.length || b.length === +b.length) {

Compare object lengths to determine if a deep comparison is necessary.

      size = a.length;
+      result = size == b.length;
+      if (result) {

Deep compare array-like object contents, ignoring non-numeric properties.

        while (size--) {

Ensure commutative equality for sparse arrays.

          if (!(result = size in a == size in b && eq(a[size], b[size], stack))) break;
+        }
+      }
+    } else {

Deep compare objects.

      for (var key in a) {
+        if (hasOwnProperty.call(a, key)) {

Count the expected number of properties.

          size++;

Deep compare each member.

          if (!(result = hasOwnProperty.call(b, key) && eq(a[key], b[key], stack))) break;
+        }
+      }

Ensure that both objects contain the same number of properties.

      if (result) {
+        for (key in b) {
+          if (hasOwnProperty.call(b, key) && !size--) break;
+        }
+        result = !size;
+      }
+    }

Remove the first object from the stack of traversed objects.

    stack.pop();
+    return result;
+  }

Perform a deep comparison to check if two objects are equal.

  _.isEqual = function(a, b) {
+    return eq(a, b, []);
+  };

Is a given array or object empty?

  _.isEmpty = function(obj) {
     if (_.isArray(obj) || _.isString(obj)) return obj.length === 0;
     for (var key in obj) if (hasOwnProperty.call(obj, key)) return false;
     return true;
-  };

Is a given value a DOM element?

  _.isElement = function(obj) {
+  };

Is a given value a DOM element?

  _.isElement = function(obj) {
     return !!(obj && obj.nodeType == 1);
-  };

Is a given value an array? + };

Is a given value an array? Delegates to ECMA5's native Array.isArray

  _.isArray = nativeIsArray || function(obj) {
     return toString.call(obj) === '[object Array]';
-  };

Is a given variable an object?

  _.isObject = function(obj) {
+  };

Is a given variable an object?

  _.isObject = function(obj) {
     return obj === Object(obj);
-  };

Is a given variable an arguments object?

  _.isArguments = function(obj) {
+  };

Is a given variable an arguments object?

  _.isArguments = function(obj) {
     return !!(obj && hasOwnProperty.call(obj, 'callee'));
-  };

Is a given value a function?

  _.isFunction = function(obj) {
+  };

Is a given value a function?

  _.isFunction = function(obj) {
     return !!(obj && obj.constructor && obj.call && obj.apply);
-  };

Is a given value a string?

  _.isString = function(obj) {
+  };

Is a given value a string?

  _.isString = function(obj) {
     return !!(obj === '' || (obj && obj.charCodeAt && obj.substr));
-  };

Is a given value a number?

  _.isNumber = function(obj) {
+  };

Is a given value a number?

  _.isNumber = function(obj) {
     return !!(obj === 0 || (obj && obj.toExponential && obj.toFixed));
-  };

Is the given value NaN? NaN happens to be the only value in JavaScript + };

Is the given value NaN? NaN happens to be the only value in JavaScript that does not equal itself.

  _.isNaN = function(obj) {
     return obj !== obj;
-  };

Is a given value a boolean?

  _.isBoolean = function(obj) {
-    return obj === true || obj === false;
-  };

Is a given value a date?

  _.isDate = function(obj) {
+  };

Is a given value a boolean?

  _.isBoolean = function(obj) {
+    return obj === true || obj === false || toString.call(obj) == '[object Boolean]';
+  };

Is a given value a date?

  _.isDate = function(obj) {
     return !!(obj && obj.getTimezoneOffset && obj.setUTCFullYear);
-  };

Is the given value a regular expression?

  _.isRegExp = function(obj) {
+  };

Is the given value a regular expression?

  _.isRegExp = function(obj) {
     return !!(obj && obj.test && obj.exec && (obj.ignoreCase || obj.ignoreCase === false));
-  };

Is a given value equal to null?

  _.isNull = function(obj) {
+  };

Is a given value equal to null?

  _.isNull = function(obj) {
     return obj === null;
-  };

Is a given variable undefined?

  _.isUndefined = function(obj) {
+  };

Is a given variable undefined?

  _.isUndefined = function(obj) {
     return obj === void 0;
-  };

Utility Functions

Run Underscore.js in noConflict mode, returning the _ variable to its + };

Utility Functions

Run Underscore.js in noConflict mode, returning the _ variable to its previous owner. Returns a reference to the Underscore object.

  _.noConflict = function() {
     root._ = previousUnderscore;
     return this;
-  };

Keep the identity function around for default iterators.

  _.identity = function(value) {
+  };

Keep the identity function around for default iterators.

  _.identity = function(value) {
     return value;
-  };

Run a function n times.

  _.times = function (n, iterator, context) {
+  };

Run a function n times.

  _.times = function (n, iterator, context) {
     for (var i = 0; i < n; i++) iterator.call(context, i);
-  };

Add your own custom functions to the Underscore object, ensuring that + };

Escape a string for HTML interpolation.

  _.escape = function(string) {
+    return (''+string).replace(/&(?!\w+;|#\d+;|#x[\da-f]+;)/gi, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;').replace(/'/g, '&#x27;').replace(/\//g,'&#x2F;');
+  };

Add your own custom functions to the Underscore object, ensuring that they're correctly added to the OOP wrapper as well.

  _.mixin = function(obj) {
     each(_.functions(obj), function(name){
       addToWrapper(name, _[name] = obj[name]);
     });
-  };

Generate a unique integer id (unique within the entire client session). + };

Generate a unique integer id (unique within the entire client session). Useful for temporary DOM ids.

  var idCounter = 0;
   _.uniqueId = function(prefix) {
     var id = idCounter++;
     return prefix ? prefix + id : id;
-  };

By default, Underscore uses ERB-style template delimiters, change the + };

By default, Underscore uses ERB-style template delimiters, change the following template settings to use alternative delimiters.

  _.templateSettings = {
     evaluate    : /<%([\s\S]+?)%>/g,
-    interpolate : /<%=([\s\S]+?)%>/g
-  };

JavaScript micro-templating, similar to John Resig's implementation. + interpolate : /<%=([\s\S]+?)%>/g, + escape : /<%-([\s\S]+?)%>/g + };

JavaScript micro-templating, similar to John Resig's implementation. Underscore templating handles arbitrary delimiters, preserves whitespace, and correctly escapes quotes within interpolated code.

  _.template = function(str, data) {
     var c  = _.templateSettings;
@@ -465,6 +522,9 @@
       'with(obj||{}){__p.push(\'' +
       str.replace(/\\/g, '\\\\')
          .replace(/'/g, "\\'")
+         .replace(c.escape, function(match, code) {
+           return "',_.escape(" + code.replace(/\\'/g, "'") + "),'";
+         })
          .replace(c.interpolate, function(match, code) {
            return "'," + code.replace(/\\'/g, "'") + ",'";
          })
@@ -478,31 +538,31 @@
          + "');}return __p.join('');";
     var func = new Function('obj', tmpl);
     return data ? func(data) : func;
-  };

The OOP Wrapper

If Underscore is called as a function, it returns a wrapped object that + };

The OOP Wrapper

If Underscore is called as a function, it returns a wrapped object that can be used OO-style. This wrapper holds altered versions of all the -underscore functions. Wrapped objects may be chained.

  var wrapper = function(obj) { this._wrapped = obj; };

Expose wrapper.prototype as _.prototype

  _.prototype = wrapper.prototype;

Helper function to continue chaining intermediate results.

  var result = function(obj, chain) {
+underscore functions. Wrapped objects may be chained.

  var wrapper = function(obj) { this._wrapped = obj; };

Expose wrapper.prototype as _.prototype

  _.prototype = wrapper.prototype;

Helper function to continue chaining intermediate results.

  var result = function(obj, chain) {
     return chain ? _(obj).chain() : obj;
-  };

A method to easily add functions to the OOP wrapper.

  var addToWrapper = function(name, func) {
+  };

A method to easily add functions to the OOP wrapper.

  var addToWrapper = function(name, func) {
     wrapper.prototype[name] = function() {
       var args = slice.call(arguments);
       unshift.call(args, this._wrapped);
       return result(func.apply(_, args), this._chain);
     };
-  };

Add all of the Underscore functions to the wrapper object.

  _.mixin(_);

Add all mutator Array functions to the wrapper.

  each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) {
+  };

Add all of the Underscore functions to the wrapper object.

  _.mixin(_);

Add all mutator Array functions to the wrapper.

  each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) {
     var method = ArrayProto[name];
     wrapper.prototype[name] = function() {
       method.apply(this._wrapped, arguments);
       return result(this._wrapped, this._chain);
     };
-  });

Add all accessor Array functions to the wrapper.

  each(['concat', 'join', 'slice'], function(name) {
+  });

Add all accessor Array functions to the wrapper.

  each(['concat', 'join', 'slice'], function(name) {
     var method = ArrayProto[name];
     wrapper.prototype[name] = function() {
       return result(method.apply(this._wrapped, arguments), this._chain);
     };
-  });

Start chaining a wrapped Underscore object.

  wrapper.prototype.chain = function() {
+  });

Start chaining a wrapped Underscore object.

  wrapper.prototype.chain = function() {
     this._chain = true;
     return this;
-  };

Extracts the result from a wrapped and chained object.

  wrapper.prototype.value = function() {
+  };

Extracts the result from a wrapped and chained object.

  wrapper.prototype.value = function() {
     return this._wrapped;
   };
 
diff --git a/index.html b/index.html
index 0641e9059..bf08b2dd7 100644
--- a/index.html
+++ b/index.html
@@ -49,6 +49,14 @@
       td {
         padding: 2px 12px 2px 0;
       }
+    ul {
+      list-style-type: circle;
+      padding: 0 0 0 20px;
+    }
+      li {
+        width: 500px;
+        margin-bottom: 10px;
+      }
     code, pre, tt {
       font-family: Monaco, Consolas, "Lucida Console", monospace;
       font-size: 12px;
@@ -118,11 +126,11 @@ 

Downloads (Right-click, and u - + - +
Development Version (1.1.7)Development Version (1.2.0) 28kb, Uncompressed with Comments
Production Version (1.1.7)Production Version (1.2.0) 3kb, Minified and Gzipped
@@ -141,14 +149,15 @@

Table of Contents

any, include, invoke, pluck, max, min, - sortBy, groupBy, sortedIndex, + sortBy, groupBy, + sortedIndex, shuffle, toArray, size

Arrays
- first, rest, last, + first, initial, last, rest, compact, flatten, without, union, intersection, difference, uniq, zip, indexOf, @@ -462,6 +471,17 @@

Collection Functions (Arrays or Objects)

 _.sortedIndex([10, 20, 30, 40, 50], 35);
 => 3
+
+ +

+ shuffle_.shuffle(list) +
+ Returns a shuffled copy of the list, using a version of the + Fisher-Yates shuffle. +

+
+_.shuffle([1, 2, 3, 4, 5, 6]);
+=> [4, 1, 6, 3, 5, 2]
 

@@ -503,26 +523,39 @@

Array Functions

=> 5

-

- rest_.rest(array, [index]) - Alias: tail +

+ initial_.initial(array, [n])
- Returns the rest of the elements in an array. Pass an index - to return the values of the array from that index onward. + Returns everything but the last entry of the array. Especially useful on + the arguments object. Pass n to exclude the last n elements + from the result.

-_.rest([5, 4, 3, 2, 1]);
-=> [4, 3, 2, 1]
+_.initial([5, 4, 3, 2, 1]);
+=> [5, 4, 3, 2]
 

- last_.last(array) + last_.last(array, [n])
- Returns the last element of an array. + Returns the last element of an array. Passing n will return + the last n elements of the array.

 _.last([5, 4, 3, 2, 1]);
 => 1
+
+ +

+ rest_.rest(array, [index]) + Alias: tail +
+ Returns the rest of the elements in an array. Pass an index + to return the values of the array from that index onward. +

+
+_.rest([5, 4, 3, 2, 1]);
+=> [4, 3, 2, 1]
 

@@ -592,12 +625,14 @@

Array Functions

- uniq_.uniq(array, [isSorted]) + uniq_.uniq(array, [isSorted], [iterator]) Alias: unique
Produces a duplicate-free version of the array, using === to test object equality. If you know in advance that the array is sorted, passing true for isSorted will run a much faster algorithm. + If you want to compute unique items based on a transformation, pass an + iterator function.

 _.uniq([1, 2, 1, 3, 1, 4]);
@@ -1149,7 +1184,8 @@ 

Utility Functions

for rendering. Useful for rendering complicated bits of HTML from JSON data sources. Template functions can both interpolate variables, using
<%= … %>, as well as execute arbitrary JavaScript code, with - <% … %>. When you evaluate a template function, pass in a + <% … %>. If you wish to interpolate a value, and have + it be HTML-escaped, use <%- … %> When you evaluate a template function, pass in a context object that has properties corresponding to the template's free variables. If you're writing a one-off, you can pass the context object as the second parameter to template in order to render @@ -1162,7 +1198,11 @@

Utility Functions

var list = "<% _.each(people, function(name) { %> <li><%= name %></li> <% }); %>"; _.template(list, {people : ['moe', 'curly', 'larry']}); -=> "<li>moe</li><li>curly</li><li>larry</li>"
+=> "<li>moe</li><li>curly</li><li>larry</li>" + +var template = _.template("<b><%- value %></b>"); +template({value : '<script>'}); +=> "<b>&lt;script&gt;</b>"

You can also use print from within JavaScript code. This is @@ -1235,6 +1275,13 @@

Duck Typing

another type, if you're setting properties with names like "concat" and "charCodeAt". So be aware.

+ +

+ In a similar fashion, _.each and all of the other functions + based on it are designed to be able to iterate over any Array-like + JavaScript object, including arguments, NodeLists, and more. + Passing hash-like objects with a numeric length key won't work. +

Links & Suggested Reading

@@ -1247,6 +1294,21 @@

Links & Suggested Reading

available on GitHub.

+

+ Underscore.php, + a PHP port of the functions that are applicable in both languages. + Includes OOP-wrapping and chaining. + The source is + available on GitHub. +

+ +

+ Underscore-perl, + a Perl port of many of the Underscore.js functions, + aimed at on Perl hashes and arrays, also + available on GitHub. +

+

Underscore.string, an Underscore extension that adds functions for string-manipulation: @@ -1280,10 +1342,38 @@

Links & Suggested Reading

Change Log

+

+ 1.2.0Oct. 5, 2011
+

    +
  • + Underscore templates now support HTML escaping interpolations, using + <%- ... %> syntax. The _.isEqual function now + supports true deep equality comparisons, with checks for cyclic structures, + thanks to Kit Cambridge. +
  • +
  • + Ryan Tenney contributed _.shuffle, which uses a modified + Fisher-Yates to give you a shuffled copy of an array. +
  • +
  • + _.uniq can now be passed an optional iterator, to determine by + what criteria an object should be considered unique. +
  • +
  • + _.last now takes an optional argument which will return the last + N elements of the list. +
  • +
  • + A new _.initial function was added, as a mirror of _.rest, + which returns all the initial values of a list (except the last N). +
  • +
+

+

1.1.7July 13, 2011
Added _.groupBy, which aggregates a collection into groups of like items. - Added _.untion and _.difference, to complement the + Added _.union and _.difference, to complement the (re-named) _.intersection. Various improvements for support of sparse arrays. _.toArray now returns a clone, if directly passed an array. diff --git a/package.json b/package.json index 08396c4d9..eb4eee826 100644 --- a/package.json +++ b/package.json @@ -8,5 +8,5 @@ "dependencies" : [], "repository" : {"type": "git", "url": "git://github.com/documentcloud/underscore.git"}, "main" : "underscore.js", - "version" : "1.1.7" + "version" : "1.2.0" } diff --git a/test/arrays.js b/test/arrays.js index 32dd73a55..80da71f6f 100644 --- a/test/arrays.js +++ b/test/arrays.js @@ -1,6 +1,6 @@ $(document).ready(function() { - module("Array-only functions (last, compact, uniq, and so on...)"); + module("Arrays"); test("arrays: first", function() { equals(_.first([1,2,3]), 1, 'can pull out the first element of an array'); @@ -24,10 +24,23 @@ $(document).ready(function() { equals(_.flatten(result).join(','), '2,3,2,3', 'works well with _.map'); }); + test("arrays: initial", function() { + equals(_.initial([1,2,3,4,5]).join(", "), "1, 2, 3, 4", 'working initial()'); + equals(_.initial([1,2,3,4],2).join(", "), "1, 2", 'initial can take an index'); + var result = (function(){ return _(arguments).initial(); })(1, 2, 3, 4); + equals(result.join(", "), "1, 2, 3", 'initial works on arguments object'); + result = _.map([[1,2,3],[1,2,3]], _.initial); + equals(_.flatten(result).join(','), '1,2,1,2', 'initial works with _.map'); + }); + test("arrays: last", function() { equals(_.last([1,2,3]), 3, 'can pull out the last element of an array'); + equals(_.last([1,2,3], 0).join(', '), "", 'can pass an index to last'); + equals(_.last([1,2,3], 2).join(', '), '2, 3', 'can pass an index to last'); var result = (function(){ return _(arguments).last(); })(1, 2, 3, 4); equals(result, 4, 'works on an arguments object'); + result = _.map([[1,2,3],[1,2,3]], _.last); + equals(result.join(','), '3,3', 'works well with _.map'); }); test("arrays: compact", function() { @@ -61,6 +74,14 @@ $(document).ready(function() { var list = [1, 1, 1, 2, 2, 3]; equals(_.uniq(list, true).join(', '), '1, 2, 3', 'can find the unique values of a sorted array faster'); + var list = [{name:'moe'}, {name:'curly'}, {name:'larry'}, {name:'curly'}]; + var iterator = function(value) { return value.name; }; + equals(_.map(_.uniq(list, false, iterator), iterator).join(', '), 'moe, curly, larry', 'can find the unique values of an array using a custom iterator'); + + var iterator = function(value) { return value +1; }; + var list = [1, 2, 2, 3, 4, 4]; + equals(_.uniq(list, true, iterator).join(', '), '1, 2, 3, 4', 'iterator works with sorted array'); + var result = (function(){ return _.uniq(arguments); })(1, 2, 1, 3, 1, 4); equals(result.join(', '), '1, 2, 3, 4', 'works on an arguments object'); }); diff --git a/test/chaining.js b/test/chaining.js index e633ba5ad..64b0500ef 100644 --- a/test/chaining.js +++ b/test/chaining.js @@ -1,6 +1,6 @@ $(document).ready(function() { - module("Underscore chaining."); + module("Chaining"); test("chaining: map/flatten/reduce", function() { var lyrics = [ diff --git a/test/collections.js b/test/collections.js index 005ee169e..cf1c815d6 100644 --- a/test/collections.js +++ b/test/collections.js @@ -1,6 +1,6 @@ $(document).ready(function() { - module("Collection functions (each, any, select, and so on...)"); + module("Collections"); test("collections: each", function() { _.each([1, 2, 3], function(num, i) { @@ -177,6 +177,9 @@ $(document).ready(function() { var neg = _.max([1, 2, 3], function(num){ return -num; }); equals(neg, 1, 'can perform a computation-based max'); + + equals(-Infinity, _.max({}), 'Maximum value of an empty object'); + equals(-Infinity, _.max([]), 'Maximum value of an empty array'); }); test('collections: min', function() { @@ -184,6 +187,9 @@ $(document).ready(function() { var neg = _.min([1, 2, 3], function(num){ return -num; }); equals(neg, 3, 'can perform a computation-based min'); + + equals(Infinity, _.min({}), 'Minimum value of an empty object'); + equals(Infinity, _.min([]), 'Minimum value of an empty array'); }); test('collections: sortBy', function() { @@ -204,6 +210,13 @@ $(document).ready(function() { equals(index, 3, '35 should be inserted at index 3'); }); + test('collections: shuffle', function() { + var numbers = _.range(10); + var shuffled = _.shuffle(numbers).sort(); + notStrictEqual(numbers, shuffled, 'original object is unmodified'); + equals(shuffled.join(','), numbers.join(','), 'contains the same members before and after shuffle'); + }); + test('collections: toArray', function() { ok(!_.isArray(arguments), 'arguments object is not an array'); ok(_.isArray(_.toArray(arguments)), 'arguments object converted into array'); diff --git a/test/functions.js b/test/functions.js index 2a1bd51bd..af35e5eff 100644 --- a/test/functions.js +++ b/test/functions.js @@ -1,6 +1,6 @@ $(document).ready(function() { - module("Function functions (bind, bindAll, and so on...)"); + module("Functions"); test("functions: bind", function() { var context = {name : 'moe'}; diff --git a/test/objects.js b/test/objects.js index 78add1fed..e05c0ddc5 100644 --- a/test/objects.js +++ b/test/objects.js @@ -1,6 +1,6 @@ $(document).ready(function() { - module("Object functions (values, extend, isEqual, and so on...)"); + module("Objects"); test("objects: keys", function() { var exception = /object/; @@ -69,23 +69,232 @@ $(document).ready(function() { }); test("objects: isEqual", function() { - var moe = {name : 'moe', lucky : [13, 27, 34]}; - var clone = {name : 'moe', lucky : [13, 27, 34]}; - ok(moe != clone, 'basic equality between objects is false'); - ok(_.isEqual(moe, clone), 'deep equality is true'); - ok(_(moe).isEqual(clone), 'OO-style deep equality works'); - ok(!_.isEqual(5, NaN), '5 is not equal to NaN'); - ok(NaN != NaN, 'NaN is not equal to NaN (native equality)'); - ok(NaN !== NaN, 'NaN is not equal to NaN (native identity)'); - ok(!_.isEqual(NaN, NaN), 'NaN is not equal to NaN'); - ok(_.isEqual(new Date(100), new Date(100)), 'identical dates are equal'); - ok(_.isEqual((/hello/ig), (/hello/ig)), 'identical regexes are equal'); - ok(!_.isEqual(null, [1]), 'a falsy is never equal to a truthy'); - ok(_.isEqual({isEqual: function () { return true; }}, {}), 'first object implements `isEqual`'); - ok(_.isEqual({}, {isEqual: function () { return true; }}), 'second object implements `isEqual`'); - ok(!_.isEqual({x: 1, y: undefined}, {x: 1, z: 2}), 'objects with the same number of undefined keys are not equal'); - ok(!_.isEqual(_({x: 1, y: undefined}).chain(), _({x: 1, z: 2}).chain()), 'wrapped objects are not equal'); - equals(_({x: 1, y: 2}).chain().isEqual(_({x: 1, y: 2}).chain()).value(), true, 'wrapped objects are equal'); + function First() { + this.value = 1; + } + First.prototype.value = 1; + function Second() { + this.value = 1; + } + Second.prototype.value = 2; + + // Basic equality and identity comparisons. + ok(_.isEqual(null, null), "`null` is equal to `null`"); + ok(_.isEqual(), "`undefined` is equal to `undefined`"); + + ok(!_.isEqual(0, -0), "`0` is not equal to `-0`"); + ok(!_.isEqual(-0, 0), "Commutative equality is implemented for `0` and `-0`"); + ok(!_.isEqual(null, undefined), "`null` is not equal to `undefined`"); + ok(!_.isEqual(undefined, null), "Commutative equality is implemented for `null` and `undefined`"); + + // String object and primitive comparisons. + ok(_.isEqual("Curly", "Curly"), "Identical string primitives are equal"); + ok(_.isEqual(new String("Curly"), new String("Curly")), "String objects with identical primitive values are equal"); + + ok(!_.isEqual("Curly", "Larry"), "String primitives with different values are not equal"); + ok(!_.isEqual(new String("Curly"), "Curly"), "String primitives and their corresponding object wrappers are not equal"); + ok(!_.isEqual("Curly", new String("Curly")), "Commutative equality is implemented for string objects and primitives"); + ok(!_.isEqual(new String("Curly"), new String("Larry")), "String objects with different primitive values are not equal"); + ok(!_.isEqual(new String("Curly"), {toString: function(){ return "Curly"; }}), "String objects and objects with a custom `toString` method are not equal"); + + // Number object and primitive comparisons. + ok(_.isEqual(75, 75), "Identical number primitives are equal"); + ok(_.isEqual(new Number(75), new Number(75)), "Number objects with identical primitive values are equal"); + + ok(!_.isEqual(75, new Number(75)), "Number primitives and their corresponding object wrappers are not equal"); + ok(!_.isEqual(new Number(75), 75), "Commutative equality is implemented for number objects and primitives"); + ok(!_.isEqual(new Number(75), new Number(63)), "Number objects with different primitive values are not equal"); + ok(!_.isEqual(new Number(63), {valueOf: function(){ return 63; }}), "Number objects and objects with a `valueOf` method are not equal"); + + // Comparisons involving `NaN`. + ok(_.isEqual(NaN, NaN), "`NaN` is equal to `NaN`"); + ok(!_.isEqual(61, NaN), "A number primitive is not equal to `NaN`"); + ok(!_.isEqual(new Number(79), NaN), "A number object is not equal to `NaN`"); + ok(!_.isEqual(Infinity, NaN), "`Infinity` is not equal to `NaN`"); + + // Boolean object and primitive comparisons. + ok(_.isEqual(true, true), "Identical boolean primitives are equal"); + ok(_.isEqual(new Boolean, new Boolean), "Boolean objects with identical primitive values are equal"); + ok(!_.isEqual(true, new Boolean(true)), "Boolean primitives and their corresponding object wrappers are not equal"); + ok(!_.isEqual(new Boolean(true), true), "Commutative equality is implemented for booleans"); + ok(!_.isEqual(new Boolean(true), new Boolean), "Boolean objects with different primitive values are not equal"); + + // Common type coercions. + ok(!_.isEqual(true, new Boolean(false)), "Boolean objects are not equal to the boolean primitive `true`"); + ok(!_.isEqual("75", 75), "String and number primitives with like values are not equal"); + ok(!_.isEqual(new Number(63), new String(63)), "String and number objects with like values are not equal"); + ok(!_.isEqual(75, "75"), "Commutative equality is implemented for like string and number values"); + ok(!_.isEqual(0, ""), "Number and string primitives with like values are not equal"); + ok(!_.isEqual(1, true), "Number and boolean primitives with like values are not equal"); + ok(!_.isEqual(new Boolean(false), new Number(0)), "Boolean and number objects with like values are not equal"); + ok(!_.isEqual(false, new String("")), "Boolean primitives and string objects with like values are not equal"); + ok(!_.isEqual(12564504e5, new Date(2009, 9, 25)), "Dates and their corresponding numeric primitive values are not equal"); + + // Dates. + ok(_.isEqual(new Date(2009, 9, 25), new Date(2009, 9, 25)), "Date objects referencing identical times are equal"); + ok(!_.isEqual(new Date(2009, 9, 25), new Date(2009, 11, 13)), "Date objects referencing different times are not equal"); + ok(!_.isEqual(new Date(2009, 11, 13), { + getTime: function(){ + return 12606876e5; + } + }), "Date objects and objects with a `getTime` method are not equal"); + ok(!_.isEqual(new Date("Curly"), new Date("Curly")), "Invalid dates are not equal"); + + // Functions. + ok(!_.isEqual(First, Second), "Different functions with identical bodies and source code representations are not equal"); + + // RegExps. + ok(_.isEqual(/(?:)/gim, /(?:)/gim), "RegExps with equivalent patterns and flags are equal"); + ok(!_.isEqual(/(?:)/g, /(?:)/gi), "RegExps with equivalent patterns and different flags are not equal"); + ok(!_.isEqual(/Moe/gim, /Curly/gim), "RegExps with different patterns and equivalent flags are not equal"); + ok(!_.isEqual(/(?:)/gi, /(?:)/g), "Commutative equality is implemented for RegExps"); + ok(!_.isEqual(/Curly/g, {source: "Larry", global: true, ignoreCase: false, multiline: false}), "RegExps and RegExp-like objects are not equal"); + + // Empty arrays, array-like objects, and object literals. + ok(_.isEqual({}, {}), "Empty object literals are equal"); + ok(_.isEqual([], []), "Empty array literals are equal"); + ok(_.isEqual([{}], [{}]), "Empty nested arrays and objects are equal"); + ok(_.isEqual({length: 0}, []), "Array-like objects and arrays are equal"); + ok(_.isEqual([], {length: 0}), "Commutative equality is implemented for array-like objects"); + + ok(!_.isEqual({}, []), "Object literals and array literals are not equal"); + ok(!_.isEqual([], {}), "Commutative equality is implemented for objects and arrays"); + + // Arrays with primitive and object values. + ok(_.isEqual([1, "Larry", true], [1, "Larry", true]), "Arrays containing identical primitives are equal"); + ok(_.isEqual([/Moe/g, new Date(2009, 9, 25)], [/Moe/g, new Date(2009, 9, 25)]), "Arrays containing equivalent elements are equal"); + + // Multi-dimensional arrays. + var a = [new Number(47), false, "Larry", /Moe/, new Date(2009, 11, 13), ['running', 'biking', new String('programming')], {a: 47}]; + var b = [new Number(47), false, "Larry", /Moe/, new Date(2009, 11, 13), ['running', 'biking', new String('programming')], {a: 47}]; + ok(_.isEqual(a, b), "Arrays containing nested arrays and objects are recursively compared"); + + // Overwrite the methods defined in ES 5.1 section 15.4.4. + a.forEach = a.map = a.filter = a.every = a.indexOf = a.lastIndexOf = a.some = a.reduce = a.reduceRight = null; + b.join = b.pop = b.reverse = b.shift = b.slice = b.splice = b.concat = b.sort = b.unshift = null; + + // Array elements and properties. + ok(_.isEqual(a, b), "Arrays containing equivalent elements and different non-numeric properties are equal"); + a.push("White Rocks"); + ok(!_.isEqual(a, b), "Arrays of different lengths are not equal"); + a.push("East Boulder"); + b.push("Gunbarrel Ranch", "Teller Farm"); + ok(!_.isEqual(a, b), "Arrays of identical lengths containing different elements are not equal"); + + // Sparse arrays. + ok(_.isEqual(Array(3), Array(3)), "Sparse arrays of identical lengths are equal"); + ok(!_.isEqual(Array(3), Array(6)), "Sparse arrays of different lengths are not equal"); + + // According to the Microsoft deviations spec, section 2.1.26, JScript 5.x treats `undefined` + // elements in arrays as elisions. Thus, sparse arrays and dense arrays containing `undefined` + // values are equivalent. + if (0 in [undefined]) { + ok(!_.isEqual(Array(3), [undefined, undefined, undefined]), "Sparse and dense arrays are not equal"); + ok(!_.isEqual([undefined, undefined, undefined], Array(3)), "Commutative equality is implemented for sparse and dense arrays"); + } + + // Simple objects. + ok(_.isEqual({a: "Curly", b: 1, c: true}, {a: "Curly", b: 1, c: true}), "Objects containing identical primitives are equal"); + ok(_.isEqual({a: /Curly/g, b: new Date(2009, 11, 13)}, {a: /Curly/g, b: new Date(2009, 11, 13)}), "Objects containing equivalent members are equal"); + ok(!_.isEqual({a: 63, b: 75}, {a: 61, b: 55}), "Objects of identical sizes with different values are not equal"); + ok(!_.isEqual({a: 63, b: 75}, {a: 61, c: 55}), "Objects of identical sizes with different property names are not equal"); + ok(!_.isEqual({a: 1, b: 2}, {a: 1}), "Objects of different sizes are not equal"); + ok(!_.isEqual({a: 1}, {a: 1, b: 2}), "Commutative equality is implemented for objects"); + ok(!_.isEqual({x: 1, y: undefined}, {x: 1, z: 2}), "Objects with identical keys and different values are not equivalent"); + + // `A` contains nested objects and arrays. + a = { + name: new String("Moe Howard"), + age: new Number(77), + stooge: true, + hobbies: ["acting"], + film: { + name: "Sing a Song of Six Pants", + release: new Date(1947, 9, 30), + stars: [new String("Larry Fine"), "Shemp Howard"], + minutes: new Number(16), + seconds: 54 + } + }; + + // `B` contains equivalent nested objects and arrays. + b = { + name: new String("Moe Howard"), + age: new Number(77), + stooge: true, + hobbies: ["acting"], + film: { + name: "Sing a Song of Six Pants", + release: new Date(1947, 9, 30), + stars: [new String("Larry Fine"), "Shemp Howard"], + minutes: new Number(16), + seconds: 54 + } + }; + ok(_.isEqual(a, b), "Objects with nested equivalent members are recursively compared"); + + // Instances. + ok(_.isEqual(new First, new First), "Object instances are equal"); + ok(_.isEqual(new First, new Second), "Objects with different constructors and identical own properties are equal"); + ok(_.isEqual({value: 1}, new First), "Object instances and objects sharing equivalent properties are identical"); + ok(!_.isEqual({value: 2}, new Second), "The prototype chain of objects should not be examined"); + + // Circular Arrays. + (a = []).push(a); + (b = []).push(b); + ok(_.isEqual(a, b), "Arrays containing circular references are equal"); + a.push(new String("Larry")); + b.push(new String("Larry")); + ok(_.isEqual(a, b), "Arrays containing circular references and equivalent properties are equal"); + a.push("Shemp"); + b.push("Curly"); + ok(!_.isEqual(a, b), "Arrays containing circular references and different properties are not equal"); + + // Circular Objects. + a = {abc: null}; + b = {abc: null}; + a.abc = a; + b.abc = b; + ok(_.isEqual(a, b), "Objects containing circular references are equal"); + a.def = 75; + b.def = 75; + ok(_.isEqual(a, b), "Objects containing circular references and equivalent properties are equal"); + a.def = new Number(75); + b.def = new Number(63); + ok(!_.isEqual(a, b), "Objects containing circular references and different properties are not equal"); + + // Cyclic Structures. + a = [{abc: null}]; + b = [{abc: null}]; + (a[0].abc = a).push(a); + (b[0].abc = b).push(b); + ok(_.isEqual(a, b), "Cyclic structures are equal"); + a[0].def = "Larry"; + b[0].def = "Larry"; + ok(_.isEqual(a, b), "Cyclic structures containing equivalent properties are equal"); + a[0].def = new String("Larry"); + b[0].def = new String("Curly"); + ok(!_.isEqual(a, b), "Cyclic structures containing different properties are not equal"); + + // Complex Circular References. + a = {foo: {b: {foo: {c: {foo: null}}}}}; + b = {foo: {b: {foo: {c: {foo: null}}}}}; + a.foo.b.foo.c.foo = a; + b.foo.b.foo.c.foo = b; + ok(_.isEqual(a, b), "Cyclic structures with nested and identically-named properties are equal"); + + // Chaining. + ok(!_.isEqual(_({x: 1, y: undefined}).chain(), _({x: 1, z: 2}).chain()), 'Chained objects containing different values are not equal'); + equals(_({x: 1, y: 2}).chain().isEqual(_({x: 1, y: 2}).chain()).value(), true, '`isEqual` can be chained'); + + // Custom `isEqual` methods. + var isEqualObj = {isEqual: function (o) { return o.isEqual == this.isEqual; }, unique: {}}; + var isEqualObjClone = {isEqual: isEqualObj.isEqual, unique: {}}; + + ok(_.isEqual(isEqualObj, isEqualObjClone), 'Both objects implement identical `isEqual` methods'); + ok(_.isEqual(isEqualObjClone, isEqualObj), 'Commutative equality is implemented for objects with custom `isEqual` methods'); + ok(!_.isEqual(isEqualObj, {}), 'Objects that do not implement equivalent `isEqual` methods are not equal'); + ok(!_.isEqual({}, isEqualObj), 'Commutative equality is implemented for objects with different `isEqual` methods'); }); test("objects: isEmpty", function() { @@ -113,14 +322,14 @@ $(document).ready(function() { parent.iElement = document.createElement('div');\ parent.iArguments = (function(){ return arguments; })(1, 2, 3);\ parent.iArray = [1, 2, 3];\ - parent.iString = 'hello';\ - parent.iNumber = 100;\ + parent.iString = new String('hello');\ + parent.iNumber = new Number(100);\ parent.iFunction = (function(){});\ parent.iDate = new Date();\ parent.iRegExp = /hi/;\ parent.iNaN = NaN;\ parent.iNull = null;\ - parent.iBoolean = false;\ + parent.iBoolean = new Boolean(false);\ parent.iUndefined = undefined;\ " ); diff --git a/test/utility.js b/test/utility.js index 94252a654..976b3b996 100644 --- a/test/utility.js +++ b/test/utility.js @@ -1,6 +1,6 @@ $(document).ready(function() { - module("Utility functions (uniqueId, template)"); + module("Utility"); test("utility: noConflict", function() { var underscore = _.noConflict(); @@ -81,6 +81,10 @@ $(document).ready(function() { var withNewlinesAndTabs = _.template('This\n\t\tis: <%= x %>.\n\tok.\nend.'); equals(withNewlinesAndTabs({x: 'that'}), 'This\n\t\tis: that.\n\tok.\nend.'); + var template = _.template("<%- value %>"); + var result = template({value: "