@@ -49,13 +49,12 @@ SC.BENCHMARK_OBJECTS = NO; */ SC.Object = function(noinit) { - if (noinit === SC.Object._noinit_) return ; + if (noinit === SC.Object._noinit_) return this ; var ret = SC.Object._init.apply(this,SC.$A(arguments)) ; return ret ; }; -Object.extend(SC.Object, -/** @scope SC.Object */ { +SC.mixin(SC.Object, /** @scope SC.Object */ { _noinit_: '__noinit__', @@ -86,7 +85,7 @@ Object.extend(SC.Object, // build function. copy class methods on to it. var ret = function(noinit) { - if (noinit && (typeof(noinit) == 'string') && (noinit == SC.Object._noinit_)) return ; + if (noinit && (typeof(noinit) == 'string') && (noinit == SC.Object._noinit_)) return this ; var ret = SC.Object._init.apply(this,SC.$A(arguments)); return ret ; }; foundation/object.js @@ -440,10 +440,11 @@ SC.Enumerable = { spec. Sorry. @params callback {Function} the callback to execute - @params target {Object} the target object to use + @params initialValue {Object} initial value for the reduce + @params reducerProperty {String} internal use only. May not be available. @returns {Array} A filtered array. */ - reduce: function(callback, initialValue) { + reduce: function(callback, initialValue, reducerProperty) { if (typeof callback !== "function") throw new TypeError() ; var len = (this.get) ? this.get('length') : this.length ; @@ -463,7 +464,7 @@ SC.Enumerable = { if (ret === undefined) { ret = next ; } else { - ret = callback.call(null, ret, next, idx, this); + ret = callback.call(null, ret, next, idx, this, reducerProperty); } } last = next ; @@ -579,13 +580,16 @@ SC.Enumerable = { } ; // Build in a separate function to avoid unintential leaks through closures... -SC._buildReducerFor = function(reducerKey) { +SC._buildReducerFor = function(reducerKey, reducerProperty) { return function(key, value) { var reducer = this[reducerKey] ; if (SC.typeOf(reducer) !== T_FUNCTION) { return (this.unknownProperty) ? this.unknownProperty(key, value) : null; } else { - return this.reduce(reducer, null) ; + // Invoke the reduce method defined in enumerable instead of using the + // one implemented in the receiver. The receiver might be a native + // implementation that does not support reducerProperty. + return SC.Enumerable.reduce.call(this, reducer, null, reducerProperty) ; } }.property('[]') ; }; @@ -645,7 +649,12 @@ SC.Reducers = { if (key[0] !== '@') return undefined ; // not a reduced property // get the reducer key and the reducer - var reducerKey = "reduce%@".fmt(key.slice(1,key.length).capitalize()) ; + var matches = key.match(/^@([^(]*)(\(([^)]*)\))?$/) ; + if (!matches || matches.length < 2) return undefined ; // no match + + var reducerKey = matches[1]; // = 'max' if key = '@max(balance)' + var reducerProperty = matches[3] ; // = 'balance' if key = '@max(balance)' + var reducerKey = "reduce%@".fmt(reducerKey.capitalize()) ; var reducer = this[reducerKey] ; // if there is no reduce function defined for this key, then we can't @@ -653,40 +662,94 @@ SC.Reducers = { if (SC.typeOf(reducer) !== T_FUNCTION) return undefined; // if we can't generate the property, just run reduce - if (generateProperty === NO) return this.reduce(reducer, null) ; + if (generateProperty === NO) { + return SC.Enumerable.reduce.call(this, reducer, null, reducerProperty) ; + } // ok, found the reducer. Let's build the computed property and install - var func = SC._buildReducerFor(reducerKey); - var p = this.constructor.prototype ; + var func = SC._buildReducerFor(reducerKey, reducerProperty); + var p = (this._type) ? this._type : this.constructor.prototype ; + if (p) { p[key] = func ; this.registerDependentKey(key, '[]') ; } // and reduce anyway... - return this.reduce(reducer, null) ; + return SC.Enumerable.reduce.call(this, reducer, null, reducerProperty) ; }, /** Reducer for @max reduced property. */ - reduceMax: function(previousValue, item, index, enumerable) { + reduceMax: function(previousValue, item, index, e, reducerProperty) { + if (reducerProperty && item) { + item = (item.get) ? item.get(reducerProperty) : item[reducerProperty]; + } if (previousValue == null) return item ; return (item > previousValue) ? item : previousValue ; }, /** + Reducer for @maxObject reduced property. + */ + reduceMaxObject: function(previousItem, item, index, e, reducerProperty) { + + // get the value for both the previous and current item. If no + // reducerProperty was supplied, use the items themselves. + var previousValue = previousItem, itemValue = item ; + if (reducerProperty) { + if (item) { + itemValue = (item.get) ? item.get(reducerProperty) : item[reducerProperty] ; + } + + if (previousItem) { + previousItemValue = (previousItem.get) ? previousItem.get(reducerProperty) : previousItem[reducerProperty] ; + } + } + if (previousValue == null) return item ; + return (itemValue > previousValue) ? item : previousItem ; + }, + + /** Reducer for @min reduced property. */ - reduceMin: function(previousValue, item, index, enumerable) { + reduceMin: function(previousValue, item, index, e, reducerProperty) { + if (reducerProperty && item) { + item = (item.get) ? item.get(reducerProperty) : item[reducerProperty]; + } if (previousValue == null) return item ; return (item < previousValue) ? item : previousValue ; }, /** + Reducer for @maxObject reduced property. + */ + reduceMinObject: function(previousItem, item, index, e, reducerProperty) { + + // get the value for both the previous and current item. If no + // reducerProperty was supplied, use the items themselves. + var previousValue = previousItem, itemValue = item ; + if (reducerProperty) { + if (item) { + itemValue = (item.get) ? item.get(reducerProperty) : item[reducerProperty] ; + } + + if (previousItem) { + previousItemValue = (previousItem.get) ? previousItem.get(reducerProperty) : previousItem[reducerProperty] ; + } + } + if (previousValue == null) return item ; + return (itemValue < previousValue) ? item : previousItem ; + }, + + /** Reducer for @average reduced property. */ - reduceAverage: function(previousValue, item, index, e) { + reduceAverage: function(previousValue, item, index, e, reducerProperty) { + if (reducerProperty && item) { + item = (item.get) ? item.get(reducerProperty) : item[reducerProperty]; + } var ret = (previousValue || 0) + item ; var len = (e.get) ? e.get('length') : e.length; if (index >= len-1) ret = ret / len; //avg after last item. @@ -696,7 +759,10 @@ SC.Reducers = { /** Reducer for @sum reduced property. */ - reduceSum: function(previousValue, item, index, e) { + reduceSum: function(previousValue, item, index, e, reducerProperty) { + if (reducerProperty && item) { + item = (item.get) ? item.get(reducerProperty) : item[reducerProperty]; + } return (previousValue == null) ? item : previousValue + item ; } } ; @@ -894,7 +960,7 @@ SC.mixin(Array.prototype, SC.Reducers) ; return ret ; }, - reduce: function(callback, initialValue) { + reduce: function(callback, initialValue, reducerProperty) { if (typeof callback !== "function") throw new TypeError() ; var len = this.length ; @@ -912,7 +978,7 @@ SC.mixin(Array.prototype, SC.Reducers) ; if (ret === undefined) { ret = next ; } else { - ret = callback.call(null, ret, next, idx, this); + ret = callback.call(null, ret, next, idx, this, reducerProperty); } } } mixins/enumerable.js @@ -603,6 +603,13 @@ SC.Observable = { // otherwise, bind as a normal property } else { + + // if you add an observer beginning with '@', then we might need to + // create or register the property... + if (this.reducedProperty && (key.charAt(0) === '@')) { + this.reducedProperty(key, undefined) ; // create if needed... + } + var observers = kvo.observers[key] = (kvo.observers[key] || []) ; var found = false; var loc = observers.length; while(!found && --loc >= 0) found = (observers[loc] == func) ; mixins/observable.js @@ -233,6 +233,91 @@ var EnumerableTests = { "invokeWhile should call method on member objects until return does not match": function() { var ret = src.invokeWhile("OK", "invokeWhileTest", "item2") ; assertEqual("FAIL", ret, "return value"); + }, + + "get @min(balance) should return the minimum balance": function() { + assertEqual(1, src.get('@min(balance)')) ; + }, + + "get @max(balance) should return the maximum balance": function() { + assertEqual(4, src.get('@max(balance)')) ; + }, + + "get @minObject(balance) should return the record with min balance": function() { + assertEqual(src.objectAt(0), src.get('@minObject(balance)')) ; + }, + + "get @maxObject(balance) should return the record with the max balance": function() { + assertEqual(src.objectAt(0), src.get('@maxObject(balance)')) ; + }, + + "get @sum(balance) should return the sum of the balances.": function() { + assertEqual(1+2+3+4, src.get("@sum(balance)")) ; + }, + + "get @average(balance) should return the average of balances": function() { + assertEqual((1+2+3+4)/4, src.get("@average(balance)")) ; + }, + + "should invoke custom reducer": function() { + // install reducer method + src.reduceTest = reduceTestFunc ; + assertEqual("TEST", src.get("@test")) ; + assertEqual("prop", src.get("@test(prop)")) ; + }, + "should trigger observer of reduced prop when array changes once property retrieved once": function() { + + // get the property...this will install the reducer property... + src.get("@max(balance)") ; + + // install observer + var observedValue = null ; + src.addObserver("@max(balance)", function() { + observedValue = src.get("@max(balance)"); + }) ; + + src.addProbe('[]') ; + src.addProbe('@max(balance)'); + + // add record to array + src.pushObject({ + first: "John", + gender: "male", + californian: NO, + ready: YES, + visited: "Paris", + balance: 5 + }) ; + + //SC.NotificationQueue.flush() ; // force observers to trigger + + // observed value should now be set because the reduced property observer + // was triggered when we changed the array contents. + assertEqual(5, observedValue) ; + }, + + "should trigger observer of reduced prop when array changes - even if you never retrieved the property before": function() { + // install observer + var observedValue = null ; + src.addObserver("@max(balance)", function() { + observedValue = src.get("@max(balance)"); + }) ; + + // add record to array + src.pushObject({ + first: "John", + gender: "male", + californian: NO, + ready: YES, + visited: "Paris", + balance: 5 + }) ; + + //SC.NotificationQueue.flush() ; // force observers to trigger + + // observed value should now be set because the reduced property observer + // was triggered when we changed the array contents. + assertEqual(5, observedValue) ; } }; @@ -245,12 +330,30 @@ var DummyEnumerable = SC.Object.extend(SC.Enumerable, { objectAt: function(idx) { return this.content[idx]; }, - nextObject: function(idx) { return this.content[idx]; } + nextObject: function(idx) { return this.content[idx]; }, + + // add support for reduced properties. + unknownProperty: function(key, value) { + var ret = this.reducedProperty(key, value) ; + if (ret === undefined) { + if (value !== undefined) this[key] = value ; + ret = value ; + } + return ret ; + }, + + pushObject: function(object) { + this.content.push(object) ; + this.enumerableContentDidChange() ; + } + }) ; var runFunc = function(a,b) { return ['DONE', a, b]; } ; var invokeWhileOK = function() { return "OK"; } ; var invokeWhileNotOK = function() { return "FAIL"; }; +var reduceTestFunc = function(prev, item, idx, e, pname) { return pname||'TEST'; } ; + var CommonArray = [ { first: "Charles", gender: "male", @@ -259,7 +362,8 @@ var CommonArray = [ visited: "Prague", doneTravelling: NO, run: runFunc, - invokeWhileTest: invokeWhileOK + invokeWhileTest: invokeWhileOK, + balance: 1 }, { first: "Jenna", @@ -269,7 +373,8 @@ var CommonArray = [ visited: "Prague", doneTravelling: NO, run: runFunc, - invokeWhileTest: invokeWhileOK + invokeWhileTest: invokeWhileOK, + balance: 2 }, { first: "Peter", @@ -279,8 +384,10 @@ var CommonArray = [ visited: "Prague", doneTravelling: NO, run: runFunc, - invokeWhileTest: invokeWhileNotOK + invokeWhileTest: invokeWhileNotOK, + balance: 3 }, + { first: "Chris", gender: "male", californian: NO, @@ -288,12 +395,13 @@ var CommonArray = [ visited: "Prague", doneTravelling: NO, run: runFunc, - invokeWhileTest: invokeWhileOK + invokeWhileTest: invokeWhileOK, + balance: 4 } ] ; Test.context("Real Array", SC.mixin(EnumerableTests, { - setup: function() { src = CommonArray; }, + setup: function() { src = CommonArray.clone(); }, teardown: function() { src = null ; } tests/mixins/enumerable.rhtml 543198e3102768087b074a71ceb2ec71da0ad760 Charles Jolley charles@sproutit.com http://github.com/sproutit/sproutcore/commit/c3564ee7f5fbeec6d73064f998e1787544da955b c3564ee7f5fbeec6d73064f998e1787544da955b 2008-08-09T18:57:35-07:00 2008-08-09T18:57:35-07:00 Add unit tests for reduced properties and fix bug they found 7eed598d11814ead50793b55c2dcd677e057460f Charles Jolley charles@sproutit.com