// ========================================================================== // Project: SproutCore Costello - Property Observing Library // Copyright: ©2006-2011 Strobe Inc. and contributors. // Portions ©2008-2010 Apple Inc. All rights reserved. // License: Licensed under MIT license (see license.js) // ========================================================================== /*global NodeList */ // These commands are used by the build tools to control load order. On the // client side these are a no-op. if (!window.require) { window.require = function require(){}; } if (!window.sc_require) { window.sc_require = require }; if (!window.sc_resource) {window.sc_resource = function sc_resource(){}; } sc_require('license') ; // ........................................ // GLOBAL CONSTANTS // // Most global constants should be defined inside of the SC namespace. // However the following two are useful enough and generally benign enough // to put into the global object. window.YES = true ; window.NO = false ; // prevent a console.log from blowing things up if we are on a browser that // does not support it if (typeof console === 'undefined') { window.console = {} ; console.log = console.info = console.warn = console.error = function(){}; } // ........................................ // BOOTSTRAP // // The root namespace and some common utility methods are defined here. The // rest of the methods go into the mixin defined below. /** @version 1.5.0.pre.4 @namespace The SproutCore namespace. All SproutCore methods and functions are defined inside of this namespace. You generally should not add new properties to this namespace as it may be overwritten by future versions of SproutCore. You can also use the shorthand "SC" instead of "SproutCore". SproutCore-Base is a framework that provides core functions for SproutCore including cross-platform functions, support for property observing and objects. It's focus is on small size and performance. You can use this in place of or along-side other cross-platform libraries such as jQuery or Prototype. The core Base framework is based on the jQuery API with a number of performance optimizations. */ window.SC = window.SC || {} ; window.SproutCore = window.SproutCore || SC ; SC.VERSION = '1.5.0.pre.4'; /** @private Adds properties to a target object. You must specify whether to overwrite a value for a property or not. Used as a base function for the wrapper functions SC.mixin and SC.supplement. @param overwrite {Boolean} if a target has a value for a property, this specifies whether or not to overwrite that value with the copyied object's property value. @param target {Object} the target object to extend @param properties {Object} one or more objects with properties to copy. @returns {Object} the target object. @static */ SC._baseMixin = function (override) { var args = Array.prototype.slice.call(arguments, 1), src, // copy reference to target object target = args[0] || {}, idx = 1, length = args.length , options, copy , key; // Handle case where we have only one item...extend SC if (length === 1) { target = this || {}; idx=0; } for ( ; idx < length; idx++ ) { if (!(options = args[idx])) continue ; for(key in options) { if (!options.hasOwnProperty(key)) continue ; copy = options[key] ; if (target===copy) continue ; // prevent never-ending loop if (copy !== undefined && ( override || (target[key] === undefined) )) target[key] = copy ; } } return target; } ; /** Adds properties to a target object. Takes the root object and adds the attributes for any additional arguments passed. @param target {Object} the target object to extend @param properties {Object} one or more objects with properties to copy. @returns {Object} the target object. @static */ SC.mixin = function() { var args = Array.prototype.slice.call(arguments); args.unshift(true); return SC._baseMixin.apply(this, args); } ; /** Adds properties to a target object. Unlike SC.mixin, however, if the target already has a value for a property, it will not be overwritten. Takes the root object and adds the attributes for any additional arguments passed. @param target {Object} the target object to extend @param properties {Object} one or more objects with properties to copy. @returns {Object} the target object. @static */ SC.supplement = function() { var args = Array.prototype.slice.call(arguments); args.unshift(false); return SC._baseMixin.apply(this, args); } ; /** Alternative to mixin. Provided for compatibility with jQuery. @function */ SC.extend = SC.mixin ; // .......................................................... // CORE FUNCTIONS // // Enough with the bootstrap code. Let's define some core functions SC.mixin(/** @scope SC */ { // ........................................ // GLOBAL CONSTANTS // T_ERROR: 'error', T_OBJECT: 'object', T_NULL: 'null', T_CLASS: 'class', T_HASH: 'hash', T_FUNCTION: 'function', T_UNDEFINED: 'undefined', T_NUMBER: 'number', T_BOOL: 'boolean', T_ARRAY: 'array', T_STRING: 'string', // ........................................ // TYPING & ARRAY MESSAGING // /** Returns a consistant type for the passed item. Use this instead of the built-in typeOf() to get the type of an item. It will return the same result across all browsers and includes a bit more detail. Here is what will be returned: | Return Value Constant | Meaning | | SC.T_STRING | String primitive | | SC.T_NUMBER | Number primitive | | SC.T_BOOLEAN | Boolean primitive | | SC.T_NULL | Null value | | SC.T_UNDEFINED | Undefined value | | SC.T_FUNCTION | A function | | SC.T_ARRAY | An instance of Array | | SC.T_CLASS | A SproutCore class (created using SC.Object.extend()) | | SC.T_OBJECT | A SproutCore object instance | | SC.T_HASH | A JavaScript object not inheriting from SC.Object | @param item {Object} the item to check @returns {String} the type */ typeOf: function(item) { if (item === undefined) return SC.T_UNDEFINED ; if (item === null) return SC.T_NULL ; var nativeType = jQuery.type(item); if (nativeType === "function") { return item.isClass ? SC.T_CLASS : SC.T_FUNCTION; } else if (nativeType === "object") { if (item.isError) { return SC.T_ERROR ; } else if (item.isObject) { return SC.T_OBJECT ; } else { return SC.T_HASH ; } } return nativeType ; }, /** Returns YES if the passed value is null or undefined. This avoids errors from JSLint complaining about use of ==, which can be technically confusing. @param {Object} obj value to test @returns {Boolean} */ none: function(obj) { return obj == null; }, /** Verifies that a value is either null or an empty string. Return false if the object is not a string. @param {Object} obj value to test @returns {Boolean} */ empty: function(obj) { return obj === null || obj === undefined || obj === ''; }, /** Returns YES if the passed object is an array or Array-like. SproutCore Array Protocol: * the object has an objectAt property; or * the object is a native Array; or * the object is an Object, and has a length property Unlike SC.typeOf this method returns true even if the passed object is not formally array but appears to be array-like (i.e. has a length property, responds to .objectAt, etc.) @param obj {Object} the object to test @returns {Boolean} */ isArray: function(obj) { if ( !obj || obj.setInterval ) { return false; } else if ( obj.objectAt ) { return true ; } else if ( obj.length !== undefined && jQuery.type(obj) === "object" ) { return true; } return false; }, /** Makes an object into an Array if it is not array or array-like already. Unlike SC.A(), this method will not clone the object if it is already an array. @param {Object} obj object to convert @returns {Array} Actual array */ makeArray: function(obj) { return SC.isArray(obj) ? obj : SC.A(obj); }, /** Converts the passed object to an Array. If the object appears to be array-like, a new array will be cloned from it. Otherwise, a new array will be created with the item itself as the only item in the array. @param object {Object} any enumerable or array-like object. @returns {Array} Array of items */ A: function(obj) { // null or undefined -- fast path if ( obj === null || obj === undefined ) return [] ; // primitive -- fast path if ( obj.slice instanceof Function ) { // do we have a string? if ( typeof(obj) === 'string' ) return [obj] ; else return obj.slice() ; } // enumerable -- fast path if (obj.toArray) return obj.toArray() ; // if not array-like, then just wrap in array. if (!SC.isArray(obj)) return [obj]; // when all else fails, do a manual convert... var ret = [], len = obj.length; while(--len >= 0) ret[len] = obj[len]; return ret ; }, // // GUIDS & HASHES // guidKey: jQuery.expando || ("SproutCore" + ( SC.VERSION + Math.random() ).replace( /\D/g, "" )), // Used for guid generation... _guidPrefixes: {"number": "nu", "string": "st"}, _guidCaches: {"number": {}, "string": {}}, _numberGuids: [], _stringGuids: {}, _keyCache: {}, /**" Returns a unique GUID for the object. If the object does not yet have a guid, one will be assigned to it. You can call this on any object, SC.Object-based or not, but be aware that it will add a _guid property. You can also use this method on DOM Element objects. @param obj {Object} any object, string, number, Element, or primitive @returns {String} the unique guid for this instance. */ guidFor: function(obj) { var cache, ret, type = typeof obj; // special cases where we don't want to add a key to object if (obj === undefined) return "(undefined)"; if (obj === null) return "(null)"; // Don't allow prototype changes to String etc. to change the guidFor if (type === SC.T_NUMBER || type === SC.T_STRING) { cache = this._guidCaches[type]; ret = cache[obj]; if(!ret) { ret = "st" + (jQuery.uuid++); cache[obj] = ret; } return ret; } else if (type === SC.T_BOOL) { return (obj) ? "(true)" : "(false)"; } var guidKey = this.guidKey; if (obj[guidKey]) return obj[guidKey]; // More special cases; not as common, so we check for them after the cache // lookup if (obj === Object) return '(Object)'; if (obj === Array) return '(Array)'; return SC.generateGuid(obj, "sc"); }, /** Returns a key name that combines the named key + prefix. This is more efficient than simply combining strings because it uses a cache internally for performance. @param {String} prefix the prefix to attach to the key @param {String} key key @returns {String} result */ keyFor: function(prefix, key) { var ret, pcache = this._keyCache[prefix]; if (!pcache) pcache = this._keyCache[prefix] = {}; // get cache for prefix ret = pcache[key]; if (!ret) ret = pcache[key] = prefix + '_' + key ; return ret ; }, /** Generates a new guid, optionally saving the guid to the object that you pass in. You will rarely need to use this method. Instead you should call SC.guidFor(obj), which return an existing guid if available. @param {Object} obj the object to assign the guid to @returns {String} the guid */ generateGuid: function(obj, prefix) { var ret = (prefix + (jQuery.uuid++)); if (obj) obj[this.guidKey] = ret ; return ret ; }, /** Returns a unique hash code for the object. If the object implements a hash() method, the value of that method will be returned. Otherwise, this will return the same value as guidFor(). If you pass multiple arguments, hashFor returns a string obtained by concatenating the hash code of each argument. Unlike guidFor(), this method allows you to implement logic in your code to cause two separate instances of the same object to be treated as if they were equal for comparisons and other functions. IMPORTANT: If you implement a hash() method, it MUST NOT return a number or a string that contains only a number. Typically hash codes are strings that begin with a "%". @param obj {Object} the object(s) @returns {String} the hash code for this instance. */ hashFor: function() { var l = arguments.length, h = '', obj, f, i; for (i=0 ; i w. */ compare: function (v, w) { // Doing a '===' check is very cheap, so in the case of equality, checking // this up-front is a big win. if (v === w) return 0; var type1 = SC.typeOf(v); var type2 = SC.typeOf(w); // If we haven't yet generated a reverse-mapping of SC.ORDER_DEFINITION, // do so now. var mapping = SC.ORDER_DEFINITION_MAPPING; if (!mapping) { var order = SC.ORDER_DEFINITION; mapping = SC.ORDER_DEFINITION_MAPPING = {}; var idx, len; for (idx = 0, len = order.length; idx < len; ++idx) { mapping[order[idx]] = idx; } // We no longer need SC.ORDER_DEFINITION. delete SC.ORDER_DEFINITION; } var type1Index = mapping[type1]; var type2Index = mapping[type2]; if (type1Index < type2Index) return -1; if (type1Index > type2Index) return 1; // ok - types are equal - so we have to check values now switch (type1) { case SC.T_BOOL: case SC.T_NUMBER: if (vw) return 1; return 0; case SC.T_STRING: var comp = v.localeCompare(w); if (comp<0) return -1; if (comp>0) return 1; return 0; case SC.T_ARRAY: var vLen = v.length; var wLen = w.length; var l = Math.min(vLen, wLen); var r = 0; var i = 0; var thisFunc = arguments.callee; while (r===0 && i < l) { r = thisFunc(v[i],w[i]); i++; } if (r !== 0) return r; // all elements are equal now // shorter array should be ordered first if (vLen < wLen) return -1; if (vLen > wLen) return 1; // arrays are equal now return 0; case SC.T_OBJECT: if (v.constructor.isComparable === YES) return v.constructor.compare(v, w); return 0; default: return 0; } }, // .......................................................... // OBJECT MANAGEMENT // /** Empty function. Useful for some operations. @returns {Object} */ K: function() { return this; }, /** Empty array. Useful for some optimizations. @property {Array} */ EMPTY_ARRAY: [], /** Empty hash. Useful for some optimizations. @property {Hash} */ EMPTY_HASH: {}, /** Empty range. Useful for some optimizations. @property {Range} */ EMPTY_RANGE: {start: 0, length: 0}, /** Creates a new object with the passed object as its prototype. This method uses JavaScript's native inheritence method to create a new object. You cannot use beget() to create new SC.Object-based objects, but you can use it to beget Arrays, Hashes, Sets and objects you build yourself. Note that when you beget() a new object, this method will also call the didBeget() method on the object you passed in if it is defined. You can use this method to perform any other setup needed. In general, you will not use beget() often as SC.Object is much more useful, but for certain rare algorithms, this method can be very useful. For more information on using beget(), see the section on beget() in Crockford's JavaScript: The Good Parts. @param obj {Object} the object to beget @returns {Object} the new object. */ beget: function(obj) { if (obj === null || obj === undefined) return null ; var K = SC.K; K.prototype = obj ; var ret = new K(); K.prototype = null ; // avoid leaks if (typeof obj.didBeget === "function") ret = obj.didBeget(ret); return ret ; }, /** Creates a clone of the passed object. This function can take just about any type of object and create a clone of it, including primitive values (which are not actually cloned because they are immutable). If the passed object implements the clone() method, then this function will simply call that method and return the result. @param object {Object} the object to clone @param deep {Boolean} if true, a deep copy of the object is made @returns {Object} the cloned object */ copy: function(object, deep) { var ret = object, idx ; // fast paths if ( object ) { if ( object.isCopyable ) return object.copy( deep ); if ( object.clone ) return object.clone(); } switch ( jQuery.type(object) ) { case "array": ret = object.slice(); if ( deep ) { idx = ret.length; while ( idx-- ) { ret[idx] = SC.copy( ret[idx], true ); } } break ; case "object": ret = {} ; for(var key in object) { ret[key] = deep ? SC.copy(object[key], true) : object[key] ; } } return ret ; }, /** Returns a new object combining the values of all passed hashes. @param object {Object} one or more objects @returns {Object} new Object */ merge: function() { var ret = {}, len = arguments.length, idx; for(idx=0; idx= 0) ? path.slice(stopAt+1) : path ; // convert path to object. var obj = this.objectForPropertyPath(path, root, stopAt) ; return (obj && key) ? [obj,key] : null ; }, /** Finds the object for the passed path or array of path components. This is the standard method used in SproutCore to traverse object paths. @param path {String} the path @param root {Object} optional root object. window is used otherwise @param stopAt {Integer} optional point to stop searching the path. @returns {Object} the found object or undefined. */ objectForPropertyPath: function(path, root, stopAt) { var loc, nextDotAt, key, max ; if (!root) root = window ; // faster method for strings if (SC.typeOf(path) === SC.T_STRING) { if (stopAt === undefined) stopAt = path.length ; loc = 0 ; while((root) && (loc < stopAt)) { nextDotAt = path.indexOf('.', loc) ; if ((nextDotAt < 0) || (nextDotAt > stopAt)) nextDotAt = stopAt; key = path.slice(loc, nextDotAt); root = root.get ? root.get(key) : root[key] ; loc = nextDotAt+1; } if (loc < stopAt) root = undefined; // hit a dead end. :( // older method using an array } else { loc = 0; max = path.length; key = null; while((loc < max) && root) { key = path[loc++]; if (key) root = (root.get) ? root.get(key) : root[key] ; } if (loc < max) root = undefined ; } return root ; }, // .......................................................... // LOCALIZATION SUPPORT // /** Known loc strings @property {Hash} */ STRINGS: {}, /** This is a simplified handler for installing a bunch of strings. This ignores the language name and simply applies the passed strings hash. @param {String} lang the language the strings are for @param {Hash} strings hash of strings @returns {SC} receiver */ stringsFor: function(lang, strings) { SC.mixin(SC.STRINGS, strings); return this ; } }); // end mixin /** @private Aliasn for SC.clone() */ SC.clone = SC.copy ; /** @private Alias for SC.A() */ SC.$A = SC.A; /** @private Provided for compatibility with old HTML templates. */ SC.didLoad = SC.K ; /** @private Used by SC.compare */ SC.ORDER_DEFINITION = [ SC.T_ERROR, SC.T_UNDEFINED, SC.T_NULL, SC.T_BOOL, SC.T_NUMBER, SC.T_STRING, SC.T_ARRAY, SC.T_HASH, SC.T_OBJECT, SC.T_FUNCTION, SC.T_CLASS ]; // ........................................ // FUNCTION ENHANCEMENTS // SC.Function = { property: function(fn, keys) { fn.dependentKeys = SC.$A(keys) ; var guid = SC.guidFor(fn) ; fn.cacheKey = "__cache__" + guid ; fn.lastSetValueKey = "__lastValue__" + guid ; fn.isProperty = true ; return fn ; }, cacheable: function(fn, aFlag) { fn.isProperty = true ; // also make a property just in case if (!fn.dependentKeys) fn.dependentKeys = [] ; fn.isCacheable = (aFlag === undefined) ? true : aFlag ; return fn ; }, idempotent: function(fn, aFlag) { fn.isProperty = true; // also make a property just in case if (!fn.dependentKeys) this.dependentKeys = [] ; fn.isVolatile = (aFlag === undefined) ? true : aFlag ; return fn ; }, enhance: function(fn) { fn.isEnhancement = true; return fn ; }, observes: function(fn, propertyPaths) { // sort property paths into local paths (i.e just a property name) and // full paths (i.e. those with a . or * in them) var loc = propertyPaths.length, local = null, paths = null ; while(--loc >= 0) { var path = propertyPaths[loc] ; // local if ((path.indexOf('.')<0) && (path.indexOf('*')<0)) { if (!local) local = fn.localPropertyPaths = [] ; local.push(path); // regular } else { if (!paths) paths = fn.propertyPaths = [] ; paths.push(path) ; } } return fn ; } }; SC.mixin(Function.prototype, /** @lends Function.prototype */ { /** Indicates that the function should be treated as a computed property. Computed properties are methods that you want to treat as if they were static properties. When you use get() or set() on a computed property, the object will call the property method and return its value instead of returning the method itself. This makes it easy to create "virtual properties" that are computed dynamically from other properties. Consider the following example: {{{ contact = SC.Object.create({ firstName: "Charles", lastName: "Jolley", // This is a computed property! fullName: function() { return this.getEach('firstName','lastName').compact().join(' ') ; }.property('firstName', 'lastName'), // this is not getFullName: function() { return this.getEach('firstName','lastName').compact().join(' ') ; } }); contact.get('firstName') ; --> "Charles" contact.get('fullName') ; --> "Charles Jolley" contact.get('getFullName') ; --> function() }}} Note that when you get the fullName property, SproutCore will call the fullName() function and return its value whereas when you get() a property that contains a regular method (such as getFullName above), then the function itself will be returned instead. h2. Using Dependent Keys Computed properties are often computed dynamically from other member properties. Whenever those properties change, you need to notify any object that is observing the computed property that the computed property has changed also. We call these properties the computed property is based upon "dependent keys". For example, in the contact object above, the fullName property depends on the firstName and lastName property. If either property value changes, any observer watching the fullName property will need to be notified as well. You inform SproutCore of these dependent keys by passing the key names as parameters to the property() function. Whenever the value of any key you name here changes, the computed property will be marked as changed also. You should always register dependent keys for computed properties to ensure they update. h2. Using Computed Properties as Setters Computed properties can be used to modify the state of an object as well as to return a value. Unlike many other key-value system, you use the same method to both get and set values on a computed property. To write a setter, simply declare two extra parameters: key and value. Whenever your property function is called as a setter, the value parameter will be set. Whenever your property is called as a getter the value parameter will be undefined. For example, the following object will split any full name that you set into a first name and last name components and save them. {{{ contact = SC.Object.create({ fullName: function(key, value) { if (value !== undefined) { var parts = value.split(' ') ; this.beginPropertyChanges() .set('firstName', parts[0]) .set('lastName', parts[1]) .endPropertyChanges() ; } return this.getEach('firstName', 'lastName').compact().join(' '); }.property('firstName','lastName') }) ; }}} h2. Why Use The Same Method for Getters and Setters? Most property-based frameworks expect you to write two methods for each property but SproutCore only uses one. We do this because most of the time when you write a setter is is basically a getter plus some extra work. There is little added benefit in writing both methods when you can conditionally exclude part of it. This helps to keep your code more compact and easier to maintain. @param dependentKeys {String...} optional set of dependent keys @returns {Function} the declared function instance */ property: function() { return SC.Function.property(this, arguments); }, /** You can call this method on a computed property to indicate that the property is cacheable (or not cacheable). By default all computed properties are not cached. Enabling this feature will allow SproutCore to cache the return value of your computed property and to use that value until one of your dependent properties changes or until you invoke propertyDidChange() and name the computed property itself. If you do not specify this option, computed properties are assumed to be not cacheable. @param {Boolean} aFlag optionally indicate cacheable or no, default YES @returns {Function} reciever */ cacheable: function(aFlag) { return SC.Function.cacheable(this, aFlag); }, /** Indicates that the computed property is volatile. Normally SproutCore assumes that your computed property is idempotent. That is, calling set() on your property more than once with the same value has the same effect as calling it only once. All non-computed properties are idempotent and normally you should make your computed properties behave the same way. However, if you need to make your property change its return value everytime your method is called, you may chain this to your property to make it volatile. If you do not specify this option, properties are assumed to be non-volatile. @param {Boolean} aFlag optionally indicate state, default to YES @returns {Function} receiver */ idempotent: function(aFlag) { return SC.Function.idempotent(this, aFlag); }, enhance: function() { return SC.Function.enhance(this); }, /** Declare that a function should observe an object at the named path. Note that the path is used only to construct the observation one time. @returns {Function} receiver */ observes: function(propertyPaths) { return SC.Function.observes(this, arguments); } }); SC.CoreString = { fmt: function(str, formats) { // first, replace any ORDERED replacements. var idx = 0; // the current index for non-numerical replacements return str.replace(/%@([0-9]+)?/g, function(s, argIndex) { argIndex = (argIndex) ? parseInt(argIndex,0) - 1 : idx++ ; s = formats[argIndex]; return ((s === null) ? '(null)' : (s === undefined) ? '' : s).toString(); }) ; }, loc: function(str, formats) { str = SC.STRINGS[str] || str; return SC.CoreString.fmt(str, arguments) ; }, w: function(str) { var ary = [], ary2 = str.split(' '), len = ary2.length, string, idx=0; for (idx=0; idx "Hello John Doe" "Hello %@2, %@1".fmt('John', 'Doe') => "Hello Doe, John" }}} @param args {Object...} optional arguments @returns {String} formatted string */ fmt: function() { return SC.CoreString.fmt(this, arguments); }, /** Localizes the string. This will look up the reciever string as a key in the current Strings hash. If the key matches, the loc'd value will be used. The resulting string will also be passed through fmt() to insert any variables. @param args {Object...} optional arguments to interpolate also @returns {String} the localized and formatted string. */ loc: function() { return SC.CoreString.loc(this, arguments); }, /** Splits the string into words, separated by spaces. Empty strings are removed from the results. @returns {Array} an array of non-empty strings */ w: function() { return SC.CoreString.w(this); } }); // // DATE ENHANCEMENT // if (!Date.now) { Date.now = function() { return new Date().getTime() ; }; }