- test!
- test!
Lorem ipsum dolor sit amet
- test!
- test!
- test!
- test!
- test!
- test!
Lorem ipsum dolor sit amet
Lorem ipsum dolor sit amet
Grow: Grow()
Shrink: Shrink()
MochiKit-1.4.2/examples/effects/effects_combi.css 0000660 0001750 0001750 00000000461 11102215702 021024 0 ustar scott scott h3 { clear: both; } .example { font-size: 1.0em; float: left; margin-right: 10px; margin-bottom: 10px; width: 112px; height: 112px; border: 4px solid #669; background-color: #ccf; text-align: center; padding: 1em 0.2em 0.2em 0.2em; } .demo { clear: both; } MochiKit-1.4.2/examples/effects/index.html 0000660 0001750 0001750 00000014153 11113647642 017540 0 ustar scott scottLorem ipsum dolor sit amet
Lorem ipsum dolor sit amet
Lorem ipsum dolor sit amet
Note: these tests use the browser default CSS style rules.
TEST
The following elements are not supported with fade/appear on all browsers!
| TEST |
| TEST |
| TEST |
| TEST |
This is an example of one might implement a key listener with MochiKit’s Signal.
For a detailed description of what happens under the hood, check out key_events.js.
View Source: [ index.html | key_events.js | key_events.css ]
Check this box to test preventDefault() in your browser:
This text is replaced with a message when you press Escape or F1.
| Event | Key Code | Key String |
|---|---|---|
| onkeydown | - | - |
| onkeyup | - | - |
| onkeypress | - | - |
| Shift | Ctrl | Alt (Option) | Meta (Command) |
|---|---|---|---|
| - | - | - | - |
<-- drag this!
Demonstrates MochiKit's MochiKit.Logging and MochiKit.LoggingPane.
Click one of the Logging Panes to pop up a view, and then start clicking on Logging Actions to see it in action!
This is an example of how one might use MochiKit to do sortable tables from data given by the server in either JSON or XML format. It uses MochiKit.Async to fetch the data, and MochiKit.DOM to display it.
Includes a micro implementation of something TAL-esque (called "MochiTAL" in the source, using a mochi: namespace). For a more detailed description of what happens under the covers, view the ajax_tables.js source and look at the comments.
| Domain Name | Creation Date | Expiry Date | Organization Name |
|---|---|---|---|
| mochibot.com | 2005-02-10 | 2007-02-10 | Jameson Hsu |
| pythonmac.org | 2003-09-24 | 2006-09-24 | Bob Ippolito |
| undefined.org | 2000-01-10 | 2006-01-10 | Robert J Ippolito |
| python.org | 1995-03-27 | 2007-03-28 | Python Software Foundation |
dp.SyntaxHighlighter Version: {V}©2004-2005 Alex Gorbatchev. All right reserved. |
This demo does "live" Regular Expression matching to help you toy with JavaScript Regular Expressions. It takes advantage of MochiKit's MochiKit.DOM to manipulate the display and MochiKit.Async to facilitate the "half a second" live updating.
The table will update while you're typing if you're idle for half a second or when you tab away from the field, whichever comes first. If you enter an invalid RegExp, the RegExp label will turn red (the "error" class). For a good JavaScript's RegExp reference, see Regular Expressions over at DevMo.
| Property | Result | Repr |
|---|---|---|
This demo is a JavaScript interpreter. Type some code into the text input and press enter to see the results. It uses MochiKit's MochiKit.DOM to manipulate the display. It also supports waiting for MochiKit.Async Deferreds via blockOn(aDeferred).
This is an example of how one might do sortable tables in an inobtrusive manner. The data is supplied by the server and is already in the table.
For a detailed description of what happens under the hood, check out sortable_tables.js.
View Source: [ index.html | sortable_tables.js ]
| Domain Name | Creation Date | Expiry Date | Organization Name |
|---|---|---|---|
| mochibot.com | 2005-02-10 | 2007-02-10 | Jameson Hsu |
| pythonmac.org | 2003-09-24 | 2006-09-24 | Bob Ippolito |
| undefined.org | 2000-01-10 | 2006-01-10 | Robert J Ippolito |
| python.org | 1995-03-27 | 2007-03-28 | Python Software Foundation |
This example demonstrates the rounded corners functionality of MochiKit's MochiKit.Visual.
The heading at the top of this page should have all four corners rounded. The heading for this section should just have the bottom corners rounded.
View Source: MochiKit-1.4.2/examples/rounded_corners/rounded_corners.css 0000660 0001750 0001750 00000000240 11102215704 023200 0 ustar scott scott h1 { background: darkgreen; color: yellow; text-align: center; } h2 { background: darkgreen; color: yellow; padding-top: 0.25em;} .invisible { display: none; } MochiKit-1.4.2/examples/rounded_corners/rounded_corners.js 0000660 0001750 0001750 00000001156 11102215704 023033 0 ustar scott scott var roundedCornersOnLoad = function () { swapDOM("visual_version", SPAN(null, MochiKit.Visual.VERSION)); roundClass("h1", null); roundClass("h2", null, {corners: "bottom"}); }; addLoadEvent(roundedCornersOnLoad); // rewrite the view-source links addLoadEvent(function () { var elems = getElementsByTagAndClassName("A", "view-source"); var page = "rounded_corners/"; for (var i = 0; i < elems.length; i++) { var elem = elems[i]; var href = elem.href.split(/\//).pop(); elem.target = "_blank"; elem.href = "../view-source/view-source.html#" + page + href; } }); MochiKit-1.4.2/examples/mouse_events/ 0000755 0001750 0001750 00000000000 11136470264 016635 5 ustar scott scott MochiKit-1.4.2/examples/mouse_events/index.html 0000660 0001750 0001750 00000010364 11113647642 020635 0 ustar scott scottFor a detailed description of what happens under the hood, check out mouse_events.js.
View Source: [ index.html | mouse_events.js | mouse_events.css ]
View Source: [ index.html ]
MochiKit-1.4.2/examples/dnd_sortable/sortable_test.html 0000660 0001750 0001750 00000003227 11113647642 022324 0 ustar scott scott
Lorem ipsum dolor sit amet consectetur adipisicing elit sed do eiusmod tempor incididunt ut labore et dolore magna aliqua(waiting for onChange)
Lorem ipsum dolor sit amet consectetur adipisicing elit sed do eiusmod tempor incididunt ut labore et dolore magna aliqua(waiting for onChange)
Lorem ipsum dolor sit amet consectetur adipisicing elit sed do eiusmod tempor incididunt ut labore et dolore magna aliqua(waiting for onChange)
Lorem ipsum dolor sit amet consectetur adipisicing elit sed do eiusmod tempor incididunt ut labore et dolore magna aliqua(waiting for onChange)
MochiKit-1.4.2/examples/dnd_sortable/sortable4_test.html 0000660 0001750 0001750 00000006027 11113647642 022411 0 ustar scott scottThis is an example of one might implement a drag handler with MochiKit’s Signal.
For a detailed description of what happens under the hood, check out draggable.js.
View Source: [ index.html | draggable.js | draggable.css ]
Test originally from this blog entry.
Here are some links in a normal paragraph: Google, Google Groups. This link has class="blog": diveintomark
Everything inside the red border is inside a div with id="foo".
This is a normal link: Yahoo
This link has class="blog": Simon Willison's Weblog
This link is inside a span, not directly child of p
Nonninn
Sniðugt
MochiKit-1.4.2/tests/test_Iter.js 0000660 0001750 0001750 00000016557 11102215552 015747 0 ustar scott scott if (typeof(dojo) != 'undefined') { dojo.require('MochiKit.Iter'); } if (typeof(JSAN) != 'undefined') { JSAN.use('MochiKit.Iter'); } if (typeof(tests) == 'undefined') { tests = {}; } tests.test_Iter = function (t) { t.is( sum([1, 2, 3, 4, 5]), 15, "sum works on Arrays" ); t.is( compare(list([1, 2, 3]), [1, 2, 3]), 0, "list([x]) == [x]" ); t.is( compare(list(range(6, 0, -1)), [6, 5, 4, 3, 2, 1]), 0, "list(range(6, 0, -1)"); t.is( compare(list(range(6)), [0, 1, 2, 3, 4, 5]), 0, "list(range(6))" ); var moreThanTwo = partial(operator.lt, 2); t.is( sum(ifilter(moreThanTwo, range(6))), 12, "sum(ifilter(, range()))" ); t.is( sum(ifilterfalse(moreThanTwo, range(6))), 3, "sum(ifilterfalse(, range()))" ); var c = count(10); t.is( compare([c.next(), c.next(), c.next()], [10, 11, 12]), 0, "count()" ); c = cycle([1, 2]); t.is( compare([c.next(), c.next(), c.next()], [1, 2, 1]), 0, "cycle()" ); c = repeat("foo", 3); t.is( compare(list(c), ["foo", "foo", "foo"]), 0, "repeat()" ); c = izip([1, 2], [3, 4, 5], repeat("foo")); t.is( compare(list(c), [[1, 3, "foo"], [2, 4, "foo"]]), 0, "izip()" ); t.is( compare(list(range(5)), [0, 1, 2, 3, 4]), 0, "range(x)" ); c = islice(range(10), 0, 10, 2); t.is( compare(list(c), [0, 2, 4, 6, 8]), 0, "islice(x, y, z)" ); c = imap(operator.add, [1, 2, 3], [2, 4, 6]); t.is( compare(list(c), [3, 6, 9]), 0, "imap(fn, p, q)" ); c = filter(partial(operator.lt, 1), iter([1, 2, 3])); t.is( compare(c, [2, 3]), 0, "filter(fn, iterable)" ); c = map(partial(operator.add, -1), iter([1, 2, 3])); t.is( compare(c, [0, 1, 2]), 0, "map(fn, iterable)" ); c = map(operator.add, iter([1, 2, 3]), [2, 4, 6]); t.is( compare(c, [3, 6, 9]), 0, "map(fn, iterable, q)" ); c = map(operator.add, iter([1, 2, 3]), iter([2, 4, 6])); t.is( compare(c, [3, 6, 9]), 0, "map(fn, iterable, iterable)" ); c = applymap(operator.add, [[1, 2], [2, 4], [3, 6]]); t.is( compare(list(c), [3, 6, 9]), 0, "applymap()" ); c = applymap(function (a) { return [this, a]; }, [[1], [2]], 1); t.is( compare(list(c), [[1, 1], [1, 2]]), 0, "applymap(self)" ); c = chain(range(2), range(3)); t.is( compare(list(c), [0, 1, 0, 1, 2]), 0, "chain(p, q)" ); var lessThanFive = partial(operator.gt, 5); c = takewhile(lessThanFive, count()); t.is( compare(list(c), [0, 1, 2, 3, 4]), 0, "takewhile()" ); c = dropwhile(lessThanFive, range(10)); t.is( compare(list(c), [5, 6, 7, 8, 9]), 0, "dropwhile()" ); c = tee(range(5), 3); t.is( compare(list(c[0]), list(c[1])), 0, "tee(..., 3) p0 == p1" ); t.is( compare(list(c[2]), [0, 1, 2, 3, 4]), 0, "tee(..., 3) p2 == fixed" ); t.is( compare(reduce(operator.add, range(10)), 45), 0, "reduce(op.add)" ); try { reduce(operator.add, []); t.ok( false, "reduce didn't raise anything with empty list and no start?!" ); } catch (e) { if (e instanceof TypeError) { t.ok( true, "reduce raised TypeError correctly" ); } else { t.ok( false, "reduce raised the wrong exception?" ); } } t.is( reduce(operator.add, [], 10), 10, "range initial value OK empty" ); t.is( reduce(operator.add, [1], 10), 11, "range initial value OK populated" ); t.is( compare(iextend([1], range(2)), [1, 0, 1]), 0, "iextend(...)" ); var rval = []; var o = [0, 1, 2, 3]; o.next = range(2).next; t.is( iextend([], o).length, 2, "iextend handles array-like iterables" ); var x = []; exhaust(imap(bind(x.push, x), range(5))); t.is( compare(x, [0, 1, 2, 3, 4]), 0, "exhaust(...)" ); t.is( every([1, 2, 3, 4, 5, 4], lessThanFive), false, "every false" ); t.is( every([1, 2, 3, 4, 4], lessThanFive), true, "every true" ); t.is( some([1, 2, 3, 4, 4], lessThanFive), true, "some true" ); t.is( some([5, 6, 7, 8, 9], lessThanFive), false, "some false" ); t.is( some([5, 6, 7, 8, 4], lessThanFive), true, "some true" ); var rval = []; forEach(range(2), rval.push, rval); t.is( compare(rval, [0, 1]), 0, "forEach works bound" ); function foo(o) { rval.push(o); } forEach(range(2), foo); t.is( compare(rval, [0, 1, 0, 1]), 0, "forEach works unbound" ); var rval = []; var o = [0, 1, 2, 3]; o.next = range(2).next; forEach(o, rval.push, rval); t.is( rval.length, 2, "forEach handles array-like iterables" ); t.is( compare(sorted([3, 2, 1]), [1, 2, 3]), 0, "sorted default" ); rval = sorted(["aaa", "bb", "c"], keyComparator("length")); t.is(compare(rval, ["c", "bb", "aaa"]), 0, "sorted custom"); t.is( compare(reversed(range(4)), [3, 2, 1, 0]), 0, "reversed iterator" ); t.is( compare(reversed([5, 6, 7]), [7, 6, 5]), 0, "reversed list" ); var o = {lst: [1, 2, 3], iterateNext: function () { return this.lst.shift(); }}; t.is( compare(list(o), [1, 2, 3]), 0, "iterateNext" ); function except(exc, func) { try { func(); t.ok(false, exc.name + " was not raised."); } catch (e) { if (e == exc) { t.ok( true, "raised " + exc.name + " correctly" ); } else { t.ok( false, "raised the wrong exception?" ); } } } odd = partial(operator.and, 1) // empty grouped = groupby([]); except(StopIteration, grouped.next); // exhaust sub-iterator grouped = groupby([2,4,6,7], odd); kv = grouped.next(); k = kv[0], subiter = kv[1]; t.is(k, 0, "odd(2) = odd(4) = odd(6) == 0"); t.is(subiter.next(), 2, "sub-iterator.next() == 2"); t.is(subiter.next(), 4, "sub-iterator.next() == 4"); t.is(subiter.next(), 6, "sub-iterator.next() == 6"); except(StopIteration, subiter.next); kv = grouped.next(); key = kv[0], subiter = kv[1]; t.is(key, 1, "odd(7) == 1"); t.is(subiter.next(), 7, "sub-iterator.next() == 7"); except(StopIteration, subiter.next); // not consume sub-iterator grouped = groupby([2,4,6,7], odd); kv = grouped.next(); key = kv[0], subiter = kv[1]; t.is(key, 0, "0 = odd(2) = odd(4) = odd(6)"); kv = grouped.next(); key = kv[0], subiter = kv[1]; t.is(key, 1, "1 = odd(7)"); except(StopIteration, grouped.next); // consume sub-iterator partially grouped = groupby([3,1,1,2], odd); kv = grouped.next(); key = kv[0], subiter = kv[1]; t.is(key, 1, "odd(1) == 1"); t.is(subiter.next(), 3, "sub-iterator.next() == 3"); kv = grouped.next(); key = kv[0], v = kv[1]; t.is(key, 0, "skip (1,1), odd(2) == 0"); except(StopIteration, grouped.next); // null grouped = groupby([null,null]); kv = grouped.next(); k = kv[0], v = kv[1]; t.is(k, null, "null ok"); // groupby - array version isEqual = (t.isDeeply || function (a, b, msg) { return t.ok(compare(a, b) == 0, msg); }); isEqual(groupby_as_array([ ] ), [ ], "empty"); isEqual(groupby_as_array([1,1,1]), [ [1,[1,1,1]] ], "[1,1,1]: [1,1,1]"); isEqual(groupby_as_array([1,2,2]), [ [1,[1] ], [2,[2,2]] ], "[1,2,2]: [1], [2,2]"); isEqual(groupby_as_array([1,1,2]), [ [1,[1,1] ], [2,[2 ]] ], "[1,1,2]: [1,1], [2]"); isEqual(groupby_as_array([null,null] ), [ [null,[null,null]] ], "[null,null]: [null,null]"); grouped = groupby_as_array([1,1,3,2,4,6,8], odd); isEqual(grouped, [[1, [1,1,3]], [0,[2,4,6,8]]], "[1,1,3,2,4,6,7] odd: [1,1,3], [2,4,6,8]"); }; MochiKit-1.4.2/tests/test_MochiKit-Color.html 0000660 0001750 0001750 00000004447 11113647642 020165 0 ustar scott scott
MochiKit-1.4.2/tests/test_MochiKit-Iter.html 0000660 0001750 0001750 00000001757 11113647642 020013 0 ustar scott scott
MochiKit-1.4.2/tests/test_Signal.js 0000660 0001750 0001750 00000043567 11102215552 016262 0 ustar scott scott if (typeof(dojo) != 'undefined') { dojo.require('MochiKit.Signal'); } if (typeof(JSAN) != 'undefined') { JSAN.use('MochiKit.Signal'); } if (typeof(tests) == 'undefined') { tests = {}; } tests.test_Signal = function (t) { var submit = MochiKit.DOM.getElement('submit'); var ident = null; var i = 0; var aFunction = function() { t.ok(this === submit, "aFunction should have 'this' as submit"); i++; if (typeof(this.someVar) != 'undefined') { i += this.someVar; } }; var aObject = {}; aObject.aMethod = function() { t.ok(this === aObject, "aMethod should have 'this' as aObject"); i++; }; ident = connect('submit', 'onclick', aFunction); MochiKit.DOM.getElement('submit').click(); t.is(i, 1, 'HTML onclick event can be connected to a function'); disconnect(ident); MochiKit.DOM.getElement('submit').click(); t.is(i, 1, 'HTML onclick can be disconnected from a function'); var submit = MochiKit.DOM.getElement('submit'); ident = connect(submit, 'onclick', aFunction); submit.click(); t.is(i, 2, 'Checking that a DOM element can be connected to a function'); disconnect(ident); submit.click(); t.is(i, 2, '...and then disconnected'); if (MochiKit.DOM.getElement('submit').fireEvent || (document.createEvent && typeof(document.createEvent('MouseEvents').initMouseEvent) == 'function')) { /* Adapted from: http://www.devdaily.com/java/jwarehouse/jforum/tests/selenium/javascript/htmlutils.js.shtml License: Apache Copyright: Copyright 2004 ThoughtWorks, Inc */ var triggerMouseEvent = function(element, eventType, canBubble) { element = MochiKit.DOM.getElement(element); canBubble = (typeof(canBubble) == 'undefined') ? true : canBubble; if (element.fireEvent) { var newEvt = document.createEventObject(); newEvt.clientX = 1; newEvt.clientY = 1; newEvt.button = 1; newEvt.detail = 3; element.fireEvent('on' + eventType, newEvt); } else if (document.createEvent && (typeof(document.createEvent('MouseEvents').initMouseEvent) == 'function')) { var evt = document.createEvent('MouseEvents'); evt.initMouseEvent(eventType, canBubble, true, // event, bubbles, cancelable document.defaultView, 3, // view, detail (either scroll or # of clicks) 1, 0, 0, 0, // screenX, screenY, clientX, clientY false, false, false, false, // ctrlKey, altKey, shiftKey, metaKey 0, null); // buttonCode, relatedTarget element.dispatchEvent(evt); } }; var eventTest = function(e) { i++; t.ok((typeof(e.event()) === 'object'), 'checking that event() is an object'); t.ok((typeof(e.type()) === 'string'), 'checking that type() is a string'); t.ok((e.target() === MochiKit.DOM.getElement('submit')), 'checking that target is "submit"'); t.ok((typeof(e.modifier()) === 'object'), 'checking that modifier() is an object'); t.ok(e.modifier().alt === false, 'checking that modifier().alt is defined, but false'); t.ok(e.modifier().ctrl === false, 'checking that modifier().ctrl is defined, but false'); t.ok(e.modifier().meta === false, 'checking that modifier().meta is defined, but false'); t.ok(e.modifier().shift === false, 'checking that modifier().shift is defined, but false'); t.ok((typeof(e.mouse()) === 'object'), 'checking that mouse() is an object'); t.ok((typeof(e.mouse().button) === 'object'), 'checking that mouse().button is an object'); t.ok(e.mouse().button.left === true, 'checking that mouse().button.left is true'); t.ok(e.mouse().button.middle === false, 'checking that mouse().button.middle is false'); t.ok(e.mouse().button.right === false, 'checking that mouse().button.right is false'); t.ok((typeof(e.mouse().page) === 'object'), 'checking that mouse().page is an object'); t.ok((typeof(e.mouse().page.x) === 'number'), 'checking that mouse().page.x is a number'); t.ok((typeof(e.mouse().page.y) === 'number'), 'checking that mouse().page.y is a number'); t.ok((typeof(e.mouse().client) === 'object'), 'checking that mouse().client is an object'); t.ok((typeof(e.mouse().client.x) === 'number'), 'checking that mouse().client.x is a number'); t.ok((typeof(e.mouse().client.y) === 'number'), 'checking that mouse().client.y is a number'); /* these should not be defined */ t.ok((typeof(e.relatedTarget()) === 'undefined'), 'checking that relatedTarget() is undefined'); t.ok((typeof(e.key()) === 'undefined'), 'checking that key() is undefined'); t.ok((typeof(e.mouse().wheel) === 'undefined'), 'checking that mouse().wheel is undefined'); }; ident = connect('submit', 'onmousedown', eventTest); triggerMouseEvent('submit', 'mousedown', false); t.is(i, 3, 'Connecting an event to an HTML object and firing a synthetic event'); disconnect(ident); triggerMouseEvent('submit', 'mousedown', false); t.is(i, 3, 'Disconnecting an event to an HTML object and firing a synthetic event'); ident = connect('submit', 'onmousewheel', function(e) { i++; t.ok((typeof(e.mouse()) === 'object'), 'checking that mouse() is an object'); t.ok((typeof(e.mouse().wheel) === 'object'), 'checking that mouse().wheel is an object'); t.ok((typeof(e.mouse().wheel.x) === 'number'), 'checking that mouse().wheel.x is a number'); t.ok((typeof(e.mouse().wheel.y) === 'number'), 'checking that mouse().wheel.y is a number'); }); var nativeSignal = 'mousewheel'; if (MochiKit.Signal._browserLacksMouseWheelEvent()) { nativeSignal = 'DOMMouseScroll'; } triggerMouseEvent('submit', nativeSignal, false); t.is(i, 4, 'Connecting a mousewheel event to an HTML object and firing a synthetic event'); disconnect(ident); triggerMouseEvent('submit', nativeSignal, false); t.is(i, 4, 'Disconnecting a mousewheel event to an HTML object and firing a synthetic event'); } // non-DOM tests var hasNoSignals = {}; var hasSignals = {someVar: 1}; var i = 0; var aFunction = function() { i++; if (typeof(this.someVar) != 'undefined') { i += this.someVar; } }; var bFunction = function(someArg, someOtherArg) { i += someArg + someOtherArg; }; var aObject = {}; aObject.aMethod = function() { i++; }; aObject.bMethod = function() { i++; }; var bObject = {}; bObject.bMethod = function() { i++; }; ident = connect(hasSignals, 'signalOne', aFunction); signal(hasSignals, 'signalOne'); t.is(i, 2, 'Connecting function'); i = 0; disconnect(ident); signal(hasSignals, 'signalOne'); t.is(i, 0, 'New style disconnecting function'); i = 0; ident = connect(hasSignals, 'signalOne', bFunction); signal(hasSignals, 'signalOne', 1, 2); t.is(i, 3, 'Connecting function'); i = 0; disconnect(ident); signal(hasSignals, 'signalOne', 1, 2); t.is(i, 0, 'New style disconnecting function'); i = 0; connect(hasSignals, 'signalOne', aFunction); signal(hasSignals, 'signalOne'); t.is(i, 2, 'Connecting function'); i = 0; disconnect(hasSignals, 'signalOne', aFunction); signal(hasSignals, 'signalOne'); t.is(i, 0, 'Old style disconnecting function'); i = 0; ident = connect(hasSignals, 'signalOne', aObject, aObject.aMethod); signal(hasSignals, 'signalOne'); t.is(i, 1, 'Connecting obj-function'); i = 0; disconnect(ident); signal(hasSignals, 'signalOne'); t.is(i, 0, 'New style disconnecting obj-function'); i = 0; connect(hasSignals, 'signalOne', aObject, aObject.aMethod); signal(hasSignals, 'signalOne'); t.is(i, 1, 'Connecting obj-function'); i = 0; disconnect(hasSignals, 'signalOne', aObject, aObject.aMethod); signal(hasSignals, 'signalOne'); t.is(i, 0, 'Disconnecting obj-function'); i = 0; ident = connect(hasSignals, 'signalTwo', aObject, 'aMethod'); signal(hasSignals, 'signalTwo'); t.is(i, 1, 'Connecting obj-string'); i = 0; disconnect(ident); signal(hasSignals, 'signalTwo'); t.is(i, 0, 'New style disconnecting obj-string'); i = 0; connect(hasSignals, 'signalTwo', aObject, 'aMethod'); signal(hasSignals, 'signalTwo'); t.is(i, 1, 'Connecting obj-string'); i = 0; disconnect(hasSignals, 'signalTwo', aObject, 'aMethod'); signal(hasSignals, 'signalTwo'); t.is(i, 0, 'Old style disconnecting obj-string'); i = 0; var shouldRaise = function() { return undefined.attr; }; try { connect(hasSignals, 'signalOne', shouldRaise); signal(hasSignals, 'signalOne'); t.ok(false, 'An exception was not raised'); } catch (e) { t.ok(true, 'An exception was raised'); } disconnect(hasSignals, 'signalOne', shouldRaise); t.is(i, 0, 'Exception raised, signal should not have fired'); i = 0; connect(hasSignals, 'signalOne', aObject, 'aMethod'); connect(hasSignals, 'signalOne', aObject, 'bMethod'); signal(hasSignals, 'signalOne'); t.is(i, 2, 'Connecting one signal to two slots in one object'); i = 0; disconnect(hasSignals, 'signalOne', aObject, 'aMethod'); disconnect(hasSignals, 'signalOne', aObject, 'bMethod'); signal(hasSignals, 'signalOne'); t.is(i, 0, 'Disconnecting one signal from two slots in one object'); i = 0; connect(hasSignals, 'signalOne', aObject, 'aMethod'); connect(hasSignals, 'signalOne', bObject, 'bMethod'); signal(hasSignals, 'signalOne'); t.is(i, 2, 'Connecting one signal to two slots in two objects'); i = 0; disconnect(hasSignals, 'signalOne', aObject, 'aMethod'); disconnect(hasSignals, 'signalOne', bObject, 'bMethod'); signal(hasSignals, 'signalOne'); t.is(i, 0, 'Disconnecting one signal from two slots in two objects'); i = 0; try { connect(nothing, 'signalOne', aObject, 'aMethod'); signal(nothing, 'signalOne'); t.ok(false, 'An exception was not raised when connecting undefined'); } catch (e) { t.ok(true, 'An exception was raised when connecting undefined'); } try { disconnect(nothing, 'signalOne', aObject, 'aMethod'); t.ok(false, 'An exception was not raised when disconnecting undefined'); } catch (e) { t.ok(true, 'An exception was raised when disconnecting undefined'); } try { connect(hasSignals, 'signalOne', nothing); signal(hasSignals, 'signalOne'); t.ok(false, 'An exception was not raised when connecting an undefined function'); } catch (e) { t.ok(true, 'An exception was raised when connecting an undefined function'); } try { disconnect(hasSignals, 'signalOne', nothing); t.ok(false, 'An exception was not raised when disconnecting an undefined function'); } catch (e) { t.ok(true, 'An exception was raised when disconnecting an undefined function'); } try { connect(hasSignals, 'signalOne', aObject, aObject.nothing); signal(hasSignals, 'signalOne'); t.ok(false, 'An exception was not raised when connecting an undefined method'); } catch (e) { t.ok(true, 'An exception was raised when connecting an undefined method'); } try { connect(hasSignals, 'signalOne', aObject, 'nothing'); signal(hasSignals, 'signalOne'); t.ok(false, 'An exception was not raised when connecting an undefined method (as string)'); } catch (e) { t.ok(true, 'An exception was raised when connecting an undefined method (as string)'); } t.is(i, 0, 'Signals should not have fired'); connect(hasSignals, 'signalOne', aFunction); connect(hasSignals, 'signalOne', aObject, 'aMethod'); disconnectAll(hasSignals, 'signalOne'); signal(hasSignals, 'signalOne'); t.is(i, 0, 'disconnectAll works with single explicit signal'); i = 0; connect(hasSignals, 'signalOne', aFunction); connect(hasSignals, 'signalOne', aObject, 'aMethod'); connect(hasSignals, 'signalTwo', aFunction); connect(hasSignals, 'signalTwo', aObject, 'aMethod'); disconnectAll(hasSignals, 'signalOne'); signal(hasSignals, 'signalOne'); t.is(i, 0, 'disconnectAll works with single explicit signal'); signal(hasSignals, 'signalTwo'); t.is(i, 3, 'disconnectAll does not disconnect unrelated signals'); i = 0; connect(hasSignals, 'signalOne', aFunction); connect(hasSignals, 'signalOne', aObject, 'aMethod'); connect(hasSignals, 'signalTwo', aFunction); connect(hasSignals, 'signalTwo', aObject, 'aMethod'); disconnectAll(hasSignals, 'signalOne', 'signalTwo'); signal(hasSignals, 'signalOne'); signal(hasSignals, 'signalTwo'); t.is(i, 0, 'disconnectAll works with two explicit signals'); i = 0; connect(hasSignals, 'signalOne', aFunction); connect(hasSignals, 'signalOne', aObject, 'aMethod'); connect(hasSignals, 'signalTwo', aFunction); connect(hasSignals, 'signalTwo', aObject, 'aMethod'); disconnectAll(hasSignals, ['signalOne', 'signalTwo']); signal(hasSignals, 'signalOne'); signal(hasSignals, 'signalTwo'); t.is(i, 0, 'disconnectAll works with two explicit signals as a list'); i = 0; connect(hasSignals, 'signalOne', aFunction); connect(hasSignals, 'signalOne', aObject, 'aMethod'); connect(hasSignals, 'signalTwo', aFunction); connect(hasSignals, 'signalTwo', aObject, 'aMethod'); disconnectAll(hasSignals); signal(hasSignals, 'signalOne'); signal(hasSignals, 'signalTwo'); t.is(i, 0, 'disconnectAll works with implicit signals'); i = 0; var toggle = function() { disconnectAll(hasSignals, 'signalOne'); connect(hasSignals, 'signalOne', aFunction); i++; }; connect(hasSignals, 'signalOne', aFunction); connect(hasSignals, 'signalTwo', function() { i++; }); connect(hasSignals, 'signalTwo', toggle); connect(hasSignals, 'signalTwo', function() { i++; }); // #147 connect(hasSignals, 'signalTwo', function() { i++; }); signal(hasSignals, 'signalTwo'); t.is(i, 4, 'disconnectAll fired in a signal loop works'); i = 0; disconnectAll('signalOne'); disconnectAll('signalTwo'); var testfunc = function () { arguments.callee.count++; }; testfunc.count = 0; var testObj = { methOne: function () { this.countOne++; }, countOne: 0, methTwo: function () { this.countTwo++; }, countTwo: 0 }; connect(hasSignals, 'signalOne', testfunc); connect(hasSignals, 'signalTwo', testfunc); signal(hasSignals, 'signalOne'); signal(hasSignals, 'signalTwo'); t.is(testfunc.count, 2, 'disconnectAllTo func precondition'); disconnectAllTo(testfunc); signal(hasSignals, 'signalOne'); signal(hasSignals, 'signalTwo'); t.is(testfunc.count, 2, 'disconnectAllTo func'); connect(hasSignals, 'signalOne', testObj, 'methOne'); connect(hasSignals, 'signalTwo', testObj, 'methTwo'); signal(hasSignals, 'signalOne'); signal(hasSignals, 'signalTwo'); t.is(testObj.countOne, 1, 'disconnectAllTo obj precondition'); t.is(testObj.countTwo, 1, 'disconnectAllTo obj precondition'); disconnectAllTo(testObj); signal(hasSignals, 'signalOne'); signal(hasSignals, 'signalTwo'); t.is(testObj.countOne, 1, 'disconnectAllTo obj'); t.is(testObj.countTwo, 1, 'disconnectAllTo obj'); testObj.countOne = testObj.countTwo = 0; connect(hasSignals, 'signalOne', testObj, 'methOne'); connect(hasSignals, 'signalTwo', testObj, 'methTwo'); disconnectAllTo(testObj, 'methOne'); signal(hasSignals, 'signalOne'); signal(hasSignals, 'signalTwo'); t.is(testObj.countOne, 0, 'disconnectAllTo obj+str'); t.is(testObj.countTwo, 1, 'disconnectAllTo obj+str'); has__Connect = { count: 0, __connect__: function (ident) { this.count += arguments.length; disconnect(ident); } }; connect(has__Connect, 'signalOne', function() { t.fail("__connect__ should have disconnected signal"); }); t.is(has__Connect.count, 3, '__connect__ is called when it exists'); signal(has__Connect, 'signalOne'); has__Disconnect = { count: 0, __disconnect__: function (ident) { this.count += arguments.length; } }; connect(has__Disconnect, 'signalOne', aFunction); connect(has__Disconnect, 'signalTwo', aFunction); disconnectAll(has__Disconnect); t.is(has__Disconnect.count, 8, '__disconnect__ is called when it exists'); var events = {}; var test_ident = connect(events, "test", function() { var fail_ident = connect(events, "fail", function () { events.failed = true; }); disconnect(fail_ident); signal(events, "fail"); }); signal(events, "test"); t.is(events.failed, undefined, 'disconnected slots do not fire'); var sink = {f: function (ev) { this.ev = ev; }}; var src = {}; bindMethods(sink); connect(src, 'signal', sink.f); signal(src, 'signal', 'worked'); t.is(sink.ev, 'worked', 'custom signal does not re-bind methods'); var lateObj = { fun: function() { this.value = 1; } }; connect(src, 'signal', lateObj, "fun"); signal(src, 'signal'); lateObj.fun = function() { this.value = 2; }; signal(src, 'signal'); t.is(lateObj.value, 2, 'connect uses late function binding'); }; MochiKit-1.4.2/tests/test_Color.js 0000660 0001750 0001750 00000014625 11102215552 016114 0 ustar scott scott if (typeof(dojo) != 'undefined') { dojo.require('MochiKit.Color'); } if (typeof(JSAN) != 'undefined') { JSAN.use('MochiKit.Color'); } if (typeof(tests) == 'undefined') { tests = {}; } tests.test_Color = function (t) { var approx = function (a, b, msg) { return t.is(a.toPrecision(4), b.toPrecision(4), msg); }; t.is( Color.whiteColor().toHexString(), "#ffffff", "whiteColor has right hex" ); t.is( Color.blackColor().toHexString(), "#000000", "blackColor has right hex" ); t.is( Color.blueColor().toHexString(), "#0000ff", "blueColor has right hex" ); t.is( Color.redColor().toHexString(), "#ff0000", "redColor has right hex" ); t.is( Color.greenColor().toHexString(), "#00ff00", "greenColor has right hex" ); t.is( compare(Color.whiteColor(), Color.whiteColor()), 0, "default colors compare right" ); t.ok( Color.whiteColor() == Color.whiteColor(), "default colors are interned" ); t.ok( Color.whiteColor().toRGBString(), "rgb(255,255,255)", "toRGBString white" ); t.ok( Color.blueColor().toRGBString(), "rgb(0,0,255)", "toRGBString blue" ); t.is( Color.fromRGB(190/255, 222/255, 173/255).toHexString(), "#bedead", "fromRGB works" ); t.is( Color.fromRGB(226/255, 15.9/255, 182/255).toHexString(), "#e210b6", "fromRGB < 16 works" ); t.is( Color.fromRGB({r:190/255,g:222/255,b:173/255}).toHexString(), "#bedead", "alt fromRGB works" ); t.is( Color.fromHexString("#bedead").toHexString(), "#bedead", "round-trip hex" ); t.is( Color.fromString("#bedead").toHexString(), "#bedead", "round-trip string(hex)" ); t.is( Color.fromRGBString("rgb(190,222,173)").toHexString(), "#bedead", "round-trip rgb" ); t.is( Color.fromString("rgb(190,222,173)").toHexString(), "#bedead", "round-trip rgb" ); var hsl = Color.redColor().asHSL(); approx( hsl.h, 0.0, "red hsl.h" ); approx( hsl.s, 1.0, "red hsl.s" ); approx( hsl.l, 0.5, "red hsl.l" ); hsl = Color.fromRGB(0, 0, 0.5).asHSL(); approx( hsl.h, 2/3, "darkblue hsl.h" ); approx( hsl.s, 1.0, "darkblue hsl.s" ); approx( hsl.l, 0.25, "darkblue hsl.l" ); hsl = Color.fromString("#4169E1").asHSL(); approx( hsl.h, (5/8), "4169e1 h"); approx( hsl.s, (8/11), "4169e1 s"); approx( hsl.l, (29/51), "4169e1 l"); hsl = Color.fromString("#555544").asHSL(); approx( hsl.h, (1/6), "555544 h" ); approx( hsl.s, (1/9), "555544 s" ); approx( hsl.l, (3/10), "555544 l" ); hsl = Color.fromRGB(0.5, 1, 0.5).asHSL(); approx( hsl.h, 1/3, "aqua hsl.h" ); approx( hsl.s, 1.0, "aqua hsl.s" ); approx( hsl.l, 0.75, "aqua hsl.l" ); t.is( Color.fromHSL(hsl.h, hsl.s, hsl.l).toHexString(), Color.fromRGB(0.5, 1, 0.5).toHexString(), "fromHSL works with components" ); t.is( Color.fromHSL(hsl).toHexString(), Color.fromRGB(0.5, 1, 0.5).toHexString(), "fromHSL alt form" ); t.is( Color.fromString("hsl(120,100%,75%)").toHexString(), "#80ff80", "fromHSLString" ); t.is( Color.fromRGB(0.5, 1, 0.5).toHSLString(), "hsl(120,100.0%,75.00%)", "toHSLString" ); t.is( Color.fromHSL(0, 0, 0).toHexString(), "#000000", "fromHSL to black" ); hsl = Color.blackColor().asHSL(); approx( hsl.h, 0.0, "black hsl.h" ); approx( hsl.s, 0.0, "black hsl.s" ); approx( hsl.l, 0.0, "black hsl.l" ); hsl.h = 1.0; hsl = Color.blackColor().asHSL(); approx( hsl.h, 0.0, "asHSL returns copy" ); var rgb = Color.brownColor().asRGB(); approx( rgb.r, 153/255, "brown rgb.r" ); approx( rgb.g, 102/255, "brown rgb.g" ); approx( rgb.b, 51/255, "brown rgb.b" ); rgb.r = 0; rgb = Color.brownColor().asRGB(); approx( rgb.r, 153/255, "asRGB returns copy" ); t.is( Color.fromName("aqua").toHexString(), "#00ffff", "aqua fromName" ); t.is( Color.fromString("aqua").toHexString(), "#00ffff", "aqua fromString" ); t.is( Color.fromName("transparent"), Color.transparentColor(), "transparent fromName" ); t.is( Color.fromString("transparent"), Color.transparentColor(), "transparent fromString" ); t.is( Color.transparentColor().toRGBString(), "rgba(0,0,0,0)", "transparent toRGBString" ); t.is( Color.fromRGBString("rgba( 0, 255, 255, 50%)").asRGB().a, 0.5, "rgba parsing alpha correctly" ); t.is( Color.fromRGBString("rgba( 0, 255, 255, 50%)").toRGBString(), "rgba(0,255,255,0.5)", "rgba output correctly" ); t.is( Color.fromRGBString("rgba( 0, 255, 255, 1)").toHexString(), "#00ffff", "fromRGBString with spaces and alpha" ); t.is( Color.fromRGBString("rgb( 0, 255, 255)").toHexString(), "#00ffff", "fromRGBString with spaces" ); t.is( Color.fromRGBString("rgb( 0, 100%, 255)").toHexString(), "#00ffff", "fromRGBString with percents" ); var hsv = Color.redColor().asHSV(); approx( hsv.h, 0.0, "red hsv.h" ); approx( hsv.s, 1.0, "red hsv.s" ); approx( hsv.v, 1.0, "red hsv.v" ); t.is( Color.fromHSV(hsv).toHexString(), Color.redColor().toHexString(), "red hexstring" ); hsv = Color.fromRGB(0, 0, 0.5).asHSV(); approx( hsv.h, 2/3, "darkblue hsv.h" ); approx( hsv.s, 1.0, "darkblue hsv.s" ); approx( hsv.v, 0.5, "darkblue hsv.v" ); t.is( Color.fromHSV(hsv).toHexString(), Color.fromRGB(0, 0, 0.5).toHexString(), "darkblue hexstring" ); hsv = Color.fromString("#4169E1").asHSV(); approx( hsv.h, 5/8, "4169e1 h"); approx( hsv.s, 32/45, "4169e1 s"); approx( hsv.v, 15/17, "4169e1 l"); t.is( Color.fromHSV(hsv).toHexString(), "#4169e1", "4169e1 hexstring" ); hsv = Color.fromString("#555544").asHSV(); approx( hsv.h, 1/6, "555544 h" ); approx( hsv.s, 1/5, "555544 s" ); approx( hsv.v, 1/3, "555544 l" ); t.is( Color.fromHSV(hsv).toHexString(), "#555544", "555544 hexstring" ); hsv = Color.fromRGB(0.5, 1, 0.5).asHSV(); approx( hsv.h, 1/3, "aqua hsv.h" ); approx( hsv.s, 0.5, "aqua hsv.s" ); approx( hsv.v, 1, "aqua hsv.v" ); t.is( Color.fromHSV(hsv.h, hsv.s, hsv.v).toHexString(), Color.fromRGB(0.5, 1, 0.5).toHexString(), "fromHSV works with components" ); t.is( Color.fromHSV(hsv).toHexString(), Color.fromRGB(0.5, 1, 0.5).toHexString(), "fromHSV alt form" ); hsv = Color.fromRGB(1, 1, 1).asHSV() approx( hsv.h, 0, 'white hsv.h' ); approx( hsv.s, 0, 'white hsv.s' ); approx( hsv.v, 1, 'white hsv.v' ); t.is( Color.fromHSV(0, 0, 1).toHexString(), '#ffffff', 'HSV saturation' ); }; MochiKit-1.4.2/tests/test_MochiKit-Signal.html 0000660 0001750 0001750 00000002321 11113647642 020311 0 ustar scott scott Please ignore this button:
MochiKit-1.4.2/tests/test_DateTime.js 0000660 0001750 0001750 00000005614 11102215552 016530 0 ustar scott scott if (typeof(dojo) != 'undefined') { dojo.require('MochiKit.DateTime'); } if (typeof(JSAN) != 'undefined') { JSAN.use('MochiKit.DateTime'); } if (typeof(tests) == 'undefined') { tests = {}; } tests.test_DateTime = function (t) { var testDate = isoDate('2005-2-3'); t.is(testDate.getFullYear(), 2005, "isoDate year ok"); t.is(testDate.getDate(), 3, "isoDate day ok"); t.is(testDate.getMonth(), 1, "isoDate month ok"); t.ok(objEqual(testDate, new Date("February 3, 2005")), "matches string date"); t.is(toISODate(testDate), '2005-02-03', 'toISODate ok'); var testDate = isoDate('2005-06-08'); t.is(testDate.getFullYear(), 2005, "isoDate year ok"); t.is(testDate.getDate(), 8, "isoDate day ok"); t.is(testDate.getMonth(), 5, "isoDate month ok"); t.ok(objEqual(testDate, new Date("June 8, 2005")), "matches string date"); t.is(toISODate(testDate), '2005-06-08', 'toISODate ok'); var testDate = isoDate('0500-12-12'); t.is(testDate.getFullYear(), 500, 'isoDate year ok for year < 1000'); t.is(testDate.getDate(), 12, 'isoDate day ok for year < 1000'); t.is(testDate.getMonth(), 11, 'isoDate month ok for year < 1000'); t.ok(objEqual(testDate, new Date("December 12, 0500")), "matches string date for year < 1000"); t.is(toISODate(testDate), '0500-12-12', 'toISODate ok for year < 1000'); t.is(compare(new Date("February 3, 2005"), new Date(2005, 1, 3)), 0, "dates compare eq"); t.is(compare(new Date("February 3, 2005"), new Date(2005, 2, 3)), -1, "dates compare lt"); t.is(compare(new Date("February 3, 2005"), new Date(2005, 0, 3)), 1, "dates compare gt"); var testDate = isoDate('2005-2-3'); t.is(compare(americanDate('2/3/2005'), testDate), 0, "americanDate eq"); t.is(compare('2/3/2005', toAmericanDate(testDate)), 0, "toAmericanDate eq"); var testTimestamp = isoTimestamp('2005-2-3 22:01:03'); t.is(compare(testTimestamp, new Date(2005,1,3,22,1,3)), 0, "isoTimestamp eq"); t.is(compare(testTimestamp, isoTimestamp('2005-2-3T22:01:03')), 0, "isoTimestamp (real ISO) eq"); t.is(compare(toISOTimestamp(testTimestamp), '2005-02-03 22:01:03'), 0, "toISOTimestamp eq"); testTimestamp = isoTimestamp('2005-2-3T22:01:03Z'); t.is(toISOTimestamp(testTimestamp, true), '2005-02-03T22:01:03Z', "toISOTimestamp (real ISO) eq"); var localTZ = Math.round((new Date(2005,1,3,22,1,3)).getTimezoneOffset()/60) var direction = (localTZ < 0) ? "+" : "-"; localTZ = Math.abs(localTZ); localTZ = direction + ((localTZ < 10) ? "0" : "") + localTZ; testTimestamp = isoTimestamp("2005-2-3T22:01:03" + localTZ); var testDateTimestamp = new Date(2005,1,3,22,1,3); t.is(compare(testTimestamp, testDateTimestamp), 0, "equal with local tz"); testTimestamp = isoTimestamp("2005-2-3T17:01:03-05"); var testDateTimestamp = new Date(Date.UTC(2005,1,3,22,1,3)); t.is(compare(testTimestamp, testDateTimestamp), 0, "equal with specific tz"); }; MochiKit-1.4.2/tests/test_MochiKit-MochiKit.html 0000660 0001750 0001750 00000001141 11113647642 020602 0 ustar scott scott
MochiKit-1.4.2/tests/test_MochiKit-Style.html 0000660 0001750 0001750 00000022107 11113647642 020200 0 ustar scott scott
| 1 | 2 | 3 |
MochiKit-1.4.2/tests/test_MochiKit-Base.html 0000660 0001750 0001750 00000001712 11113647642 017751 0 ustar scott scott
MochiKit-1.4.2/tests/test_MochiKit-Logging.html 0000660 0001750 0001750 00000002104 11113647642 020461 0 ustar scott scott
MochiKit-1.4.2/tests/index.html 0000660 0001750 0001750 00000001263 11113647642 015443 0 ustar scott scott MochiKit-1.4.2/tests/test_MochiKit-DateTime.html 0000660 0001750 0001750 00000002106 11113647642 020571 0 ustar scott scott
MochiKit-1.4.2/tests/test_MochiKit-Async.html 0000660 0001750 0001750 00000027125 11113647642 020162 0 ustar scott scott
MochiKit-1.4.2/tests/test_Base.js 0000660 0001750 0001750 00000056616 11102215552 015716 0 ustar scott scott if (typeof(dojo) != 'undefined') { dojo.require('MochiKit.Base'); } if (typeof(JSAN) != 'undefined') { JSAN.use('MochiKit.Base'); } if (typeof(tests) == 'undefined') { tests = {}; } tests.test_Base = function (t) { // test bind var not_self = {"toString": function () { return "not self"; } }; var self = {"toString": function () { return "self"; } }; var func = function (arg) { return this.toString() + " " + arg; }; var boundFunc = bind(func, self); not_self.boundFunc = boundFunc; t.is( boundFunc("foo"), "self foo", "boundFunc bound to self properly" ); t.is( not_self.boundFunc("foo"), "self foo", "boundFunc bound to self on another obj" ); t.is( bind(boundFunc, not_self)("foo"), "not self foo", "boundFunc successfully rebound!" ); t.is( bind(boundFunc, undefined, "foo")(), "self foo", "boundFunc partial no self change" ); t.is( bind(boundFunc, not_self, "foo")(), "not self foo", "boundFunc partial self change" ); // test method not_self = {"toString": function () { return "not self"; } }; self = {"toString": function () { return "self"; } }; func = function (arg) { return this.toString() + " " + arg; }; var boundMethod = method(self, func); not_self.boundMethod = boundMethod; t.is( boundMethod("foo"), "self foo", "boundMethod bound to self properly" ); t.is( not_self.boundMethod("foo"), "self foo", "boundMethod bound to self on another obj" ); t.is( method(not_self, boundMethod)("foo"), "not self foo", "boundMethod successfully rebound!" ); t.is( method(undefined, boundMethod, "foo")(), "self foo", "boundMethod partial no self change" ); t.is( method(not_self, boundMethod, "foo")(), "not self foo", "boundMethod partial self change" ); // test bindLate self = {"toString": function () { return "self"; } }; boundFunc = bindLate("toString", self); t.is( boundFunc(), "self", "bindLate binds properly" ); self.toString = function () { return "not self"; }; t.is( boundFunc(), "not self", "bindLate late function lookup" ); func = function (arg) { return this.toString() + " " + arg; }; boundFunc = bindLate(func, self); t.is( boundFunc("foo"), "not self foo", "bindLate fallback to standard bind" ); // test bindMethods var O = function (value) { bindMethods(this); this.value = value; }; O.prototype.func = function () { return this.value; }; var o = new O("boring"); var p = {}; p.func = o.func; var func = o.func; t.is( o.func(), "boring", "bindMethods doesn't break shit" ); t.is( p.func(), "boring", "bindMethods works on other objects" ); t.is( func(), "boring", "bindMethods works on functions" ); var p = clone(o); t.ok( p instanceof O, "cloned correct inheritance" ); var q = clone(p); t.ok( q instanceof O, "clone-cloned correct inheritance" ); q.foo = "bar"; t.is( p.foo, undefined, "clone-clone is copy-on-write" ); p.bar = "foo"; t.is( o.bar, undefined, "clone is copy-on-write" ); t.is( q.bar, "foo", "clone-clone has proper delegation" ); // unbind p.func = bind(p.func, null); t.is( p.func(), "boring", "clone function calls correct" ); q.value = "awesome"; t.is( q.func(), "awesome", "clone really does work" ); // test boring boolean funcs t.is( isNull(null), true, "isNull matches null" ); t.is( isNull(undefined), false, "isNull doesn't match undefined" ); t.is( isNull({}), false, "isNull doesn't match objects" ); t.is( isCallable(isCallable), true, "isCallable returns true on itself" ); t.is( isCallable(1), false, "isCallable returns false on numbers" ); t.is( isUndefined(null), false, "null is not undefined" ); t.is( isUndefined(""), false, "empty string is not undefined" ); t.is( isUndefined(undefined), true, "undefined is undefined" ); t.is( isUndefined({}.foo), true, "missing property is undefined" ); t.is( isUndefinedOrNull(null), true, "null is undefined or null" ); t.is( isUndefinedOrNull(""), false, "empty string is not undefined or null" ); t.is( isUndefinedOrNull(undefined), true, "undefined is undefined or null" ); t.is( isUndefinedOrNull({}.foo), true, "missing property is undefined or null" ); t.is( isEmpty(null), true, "isEmpty null" ); t.is( isEmpty([], [], ""), true, "isEmpty true" ); t.is( isEmpty([], [1], ""), true, "isEmpty true" ); t.is( isEmpty([1], [1], "1"), false, "isEmpty false" ); t.is( isEmpty([1], [1], "1"), false, "isEmpty false" ); t.is( isNotEmpty(null), false, "isNotEmpty null" ); t.is( isNotEmpty([], [], ""), false, "isNotEmpty false" ); t.is( isNotEmpty([], [1], ""), false, "isNotEmpty false" ); t.is( isNotEmpty([1], [1], "1"), true, "isNotEmpty true" ); t.is( isNotEmpty([1], [1], "1"), true, "isNotEmpty true" ); t.is( isArrayLike(undefined), false, "isArrayLike(undefined)" ); t.is( isArrayLike(null), false, "isArrayLike(null)" ); t.is( isArrayLike([]), true, "isArrayLike([])" ); // test extension of arrays var a = []; var b = []; var three = [1, 2, 3]; extend(a, three, 1); t.ok( objEqual(a, [2, 3]), "extend to an empty array" ); extend(a, three, 1) t.ok( objEqual(a, [2, 3, 2, 3]), "extend to a non-empty array" ); extend(b, three); t.ok( objEqual(b, three), "extend of an empty array" ); var c1 = extend(null, three); t.ok( objEqual(c1, three), "extend null" ); var c2 = extend(undefined, three); t.ok( objEqual(c2, three), "extend undefined" ); t.is( compare(1, 2), -1, "numbers compare lt" ); t.is( compare(2, 1), 1, "numbers compare gt" ); t.is( compare(1, 1), 0, "numbers compare eq" ); t.is( compare([1], [1]), 0, "arrays compare eq" ); t.is( compare([1], [1, 2]), -1, "arrays compare lt (length)" ); t.is( compare([1, 2], [2, 1]), -1, "arrays compare lt (contents)" ); t.is( compare([1, 2], [1]), 1, "arrays compare gt (length)" ); t.is( compare([2, 1], [1, 1]), 1, "arrays compare gt (contents)" ); // test partial application var a = []; var func = function (a, b) { if (arguments.length != 2) { return "bad args"; } else { return this.value + a + b; } }; var self = {"value": 1, "func": func}; var self2 = {"value": 2}; t.is( self.func(2, 3), 6, "setup for test is correct" ); self.funcTwo = partial(self.func, 2); t.is( self.funcTwo(3), 6, "partial application works" ); t.is( self.funcTwo(3), 6, "partial application works still" ); t.is( bind(self.funcTwo, self2)(3), 7, "rebinding partial works" ); self.funcTwo = bind(bind(self.funcTwo, self2), null); t.is( self.funcTwo(3), 6, "re-unbinding partial application works" ); // nodeWalk test // ... looks a lot like a DOM tree on purpose var tree = { "id": "nodeWalkTestTree", "test:int": "1", "childNodes": [ { "test:int": "2", "childNodes": [ {"test:int": "5"}, "ignored string", {"ignored": "object"}, ["ignored", "list"], { "test:skipchildren": "1", "childNodes": [{"test:int": 6}] } ] }, {"test:int": "3"}, {"test:int": "4"} ] } var visitedNodes = []; nodeWalk(tree, function (node) { var attr = node["test:int"]; if (attr) { visitedNodes.push(attr); } if (node["test:skipchildren"]) { return; } return node.childNodes; }); t.ok( objEqual(visitedNodes, ["1", "2", "3", "4", "5"]), "nodeWalk looks like it works"); // test map var minusOne = function (x) { return x - 1; }; var res = map(minusOne, [1, 2, 3]); t.ok( objEqual(res, [0, 1, 2]), "map works" ); var res2 = xmap(minusOne, 1, 2, 3); t.ok( objEqual(res2, res), "xmap works" ); res = map(operator.add, [1, 2, 3], [2, 4, 6]); t.ok( objEqual(res, [3, 6, 9]), "map(fn, p, q) works" ); res = map(operator.add, [1, 2, 3], [2, 4, 6, 8]); t.ok( objEqual(res, [3, 6, 9]), "map(fn, p, q) works (q long)" ); res = map(operator.add, [1, 2, 3, 4], [2, 4, 6]); t.ok( objEqual(res, [3, 6, 9]), "map(fn, p, q) works (p long)" ); res = map(null, [1, 2, 3], [2, 4, 6]); t.ok( objEqual(res, [[1, 2], [2, 4], [3, 6]]), "map(null, p, q) works" ); res = zip([1, 2, 3], [2, 4, 6]); t.ok( objEqual(res, [[1, 2], [2, 4], [3, 6]]), "zip(p, q) works" ); res = map(null, [1, 2, 3]); t.ok( objEqual(res, [1, 2, 3]), "map(null, lst) works" ); t.is( isNotEmpty("foo"), true, "3 char string is not empty" ); t.is( isNotEmpty(""), false, "0 char string is empty" ); t.is( isNotEmpty([1, 2, 3]), true, "3 element list is not empty" ); t.is( isNotEmpty([]), false, "0 element list is empty" ); // test filter var greaterThanThis = function (x) { return x > this; }; var greaterThanOne = function (x) { return x > 1; }; var res = filter(greaterThanOne, [-1, 0, 1, 2, 3]); t.ok( objEqual(res, [2, 3]), "filter works" ); var res = filter(greaterThanThis, [-1, 0, 1, 2, 3], 1); t.ok( objEqual(res, [2, 3]), "filter self works" ); var res2 = xfilter(greaterThanOne, -1, 0, 1, 2, 3); t.ok( objEqual(res2, res), "xfilter works" ); t.is(objMax(1, 2, 9, 12, 42, -16, 16), 42, "objMax works (with numbers)"); t.is(objMin(1, 2, 9, 12, 42, -16, 16), -16, "objMin works (with numbers)"); // test adapter registry var R = new AdapterRegistry(); R.register("callable", isCallable, function () { return "callable"; }); R.register("arrayLike", isArrayLike, function () { return "arrayLike"; }); t.is( R.match(function () {}), "callable", "registry found callable" ); t.is( R.match([]), "arrayLike", "registry found ArrayLike" ); try { R.match(null); t.ok( false, "non-matching didn't raise!" ); } catch (e) { t.is( e, NotFound, "non-matching raised correctly" ); } R.register("undefinedOrNull", isUndefinedOrNull, function () { return "undefinedOrNull" }); R.register("undefined", isUndefined, function () { return "undefined" }); t.is( R.match(undefined), "undefinedOrNull", "priorities are as documented" ); t.ok( R.unregister("undefinedOrNull"), "removed adapter" ); t.is( R.match(undefined), "undefined", "adapter was removed" ); R.register("undefinedOrNull", isUndefinedOrNull, function () { return "undefinedOrNull" }, true); t.is( R.match(undefined), "undefinedOrNull", "override works" ); var a1 = {"a": 1, "b": 2, "c": 2}; var a2 = {"a": 2, "b": 1, "c": 2}; t.is( keyComparator("a")(a1, a2), -1, "keyComparator 1 lt" ); t.is( keyComparator("c")(a1, a2), 0, "keyComparator 1 eq" ); t.is( keyComparator("c", "b")(a1, a2), 1, "keyComparator 2 eq gt" ); t.is( keyComparator("c", "a")(a1, a2), -1, "keyComparator 2 eq lt" ); t.is( reverseKeyComparator("a")(a1, a2), 1, "reverseKeyComparator" ); t.is( compare(concat([1], [2], [3]), [1, 2, 3]), 0, "concat" ); t.is( repr("foo"), '"foo"', "string repr" ); t.is( repr(1), '1', "number repr" ); t.is( listMin([1, 3, 5, 3, -1]), -1, "listMin" ); t.is( objMin(1, 3, 5, 3, -1), -1, "objMin" ); t.is( listMax([1, 3, 5, 3, -1]), 5, "listMax" ); t.is( objMax(1, 3, 5, 3, -1), 5, "objMax" ); var v = keys(a1); v.sort(); t.is( compare(v, ["a", "b", "c"]), 0, "keys" ); v = items(a1); v.sort(); t.is( compare(v, [["a", 1], ["b", 2], ["c", 2]]), 0, "items" ); var StringMap = function() {}; a = new StringMap(); a.foo = "bar"; b = new StringMap(); b.foo = "bar"; try { compare(a, b); t.ok( false, "bad comparison registered!?" ); } catch (e) { t.ok( e instanceof TypeError, "bad comparison raised TypeError" ); } t.is( repr(a), "[object Object]", "default repr for StringMap" ); var isStringMap = function () { for (var i = 0; i < arguments.length; i++) { if (!(arguments[i] instanceof StringMap)) { return false; } } return true; }; registerRepr("stringMap", isStringMap, function (obj) { return "StringMap(" + repr(items(obj)) + ")"; } ); t.is( repr(a), 'StringMap([["foo", "bar"]])', "repr worked" ); // not public API MochiKit.Base.reprRegistry.unregister("stringMap"); t.is( repr(a), "[object Object]", "default repr for StringMap" ); registerComparator("stringMap", isStringMap, function (a, b) { // no sorted(...) in base a = items(a); b = items(b); a.sort(compare); b.sort(compare); return compare(a, b); } ); t.is( compare(a, b), 0, "registerComparator" ); update(a, {"foo": "bar"}, {"wibble": "baz"}, undefined, null, {"grr": 1}); t.is( a.foo, "bar", "update worked (first obj)" ); t.is( a.wibble, "baz", "update worked (second obj)" ); t.is( a.grr, 1, "update worked (skipped undefined and null)" ); t.is( compare(a, b), 1, "update worked (comparison)" ); setdefault(a, {"foo": "unf"}, {"bar": "web taco"} ); t.is( a.foo, "bar", "setdefault worked (skipped existing)" ); t.is( a.bar, "web taco", "setdefault worked (set non-existing)" ); a = null; a = setdefault(null, {"foo": "bar"}); t.is( a.foo, "bar", "setdefault worked (self is null)" ); a = null; a = setdefault(undefined, {"foo": "bar"}); t.is( a.foo, "bar", "setdefault worked (self is undefined)" ); a = null; a = update(null, {"foo": "bar"}, {"wibble": "baz"}, undefined, null, {"grr": 1}); t.is( a.foo, "bar", "update worked (self is null, first obj)" ); t.is( a.wibble, "baz", "update worked (self is null, second obj)" ); t.is( a.grr, 1, "update worked (self is null, skipped undefined and null)" ); a = null; a = update(undefined, {"foo": "bar"}, {"wibble": "baz"}, undefined, null, {"grr": 1}); t.is( a.foo, "bar", "update worked (self is undefined, first obj)" ); t.is( a.wibble, "baz", "update worked (self is undefined, second obj)" ); t.is( a.grr, 1, "update worked (self is undefined, skipped undefined and null)" ); var c = items(merge({"foo": "bar"}, {"wibble": "baz"})); c.sort(compare); t.is( compare(c, [["foo", "bar"], ["wibble", "baz"]]), 0, "merge worked" ); // not public API MochiKit.Base.comparatorRegistry.unregister("stringMap"); try { compare(a, b); t.ok( false, "bad comparison registered!?" ); } catch (e) { t.ok( e instanceof TypeError, "bad comparison raised TypeError" ); } var o = {"__repr__": function () { return "__repr__"; }}; t.is( repr(o), "__repr__", "__repr__ protocol" ); t.is( repr(MochiKit.Base), MochiKit.Base.__repr__(), "__repr__ protocol when repr is defined" ); var o = {"NAME": "NAME"}; t.is( repr(o), "NAME", "NAME protocol (obj)" ); o = function () { return "TACO" }; o.NAME = "NAME"; t.is( repr(o), "NAME", "NAME protocol (func)" ); t.is( repr(MochiKit.Base.nameFunctions), "MochiKit.Base.nameFunctions", "test nameFunctions" ); // Done! t.is( urlEncode("1+2=2").toUpperCase(), "1%2B2%3D2", "urlEncode" ); t.is( queryString(["a", "b"], [1, "two"]), "a=1&b=two", "queryString"); t.is( queryString({"a": 1}), "a=1", "one item alternate form queryString" ); var o = {"a": 1, "b": 2, "c": function() {}}; var res = queryString(o).split("&"); res.sort(); t.is( res.join("&"), "a=1&b=2", "two item alternate form queryString, function skip" ); var res = parseQueryString("1+1=2&b=3%3D2"); t.is( res["1 1"], "2", "parseQueryString pathological name" ); t.is( res.b, "3=2", "parseQueryString second name:value pair" ); var res = parseQueryString("foo=one&foo=two", true); t.is( res["foo"].join(" "), "one two", "parseQueryString useArrays" ); var res = parseQueryString("?foo=2&bar=1"); t.is( res["foo"], "2", "parseQueryString strip leading question mark"); var res = parseQueryString("x=1&y=2"); t.is( typeof(res['&']), "undefined", "extra cruft in parseQueryString output"); t.is( serializeJSON("foo\n\r\b\f\t\u000B\u001B"), "\"foo\\n\\r\\b\\f\\t\\u000B\\u001B\"", "string JSON" ); t.is( serializeJSON(null), "null", "null JSON"); try { serializeJSON(undefined); t.ok(false, "undefined should not be serializable"); } catch (e) { t.ok(e instanceof TypeError, "undefined not serializable"); } t.is( serializeJSON(1), "1", "1 JSON"); t.is( serializeJSON(1.23), "1.23", "1.23 JSON"); t.is( serializeJSON(serializeJSON), null, "function JSON (null, not string)" ); t.is( serializeJSON([1, "2", 3.3]), "[1, \"2\", 3.3]", "array JSON" ); var res = evalJSON(serializeJSON({"a":1, "b":2})); t.is( res.a, 1, "evalJSON on an object (1)" ); t.is( res.b, 2, "evalJSON on an object (2)" ); var res = {"a": 1, "b": 2, "json": function () { return this; }}; var res = evalJSON(serializeJSON(res)); t.is( res.a, 1, "evalJSON on an object that jsons self (1)" ); t.is( res.b, 2, "evalJSON on an object that jsons self (2)" ); var strJSON = {"a": 1, "b": 2, "json": function () { return "json"; }}; t.is( serializeJSON(strJSON), "\"json\"", "json serialization calling" ); t.is( serializeJSON([strJSON]), "[\"json\"]", "json serialization calling in a structure" ); t.is( evalJSON('/* {"result": 1} */').result, 1, "json comment stripping" ); t.is( evalJSON('/* {"*/ /*": 1} */')['*/ /*'], 1, "json comment stripping" ); registerJSON("isDateLike", isDateLike, function (d) { return "this was a date"; } ); t.is( serializeJSON(new Date()), "\"this was a date\"", "json registry" ); MochiKit.Base.jsonRegistry.unregister("isDateLike"); var a = {"foo": {"bar": 12, "wibble": 13}}; var b = {"foo": {"baz": 4, "bar": 16}, "bar": 4}; updatetree(a, b); var expect = [["bar", 16], ["baz", 4], ["wibble", 13]]; var got = items(a.foo); got.sort(compare); t.is( repr(got), repr(expect), "updatetree merge" ); t.is( a.bar, 4, "updatetree insert" ); var aa = {"foo": {"bar": 12, "wibble": 13}}; var bb = {"foo": {"baz": 4, "bar": 16}, "bar": 4}; cc = updatetree(null, aa, bb); got = items(cc.foo); got.sort(compare); t.is( repr(got), repr(expect), "updatetree merge (self is null)" ); t.is( cc.bar, 4, "updatetree insert (self is null)" ); cc = updatetree(undefined, aa, bb); got = items(cc.foo); got.sort(compare); t.is( repr(got), repr(expect), "updatetree merge (self is undefined)" ); t.is( cc.bar, 4, "updatetree insert (self is undefined)" ); var c = counter(); t.is( c(), 1, "counter starts at 1" ); t.is( c(), 2, "counter increases" ); c = counter(2); t.is( c(), 2, "counter starts at 2" ); t.is( c(), 3, "counter increases" ); t.is( findValue([1, 2, 3], 4), -1, "findValue returns -1 on not found"); t.is( findValue([1, 2, 3], 1), 0, "findValue returns correct index"); t.is( findValue([1, 2, 3], 1, 1), -1, "findValue honors start"); t.is( findValue([1, 2, 3], 2, 0, 1), -1, "findValue honors end"); t.is( findIdentical([1, 2, 3], 4), -1, "findIdentical returns -1"); t.is( findIdentical([1, 2, 3], 1), 0, "findIdentical returns correct index"); t.is( findIdentical([1, 2, 3], 1, 1), -1, "findIdentical honors start"); t.is( findIdentical([1, 2, 3], 2, 0, 1), -1, "findIdentical honors end"); var flat = flattenArguments(1, "2", 3, [4, [5, [6, 7], 8, [], 9]]); var expect = [1, "2", 3, 4, 5, 6, 7, 8, 9]; t.is( repr(flat), repr(expect), "flattenArguments" ); var fn = function () { return [this, concat(arguments)]; } t.is( methodcaller("toLowerCase")("FOO"), "foo", "methodcaller with a method name" ); t.is( repr(methodcaller(fn, 2, 3)(1)), "[1, [2, 3]]", "methodcaller with a function" ); var f1 = function (x) { return [1, x]; }; var f2 = function (x) { return [2, x]; }; var f3 = function (x) { return [3, x]; }; t.is( repr(f1(f2(f3(4)))), "[1, [2, [3, 4]]]", "test the compose test" ); t.is( repr(compose(f1,f2,f3)(4)), "[1, [2, [3, 4]]]", "three fn composition works" ); t.is( repr(compose(compose(f1,f2),f3)(4)), "[1, [2, [3, 4]]]", "associative left" ); t.is( repr(compose(f1,compose(f2,f3))(4)), "[1, [2, [3, 4]]]", "associative right" ); try { compose(f1, "foo"); t.ok( false, "wrong compose argument not raised!" ); } catch (e) { t.is( e.name, 'TypeError', "wrong compose argument raised correctly" ); } t.is(camelize('one'), 'one', 'one word'); t.is(camelize('one-two'), 'oneTwo', 'two words'); t.is(camelize('one-two-three'), 'oneTwoThree', 'three words'); t.is(camelize('1-one'), '1One', 'letter and word'); t.is(camelize('one-'), 'one', 'trailing hyphen'); t.is(camelize('-one'), 'One', 'starting hyphen'); t.is(camelize('o-two'), 'oTwo', 'one character and word'); var flat = flattenArray([1, "2", 3, [4, [5, [6, 7], 8, [], 9]]]); var expect = [1, "2", 3, 4, 5, 6, 7, 8, 9]; t.is( repr(flat), repr(expect), "flattenArray" ); /* mean */ try { mean(); t.ok( false, "mean no arguments didn't raise!" ); } catch (e) { t.is( e.name, 'TypeError', "no arguments raised correctly" ); } t.is( mean(1), 1, 'single argument (arg list)'); t.is( mean([1]), 1, 'single argument (array)'); t.is( mean(1,2,3), 2, 'three arguments (arg list)'); t.is( mean([1,2,3]), 2, 'three arguments (array)'); t.is( average(1), 1, 'test the average alias'); /* median */ try { median(); t.ok( false, "median no arguments didn't raise!" ); } catch (e) { t.is( e.name, 'TypeError', "no arguments raised correctly" ); } t.is( median(1), 1, 'single argument (arg list)'); t.is( median([1]), 1, 'single argument (array)'); t.is( median(3,1,2), 2, 'three arguments (arg list)'); t.is( median([3,1,2]), 2, 'three arguments (array)'); t.is( median(3,1,2,4), 2.5, 'four arguments (arg list)'); t.is( median([3,1,2,4]), 2.5, 'four arguments (array)'); /* #185 */ t.is( serializeJSON(parseQueryString("")), "{}", "parseQueryString('')" ); t.is( serializeJSON(parseQueryString("", true)), "{}", "parseQueryString('', true)" ); /* #109 */ t.is( queryString({ids: [1,2,3]}), "ids=1&ids=2&ids=3", "queryString array value" ); t.is( queryString({ids: "123"}), "ids=123", "queryString string value" ); /* test values */ var o = {a: 1, b: 2, c: 4, d: -1}; var got = values(o); got.sort(); t.is( repr(got), repr([-1, 1, 2, 4]), "values()" ); t.is( queryString([["foo", "bar"], ["baz", "wibble"]]), "foo=baz&bar=wibble" ); o = parseQueryString("foo=1=1=1&bar=2&baz&wibble="); t.is( o.foo, "1=1=1", "parseQueryString multiple = first" ); t.is( o.bar, "2", "parseQueryString multiple = second" ); t.is( o.baz, "", "parseQueryString multiple = third" ); t.is( o.wibble, "", "parseQueryString multiple = fourth" ); /* queryString with null values */ t.is( queryString(["a", "b"], [1, null]), "a=1", "queryString with null value" ); t.is( queryString({"a": 1, "b": null}), "a=1", "queryString with null value" ); var reprFunc = function (a, b) { return; } t.is( repr(reprFunc), "function (a, b) {...}", "repr of function" ); }; MochiKit-1.4.2/tests/SimpleTest/ 0000755 0001750 0001750 00000000000 11136470265 015537 5 ustar scott scott MochiKit-1.4.2/tests/SimpleTest/test.css 0000660 0001750 0001750 00000000563 11102215550 017215 0 ustar scott scott .test_ok { color: green; display: none; } .test_not_ok { color: red; display: block; } .test_ok, .test_not_ok { border-bottom-width: 2px; border-bottom-style: solid; border-bottom-color: black; } .all_pass { background-color: lime; } .some_fail { background-color: red; } .tests_report { border-width: 2px; border-style: solid; width: 20em; } MochiKit-1.4.2/tests/SimpleTest/SimpleTest.js 0000660 0001750 0001750 00000026417 11102215550 020161 0 ustar scott scott /** * SimpleTest, a partial Test.Simple/Test.More API compatible test library. * * Why? * * Test.Simple doesn't work on IE < 6. * TODO: * * Support the Test.Simple API used by MochiKit, to be able to test MochiKit * itself against IE 5.5 * **/ if (typeof(SimpleTest) == "undefined") { var SimpleTest = {}; } // Check to see if the TestRunner is present and has logging if (typeof(parent) != "undefined" && parent.TestRunner) { SimpleTest._logEnabled = parent.TestRunner.logEnabled; } SimpleTest._tests = []; SimpleTest._stopOnLoad = true; /** * Something like assert. */ SimpleTest.ok = function (condition, name, diag) { var test = {'result': !!condition, 'name': name, 'diag': diag || ""}; if (SimpleTest._logEnabled) { var msg = test.result ? "PASS" : "FAIL"; msg += " | " + test.name; if (test.result) { parent.TestRunner.logger.log(msg); } else { msg += " | " + test.diag; parent.TestRunner.logger.error(msg); } } SimpleTest._tests.push(test); }; /** * Roughly equivalent to ok(a==b, name) */ SimpleTest.is = function (a, b, name) { var repr = MochiKit.Base.repr; SimpleTest.ok(a == b, name, "got " + repr(a) + ", expected " + repr(b)); }; /** * Roughly equivalent to ok(compare(a,b)==0, name) */ SimpleTest.eq = function (a, b, name) { var repr = MochiKit.Base.repr; try { SimpleTest.ok(compare(a, b) == 0, name, "got " + repr(a) + ", expected " + repr(b)); } catch (e) { SimpleTest.ok(false, name, "exception in compare: " + repr(e)); } }; /** * Makes a test report, returns it as a DIV element. **/ SimpleTest.report = function () { var DIV = MochiKit.DOM.DIV; var passed = 0; var failed = 0; var results = MochiKit.Base.map( function (test) { var cls, msg; if (test.result) { passed++; cls = "test_ok"; msg = "ok - " + test.name; } else { failed++; cls = "test_not_ok"; msg = "not ok - " + test.name; if (test.diag != null && test.diag != "") { msg += ": " + test.diag; } } return DIV({"class": cls}, msg); }, SimpleTest._tests ); var summary_class = ((failed == 0) ? 'all_pass' : 'some_fail'); return DIV({'class': 'tests_report'}, DIV({'class': 'tests_summary ' + summary_class}, DIV({'class': 'tests_passed'}, "Passed: " + passed), DIV({'class': 'tests_failed'}, "Failed: " + failed)), results ); }; /** * Toggle element visibility **/ SimpleTest.toggle = function(el) { if (MochiKit.Style.getStyle(el, 'display') == 'block') { el.style.display = 'none'; } else { el.style.display = 'block'; } }; /** * Toggle visibility for divs with a specific class. **/ SimpleTest.toggleByClass = function (cls) { var elems = getElementsByTagAndClassName('div', cls); MochiKit.Base.map(SimpleTest.toggle, elems); }; /** * Shows the report in the browser **/ SimpleTest.showReport = function() { var togglePassed = A({'href': '#'}, "Toggle passed tests"); var toggleFailed = A({'href': '#'}, "Toggle failed tests"); togglePassed.onclick = partial(SimpleTest.toggleByClass, 'test_ok'); toggleFailed.onclick = partial(SimpleTest.toggleByClass, 'test_not_ok'); var body = document.getElementsByTagName("body")[0]; var firstChild = body.childNodes[0]; var addNode; if (firstChild) { addNode = function (el) { body.insertBefore(el, firstChild); }; } else { addNode = function (el) { body.appendChild(el) }; } addNode(togglePassed); addNode(SPAN(null, " ")); addNode(toggleFailed); addNode(SimpleTest.report()); }; /** * Tells SimpleTest to don't finish the test when the document is loaded, * useful for asynchronous tests. * * When SimpleTest.waitForExplicitFinish is called, * explicit SimpleTest.finish() is required. **/ SimpleTest.waitForExplicitFinish = function () { SimpleTest._stopOnLoad = false; }; /** * Talks to the TestRunner if being ran on a iframe and the parent has a * TestRunner object. **/ SimpleTest.talkToRunner = function () { if (typeof(parent) != "undefined" && parent.TestRunner) { parent.TestRunner.testFinished(document); } }; /** * Finishes the tests. This is automatically called, except when * SimpleTest.waitForExplicitFinish() has been invoked. **/ SimpleTest.finish = function () { SimpleTest.showReport(); SimpleTest.talkToRunner(); }; addLoadEvent(function() { if (SimpleTest._stopOnLoad) { SimpleTest.finish(); } }); // --------------- Test.Builder/Test.More isDeeply() ----------------- SimpleTest.DNE = {dne: 'Does not exist'}; SimpleTest.LF = "\r\n"; SimpleTest._isRef = function (object) { var type = typeof(object); return type == 'object' || type == 'function'; }; SimpleTest._deepCheck = function (e1, e2, stack, seen) { var ok = false; // Either they're both references or both not. var sameRef = !(!SimpleTest._isRef(e1) ^ !SimpleTest._isRef(e2)); if (e1 == null && e2 == null) { ok = true; } else if (e1 != null ^ e2 != null) { ok = false; } else if (e1 == SimpleTest.DNE ^ e2 == SimpleTest.DNE) { ok = false; } else if (sameRef && e1 == e2) { // Handles primitives and any variables that reference the same // object, including functions. ok = true; } else if (SimpleTest.isa(e1, 'Array') && SimpleTest.isa(e2, 'Array')) { ok = SimpleTest._eqArray(e1, e2, stack, seen); } else if (typeof e1 == "object" && typeof e2 == "object") { ok = SimpleTest._eqAssoc(e1, e2, stack, seen); } else { // If we get here, they're not the same (function references must // always simply rererence the same function). stack.push({ vals: [e1, e2] }); ok = false; } return ok; }; SimpleTest._eqArray = function (a1, a2, stack, seen) { // Return if they're the same object. if (a1 == a2) return true; // JavaScript objects have no unique identifiers, so we have to store // references to them all in an array, and then compare the references // directly. It's slow, but probably won't be much of an issue in // practice. Start by making a local copy of the array to as to avoid // confusing a reference seen more than once (such as [a, a]) for a // circular reference. for (var j = 0; j < seen.length; j++) { if (seen[j][0] == a1) { return seen[j][1] == a2; } } // If we get here, we haven't seen a1 before, so store it with reference // to a2. seen.push([ a1, a2 ]); var ok = true; // Only examines enumerable attributes. Only works for numeric arrays! // Associative arrays return 0. So call _eqAssoc() for them, instead. var max = a1.length > a2.length ? a1.length : a2.length; if (max == 0) return SimpleTest._eqAssoc(a1, a2, stack, seen); for (var i = 0; i < max; i++) { var e1 = i > a1.length - 1 ? SimpleTest.DNE : a1[i]; var e2 = i > a2.length - 1 ? SimpleTest.DNE : a2[i]; stack.push({ type: 'Array', idx: i, vals: [e1, e2] }); if (ok = SimpleTest._deepCheck(e1, e2, stack, seen)) { stack.pop(); } else { break; } } return ok; }; SimpleTest._eqAssoc = function (o1, o2, stack, seen) { // Return if they're the same object. if (o1 == o2) return true; // JavaScript objects have no unique identifiers, so we have to store // references to them all in an array, and then compare the references // directly. It's slow, but probably won't be much of an issue in // practice. Start by making a local copy of the array to as to avoid // confusing a reference seen more than once (such as [a, a]) for a // circular reference. seen = seen.slice(0); for (var j = 0; j < seen.length; j++) { if (seen[j][0] == o1) { return seen[j][1] == o2; } } // If we get here, we haven't seen o1 before, so store it with reference // to o2. seen.push([ o1, o2 ]); // They should be of the same class. var ok = true; // Only examines enumerable attributes. var o1Size = 0; for (var i in o1) o1Size++; var o2Size = 0; for (var i in o2) o2Size++; var bigger = o1Size > o2Size ? o1 : o2; for (var i in bigger) { var e1 = o1[i] == undefined ? SimpleTest.DNE : o1[i]; var e2 = o2[i] == undefined ? SimpleTest.DNE : o2[i]; stack.push({ type: 'Object', idx: i, vals: [e1, e2] }); if (ok = SimpleTest._deepCheck(e1, e2, stack, seen)) { stack.pop(); } else { break; } } return ok; }; SimpleTest._formatStack = function (stack) { var variable = '$Foo'; for (var i = 0; i < stack.length; i++) { var entry = stack[i]; var type = entry['type']; var idx = entry['idx']; if (idx != null) { if (/^\d+$/.test(idx)) { // Numeric array index. variable += '[' + idx + ']'; } else { // Associative array index. idx = idx.replace("'", "\\'"); variable += "['" + idx + "']"; } } } var vals = stack[stack.length-1]['vals'].slice(0, 2); var vars = [ variable.replace('$Foo', 'got'), variable.replace('$Foo', 'expected') ]; var out = "Structures begin differing at:" + SimpleTest.LF; for (var i = 0; i < vals.length; i++) { var val = vals[i]; if (val == null) { val = 'undefined'; } else { val == SimpleTest.DNE ? "Does not exist" : "'" + val + "'"; } } out += vars[0] + ' = ' + vals[0] + SimpleTest.LF; out += vars[1] + ' = ' + vals[1] + SimpleTest.LF; return ' ' + out; }; SimpleTest.isDeeply = function (it, as, name) { var ok; // ^ is the XOR operator. if (SimpleTest._isRef(it) ^ SimpleTest._isRef(as)) { // One's a reference, one isn't. ok = false; } else if (!SimpleTest._isRef(it) && !SimpleTest._isRef(as)) { // Neither is an object. ok = SimpleTest.is(it, as, name); } else { // We have two objects. Do a deep comparison. var stack = [], seen = []; if ( SimpleTest._deepCheck(it, as, stack, seen)) { ok = SimpleTest.ok(true, name); } else { ok = SimpleTest.ok(false, name, SimpleTest._formatStack(stack)); } } return ok; }; SimpleTest.typeOf = function (object) { var c = Object.prototype.toString.apply(object); var name = c.substring(8, c.length - 1); if (name != 'Object') return name; // It may be a non-core class. Try to extract the class name from // the constructor function. This may not work in all implementations. if (/function ([^(\s]+)/.test(Function.toString.call(object.constructor))) { return RegExp.$1; } // No idea. :-( return name; }; SimpleTest.isa = function (object, clas) { return SimpleTest.typeOf(object) == clas; }; // Global symbols: var ok = SimpleTest.ok; var is = SimpleTest.is; var isDeeply = SimpleTest.isDeeply; MochiKit-1.4.2/tests/SimpleTest/TestRunner.js 0000660 0001750 0001750 00000010612 11102215550 020167 0 ustar scott scott /** * TestRunner: A test runner for SimpleTest * TODO: * * * Avoid moving iframes: That causes reloads on mozilla and opera. * * **/ var TestRunner = {}; TestRunner.logEnabled = false; TestRunner._iframes = {}; TestRunner._iframeDocuments = {}; TestRunner._iframeRows = {}; TestRunner._currentTest = 0; TestRunner._urls = []; TestRunner._testsDiv = DIV(); TestRunner._progressDiv = DIV(); TestRunner._summaryDiv = DIV(null, H1(null, "Tests Summary"), TABLE(null, THEAD(null, TR(null, TH(null, "Test"), TH(null, "Passed"), TH(null, "Failed") ) ), TBODY() ) ); /** * This function is called after generating the summary. **/ TestRunner.onComplete = null; /** * If logEnabled is true, this is the logger that will be used. **/ TestRunner.logger = MochiKit.Logging.logger; /** * Toggle element visibility **/ TestRunner._toggle = function(el) { if (el.className == "noshow") { el.className = ""; el.style.cssText = ""; } else { el.className = "noshow"; el.style.cssText = "width:0px; height:0px; border:0px;"; } }; /** * Creates the iframe that contains a test **/ TestRunner._makeIframe = function (url) { var iframe = document.createElement('iframe'); iframe.src = url; iframe.name = url; iframe.width = "500"; var tbody = TestRunner._summaryDiv.getElementsByTagName("tbody")[0]; var tr = TR(null, TD({'colspan': '3'}, iframe)); iframe._row = tr; tbody.appendChild(tr); return iframe; }; /** * TestRunner entry point. * * The arguments are the URLs of the test to be ran. * **/ TestRunner.runTests = function (/*url...*/) { if (TestRunner.logEnabled) TestRunner.logger.log("SimpleTest START"); var body = document.getElementsByTagName("body")[0]; appendChildNodes(body, TestRunner._testsDiv, TestRunner._progressDiv, TestRunner._summaryDiv ); for (var i = 0; i < arguments.length; i++) { TestRunner._urls.push(arguments[i]); } TestRunner.runNextTest(); }; /** * Run the next test. If no test remains, calls makeSummary **/ TestRunner.runNextTest = function() { if (TestRunner._currentTest < TestRunner._urls.length) { var url = TestRunner._urls[TestRunner._currentTest]; var progress = SPAN(null, "Running ", A({href:url}, url), "..." ); if (TestRunner.logEnabled) TestRunner.logger.log(scrapeText(progress)); TestRunner._progressDiv.appendChild(progress); TestRunner._iframes[url] = TestRunner._makeIframe(url); } else { TestRunner.makeSummary(); if (TestRunner.onComplete) TestRunner.onComplete(); } }; /** * This stub is called by SimpleTest when a test is finished. **/ TestRunner.testFinished = function (doc) { appendChildNodes(TestRunner._progressDiv, SPAN(null, "Done"), BR()); var finishedURL = TestRunner._urls[TestRunner._currentTest]; if (TestRunner.logEnabled) TestRunner.logger.debug("SimpleTest finished " + finishedURL); TestRunner._iframeDocuments[finishedURL] = doc; // TestRunner._iframes[finishedURL].style.display = "none"; TestRunner._toggle(TestRunner._iframes[finishedURL]); TestRunner._currentTest++; TestRunner.runNextTest(); }; /** * Display the summary in the browser **/ TestRunner.makeSummary = function() { if (TestRunner.logEnabled) TestRunner.logger.log("SimpleTest FINISHED"); var rows = []; for (var url in TestRunner._iframeDocuments) { var doc = TestRunner._iframeDocuments[url]; var nOK = withDocument(doc, partial(getElementsByTagAndClassName, 'div', 'test_ok') ).length; var nNotOK = withDocument(doc, partial(getElementsByTagAndClassName, 'div', 'test_not_ok') ).length; var toggle = partial(TestRunner._toggle, TestRunner._iframes[url]); var jsurl = "TestRunner._toggle(TestRunner._iframes['" + url + "'])"; var row = TR( {'style': {'backgroundColor': nNotOK > 0 ? "#f00":"#0f0"}}, TD(null, url), TD(null, nOK), TD(null, nNotOK) ); row.onclick = toggle; var tbody = TestRunner._summaryDiv.getElementsByTagName("tbody")[0]; tbody.insertBefore(row, TestRunner._iframes[url]._row) } }; MochiKit-1.4.2/tests/test_MochiKit-Visual.html 0000660 0001750 0001750 00000014331 11113647642 020343 0 ustar scott scott
MochiKit-1.4.2/tests/test_MochiKit-Format.html 0000660 0001750 0001750 00000002100 11113647642 020317 0 ustar scott scott
MochiKit-1.4.2/tests/FakeJSAN.js 0000660 0001750 0001750 00000002032 11102215552 015306 0 ustar scott scott var JSAN = { global: this, use: function (module, symbols) { var components = module.split(/\./); var fn = components.join('/') + '.js'; var o = JSAN.global; var i, c; for (i = 0; i < components.length; i++) { o = o[components[i]]; if (typeof(o) == 'undefined') { break; } } if (typeof(o) != 'undefined') { return o; } load(fn); o = JSAN.global; for (i = 0; i < components.length; i++) { o = o[components[i]]; if (typeof(o) == 'undefined') { return undefined; } } if (!symbols) { var tags = o.EXPORT_TAGS; if (tags) { symbols = tags[':common'] || tags[':all']; } } if (symbols) { for (i = 0; i < symbols.length; i++) { c = symbols[i]; JSAN.global[c] = o[c]; } } return o; } }; MochiKit-1.4.2/tests/cli.js 0000660 0001750 0001750 00000000263 11102215552 014537 0 ustar scott scott MochiKit = {__export__: true}; load('tests/FakeJSAN.js') JSAN.use('MochiKit.MockDOM'); var window = this; var document = MochiKit.MockDOM.document; JSAN.use('MochiKit.MochiKit'); MochiKit-1.4.2/tests/test_MochiKit-JSAN.html 0000660 0001750 0001750 00000001371 11113647642 017633 0 ustar scott scott
MochiKit-1.4.2/tests/test_MochiKit-DOM-Safari.html 0000660 0001750 0001750 00000002600 11113647642 020716 0 ustar scott scott
MochiKit-1.4.2/tests/standalone.js 0000660 0001750 0001750 00000000651 11102215552 016121 0 ustar scott scott load('tests/cli.js'); JSAN.use('MochiKit.Test'); print("[[ MochiKit.Base ]]"); runTests('tests.test_Base'); print("[[ MochiKit.Color ]]"); runTests('tests.test_Color'); print("[[ MochiKit.DateTime ]]"); runTests('tests.test_DateTime'); print("[[ MochiKit.Format ]]"); runTests('tests.test_Format'); print("[[ MochiKit.Iter ]]"); runTests('tests.test_Iter'); print("[[ MochiKit.Logging ]]"); runTests('tests.test_Logging'); MochiKit-1.4.2/tests/test_MochiKit-Async.json 0000660 0001750 0001750 00000000021 11102215552 020136 0 ustar scott scott {"passed": true} MochiKit-1.4.2/tests/test_DragAndDrop.js 0000660 0001750 0001750 00000002303 11102215552 017151 0 ustar scott scott if (typeof(dojo) != 'undefined') { dojo.require('MochiKit.Signal'); } if (typeof(JSAN) != 'undefined') { JSAN.use('MochiKit.Signal'); } if (typeof(tests) == 'undefined') { tests = {}; } tests.test_DragAndDrop = function (t) { var drag1 = new MochiKit.DragAndDrop.Draggable('drag1', {'revert': true, 'ghosting': true}); var drop1 = new MochiKit.DragAndDrop.Droppable('drop1', {'hoverclass': 'drop-hover'}); drop1.activate(); t.is(hasElementClass('drop1', 'drop-hover'), true, "hoverclass ok"); drop1.deactivate(); t.is(hasElementClass('drop1', 'drop-hover'), false, "remove hoverclass ok"); drop1.destroy(); t.is( isEmpty(MochiKit.DragAndDrop.Droppables.drops), true, "Unregister droppable ok"); var onhover = function (element) { t.is(element, getElement('drag1'), 'onhover ok'); }; var drop2 = new MochiKit.DragAndDrop.Droppable('drop1', {'onhover': onhover}); var pos = getElementPosition('drop1'); pos = {"x": pos.x + 5, "y": pos.y + 5}; MochiKit.DragAndDrop.Droppables.show({"page": pos}, getElement('drag1')); drag1.destroy(); t.is( isEmpty(MochiKit.DragAndDrop.Draggables.drops), true, "Unregister draggable ok"); }; MochiKit-1.4.2/tests/test_Logging.js 0000660 0001750 0001750 00000006262 11102215552 016422 0 ustar scott scott if (typeof(dojo) != 'undefined') { dojo.require('MochiKit.Logging'); } if (typeof(JSAN) != 'undefined') { JSAN.use('MochiKit.Logging'); } if (typeof(tests) == 'undefined') { tests = {}; } tests.test_Logging = function (t) { // just in case logger.clear(); t.is( logLevelAtLeast('DEBUG')('INFO'), false, 'logLevelAtLeast false' ); t.is( logLevelAtLeast('WARNING')('INFO'), false, 'logLevelAtLeast true' ); t.ok( logger instanceof Logger, "global logger installed" ); var allMessages = []; logger.addListener("allMessages", null, bind(allMessages.push, allMessages)); var fatalMessages = []; logger.addListener("fatalMessages", "FATAL", bind(fatalMessages.push, fatalMessages)); var firstTwo = []; logger.addListener("firstTwo", null, bind(firstTwo.push, firstTwo)); log("foo"); var msgs = logger.getMessages(); t.is( msgs.length, 1, 'global log() put one message in queue' ); t.is( compare(allMessages, msgs), 0, "allMessages listener" ); var msg = msgs.pop(); t.is( compare(msg.info, ["foo"]), 0, "info matches" ); t.is( msg.level, "INFO", "level matches" ); logDebug("debugFoo"); t.is( msgs.length, 0, 'getMessages() returns copy' ); msgs = logger.getMessages(); t.is( compare(allMessages, msgs), 0, "allMessages listener" ); t.is( msgs.length, 2, 'logDebug()' ); msg = msgs.pop(); t.is( compare(msg.info, ["debugFoo"]), 0, "info matches" ); t.is( msg.level, "DEBUG", "level matches" ); logger.removeListener("firstTwo"); logError("errorFoo"); msgs = logger.getMessages(); t.is( compare(allMessages, msgs), 0, "allMessages listener" ); t.is( msgs.length, 3, 'logError()' ); msg = msgs.pop(); t.is( compare(msg.info, ["errorFoo"]), 0, "info matches" ); t.is( msg.level, "ERROR", "level matches" ); logWarning("warningFoo"); msgs = logger.getMessages(); t.is( compare(allMessages, msgs), 0, "allMessages listener" ); t.is( msgs.length, 4, 'logWarning()' ); msg = msgs.pop(); t.is( compare(msg.info, ["warningFoo"]), 0, "info matches" ); t.is( msg.level, "WARNING", "level matches" ); logFatal("fatalFoo"); msgs = logger.getMessages(); t.is( compare(allMessages, msgs), 0, "allMessages listener" ); t.is( msgs.length, 5, 'logFatal()' ); msg = msgs.pop(); t.is( compare(fatalMessages, [msg]), 0, "fatalMessages listener" ); t.is( compare(msg.info, ["fatalFoo"]), 0, "info matches" ); t.is( msg.level, "FATAL", "level matches" ); msgs = logger.getMessages(1); t.is( compare(fatalMessages, msgs), 0, "getMessages with limit returns latest" ); logger.removeListener("allMessages"); logger.removeListener("fatalMessages"); t.is( compare(firstTwo, logger.getMessages().slice(0, 2)), 0, "firstTwo" ); logger.clear(); msgs = logger.getMessages(); t.is(msgs.length, 0, "clear removes existing messages"); logger.baseLog(LogLevel.INFO, 'infoFoo'); msg = logger.getMessages().pop(); t.is(msg.level, "INFO", "baseLog converts level") logger.baseLog(45, 'errorFoo'); msg = logger.getMessages().pop(); t.is(msg.level, "ERROR", "baseLog converts ad-hoc level") }; MochiKit-1.4.2/tests/test_Format.js 0000660 0001750 0001750 00000011553 11102215552 016263 0 ustar scott scott if (typeof(dojo) != 'undefined') { dojo.require('MochiKit.Format'); } if (typeof(JSAN) != 'undefined') { JSAN.use('MochiKit.Format'); } if (typeof(tests) == 'undefined') { tests = {}; } tests.test_Format = function (t) { t.is( truncToFixed(0.1234, 3), "0.123", "truncToFixed truncate" ); t.is( truncToFixed(0.12, 3), "0.120", "truncToFixed trailing zeros" ); t.is( truncToFixed(0.15, 1), "0.1", "truncToFixed no round" ); t.is( truncToFixed(0.15, 0), "0", "truncToFixed zero (edge case)" ); t.is( truncToFixed(568.80, 2), "568.80", "truncToFixed 568.80, floating-point error" ); t.is( truncToFixed(1.23e+20, 2), "123000000000000000000.00", "truncToFixed 1.23e+20" ); t.is( truncToFixed(-1.23e+20, 2), "-123000000000000000000.00", "truncToFixed -1.23e+20" ); t.is( truncToFixed(1.23e-10, 2), "0.00", "truncToFixed 1.23e-10" ); t.is( roundToFixed(0.1234, 3), "0.123", "roundToFixed truncate" ); t.is( roundToFixed(0.12, 3), "0.120", "roundToFixed trailing zeros" ); t.is( roundToFixed(0.15, 1), "0.2", "roundToFixed round" ); t.is( roundToFixed(0.15, 0), "0", "roundToFixed zero (edge case)" ); t.is( roundToFixed(568.80, 2), "568.80", "roundToFixed 568.80, floating-point error" ); t.is( twoDigitFloat(-0.1234), "-0.12", "twoDigitFloat -0.1234 correct"); t.is( twoDigitFloat(-0.1), "-0.1", "twoDigitFloat -0.1 correct"); t.is( twoDigitFloat(-0), "0", "twoDigitFloat -0 correct"); t.is( twoDigitFloat(0), "0", "twoDigitFloat 0 correct"); t.is( twoDigitFloat(1), "1", "twoDigitFloat 1 correct"); t.is( twoDigitFloat(1.0), "1", "twoDigitFloat 1.0 correct"); t.is( twoDigitFloat(1.2), "1.2", "twoDigitFloat 1.2 correct"); t.is( twoDigitFloat(1.234), "1.23", "twoDigitFloat 1.234 correct"); t.is( twoDigitFloat(0.23), "0.23", "twoDigitFloat 0.23 correct"); t.is( twoDigitFloat(0.01), "0.01", "twoDigitFloat 0.01 correct"); t.is( twoDigitFloat(568.80), "568.8", "twoDigitFloat, floating-point error"); t.is( percentFormat(123), "12300%", "percentFormat 123 correct"); t.is( percentFormat(1.23), "123%", "percentFormat 123 correct"); t.is( twoDigitAverage(1, 0), "0", "twoDigitAverage dbz correct"); t.is( twoDigitAverage(1, 1), "1", "twoDigitAverage 1 correct"); t.is( twoDigitAverage(1, 10), "0.1", "twoDigitAverage .1 correct"); function reprIs(a, b) { arguments[0] = repr(a); arguments[1] = repr(b); t.is.apply(this, arguments); } reprIs( lstrip("\r\t\n foo \n\t\r"), "foo \n\t\r", "lstrip whitespace chars" ); reprIs( rstrip("\r\t\n foo \n\t\r"), "\r\t\n foo", "rstrip whitespace chars" ); reprIs( strip("\r\t\n foo \n\t\r"), "foo", "strip whitespace chars" ); reprIs( lstrip("\r\n\t \r", "\r"), "\n\t \r", "lstrip custom chars" ); reprIs( rstrip("\r\n\t \r", "\r"), "\r\n\t ", "rstrip custom chars" ); reprIs( strip("\r\n\t \r", "\r"), "\n\t ", "strip custom chars" ); var nf = numberFormatter("$###,###.00 footer"); t.is( nf(1000.1), "$1,000.10 footer", "trailing zeros" ); t.is( nf(1000000.1), "$1,000,000.10 footer", "two seps" ); t.is( nf(100), "$100.00 footer", "shorter than sep" ); t.is( nf(100.555), "$100.56 footer", "rounding" ); t.is( nf(-100.555), "$-100.56 footer", "default neg" ); nf = numberFormatter("-$###,###.00"); t.is( nf(-100.555), "-$100.56", "custom neg" ); nf = numberFormatter("0000.0000"); t.is( nf(0), "0000.0000", "leading and trailing" ); t.is( nf(1.1), "0001.1000", "leading and trailing" ); t.is( nf(12345.12345), "12345.1235", "no need for leading/trailing" ); nf = numberFormatter("0000.0000"); t.is( nf("taco"), "", "default placeholder" ); nf = numberFormatter("###,###.00", "foo", "de_DE"); t.is( nf("taco"), "foo", "custom placeholder" ); t.is( nf(12345.12345), "12.345,12", "de_DE locale" ); nf = numberFormatter("#%"); t.is( nf(1), "100%", "trivial percent" ); t.is( nf(0.55), "55%", "percent" ); var customLocale = { separator: " apples and ", decimal: " bagels at ", percent: "am for breakfast"}; var customFormatter = numberFormatter("###,###.0%", "No breakfast", customLocale); t.is( customFormatter(23.458), "2 apples and 345 bagels at 8am for breakfast", "custom locale" ); nf = numberFormatter("###,###"); t.is( nf(123), "123", "large number format" ); t.is( nf(1234), "1,234", "large number format" ); t.is( nf(12345), "12,345", "large number format" ); t.is( nf(123456), "123,456", "large number format" ); t.is( nf(1234567), "1,234,567", "large number format" ); t.is( nf(12345678), "12,345,678", "large number format" ); t.is( nf(123456789), "123,456,789", "large number format" ); t.is( nf(1234567890), "1,234,567,890", "large number format" ); t.is( nf(12345678901), "12,345,678,901", "large number format" ); t.is( nf(123456789012), "123,456,789,012", "large number format" ); }; MochiKit-1.4.2/tests/test_MochiKit-DOM.html 0000660 0001750 0001750 00000040066 11113647642 017523 0 ustar scott scott
MochiKit-1.4.2/tests/test_MochiKit-DragAndDrop.html 0000660 0001750 0001750 00000003102 11113647642 021217 0 ustar scott scott
MochiKit-1.4.2/doc/ 0000755 0001750 0001750 00000000000 11136470264 013050 5 ustar scott scott MochiKit-1.4.2/doc/js/ 0000755 0001750 0001750 00000000000 11136470264 013464 5 ustar scott scott MochiKit-1.4.2/doc/js/toc.js 0000660 0001750 0001750 00000007135 11102215564 014604 0 ustar scott scott function function_ref(fn) { return A({"href": fn[1], "class": "mochiref reference"}, fn[0], BR()); }; function toggle_docs() { toggleElementClass("invisible", "show_index", "function_index"); return false; }; function create_toc() { if (getElement("distribution")) { return global_index(); } if (getElement("api-reference")) { return module_index(); } }; function doXHTMLRequest(url) { var d = doXHR(url, {mimeType: 'text/xml'}); return d.addCallback(function (res) { if (res.responseXML.documentElement) { return res.responseXML.documentElement; } else { var container = document.createElement('div'); container.innerHTML = res.responseText; return container; } }); }; function load_request(href, div, doc) { var functions = withDocument(doc, spider_doc); forEach(functions, function (func) { // fix anchors if (func[1].charAt(0) == "#") { func[1] = href + func[1]; } else if (func[1].lastIndexOf("#") != -1) { func[1] = href + "#" + func[1].split("#")[1]; } }); var showLink = A({"class": "force-pointer"}, "[+]"); var hideLink = A({"class": "force-pointer"}, "[\u2013]"); var functionIndex = DIV({"id": "function_index", "class": "invisible"}, hideLink, P(null, map(function_ref, functions)) ); var toggleFunc = function (e) { toggleElementClass("invisible", showLink, functionIndex); }; connect(showLink, "onclick", toggleFunc); connect(hideLink, "onclick", toggleFunc); replaceChildNodes(div, showLink, functionIndex ); return [showLink, toggleFunc]; }; function global_index() { var distList = getElementsByTagAndClassName("ul")[0]; var bullets = getElementsByTagAndClassName("li", null, distList); var lst = []; for (var i = 0; i < bullets.length; i++) { var tag = bullets[i]; var firstLink = getElementsByTagAndClassName("a", "mochiref", tag)[0]; var href = getNodeAttribute(firstLink, "href"); var div = DIV(null, "[\u2026]"); appendChildNodes(tag, BR(), div); lst.push(doXHTMLRequest(href).addCallback(load_request, href, div)); } var loadingNode = DIV(null, "[loading index\u2026]"); distList.parentNode.insertBefore(P(null, loadingNode), distList); var dl = gatherResults(lst).addCallback(function (res) { var toggleFunc = function (e) { for (var i = 0; i < res.length; i++) { var item = res[i]; if (!hasElementClass(item[0], "invisible")) { item[1](); } } }; var node = A({"class": "force-pointer"}, "[click to expand all]"); swapDOM(loadingNode, node); connect(node, "onclick", toggleFunc); }); }; function spider_doc() { return map( function (tag) { return [scrapeText(tag), getNodeAttribute(tag, "href")]; }, getElementsByTagAndClassName("a", "mochidef") ); }; function module_index() { var sections = getElementsByTagAndClassName("div", "section"); var ptr = sections[1]; var ref = DIV({"class": "section"}, H1(null, "Function Index"), A({"id": "show_index", "href": "#", "onclick": toggle_docs}, "[show]"), DIV({"id": "function_index", "class": "invisible"}, A({"href":"#", "onclick": toggle_docs}, "[hide]"), P(null, map(function_ref, spider_doc())))); ptr.parentNode.insertBefore(ref, ptr); }; connect(window, 'onload', create_toc); MochiKit-1.4.2/doc/rst/ 0000755 0001750 0001750 00000000000 11136470264 013660 5 ustar scott scott MochiKit-1.4.2/doc/rst/MochiKit/ 0000755 0001750 0001750 00000000000 11136470264 015367 5 ustar scott scott MochiKit-1.4.2/doc/rst/MochiKit/Async.rst 0000660 0001750 0001750 00000057150 11102215564 017175 0 ustar scott scott .. title:: MochiKit.Async - manage asynchronous tasks Name ==== MochiKit.Async - manage asynchronous tasks Synopsis ======== :: var url = "/src/b/bo/bob/MochiKit.Async/META.json"; /* META.json looks something like this: {"name": "MochiKit", "version": "0.5"} */ var d = loadJSONDoc(url); var gotMetadata = function (meta) { if (MochiKit.Async.VERSION == meta.version) { alert("You have the newest MochiKit.Async!"); } else { alert("MochiKit.Async " + meta.version + " is available, upgrade!"); } }; var metadataFetchFailed = function (err) { alert("The metadata for MochiKit.Async could not be fetched :("); }; d.addCallbacks(gotMetadata, metadataFetchFailed); Description =========== MochiKit.Async provides facilities to manage asynchronous (as in AJAX [1]_) tasks. The model for asynchronous computation used in this module is heavily inspired by Twisted [2]_. Dependencies ============ - :mochiref:`MochiKit.Base` Security Concerns ================= The current implementation of evalJSONRequest does no input validation. Invalid JSON can execute arbitrary JavaScript code in the client. This isn't normally a concern because of the same-origin policy in web browsers; the server is already sending arbitrary code to the client (your program!). While this isn't directly relevant to MochiKit, server-side code that produces JSON should consider potential cross-site request forgery. Currently known exploits require a JSON array to be the outer-most object, and the data to be leaked must be known keys in objects contained by that array:: [{"some_known_key": "this can be leaked"}, "but not this"] This exploit does not apply to the most common usage of JSON, sending an object:: {"some_known_key": "this can't be leaked"} There are several ways to avoid this, here are a few: * Use some non-standard addition to JSON that adds constructs to prevent script tag parsing, such as wrapping the data in a comment or an infinite loop. MochiKit supports comment-wrapped JSON, but it's up to the server to send it that way. * Require some kind of authentication token in the URL. * Allow only POST requests to access sensitive JSON. * Only send JSON objects, not arrays. JSON objects aren't valid JavaScript syntax on their own without parentheses. Overview ======== Deferred -------- The Deferred constructor encapsulates a single value that is not available yet. The most important example of this in the context of a web browser would be an ``XMLHttpRequest`` to a server. The importance of the Deferred is that it allows a consistent API to be exposed for all asynchronous computations that occur exactly once. The producer of the Deferred is responsible for doing all of the complicated work behind the scenes. This often means waiting for a timer to fire, or waiting for an event (e.g. ``onreadystatechange`` of ``XMLHttpRequest``). It could also be coordinating several events (e.g. ``XMLHttpRequest`` with a timeout, or several Deferreds (e.g. fetching a set of XML documents that should be processed at the same time). Since these sorts of tasks do not respond immediately, the producer of the Deferred does the following steps before returning to the consumer: 1. Create a ``new`` :mochiref:`Deferred();` object and keep a reference to it, because it will be needed later when the value is ready. 2. Setup the conditions to create the value requested (e.g. create a new ``XMLHttpRequest``, set its ``onreadystatechange``). 3. Return the :mochiref:`Deferred` object. Since the value is not yet ready, the consumer attaches a function to the Deferred that will be called when the value is ready. This is not unlike ``setTimeout``, or other similar facilities you may already be familiar with. The consumer can also attach an "errback" to the :mochiref:`Deferred`, which is a callback for error handling. When the value is ready, the producer simply calls ``myDeferred.callback(theValue)``. If an error occurred, it should call ``myDeferred.errback(theValue)`` instead. As soon as this happens, the callback that the consumer attached to the :mochiref:`Deferred` is called with ``theValue`` as the only argument. There are quite a few additional "advanced" features baked into :mochiref:`Deferred`, such as cancellation and callback chains, so take a look at the API reference if you would like to know more! API Reference ============= Errors ------ :mochidef:`AlreadyCalledError`: Thrown by a :mochiref:`Deferred` if ``.callback`` or ``.errback`` are called more than once. *Availability*: Available in MochiKit 1.3.1+ :mochidef:`BrowserComplianceError`: Thrown when the JavaScript runtime is not capable of performing the given function. Currently, this happens if the browser does not support ``XMLHttpRequest``. *Availability*: Available in MochiKit 1.3.1+ :mochidef:`CancelledError`: Thrown by a :mochiref:`Deferred` when it is cancelled, unless a canceller is present and throws something else. *Availability*: Available in MochiKit 1.3.1+ :mochidef:`GenericError`: Results passed to ``.fail`` or ``.errback`` of a :mochiref:`Deferred` are wrapped by this ``Error`` if ``!(result instanceof Error)``. *Availability*: Available in MochiKit 1.3.1+ :mochidef:`XMLHttpRequestError`: Thrown when an ``XMLHttpRequest`` does not complete successfully for any reason. The ``req`` property of the error is the failed ``XMLHttpRequest`` object, and for convenience the ``number`` property corresponds to ``req.status``. *Availability*: Available in MochiKit 1.3.1+ Constructors ------------ :mochidef:`Deferred()`: Encapsulates a sequence of callbacks in response to a value that may not yet be available. This is modeled after the Deferred class from Twisted [3]_. .. _`Twisted`: http://twistedmatrix.com/ Why do we want this? JavaScript has no threads, and even if it did, threads are hard. Deferreds are a way of abstracting non-blocking events, such as the final response to an ``XMLHttpRequest``. The sequence of callbacks is internally represented as a list of 2-tuples containing the callback/errback pair. For example, the following call sequence:: var d = new Deferred(); d.addCallback(myCallback); d.addErrback(myErrback); d.addBoth(myBoth); d.addCallbacks(myCallback, myErrback); is translated into a :mochiref:`Deferred` with the following internal representation:: [ [myCallback, null], [null, myErrback], [myBoth, myBoth], [myCallback, myErrback] ] The :mochiref:`Deferred` also keeps track of its current status (fired). Its status may be one of the following three values: ===== ================================ Value Condition ===== ================================ -1 no value yet (initial condition) 0 success 1 error ===== ================================ A :mochiref:`Deferred` will be in the error state if one of the following conditions are met: 1. The result given to callback or errback is "``instanceof Error``" 2. The callback or errback threw while executing. If the thrown object is not ``instanceof Error``, it will be wrapped with :mochiref:`GenericError`. Otherwise, the :mochiref:`Deferred` will be in the success state. The state of the :mochiref:`Deferred` determines the next element in the callback sequence to run. When a callback or errback occurs with the example deferred chain, something equivalent to the following will happen (imagine that exceptions are caught and returned as-is):: // d.callback(result) or d.errback(result) if (!(result instanceof Error)) { result = myCallback(result); } if (result instanceof Error) { result = myErrback(result); } result = myBoth(result); if (result instanceof Error) { result = myErrback(result); } else { result = myCallback(result); } The result is then stored away in case another step is added to the callback sequence. Since the :mochiref:`Deferred` already has a value available, any new callbacks added will be called immediately. There are two other "advanced" details about this implementation that are useful: Callbacks are allowed to return :mochiref:`Deferred` instances, so you can build complicated sequences of events with (relative) ease. The creator of the :mochiref:`Deferred` may specify a canceller. The canceller is a function that will be called if :mochiref:`Deferred.prototype.cancel` is called before the :mochiref:`Deferred` fires. You can use this to allow an ``XMLHttpRequest`` to be cleanly cancelled, for example. Note that cancel will fire the :mochiref:`Deferred` with a :mochiref:`CancelledError` (unless your canceller throws or returns a different ``Error``), so errbacks should be prepared to handle that ``Error`` gracefully for cancellable :mochiref:`Deferred` instances. *Availability*: Available in MochiKit 1.3.1+ :mochidef:`Deferred.prototype.addBoth(func)`: Add the same function as both a callback and an errback as the next element on the callback sequence. This is useful for code that you want to guarantee to run, e.g. a finalizer. If additional arguments are given, then ``func`` will be replaced with :mochiref:`MochiKit.Base.partial.apply(null, arguments)`. This differs from `Twisted`_, because the result of the callback or errback will be the *last* argument passed to ``func``. If ``func`` returns a :mochiref:`Deferred`, then it will be chained (its value or error will be passed to the next callback). Note that once the returned ``Deferred`` is chained, it can no longer accept new callbacks. *Availability*: Available in MochiKit 1.3.1+ :mochidef:`Deferred.prototype.addCallback(func[, ...])`: Add a single callback to the end of the callback sequence. If additional arguments are given, then ``func`` will be replaced with :mochiref:`MochiKit.Base.partial.apply(null, arguments)`. This differs from `Twisted`_, because the result of the callback will be the *last* argument passed to ``func``. If ``func`` returns a :mochiref:`Deferred`, then it will be chained (its value or error will be passed to the next callback). Note that once the returned ``Deferred`` is chained, it can no longer accept new callbacks. *Availability*: Available in MochiKit 1.3.1+ :mochidef:`Deferred.prototype.addCallbacks(callback, errback)`: Add separate callback and errback to the end of the callback sequence. Either callback or errback may be ``null``, but not both. If ``callback`` or ``errback`` returns a :mochiref:`Deferred`, then it will be chained (its value or error will be passed to the next callback). Note that once the returned ``Deferred`` is chained, it can no longer accept new callbacks. *Availability*: Available in MochiKit 1.3.1+ :mochidef:`Deferred.prototype.addErrback(func)`: Add a single errback to the end of the callback sequence. If additional arguments are given, then ``func`` will be replaced with :mochiref:`MochiKit.Base.partial.apply(null, arguments)`. This differs from `Twisted`_, because the result of the errback will be the *last* argument passed to ``func``. If ``func`` returns a :mochiref:`Deferred`, then it will be chained (its value or error will be passed to the next callback). Note that once the returned ``Deferred`` is chained, it can no longer accept new callbacks. *Availability*: Available in MochiKit 1.3.1+ :mochidef:`Deferred.prototype.callback([result])`: Begin the callback sequence with a non-``Error`` result. Result may be any value except for a :mochiref:`Deferred`. Either ``.callback`` or ``.errback`` should be called exactly once on a :mochiref:`Deferred`. *Availability*: Available in MochiKit 1.3.1+ :mochidef:`Deferred.prototype.cancel()`: Cancels a :mochiref:`Deferred` that has not yet received a value, or is waiting on another :mochiref:`Deferred` as its value. If a canceller is defined, the canceller is called. If the canceller did not return an ``Error``, or there was no canceller, then the errback chain is started with :mochiref:`CancelledError`. *Availability*: Available in MochiKit 1.3.1+ :mochidef:`Deferred.prototype.errback([result])`: Begin the callback sequence with an error result. Result may be any value except for a :mochiref:`Deferred`, but if ``!(result instanceof Error)``, it will be wrapped with :mochiref:`GenericError`. Either ``.callback`` or ``.errback`` should be called exactly once on a :mochidef:`Deferred`. *Availability*: Available in MochiKit 1.3.1+ :mochidef:`DeferredLock()`: A lock for asynchronous systems. The ``locked`` property of a :mochiref:`DeferredLock` will be ``true`` if it locked, ``false`` otherwise. Do not change this property. *Availability*: Available in MochiKit 1.3.1+ :mochidef:`DeferredLock.prototype.acquire()`: Attempt to acquire the lock. Returns a :mochiref:`Deferred` that fires on lock acquisition with the :mochiref:`DeferredLock` as the value. If the lock is locked, then the :mochiref:`Deferred` goes into a waiting list. *Availability*: Available in MochiKit 1.3.1+ :mochidef:`DeferredLock.prototype.release()`: Release the lock. If there is a waiting list, then the first :mochiref:`Deferred` in that waiting list will be called back. *Availability*: Available in MochiKit 1.3.1+ :mochidef:`DeferredList(list, [fireOnOneCallback, fireOnOneErrback, consumeErrors, canceller])`: Combine a list of :mochiref:`Deferred` into one. Track the callbacks and return a list of (success, result) tuples, 'success' being a boolean indicating whether result is a normal result or an error. Once created, you have access to all :mochiref:`Deferred` methods, like addCallback, addErrback, addBoth. The behaviour can be changed by the following options: ``fireOnOneCallback``: Flag for launching the callback once the first Deferred of the list has returned. ``fireOnOneErrback``: Flag for calling the errback at the first error of a Deferred. ``consumeErrors``: Flag indicating that any errors raised in the Deferreds should be consumed by the DeferredList. Example:: // We need to fetch data from 2 different urls var d1 = loadJSONDoc(url1); var d2 = loadJSONDoc(url2); var l1 = new DeferredList([d1, d2], false, false, true); l1.addCallback(function (resultList) { MochiKit.Base.map(function (result) { if (result[0]) { alert("Data is here: " + result[1]); } else { alert("Got an error: " + result[1]); } }, resultList); }); *Availability*: Available in MochiKit 1.3.1+ Functions --------- :mochidef:`callLater(seconds, func[, args...])`: Call ``func(args...)`` after at least ``seconds`` seconds have elapsed. This is a convenience method for:: func = partial.apply(extend(null, arguments, 1)); return wait(seconds).addCallback(function (res) { return func() }); Returns a cancellable :mochiref:`Deferred`. *Availability*: Available in MochiKit 1.3.1+ :mochidef:`doXHR(url[, {option: value, ...}])`: Perform a customized ``XMLHttpRequest`` and wrap it with a :mochiref:`Deferred` that may be cancelled. Note that only ``200`` (OK), ``201`` (CREATED), ``204`` (NO CONTENT) and ``304`` (NOT MODIFIED) are considered success codes. All other status codes will result in an errback with an ``XMLHttpRequestError``. ``url``: The URL for this request. The following options are currently accepted: ``method``: The HTTP method. Default is ``'GET'``. ``sendContent``: The content to send (e.g. with POST). Default is no content. ``queryString``: If present it will be used to build a query string to append to the url using :mochiref:`MochiKit.Base.queryString`. Default is no query string. ``username``: The username for the request. Default is no username. ``password``: The password for the request. Default is no password. ``headers``: Additional headers to set in the request, either as an object such as ``{'Accept': 'text/xml'}`` or as an Array of 2-Arrays ``[['Accept', 'text/xml']]``. Default is no additional headers. ``mimeType``: An override mime type. The typical use of this is to pass 'text/xml' to force XMLHttpRequest to attempt to parse responseXML. Default is no override. *returns*: :mochiref:`Deferred` that will callback with the ``XMLHttpRequest`` instance on success *Availability*: Available in MochiKit 1.4+. :mochidef:`doSimpleXMLHttpRequest(url[, queryArguments...])`: Perform a simple ``XMLHttpRequest`` and wrap it with a :mochiref:`Deferred` that may be cancelled. Note that only ``200`` (OK), ``201`` (CREATED), ``204`` (NO CONTENT) and ``304`` (NOT MODIFIED) are considered success codes. All other status codes will result in an errback with an ``XMLHttpRequestError``. ``url``: The URL to GET ``queryArguments``: If this function is called with more than one argument, a ``"?"`` and the result of :mochiref:`MochiKit.Base.queryString` with the rest of the arguments are appended to the URL. For example, this will do a GET request to the URL ``http://example.com?bar=baz``:: doSimpleXMLHttpRequest("http://example.com", {bar: "baz"}); *returns*: :mochiref:`Deferred` that will callback with the ``XMLHttpRequest`` instance on success *Availability*: Available in MochiKit 1.3.1+. Support for 201 and 204 were added in MochiKit 1.4. :mochidef:`evalJSONRequest(req)`: Evaluate a JSON [4]_ ``XMLHttpRequest`` ``req``: The request whose ``.responseText`` property is to be evaluated. If the JSON is wrapped in a comment, the comment will be stripped before evaluation. *returns*: A JavaScript object *Availability*: Available in MochiKit 1.3.1+ :mochidef:`fail([result])`: Return a :mochiref:`Deferred` that has already had ``.errback(result)`` called. See ``succeed`` documentation for rationale. ``result``: The result to give to :mochiref:`Deferred.prototype.errback(result)`. *returns*: A ``new`` :mochiref:`Deferred()` *Availability*: Available in MochiKit 1.3.1+ :mochidef:`gatherResults(deferreds)`: A convenience function that returns a :mochiref:`DeferredList` from the given ``Array`` of :mochiref:`Deferred` instances that will callback with an ``Array`` of just results when they're available, or errback on the first array. *Availability*: Available in MochiKit 1.3.1+ :mochidef:`getXMLHttpRequest()`: Return an ``XMLHttpRequest`` compliant object for the current platform. In order of preference: - ``new XMLHttpRequest()`` - ``new ActiveXObject('Msxml2.XMLHTTP')`` - ``new ActiveXObject('Microsoft.XMLHTTP')`` - ``new ActiveXObject('Msxml2.XMLHTTP.4.0')`` *Availability*: Available in MochiKit 1.3.1+ :mochidef:`maybeDeferred(func[, argument...])`: Call a ``func`` with the given arguments and ensure the result is a :mochiref:`Deferred`. ``func``: The function to call. *returns*: A new :mochiref:`Deferred` based on the call to ``func``. If ``func`` does not naturally return a :mochiref:`Deferred`, its result or error value will be wrapped by one. *Availability*: Available in MochiKit 1.3.1+ :mochidef:`loadJSONDoc(url[, queryArguments...])`: Do a simple ``XMLHttpRequest`` to a URL and get the response as a JSON [4]_ document. ``url``: The URL to GET ``queryArguments``: If this function is called with more than one argument, a ``"?"`` and the result of :mochiref:`MochiKit.Base.queryString` with the rest of the arguments are appended to the URL. For example, this will do a GET request to the URL ``http://example.com?bar=baz``:: loadJSONDoc("http://example.com", {bar: "baz"}); *returns*: :mochiref:`Deferred` that will callback with the evaluated JSON [4]_ response upon successful ``XMLHttpRequest`` *Availability*: Available in MochiKit 1.3.1+ :mochidef:`sendXMLHttpRequest(req[, sendContent])`: Set an ``onreadystatechange`` handler on an ``XMLHttpRequest`` object and send it off. Will return a cancellable :mochiref:`Deferred` that will callback on success. Note that only ``200`` (OK), ``201`` (CREATED), ``204`` (NO CONTENT) and ``304`` (NOT MODIFIED) are considered success codes. All other status codes will result in an errback with an ``XMLHttpRequestError``. ``req``: An preconfigured ``XMLHttpRequest`` object (open has been called). ``sendContent``: Optional string or DOM content to send over the ``XMLHttpRequest``. *returns*: :mochiref:`Deferred` that will callback with the ``XMLHttpRequest`` instance on success. *Availability*: Available in MochiKit 1.3.1+. Support for 201 and 204 were added in MochiKit 1.4. :mochidef:`succeed([result])`: Return a :mochiref:`Deferred` that has already had ``.callback(result)`` called. This is useful when you're writing synchronous code to an asynchronous interface: i.e., some code is calling you expecting a :mochiref:`Deferred` result, but you don't actually need to do anything asynchronous. Just return ``succeed(theResult)``. See ``fail`` for a version of this function that uses a failing :mochiref:`Deferred` rather than a successful one. ``result``: The result to give to :mochiref:`Deferred.prototype.callback(result)` *returns*: a ``new`` :mochiref:`Deferred` *Availability*: Available in MochiKit 1.3.1+ :mochidef:`wait(seconds[, res])`: Return a new cancellable :mochiref:`Deferred` that will ``.callback(res)`` after at least ``seconds`` seconds have elapsed. *Availability*: Available in MochiKit 1.3.1+ See Also ======== .. [1] AJAX, Asynchronous JavaScript and XML: http://en.wikipedia.org/wiki/AJAX .. [2] Twisted, an event-driven networking framework written in Python: http://twistedmatrix.com/ .. [3] Twisted Deferred Reference: http://twistedmatrix.com/projects/core/documentation/howto/defer.html .. [4] JSON, JavaScript Object Notation: http://json.org/ Authors ======= - Bob Ippolito
| head1 | head2 | head3 |
| foot1 | foot2 | foot3 |
| dataA1 | dataA2 | dataA3 |
| dataB1 | dataB2 | dataB3 |
Back to docs index
2008-11-27 v1.4.2 (bug fix release)
2008-11-02 v1.4.1 (bug fix release)
2008-10-21 v1.4
2006-04-29 v1.3.1 (bug fix release)
2006-04-26 v1.3 "warp zone"
2006-01-26 v1.2 "the ocho"
2005-11-14 v1.1
2005-10-24 v1.0
2005-10-08 v0.90
2005-08-12 v0.80
2005-08-04 v0.70
2005-07-29 v0.60
2005-07-27 v0.50
Back to docs index
MochiKit.Visual - visual effects
// round the corners of all h1 elements
roundClass("h1", null);
// round the top left corner of the element with the id "title"
roundElement("title", {corners: "tl"});
// Add an fade effect to an element
fade('myelement');
MochiKit.Visual provides visual effects and animations for HTML elements.
MochiKit.Visual provides different visual effects: rounded corners and animations for your HTML elements. Rounded corners are created completely through CSS manipulations and require no external images or style sheets. This implementation was adapted from Rico. Dynamic effects are ported from Scriptaculous.
Dynamic or animated effects are managed by a basic looping service (see Base). The effect looping is controlled by timers that are invoked at regular and short intervals while the effect is executing. The base looping service takes the current system time into consideration, automatically skipping effect steps on execution delays.
The effect classes need only handle dynamic updates based on a floating-point number between 0.0 and 1.0 (the effect position). This effect position may also be manipulated by Transitions to provide non-linear updates, which may further enhance the visual effect.
The effect timer and transitions can be controlled through a set of DefaultOptions that are available for all effect classes.
When you create effects based on user input (mouse clicks for example), it can create conflicts between the effects if multiple effects are running at the same time. To manage this problem, the Queue mechanism has been introduced: it's responsible for running the effects as you desired.
By default, you have one Queue called 'global', and the effects run in 'parallel' (see DefaultOptions). Every effect has a queue option to customize this. Its value can be a string, thereby using the global scope:
But you have even more control if you use an object with the following property keys:
roundClass(tagName[, className[, options]]):
Rounds all of the elements that match the tagName and className specifiers, using the options provided. tagName or className can be null to match all tags or classes. Regarding the options, see the roundElement function.
- Availability:
- Available in MochiKit 1.3.1+
roundElement(element[, options]):
Immediately round the corners of the specified element.
- element:
- An element ID string or a DOM node (see MochiKit.DOM.getElement).
- options:
The options mapping has the following defaults:
corners "all" color "fromElement" bgColor "fromParent" blend true border false compact false The options parameters can have following values:
- corners:
Specifies which corners of the element should be rounded. Choices are:
- all
- top
- bottom
- tl (top left)
- bl (bottom left)
- tr (top right)
- br (bottom right)
- Example:
- "tl br": top-left and bottom-right corners are rounded
- blend:
- Specifies whether the color and background color should be blended together to produce the border color.
- Availability:
- Available in MochiKit 1.3.1+
toggle(element[, effect[, options]]):
Toggle an element between visible and invisible state using an effect.
- element:
- An element ID string or a DOM node (see MochiKit.DOM.getElement).
- effect:
One of the visual pairs to use:
"appear" appear and fade "blind" blindUp and blindDown "size" grow and shrink "slide" slideUp and slideDown - options:
- The optional effect options (see the respective effect functions for details).
- Availability:
- Available in MochiKit 1.4+
tagifyText(element[, tagifyStyle]):
Transform the node text into SPAN nodes each containing a single letter. Only text nodes that are immediate children will be modified by this function.
- element:
- An element ID string or a DOM node (see MochiKit.DOM.getElement).
- tagifyStyle:
- Style to apply to each new SPAN node, defaults to 'position: relative'.
- Availability:
- Available in MochiKit 1.4+
multiple(elements, effect[, options]):
Launch the same effect on a list of elements.
- elements:
- A list of element ID strings or a DOM nodes (see MochiKit.DOM.getElement).
- effect:
- An effect class constructor function.
- options:
The effect options (see the respective effect class). A special speed value will be added to the effect delay for each additional element in the list. This cause the effects to not run exactly in parallel by default.
speed 0.1 delay 0.0 (initial) - Availability:
- Available in MochiKit 1.4+
Fades an element using the Opacity effect. Once the effect has completed, the element will be hidden with MochiKit.Style.hideElement and the original element opacity will be restored.
- element:
- An element ID string or a DOM node (see MochiKit.DOM.getElement).
- options:
from element.opacity || 1.0 to 0.0 - Availability:
- Available in MochiKit 1.4+
Slowly shows an element using the Opacity effect. If the element has "display: none" style, it will be changed to "display: block" with MochiKit.Style.showElement.
- element:
- An element ID string or a DOM node (see MochiKit.DOM.getElement).
- options:
from element.opacity || 0.0 to 1.0 - Availability:
- Available in MochiKit 1.4+
Make an element double size while also fading it using the Scale and Opacity effects in parallel. Once the effect has completed, the element will be hidden with MochiKit.Style.hideElement and the original element size, position and opacity will be restored.
- element:
- An element ID string or a DOM node (see MochiKit.DOM.getElement).
- options:
- See DefaultOptions.
- Availability:
- Available in MochiKit 1.4+
Blind an element up, changing its vertical size to 0 using the Scale effect. Once the effect has completed, the element will be hidden with MochiKit.Style.hideElement and the original element size will be restored.
- element:
- An element ID string or a DOM node (see MochiKit.DOM.getElement).
- options:
- See DefaultOptions.
- Availability:
- Available in MochiKit 1.4+
blindDown(element [, options]):
Blind an element down, restoring its vertical size using the Scale effect. If the element has "display: none" style, it will be changed to "display: block" with MochiKit.Style.showElement.
- element:
- An element ID string or a DOM node (see MochiKit.DOM.getElement).
- options:
- See DefaultOptions.
- Availability:
- Available in MochiKit 1.4+
switchOff(element [, options]):
A switch-off like effect, making the element disappear, using the Opacity and Scale effects in sequence. The initial Opacity effect uses a flicker (partially random) transformation. Once the effect has completed, the element will be hidden with MochiKit.Style.hideElement and the original element opacity, size and position will be restored.
- element:
- An element ID string or a DOM node (see MochiKit.DOM.getElement).
- options:
- See DefaultOptions. Note that the options will only affect the secondary Scale effect.
- Availability:
- Available in MochiKit 1.4+
Make the element fall and fade using the Move and Opacity effects in parallel. Once the effect has completed, the element will be hidden with MochiKit.Style.hideElement and the original element position and opacity will be restored.
- element:
- An element ID string or a DOM node (see MochiKit.DOM.getElement).
- options:
The distance option controls the number of pixels that the element will move downwards. See also the DefaultOptions.
distance 100 - Availability:
- Available in MochiKit 1.4+
Shake an element from left to right using a sequence of six Move effects. Once the effect has completed, the original element position will be restored.
- element:
- An element ID string or a DOM node (see MochiKit.DOM.getElement).
- options:
- See DefaultOptions. Note that the options will only affect the last Move effect.
- Availability:
- Available in MochiKit 1.4+
slideDown(element [, options]):
Slide an element down using the Scale effect. The element must have a fixed height and contain a single child. If the element has "display: none" style it will be changed to "display: block" with MochiKit.Style.showElement.
- element:
- An element ID string or a DOM node (see MochiKit.DOM.getElement).
- options:
- See DefaultOptions.
- Availability:
- Available in MochiKit 1.4+
Slide an element up using the Scale effect. The element must have a fixed height and contain a single child. Once the effect has completed, the element will be hidden with MochiKit.Style.hideElement and the original element size will be restored.
- element:
- An element ID string or a DOM node (see MochiKit.DOM.getElement).
- options:
- See DefaultOptions.
- Availability:
- Available in MochiKit 1.4+
Reduce the horizontal and vertical sizes at the same time using a single Scale effect. The result is similar to the shrink effect with a top-left value for the direction option. The element should have fixed width and height. Once the effect has completed, the element will be hidden with MochiKit.Style.hideElement and the original element size will be restored.
- element:
- An element ID string or a DOM node (see MochiKit.DOM.getElement).
- options:
- See DefaultOptions.
- Availability:
- Available in MochiKit 1.4+
Grows an element size using Scale, Move and Opacity effects in parallel. The element should have fixed width, height and top-left position. Before the effect starts, the element will be shown with MochiKit.Style.showElement and the size and position values will be read.
- element:
- An element ID string or a DOM node (see MochiKit.DOM.getElement).
- options:
The following options and default values control this effect. Note that the Opacity effect is turned off by default. See also the DefaultOptions.
direction "center" moveTransition MochiKit.Visual.Transitions.sinoidal scaleTransition MochiKit.Visual.Transitions.sinoidal opacityTransition MochiKit.Visual.Transitions.full The direction option controls the origin point of the effect. The following values are allowed:
"center" Grows from the center "top-left" Grows from the top left corner "top-right" Grows from the top right corner "bottom-left" Grows from the bottom left corner "bottom-right" Grows from the bottom right corner
- Availability:
- Available in MochiKit 1.4+
Shrinks an element using Scale, Move and Opacity effects in parallel. The element should have fixed width, height and top-left position. Once the effect has completed, the element will be hidden with MochiKit.Style.hideElement and the original size and position will be restored.
- element:
- An element ID string or a DOM node (see MochiKit.DOM.getElement).
- options:
The following options and default values control this effect. Note that the Opacity effect is turned off by default. See also the DefaultOptions.
direction "center" moveTransition MochiKit.Visual.Transitions.sinoidal scaleTransition MochiKit.Visual.Transitions.sinoidal opacityTransition MochiKit.Visual.Transitions.full The direction option controls the destination point of the effect. The following values are allowed:
"center" Grows from the center "top-left" Grows from the top left corner "top-right" Grows from the top right corner "bottom-left" Grows from the bottom left corner "bottom-right" Grows from the bottom right corner
- Availability:
- Available in MochiKit 1.4+
Switches the element visibility using a pulsating Opacity effect. The effect both starts and ends with a 0 opacity value.
- element:
- An element ID string or a DOM node (see MochiKit.DOM.getElement).
- options:
The pulses option controls the number of pulses made during the effect. See also the DefaultOptions.
pulses 5 - Availability:
- Available in MochiKit 1.4+
Reduce first the element vertical size, and then the horizontal size using two Scale effects in sequence. The element should have both fixed width and height. Once the effect has completed, the element will be hidden with MochiKit.Style.hideElement and the original size and position will be restored.
- element:
- An element ID string or a DOM node (see MochiKit.DOM.getElement).
- options:
- See DefaultOptions. Note that the options will only affect the first Scale effect.
- Availability:
- Available in MochiKit 1.4+
Default transition functions available for all effects. A transition function adjusts the current position value between 0 and 1 in order to achieve a non-linear sequence of position values for the effect.
linear A straight linear transition. sinoidal A smooth sine value transition. reverse A reverse linear transition. flicker A sine transition with random additions. wobble A multi-period sine curve transition with 4.5 wobbles and ending with one (1). pulse A multi-period triangle curve transition with 5 pulses (by default) and ending with zero (0). parabolic A smooth parabolic transition. none A fixed zero (0) value transition. full A fixed one (1) value transition.
- Availability:
- Available in MochiKit 1.4+
Default options for all effects. Note that all effects inherit the Base class and thereby also support a number of events that can be specified as callback functions among the effect options.
transition MochiKit.Visual.Transitions.sinoidal duration 1.0 (seconds) fps 25.0 sync false (only set for Parallel or Sequence effects) from 0.0 to 1.0 delay 0.0 queue 'parallel'
- Availability:
- Available in MochiKit 1.4+
Base class to all effects. Define a basic looping service, use it for creating new effects.
You can override the methods setup, update and finish.
The class defines a number of events that will be called during effect life. The events are:
- beforeStart
- beforeSetup
- beforeUpdate
- afterUpdate
- beforeFinish
- afterFinish
If you want to define your own callbacks, define it in the options parameter of the effect. Example:
// I slide it up and then down again slideUp('myelement', {afterFinish: function () { slideDown('myelement'); });Specific internal events are also available: for each one listed above, the same exists with an 'Internal' postfix (e.g. 'beforeStartInternal'). Their purpose is mainly for creating your own effect and keep the user access to event callbacks (not overriding the library ones).
- Availability:
- Available in MochiKit 1.4+
Parallel(effects [, options]):
Launch a list of effects in parallel.
- effects:
- An array of instantiated effect objects. Note that they must all have sync set to true.
- options:
- See DefaultOptions.
- Availability:
- Available in MochiKit 1.4+
Sequence(effects [, options]):
Launch a list of effects in sequence, one after the other.
- effects:
- An array of instantiated effect objects. Note that they must all have sync set to true.
- options:
See DefaultOptions. Note that the default value for some options is different and that some of the transition and timing options don't make sense to override.
transition MochiKit.Visual.Transitions.linear duration Sum of the duration for all effects. from Only 0.0 makes sense. to Only 1.0 makes sense. - Availability:
- Available in MochiKit 1.4+
Change the opacity of an element progressively.
- element:
- An element ID string or a DOM node (see MochiKit.DOM.getElement).
- options:
The following options and default values control this effect. See also the DefaultOptions.
from 0.0 to 1.0 - Availability:
- Available in MochiKit 1.4+
Changes the (top left) position of an element in small steps, creating a moving effect.
- element:
- An element ID string or a DOM node (see MochiKit.DOM.getElement).
- options:
The following options and default values control this effect. See also the DefaultOptions.
x 0 y 0 mode 'relative' The mode option controls if the specified x and y coordinates are relative or absolute with respect to the current element position.
- Availability:
- Available in MochiKit 1.4+
Scale(element, percent [, options]):
Changes the size of an element.
- element:
- An element ID string or a DOM node (see MochiKit.DOM.getElement).
- percent:
- Final wanted size in percent of current size. The size will be reduced if the value is between 0 and 100, and raised if the value is above 100.
- options:
The following options and default values control this effect. See also the DefaultOptions.
scaleX true scaleY true scaleContent true scaleFromCenter false scaleMode "box" scaleFrom 100.0 scaleTo percent The scaleContent option controls if the element font-size should also be scaled along with the size. The scaleFromCenter option allows continual adjustment of the element top left position to keep the element centered during the size change. The scaleMode option is used to determine the original element size. It can have one of the following values:
"box" Uses offsetHeight and offsetWidth "contents" Uses scrollHeight and scrollWidth {...} Uses originalHeight and originalWidth from the specified object
- Availability:
- Available in MochiKit 1.4+
Highlight(element [, options]):
Highlights an element by flashing the background color. The color is first set to the startcolor and is then slowly morphed into the endcolor, normally the original background color of the element.
- element:
- An element ID string or a DOM node (see MochiKit.DOM.getElement).
- options:
The following options and default values control this effect. See also the DefaultOptions.
startcolor '#ffff99' endcolor element.style.backgroundColor - Availability:
- Available in MochiKit 1.4+
ScrollTo(element [, options]):
Scroll the window to the position of the given element. Note that this effect only scrolls the top window and not any parent elements with scrollbars due to "overflow: auto" style.
- element:
- An element ID string or a DOM node (see MochiKit.DOM.getElement).
- options:
- See DefaultOptions.
- Availability:
- Available in MochiKit 1.4+
Make a transformation to the given element. It's called with the option style with an array holding the styles to change. It works with properties for size (font-size, border-width, ...) and properties for color (color, background-color, ...).
For size, it's better to have defined the original style. You must use the same unit in the call to Morph (no translation exists between two different units).
Parsed length are postfixed with: em, ex, px, in, cm, mm, pt, pc.
Example:
<div id="foo" style="font-size: 1em">MyDiv</div> ... Morph("foo", {"style": {"font-size": "2em"}});
- element:
- An element ID string or a DOM node (see MochiKit.DOM.getElement).
- options:
- See DefaultOptions.
- Availability:
- Available in MochiKit 1.4+
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed free software; you can redistribute it and/or modify it under the terms of the MIT License or the Academic Free License v2.1.
Portions adapted from Rico are available under the terms of the Apache License, Version 2.0.
Portions adapted from Scriptaculous are available under the terms of the MIT License.
Back to docs index
MochiKit.Format - string formatting goes here
assert( truncToFixed(0.12345, 4) == "0.1234" );
assert( roundToFixed(0.12345, 4) == "0.1235" );
assert( twoDigitAverage(1, 0) == "0" );
assert( twoDigitFloat(1.2345) == "1.23" );
assert( twoDigitFloat(1) == "1" );
assert( percentFormat(1.234567) == "123.46%" );
assert( numberFormatter("###,###%")(125) == "12,500%" );
assert( numberFormatter("##.000")(1.25) == "1.250" );
Formatting strings and stringifying numbers is boring, so a couple useful functions in that domain live here.
None.
MochiKit provides an extensible number formatting facility, modeled loosely after the Number Format Pattern Syntax [1] from Java. numberFormatter(pattern[, placeholder=""[, locale="default"]) returns a function that converts Number to string using the given information. pattern is a string consisting of the following symbols:
| Symbol | Meaning |
|---|---|
| - | If given, used as the position of the minus sign for negative numbers. If not given, the position to the left of the first number placeholder is used. |
| # | The placeholder for a number that does not imply zero padding. |
| 0 | The placeholder for a number that implies zero padding. If it is used to the right of a decimal separator, it implies trailing zeros, otherwise leading zeros. |
| , | The placeholder for a "thousands separator". May be used at most once, and it must be to the left of a decimal separator. Will be replaced by locale.separator in the result (the default is also ,). |
| . | The decimal separator. The quantity of # or 0 after the decimal separator will determine the precision of the result. If no decimal separator is present, the fractional precision is 0 -- meaning that it will be rounded to the nearest integer. |
| % | If present, the number will be multiplied by 100 and the % will be replaced by locale.percent. |
formatLocale(locale="default"):
Return a locale object for the given locale. locale may be either a string, which is looked up in the MochiKit.Format.LOCALE object, or a locale object. If no locale is given, LOCALE.default is used (equivalent to LOCALE.en_US).
- Availability:
- Available in MochiKit 1.3.1+
Returns a string based on str with leading whitespace stripped.
If chars is given, then that expression will be used instead of whitespace. chars should be a string suitable for use in a RegExp [character set].
- Availability:
- Available in MochiKit 1.3.1+
numberFormatter(pattern, placeholder="", locale="default"):
Return a function formatNumber(aNumber) that formats numbers as a string according to the given pattern, placeholder and locale.
pattern is a string that describes how the numbers should be formatted, for more information see Formatting Numbers.
locale is a string of a known locale (en_US, de_DE, fr_FR, default) or an object with the following fields:
separator The "thousands" separator for this locale (en_US is ",") decimal The decimal separator for this locale (en_US is ".") percent The percent symbol for this locale (en_US is "%")
- Availability:
- Available in MochiKit 1.3.1+
Return a string representation of aNumber * 100, rounded to a maximum precision of 2 fractional digits. Roughly equivalent to: sprintf("%.2f%%", aNumber * 100)
In new code, you probably want to use: numberFormatter("#.##%")(aNumber) instead.
- Availability:
- Available in MochiKit 1.3.1+
roundToFixed(aNumber, precision):
Return a string representation of aNumber, rounded to precision digits with trailing zeros. This is similar to Number.toFixed(aNumber, precision), but this has implementation consistent rounding behavior (some versions of Safari round 0.5 down!) and also includes preceding 0 for numbers less than 1 (Safari, again).
For example, roundToFixed(0.1357, 2) returns 0.14 on every supported platform, where some return .13 for (0.1357).toFixed(2).
- Availability:
- Available in MochiKit 1.3.1+
Returns a string based on str with trailing whitespace stripped.
If chars is given, then that expression will be used instead of whitespace. chars should be a string suitable for use in a RegExp [character set].
- Availability:
- Available in MochiKit 1.3.1+
Returns a string based on str with leading and trailing whitespace stripped (equivalent to lstrip(rstrip(str, chars), chars)).
If chars is given, then that expression will be used instead of whitespace. chars should be a string suitable for use in a RegExp [character set].
- Availability:
- Available in MochiKit 1.3.1+
truncToFixed(aNumber, precision):
Return a string representation of aNumber, truncated to precision digits with trailing zeros. This is similar to aNumber.toFixed(precision), but this truncates rather than rounds and has implementation consistent behavior for numbers less than 1. Specifically, truncToFixed(aNumber, precision) will always have a preceding 0 for numbers less than 1.
For example, truncToFixed(0.1357, 2) returns 0.13.
- Availability:
- Available in MochiKit 1.3.1+
twoDigitAverage(numerator, denominator):
Calculate an average from a numerator and a denominator and return it as a string rounded to a maximum precision of two fractional digits (e.g. "1.23").
If the denominator is 0, "0" will be returned instead of NaN.
- Availability:
- Available in MochiKit 1.3.1+
Return a string representation of aNumber, rounded to a maximum precision of 2 fractional digits. This is a variation of roundToFixed(aNumber, 2) that removes trailing zeros from the fractional part.
For example, twoDigitFloat(0.1357) returns 0.14 and twoDigitFloat(12.00) returns 12.
In new code, you probably want to use: numberFormatter("#.##")(aNumber) instead.
- Availability:
- Available in MochiKit 1.3.1+
| [1] | Java Number Format Pattern Syntax: http://java.sun.com/docs/books/tutorial/i18n/format/numberpattern.html |
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed free software; you can redistribute it and/or modify it under the terms of the MIT License or the Academic Free License v2.1.
Back to docs index
MochiKit.DateTime - "what time is it anyway?"
stringDate = toISOTimestamp(new Date()); dateObject = isoTimestamp(stringDate);
Remote servers don't give you JavaScript Date objects, and they certainly don't want them from you, so you need to deal with string representations of dates and timestamps. MochiKit.Date does that.
None.
Convert an ISO 8601 date (YYYY-MM-DD) to a Date object.
- Availability:
- Available in MochiKit 1.3.1+
Convert any ISO 8601 [1] timestamp (or something reasonably close to it) to a Date object. Will accept the "de facto" form:
YYYY-MM-DD hh:mm:ssor (the proper form):
YYYY-MM-DDThh:mm:ssZIf a time zone designator ("Z" or "[+-]HH:MM") is not present, then the local timezone is used.
- Availability:
- Available in MochiKit 1.3.1+
Convert a Date object to a string in the form of hh:mm:ss
- Availability:
- Available in MochiKit 1.3.1+
toISOTimestamp(date, realISO=false):
Convert a Date object to something that's ALMOST but not quite an ISO 8601 [1]_timestamp. If it was a proper ISO timestamp it would be:
YYYY-MM-DDThh:mm:ssZHowever, we see junk in SQL and other places that looks like this:
YYYY-MM-DD hh:mm:ssSo, this function returns the latter form, despite its name, unless you pass true for realISO.
- Availability:
- Available in MochiKit 1.3.1+
Convert a Date object to an ISO 8601 [1] date string (YYYY-MM-DD)
- Availability:
- Available in MochiKit 1.3.1+
Converts a MM/DD/YYYY date to a Date object
- Availability:
- Available in MochiKit 1.3.1+
Converts a Date object to an MM/DD/YYYY date, e.g. 01/01/2001
- Availability:
- Available in MochiKit 1.3.1+
Converts a Date object to an M/D/YYYY date, e.g. 1/1/2001
- Availability:
- Available in MochiKit 1.3.1+
| [1] | (1, 2) W3C profile of ISO 8601: http://www.w3.org/TR/NOTE-datetime |
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed free software; you can redistribute it and/or modify it under the terms of the MIT License or the Academic Free License v2.1.
Back to docs index
MochiKit.LoggingPane - Interactive MochiKit.Logging pane
// open a pop-up window createLoggingPane() // use a div at the bottom of the document createLoggingPane(true);
MochiKit.Logging does not have any browser dependencies and is completely unobtrusive. MochiKit.LoggingPane is a browser-based colored viewing pane for your MochiKit.Logging output that can be used as a pop-up or inline.
It also allows for regex and level filtering! MochiKit.LoggingPane is used as the default MochiKit.Logging.debuggingBookmarklet() if it is loaded.
LoggingPane(inline=false, logger=MochiKit.Logging.logger):
A listener for a MochiKit.Logging logger with an interactive DOM representation.
If inline is true, then the LoggingPane will be a DIV at the bottom of the document. Otherwise, it will be in a pop-up window with a name based on the calling page's URL. If there is an element in the document with an id of _MochiKit_LoggingPane, it will be used instead of appending a new DIV to the body.
logger is the reference to the MochiKit.Logging.Logger to listen to. If not specified, the global default logger is used.
Properties:
- win:
- Reference to the pop-up window (undefined if inline)
- inline:
- true if the LoggingPane is inline
- colorTable:
An object with property->value mappings for each log level and its color. May also be mutated on LoggingPane.prototype to affect all instances. For example:
MochiKit.LoggingPane.LoggingPane.prototype.colorTable = { DEBUG: "green", INFO: "black", WARNING: "blue", ERROR: "red", FATAL: "darkred" };
- Availability:
- Available in MochiKit 1.3.1+
LoggingPane.prototype.closePane():
Close the LoggingPane (close the child window, or remove the _MochiKit_LoggingPane DIV from the document).
- Availability:
- Available in MochiKit 1.3.1+
createLoggingPane(inline=false):
Create or return an existing LoggingPane for this document with the given inline setting. This is preferred over using LoggingPane directly, as only one LoggingPane should be present in a given document.
- Availability:
- Available in MochiKit 1.3.1+
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed free software; you can redistribute it and/or modify it under the terms of the MIT License or the Academic Free License v2.1.
Back to docs index
MochiKit.Position - DOM Position manipulation API
This module is experimental and is present in MochiKit 1.4+ only. No functions are currently exported from this module. Documentation is forthcoming.
Copyright 2005-2006 Bob Ippolito <bob@redivi.com>, and others. This program is dual-licensed free software; you can redistribute it and/or modify it under the terms of the MIT License or the Academic Free License v2.1.
Back to docs index
MochiKit.DOM - painless DOM manipulation API
var rows = [
["dataA1", "dataA2", "dataA3"],
["dataB1", "dataB2", "dataB3"]
];
row_display = function (row) {
return TR(null, map(partial(TD, null), row));
}
var newTable = TABLE({'class': 'prettytable'},
THEAD(null,
row_display(["head1", "head2", "head3"])),
TFOOT(null,
row_display(["foot1", "foot2", "foot3"])),
TBODY(null,
map(row_display, rows)));
// put that in your document.createElement and smoke it!
swapDOM(oldTable, newTable);
As you probably know, the DOM APIs are some of the most painful Java-inspired APIs you'll run across from a highly dynamic language. Don't worry about that though, because they provide a reasonable basis to build something that sucks a lot less.
MochiKit.DOM takes much of its inspiration from Nevow's [1] stan [2]. This means you choose a tag, give it some attributes, then stuff it full of whatever objects you want. MochiKit.DOM isn't stupid, it knows that a string should be a text node, and that you want functions to be called, and that Array-like objects should be expanded, and stupid null values should be skipped.
Hell, it will let you return strings from functions, and use iterators from MochiKit.Iter. If that's not enough, just teach it new tricks with registerDOMConverter. If you have never used an API like this for creating DOM elements, you've been wasting your damn time. Get with it!
In order of precedence, createDOM coerces given arguments to DOM nodes using the following rules:
createDOM provides you with an excellent facility for creating DOM trees that is easy on the wrists. One of the best ways to understand how to use it is to take a look at an example:
var rows = [
["dataA1", "dataA2", "dataA3"],
["dataB1", "dataB2", "dataB3"]
];
row_display = function (row) {
return TR(null, map(partial(TD, null), row));
}
var newTable = TABLE({'class': 'prettytable'},
THEAD(null,
row_display(["head1", "head2", "head3"])),
TFOOT(null,
row_display(["foot1", "foot2", "foot3"])),
TBODY(null,
map(row_display, rows)));
This will create a table with the following visual layout (if it were inserted into the document DOM):
head1 head2 head3 dataA1 dataA2 dataA3 dataB1 dataB2 dataB3 foot1 foot2 foot3
Corresponding to the following HTML:
<table class="prettytable">
<thead>
<tr>
<td>head1</td>
<td>head2</td>
<td>head3</td>
</tr>
</thead>
<tfoot>
<tr>
<td>foot1</td>
<td>foot2</td>
<td>foot3</td>
</tr>
</tfoot>
<tbody>
<tr>
<td>dataA1</td>
<td>dataA2</td>
<td>dataA3</td>
</tr>
<tr>
<td>dataB1</td>
<td>dataB2</td>
<td>dataB3</td>
</tr>
</tbody>
</table>
In order to prevent having to pass a window and/or document variable to every MochiKit.DOM function (e.g. when working with a child window), MochiKit.DOM maintains a context variable for each of them. They are managed with the withWindow and withDocument functions, and can be acquired with currentWindow() and currentDocument()
For example, if you are creating DOM nodes in a child window, you could do something like this:
withWindow(child, function () {
var doc = currentDocument();
appendChildNodes(doc.body, H1(null, "This is in the child!"));
});
Note that withWindow(win, ...) also implies withDocument(win.document, ...).
An alias for getElement(id[, ...])
- Availability:
- Available in MochiKit 1.3.1+
addElementClass(element, className):
Ensure that the given element has className set as part of its class attribute. This will not disturb other class names. element is looked up with getElement, so string identifiers are also acceptable.
- Availability:
- Available in MochiKit 1.3.1+
Note that addLoadEvent can not be used in combination with MochiKit.Signal if the onload event is connected. Once an event is connected with MochiKit.Signal, no other APIs may be used for that same event.
This will stack window.onload functions on top of each other. Each function added will be called after onload in the order that they were added.
- Availability:
- Available in MochiKit 1.3.1+
addToCallStack(target, path, func[, once]):
Note that addToCallStack is not compatible with MochiKit.Signal. Once an event is connected with MochiKit.Signal, no other APIs may be used for that same event.
Set the property path of target to a function that calls the existing function at that property (if any), then calls func.
If target[path]() returns exactly false, then func will not be called.
If once is true, then target[path] is set to null after the function call stack has completed.
If called several times for the same target[path], it will create a stack of functions (instead of just a pair).
- Availability:
- Available in MochiKit 1.3.1+
appendChildNodes(node[, childNode[, ...]]):
Append children to a DOM element using the DOM Coercion Rules.
- node:
- A reference to the DOM element to add children to (if a string is given, getElement(node) will be used to locate the node)
- childNode...:
- All additional arguments, if any, will be coerced into DOM nodes that are appended as children using the DOM Coercion Rules.
- returns:
- The given DOM element
- Availability:
- Available in MochiKit 1.3.1+
insertSiblingNodesBefore(node[, siblingNode[, ...]]):
Insert children into the DOM structure using the DOM Coercion Rules.
- node:
- A reference to the DOM element you want to insert children before (if a string is given, getElement(node) will be used to locate the node)
- siblingNode...:
- All additional arguments, if any, will be coerced into DOM nodes that are inserted as siblings using the DOM Coercion Rules.
- returns:
- The parent of the given DOM element
- Availability:
- Available in MochiKit 1.4+
insertSiblingNodesAfter(node[, siblingNode[, ...]]):
Insert children into the DOM structure using the DOM Coercion Rules.
- node:
- A reference to the DOM element you want to insert children after (if a string is given, getElement(node) will be used to locate the node)
- siblingNode...:
- All additional arguments, if any, will be coerced into DOM nodes that are inserted as siblings using the DOM Coercion Rules.
- returns:
- The parent of the given DOM element
- Availability:
- Available in MochiKit 1.4+
createDOM(name[, attrs[, node[, ...]]]):
Create a DOM fragment in a really convenient manner, much like Nevow`s [1] stan [2].
Partially applied versions of this function for common tags are available as aliases:
- A
- BUTTON
- BR
- CANVAS
- DD
- DIV
- DL
- DT
- FIELDSET
- FORM
- H1
- H2
- H3
- H4
- H5
- H6
- HR
- IMG
- INPUT
- LABEL
- LEGEND
- LI
- OL
- OPTGROUP
- OPTION
- P
- PRE
- SELECT
- SPAN
- STRONG
- TABLE
- TBODY
- TD
- TEXTAREA
- TFOOT
- TH
- THEAD
- TR
- TT
- UL
See Creating DOM Element Trees for a comprehensive example.
- name:
- The kind of fragment to create (e.g. 'span'), such as you would pass to document.createElement.
- attrs:
An object whose properties will be used as the attributes (e.g. {'style': 'display:block'}), or null if no attributes need to be set.
See updateNodeAttributes for more information.
For convenience, if attrs is a string, null is used and the string will be considered the first node.
- node...:
- All additional arguments, if any, will be coerced into DOM nodes that are appended as children using the DOM Coercion Rules.
- returns:
- A DOM element
- Availability:
- Available in MochiKit 1.3.1+
createDOMFunc(tag[, attrs[, node[, ...]]]):
Convenience function to create a partially applied createDOM function. You'd want to use this if you add additional convenience functions for creating tags, or if you find yourself creating a lot of tags with a bunch of the same attributes or contents.
See createDOM for more detailed descriptions of the arguments.
- tag:
- The name of the tag
- attrs:
- Optionally specify the attributes to apply
- node...:
- Optionally specify any children nodes it should have
- returns:
- function that takes additional arguments and calls createDOM
- Availability:
- Available in MochiKit 1.3.1+
Return the current document DOM Context. This will always be the same as the global document unless withDocument or withWindow is currently executing.
- Availability:
- Available in MochiKit 1.3.1+
Return the current window DOM Context. This will always be the same as the global window unless withWindow is currently executing.
- Availability:
- Available in MochiKit 1.3.1+
Convert a DOM tree to an Array of HTML string fragments. This should be used for debugging/testing purposes only.
The DOM property innerHTML or cloneNode(true) method should be used for most purposes.
- Availability:
- Available in MochiKit 1.3.1+
Make a string safe for HTML, converting the usual suspects (<, >, ", &) to their HTML character entity equivalents.
- Availability:
- Available in MochiKit 1.3.1+
Note that focusOnLoad can not be used in combination with MochiKit.Signal if the onload event is connected. Once an event is connected with MochiKit.Signal, no other APIs may be used for that same event.
This adds an onload event to focus the given element.
- Availability:
- Available in MochiKit 1.3.1+
formContents(elem=document.body):
Search the DOM tree, starting at elem, for any elements with a name and value attribute. Return a 2-element Array of names and values suitable for use with MochiKit.Base.queryString.
- Availability:
- Available in MochiKit 1.3.1+
A small quick little function to encapsulate the getElementById method. It includes a check to ensure we can use that method.
If the id isn't a string, it will be returned as-is.
Also available as $(...) for convenience and compatibility with other JavaScript frameworks.
If multiple arguments are given, an Array will be returned.
- Availability:
- Available in MochiKit 1.3.1+
getElementsByTagAndClassName(tagName, className, parent=document):
Returns an array of elements in parent that match the tag name and class name provided. If parent is a string, it will be looked up with getElement.
If tagName is null or "*", all elements will be searched for the matching class.
If className is null, all elements matching the provided tag are returned.
- Availability:
- Available in MochiKit 1.3.1+
getFirstElementByTagAndClassName(tagName, className, parent=document):
Return the first element in parent that matches the tag name and class name provided. If parent is a string, it will be looked up with getElement.
If tagName is null or "*", all elements will be searched for the matching class.
If className is null, the first element matching the provided tag will be returned.
- Availability:
- Available in MochiKit 1.4+
getFirstParentByTagAndClassName(elem, tagName='*', className=null):
Returns the first parent of elem that matches the tag name and class name provided. If elem is a string, it will be looked up using getElement.
If tagName is null or "*", all elements will be searched for the matching class.
If className is null, the first element matching the provided tag name will be returned.
If no match is found, null will be returned.
- Availability:
- Available in MochiKit 1.4+
Get the value of the given attribute for a DOM element without ever raising an exception (will return null on exception).
- node:
- A reference to the DOM element to update (if a string is given, getElement(node) will be used to locate the node)
- attr:
The name of the attribute
Note that it will do the right thing for IE, so don't do the class -> className hack yourself.
- returns:
- The attribute's value, or null
- Availability:
- Available in MochiKit 1.3.1+
hasElementClass(element, className[, ...]):
Return true if className is found on the element. element is looked up with getElement, so string identifiers are also acceptable.
- Availability:
- Available in MochiKit 1.3.1+
isChildNode(node, maybeParent):
Determine whether node is a child node or decendant node of maybeParent. Returns true if so, and false if not. A node is considered a child node of itself for the purposes of this function.
If either node or maybeParent are strings, the related nodes will be looked up with getElement.
- Availability:
- Available in MochiKit 1.4+
registerDOMConverter(name, check, wrap[, override]):
Register an adapter to convert objects that match check(obj, ctx) to a DOM element, or something that can be converted to a DOM element (i.e. number, bool, string, function, iterable).
- Availability:
- Available in MochiKit 1.3.1+
Remove and return node from a DOM tree.
- node:
- the DOM element (or string id of one) to be removed
- returns
- The removed element
- Availability:
- Available in MochiKit 1.3.1+
removeElementClass(element, className):
Ensure that the given element does not have className set as part of its class attribute. This will not disturb other class names. element is looked up with getElement, so string identifiers are also acceptable.
- Availability:
- Available in MochiKit 1.3.1+
Remove all text node children that contain only whitespace from node. Useful in situations where such empty text nodes can interfere with DOM traversal.
- node:
- the DOM element (or string id of one) to remove whitespace child nodes from.
- Availability:
- Available in MochiKit 1.4+
replaceChildNodes(node[, childNode[, ...]]):
Remove all children from the given DOM element, then append any given childNodes to it (by calling appendChildNodes).
- node:
- A reference to the DOM element to add children to (if a string is given, getElement(node) will be used to locate the node)
- childNode...:
- All additional arguments, if any, will be coerced into DOM nodes that are appended as children using the DOM Coercion Rules.
- returns:
- The given DOM element
- Availability:
- Available in MochiKit 1.3.1+
scrapeText(node[, asArray=false]):
Walk a DOM tree in-order and scrape all of the text out of it as a string.
If asArray is true, then an Array will be returned with each individual text node. These two are equivalent:
assert( scrapeText(node) == scrapeText(node, true).join("") );
- Availability:
- Available in MochiKit 1.3.1+
setElementClass(element, className):
Set the entire class attribute of element to className. element is looked up with getElement, so string identifiers are also acceptable.
- Availability:
- Available in MochiKit 1.3.1+
setNodeAttribute(node, attr, value):
Set the value of the given attribute for a DOM element without ever raising an exception (will return null on exception). If setting more than one attribute, you should use updateNodeAttributes.
- node:
- A reference to the DOM element to update (if a string is given, getElement(node) will be used to locate the node)
- attr:
The name of the attribute
Note that it will do the right thing for IE, so don't do the class -> className hack yourself.
Also note that the DOM element object property with the same name will also be set if not already identical to the attribute value. This is needed to compensate for weird attributes that distinguish between the property and attribute values (i.e. the "value" attribute for fields).
- value:
- The value of the attribute, may be an object to be merged (e.g. for setting style).
- returns:
- The given DOM element or null on failure
- Availability:
- Available in MochiKit 1.3.1+
Replace dest in a DOM tree with src, returning src.
- dest:
- a DOM element (or string id of one) to be replaced
- src:
- the DOM element (or string id of one) to replace it with, or null if dest is to be removed (replaced with nothing).
- returns:
- a DOM element (src)
- Availability:
- Available in MochiKit 1.3.1+
swapElementClass(element, fromClass, toClass):
If fromClass is set on element, replace it with toClass. This will not disturb other classes on that element. element is looked up with getElement, so string identifiers are also acceptable.
- Availability:
- Available in MochiKit 1.3.1+
toggleElementClass(className[, element[, ...]]):
Toggle the presence of a given className in the class attribute of all given elements. All elements will be looked up with getElement, so string identifiers are acceptable.
- Availability:
- Available in MochiKit 1.3.1+
Convert a DOM tree to a HTML string using emitHTML. This should be used for debugging/testing purposes only.
The DOM property innerHTML or cloneNode(true) method should be used for most purposes.
- Availability:
- Available in MochiKit 1.3.1+
updateNodeAttributes(node, attrs):
Update the attributes of a DOM element from a given object.
- node:
- A reference to the DOM element to update (if a string is given, getElement(node) will be used to locate the node)
- attrs:
An object whose properties will be used to set the attributes (e.g. {'class': 'invisible'}), or null if no attributes need to be set. If an object is given for the attribute value (e.g. {'style': {'display': 'block'}}) then MochiKit.Base.updatetree will be used to set that attribute.
Note that it will do the right thing for IE, so don't do the class -> className hack yourself, and it deals with setting "on..." event handlers correctly.
Also note that the DOM element object property with the same name will also be set if not already identical to the attribute value. This is needed to compensate for weird attributes that distinguish between the property and attribute values (i.e. the "value" attribute for fields).
- returns:
- The given DOM element
- Availability:
- Available in MochiKit 1.3.1+
Call func with the window DOM Context set to win and the document DOM Context set to win.document. When func() returns or throws an error, the DOM Context will be restored to its previous state.
The return value of func() is returned by this function.
- Availability:
- Available in MochiKit 1.3.1+
Call func with the doc DOM Context set to doc. When func() returns or throws an error, the DOM Context will be restored to its previous state.
The return value of func() is returned by this function.
- Availability:
- Available in MochiKit 1.3.1+
These functions were previously available in MochiKit.DOM, but have been moved to MochiKit.Style in recent versions. Function aliases remain for backwards compability.
computedStyle(htmlElement, cssProperty, mozillaEquivalentCSS):
Looks up a CSS property for the given element. The element can be specified as either a string with the element's ID or the element object itself.
- cssProperty:
- MochiKit 1.3.1 expects camel case, e.g. backgroundColor. MochiKit 1.4+ expects CSS selector case, e.g. background-color, but will accept camel case for backwards-compatibility.
- mozillaEquivalentCSS:
- MochiKit 1.3.1 expects selector case. MochiKit 1.4+ ignores this argument.
- Availability:
- Available in MochiKit 1.3.1, deprecated in favor of MochiKit.Style.getStyle in 1.4+
Return the absolute pixel width and height (including padding and border, but not margins) of element as an object with w and h properties, or undefined if element is not in the document. element may be specified as a string to be looked up with getElement, a DOM element, or trivially as an object with w and/or h properties.
- Availability:
- Available in MochiKit 1.3.1, deprecated in favor of MochiKit.Style.getElementDimensions in 1.4+
elementPosition(element[, relativeTo={x: 0, y: 0}]):
Return the absolute pixel position of element in the document as an object with x and y properties, or undefined if element is not in the document. element may be specified as a string to be looked up with getElement, a DOM element, or trivially as an object with x and/or y properties.
If relativeTo is given, then its coordinates are subtracted from the absolute position of element, e.g.:
var elemPos = elementPosition(elem); var anotherElemPos = elementPosition(anotherElem); var relPos = elementPosition(elem, anotherElem); assert( relPos.x == (elemPos.x - anotherElemPos.x) ); assert( relPos.y == (elemPos.y - anotherElemPos.y) );relativeTo may be specified as a string to be looked up with getElement, a DOM element, or trivially as an object with x and/or y properties.
- Availability:
- Available in MochiKit 1.3.1, deprecated in favor of MochiKit.Style.getElementPosition in 1.4+
Return the pixel width and height of the viewport as an object with w and h properties. element is looked up with getElement, so string identifiers are also acceptable.
- Availability:
- Available in MochiKit 1.3.1, moved to MochiKit.Style.getViewportDimensions in 1.4+
Partial form of setDisplayForElement, specifically:
partial(setDisplayForElement, "none")For information about the caveats of using a style.display based show/hide mechanism, and a CSS based alternative, see Element Visibility.
- Availability:
- Available in MochiKit 1.3.1, moved to MochiKit.Style.hideElement in 1.4+
Ensure that element.style.overflow = 'hidden'. If element is a string, then it will be looked up with getElement.
Returns the original values of overflow, overflow-y and overflow-y so that they may be restored with undoClipping(element, overflow).
- Availability:
- Available in MochiKit 1.4+, moved to MochiKit.Style.makeClipping in 1.4.1+
Ensure that element.style.position is set to "relative" if it is not set or is "static". If element is a string, then it will be looked up with getElement.
- Availability:
- Available in MochiKit 1.4+, moved to MochiKit.Style.makePositioned in 1.4.1+
setElementDimensions(element, dimensions[, units='px']):
Sets the dimensions of element in the document from an object with w and h properties.
- node:
- A reference to the DOM element to update (if a string is given, getElement(node) will be used to locate the node)
- dimensions:
- An object with w and h properties
- units:
- Optionally set the units to use, default is px
- Availability:
- Available in MochiKit 1.3.1, moved to MochiKit.Style.setElementDimensions in 1.4+
setElementPosition(element, position[, units='px']):
Sets the absolute position of element in the document from an object with x and y properties.
- node:
- A reference to the DOM element to update (if a string is given, getElement(node) will be used to locate the node)
- position:
- An object with x and y properties
- units:
- Optionally set the units to use, default is px
- Availability:
- Available in MochiKit 1.3.1, moved to MochiKit.Style.setElementPosition in 1.4+
setDisplayForElement(display, element[, ...]):
Change the style.display for the given element(s). Usually used as the partial forms:
Elements are looked up with getElement, so string identifiers are acceptable.
For information about the caveats of using a style.display based show/hide mechanism, and a CSS based alternative, see Element Visibility.
- Availability:
- Available in MochiKit 1.3.1, moved to MochiKit.Style.setDisplayForElement in 1.4+
Sets opacity for element. Valid opacity values range from 0 (invisible) to 1 (opaque). element is looked up with getElement, so string identifiers are also acceptable.
- Availability:
- Available in MochiKit 1.3.1, moved to MochiKit.Style.setOpacity in 1.4+
Partial form of setDisplayForElement, specifically:
partial(setDisplayForElement, "block")For information about the caveats of using a style.display based show/hide mechanism, and a CSS based alternative, see Element Visibility.
- Availability:
- Available in MochiKit 1.3.1, moved to MochiKit.Style.showElement in 1.4+
undoClipping(element, overflow):
Restore the setting of element.style.overflow set by makeClipping(element). If element is a string, then it will be looked up with getElement.
- Availability:
- Available in MochiKit 1.4+, moved to MochiKit.Style.undoClipping in 1.4.1+
Restore the setting of element.style.position set by makePositioned(element). If element is a string, then it will be looked up with getElement.
- Availability:
- Available in MochiKit 1.4+, moved to MochiKit.Style.undoPositioned in 1.4.1+
These objects are available in MochiKit 1.3.1, but have been moved to MochiKit.Style in 1.4+.
Constructs an object with x and y properties. obj.toString() returns something like {x: 0, y: 42} for debugging.
Availability: Available in MochiKit 1.3.1, moved to MochiKit.Style.Coordinates in 1.4+
Constructs an object with w and h properties. obj.toString() returns something like {w: 0, h: 42} for debugging.
Availability: Available in MochiKit 1.3.1, moved to MochiKit.Style.Dimensions in 1.4+
| [1] | (1, 2) Nevow, a web application construction kit for Python: http://divmod.org/trac/wiki/DivmodNevow |
| [2] | (1, 2) nevow.stan is a domain specific language for Python (read as "crazy getitem/call overloading abuse") that Donovan and I schemed up at PyCon 2003 at this super ninja Python/C++ programmer's (David Abrahams) hotel room. Donovan later inflicted this upon the masses in Nevow. Check out the Nevow Guide for some examples: http://divmod.org/trac/wiki/DivmodNevow |
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed free software; you can redistribute it and/or modify it under the terms of the MIT License or the Academic Free License v2.1.
Back to docs index
MochiKit.Selector - Selecting elements by CSS selector syntax
MochiKit.Base.map(MochiKit.Visual.fade, $$('p.fademe'));
MochiKit.Selector provides utilities to select elements by CSS selector syntax. In particular it provides the $$ function.
This module provides facilities to select childs of a DOM node by using CSS selector syntax. In particular, it provides the $$ function, which performs such a selection on the current document.
Many of CSS3 [1] selectors are supported:
Select by tag name (A)
Select by class (.theclass)
Select by id (#someid)
Multiple selectors can be concatenated, like this: P.quote[author~='Torvalds'], in which case elements matching all the selectors are returned. Furthermore, such concatenations can be combined by joining them with spaces and combinators. This invokes the regular CSS behaviour of matching parts of the combination in sequence, starting off each part from the elements returned by the preceeding part.
For the :nth-* pseudoclasses, the an+b syntax is partially supported, specifically a and b must be non-negative and only a is optional (this differs from the CSS std.) Also, odd and even are supported, e.g. table tr:nth-child(odd) gives you every other row of table starting with the first one.
For further documentation of CSS selectors, refer to the W3C CSS standard. [1]
The original version of this module was ported from Prototype.
Note: This module is currently experimental and API stability cannot be fully guaranteed. The implementation is scheduled to be replaced with a new faster version (now in development) during the MochiKit 1.5 development cycle.
Note: Due to how Internet Explorer handles node attributes, some attribute selectors may not work as expected. In particular a[title] will not work as all A elements in the Internet Explorer DOM model have a title attribute regardless of whether it's specified in the markup or not.
findDocElements(expression[, ...]):
Performs a selection on the active document. Equivalent to findChildElements(MochiKit.DOM.currentDocument(), [expression, ...])
- Availability:
- Available in MochiKit 1.4+
findChildElements(element, expressions):
Traverses the child nodes of element and returns the subset of those that match any of the selector expressions in expressions.
Each expression can be a combination of simple expressions, by concatenating them with spaces or combinators. In that case, normal CSS rules apply, each simple expression is evaluated in turn and the results of that one is used as the scope for the succeeding expression (see Selector.findElements). Finally, the results of the last simple expression is returned as the search result.
- Availability:
- Available in MochiKit 1.4+
An alias to findDocElements.
- Availability:
- Available in MochiKit 1.4+
An object storing the parsed version of a simple CSS selector expression and providing functions for executing searches.
Simple means that the expression is not a combination of expressions, i.e. it does not contain any spaces.
Usually the user would not instantiate or use this object directly, but heres how:
var selector = new MochiKit.Selector.Selector('#someelementid'); var searchResults = selector.findElements(rootElement);
- Deprecated:
- Use findChildElements instead. The Selector class will be removed in version 1.5.
- Availability:
- Available in MochiKit 1.4+
Selector.findElements(scope[, axis=""]):
Performs a search on scope. The value of axis controls what relatives of scope are considered.
- scope:
- A DOM node that acts as a starting point for the search.
- axis:
- One of ">", "+", "~" or the empty string (default). If the empty string, all descendant nodes of scope are tested against the expression. If > only direct child nodes of scope are tested, if + only the next sibling (if any) of scope is tested and if ~ all succeeding siblings of scope are tested.
- Deprecated:
- Use findChildElements instead. The Selector class will be removed in version 1.5.
- Availability:
- Available in MochiKit 1.4+
| [1] | (1, 2) CSS Selectors Level 3 (Last Call, oct. 2006): http://www.w3.org/TR/2005/WD-css3-selectors-20051215/ |
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed free software; you can redistribute it and/or modify it under the terms of the MIT License or the Academic Free License v2.1.
Based on Prototype, (c) 2005 Sam Stephenson, available under the Prototype license
Back to docs index
MochiKit.DragAndDrop - drag and drop elements with MochiKit
// Create a draggable
new Draggable('mydrag');
// Create a corresponding droppable
new Droppable('mydrop', {
accept: ['drag-class'],
ondrop: function (element) {
alert('"' + element.id + '" was dropped on me');
}
});
MochiKit.DragAndDrop enables you the power of dragging elements through your pages, for richer interfaces.
The implementation was adapted from Scriptaculous.
Draggable(element[, options]):
A object that can be drag with the mouse.
You have the following options, with corresponding default values:
- handle (false):
- Option for giving the element where starting the drag. By default it's the element itself, but you can either put a class of a subelement or the id of another element as handle.
- starteffect (MochiKit.Visual.Opacity):
- Function called once the drag has begun, taking the dragged element as argument. It's an effect by default but you can define any callback.
- reverteffect (MochiKit.Visual.Move):
- Effect applied when drag is cancelled. You have to define the revert option to enable the call. By default it brings the element back to its initial position, so you should know what you want when you modify this. The function should return an effect that can be cancelled.
- endeffect (MochiKit.Visual.Opacity):
- Pending part of starteffect. If you have modified your element during start, you'd usually want to revert it in the function.
- zindex (1000):
- Zindex of the drag element. By default it brings it to front.
- revert (false):
- Indicate if the reverteffect function should be called. If you define a function here, this function will be called before reverteffect, with the element as first argument.
- snap (false):
- Define the behaviour of the drag element when moving. It can either be a function, a value or an array of two values. If it's a function, it should take the (x, y) position of the element as arguments, and return the position draw in the browser. If its a value, it's used as a modulo for each coordinates. If it's an array, each value is applied for the corresponding coordinate.
- selectclass (null):
- If defined, name of CSS class applied during the drag.
- ghosting (null):
- Make a ghost from the draggable: clone it at start, then remove the clone at end.
- onchange (MochiKit.Base.noop):
- Function called when updates are made on the draggable object.
- scroll (false):
- Element to scroll around, if precised. For example, window will allow the draggable to scroll in the page.
- scrollSensitivity (20):
- Scroll sensitivity, used when scroll is used.
- scrollSpeed (15):
- Scroll speed, used when scroll is used.
A draggable generates some signals during its lifetime: start, drag and end. They are available through the Draggables handler, and are called with a draggable as argument. You can register a callback for these events like this:
onStart = function (draggable) { // Do some stuff }; connect(Draggables, 'start', onStart);
- Availability:
- Available in MochiKit 1.4+
Droppable(element[, options]):
A object where you can drop a draggable.
You have the following options, with corresponding default values:
- greedy (true):
- Stop on this droppable when a draggable drops over it.
- hoverclass (null):
- If defined, name of CSS class applied when a draggable is hover the droppable element (hover state).
- hoverfunc (MochiKit.Base.noop):
- Function called on hover state.
- accept (null):
- Array of CSS classes allowed to drop on this.
- activeclass (null):
- If defined, name of CSS class applied if a possible draggable begins its start (active state).
- onactive (MochiKit.Base.noop):
- Function called on active state.
- containment ([]):
- Specify a list of elements to check for active state: only the children of the specified elements can be dropped. Mainly useful for Sortable.
- onhover (MochiKit.Base.noop):
- Specific hover function, mainly used for Sortable.
- ondrop (MochiKit.Base.noop):
- Function called when a draggable is dropped. The function takes three arguments: the draggable element, the droppable element, and the event that raised the drop.
- Availability:
- Available in MochiKit 1.4+
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed free software; you can redistribute it and/or modify it under the terms of the MIT License or the Academic Free License v2.1.
Portions adapted from Scriptaculous are available under the terms of the MIT License.
MochiKit - makes JavaScript suck a bit less
To turn off MochiKit's export feature (which may be necessary for compatibility with some existing code), do this before loading MochiKit:
<script type="text/javascript">MochiKit = {__export__: false};</script>
When export mode is off, you must use fully qualified names for all MochiKit functions (e.g. MochiKit.Base.map(...)).
2008-11-27 v1.4.2 (bug fix release)
2008-11-02 v1.4.1 (bug fix release)
2008-10-21 v1.4
2006-04-29 v1.3.1 (bug fix release)
2006-04-26 v1.3 "warp zone"
2006-01-26 v1.2 "the ocho"
2005-11-14 v1.1
2005-10-24 v1.0
2005-10-08 v0.90
2005-08-12 v0.80
2005-08-04 v0.70
2005-07-29 v0.60
2005-07-27 v0.50
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed free software; you can redistribute it and/or modify it under the terms of the MIT License or the Academic Free License v2.1.
Back to docs index
MochiKit.Base - functional programming and useful comparisons
myObjectRepr = function () {
// gives a nice, stable string representation for objects,
// ignoring any methods
var keyValuePairs = [];
for (var k in this) {
var v = this[k];
if (typeof(v) != 'function') {
keyValuePairs.push([k, v]);
}
};
keyValuePairs.sort(compare);
return "{" + map(
function (pair) {
return map(repr, pair).join(":");
},
keyValuePairs
).join(", ") + "}";
};
// repr() will look for objects that have a repr method
myObjectArray = [
{"a": 3, "b": 2, "repr": myObjectRepr},
{"a": 1, "b": 2, "repr": myObjectRepr}
];
// sort it by the "a" property, check to see if it matches
myObjectArray.sort(keyComparator("a"));
expectedRepr = '[{"a": 1, "b": 2}, {"a": 3, "b": 2}]';
assert( repr(myObjectArray) == expectedRepr );
// get just the "a" values out into an array
sortedAValues = map(itemgetter("a"), myObjectArray);
assert( compare(sortedAValues, [1, 3]) == 0 );
// serialize an array as JSON, unserialize it, expect something equivalent
myArray = [1, 2, "3", null, undefined];
assert( objEqual(evalJSON(serializeJSON(myArray)), myArray) );
MochiKit.Base is the foundation for the MochiKit suite. It provides:
Python users will feel at home with MochiKit.Base, as the facilities are quite similar to those available as part of Python and the Python standard library.
None.
The comparators (operators for comparison) in JavaScript are deeply broken, and it is not possible to teach them new tricks.
MochiKit exposes an extensible comparison facility as a simple compare(a, b) function, which should be used in lieu of JavaScript's operators whenever comparing objects other than numbers or strings (though you can certainly use compare for those, too!).
The compare function has the same signature and return value as a sort function for Array.prototype.sort, and is often used in that context.
Defining new comparators for the compare function to use is done by adding an entry to its AdapterRegistry with the registerComparator function.
JavaScript's default representation mechanism, toString, is notorious for having terrible default behavior. It's also very unwise to change that default, as other JavaScript code you may be using may depend on it.
It's also useful to separate the concept of a "string representation" and a "string representation for programmers", much like Python does with its str and repr protocols.
repr provides this programmer representation for JavaScript, in a way that doesn't require object prototype hacking: using an AdapterRegistry.
Objects that implement the repr protocol can either implement a .repr() or .__repr__() method, or they can simply have an adapter setup to generate programmer representations. By default, the registry provides nice representations for null, undefined, Array, and objects or functions with a NAME attribute that use the default toString. For objects that repr doesn't already understand, it simply defaults to toString, so it will integrate seamlessly with code that implements the idiomatic JavaScript toString method!
To define a programmer representation for your own objects, simply add a .repr() or .__repr__() method that returns a string. For objects that you didn't create (e.g., from a script you didn't write, or a built-in object), it is instead recommended that you create an adapter with registerRepr.
JSON [1], JavaScript Object Notation, is a widely used serialization format in the context of web development. It's extremely simple, lightweight, and fast. In its essence, JSON is a restricted subset of JavaScript syntax suitable for sending over the wire that can be unserialized with a simple eval. It's often used as an alternative to XML in "AJAX" contexts because it is compact, fast, and much simpler to use for most purposes.
To create a JSON serialization of any object, simply call serializeJSON() with that object. To unserialize a JSON string, simply call evalJSON() with the serialization.
In order of precedence, serializeJSON coerces the given argument into a JSON serialization:
MochiKit makes extensive use of adapter registries, which enable you to implement object-specific behaviors for objects that you do not necessarily want to modify, such as built-in objects. This is especially useful because JavaScript does not provide a method for hiding user-defined properties from for propName in obj enumeration.
AdapterRegistry is simply an encapsulation for an ordered list of "check" and "wrap" function pairs. Each AdapterRegistry instance should perform one function, but may have multiple ways to achieve that function based upon the arguments. One way to think of it is as a poor man's generic function, or multiple dispatch (on arbitrary functions, not just type!).
Check functions take one or more arguments, and return true if the argument list is suitable for the wrap function. Check functions should perform "cheap" checks of an object's type or contents, before the "expensive" wrap function is called.
Wrap functions take the same arguments as check functions and do some operation, such as creating a programmer representation or comparing both arguments.
Much of MochiKit.Base is there to simply remove the grunt work of doing generic JavaScript programming.
Need to take every property from one object and set them on another? No problem, just call update(dest, src)! What if you just wanted to update keys that weren't already set? Look no further than setdefault(dest, src[, ...]).
Want to return a mutable object, but don't want to suffer the consequences if the user mutates it? Just clone(it) and you'll get a copy-on-write clone. Cheaper than a copy!
Need to extend an Array with another array? Or even an Array-like object such as a NodeList or the special arguments object? Even if you need to skip the first few elements of the source Array-like object, it's no problem with extend(dstArray, srcArrayLike[, skip])!
Wouldn't it be convenient to have all of the JavaScript operators were available as functions somewhere? That's what the operators table is for, and it even comes with additional operators based on the compare function.
Need to walk some tree of objects and manipulate or find something in it? A DOM element tree perhaps? Use nodeWalk(node, visitor)!
There's plenty more, so check out the API Reference below.
Functional programming constructs such as map and filter can save you a lot of time, because JavaScript iteration is error-prone and arduous. Writing less code is the best way to prevent bugs, and functional programming can help you do that.
MochiKit.Base ships with a few simple Array-based functional programming constructs, namely map and filter, and their "extended" brethren, xmap and xfilter.
map(func, arrayLike[, ...]) takes a function and an Array-like object, and creates a new Array. The new Array is the result of func(element) for every element of arrayLike, much like the Array.prototype.map extension in Mozilla. However, MochiKit.Base takes that a step further and gives you the full blown Python version of map, which will take several Array-like objects, and calls the function with one argument per given Array-like, e.g.:
var arrayOne = [1, 2, 3, 4, 5]; var arrayTwo = [1, 5, 2, 4, 3]; var arrayThree = [5, 2, 1, 3, 4]; var biggestElements = map(objMax, arrayOne, arrayTwo, arrayThree); assert( objEqual(biggestElements, [5, 5, 3, 4, 5]) );
filter(func, arrayLike[, self]) takes a function and an Array-like object, and returns a new Array. This is basically identical to the Array.prototype.filter extension in Mozilla. self, if given, will be used as this in the context of func when called.
xmap and xfilter are just special forms of map and filter that accept a function as the first argument, and use the extra arguments as the Array-like. Not terribly interesting, but a definite time-saver in some cases.
If you appreciate the functional programming facilities here, you should definitely check out MochiKit.Iter, which provides full blown iterators, MochiKit.Iter.range, MochiKit.Iter.reduce, and a near-complete port of Python's itertools [2] module, with some extra stuff thrown in for good measure!
JavaScript's method-calling special form and lack of bound functions (functions that know what this should be) are one of the first stumbling blocks that programmers new to JavaScript face. The bind(func, self) method fixes that right up by returning a new function that calls func with the right this.
In order to take real advantage of all this fancy functional programming stuff, you're probably going to want partial application. This allows you to create a new function from an existing function that remembers some of the arguments. For example, if you wanted to compare a given object to a slew of other objects, you could do something like this:
compareWithOne = partial(compare, 1); results = map(compareWithOne, [0, 1, 2, 3]); assert( objEqual(results, [-1, 0, 1, 1]) );
One of the better uses of partial functions is in MochiKit.DOM, which is certainly a must-see for those of you creating lots of DOM elements with JavaScript!
A singleton error raised when no suitable adapter is found
- Availability:
- Available in MochiKit 1.3.1+
A registry to facilitate adaptation.
All check/wrap function pairs in a given registry should take the same number of arguments.
- Availability:
- Available in MochiKit 1.3.1+
AdapterRegistry.prototype.register(name, check, wrap[, override]):
- name:
- a unique identifier used to identify this adapter so that it may be unregistered.
- check:
- function that should return true if the given arguments are appropriate for the wrap function.
- wrap:
- function that takes the same parameters as check and does the adaptation. Every wrap/check function pair in the registry should have the same number of arguments.
- override:
- if true, the check function will be given highest priority. Otherwise, the lowest.
- Availability:
- Available in MochiKit 1.3.1+
AdapterRegistry.prototype.match(obj[, ...]):
Find an adapter for the given arguments by calling every check function until one returns true.
If no suitable adapter is found, throws NotFound.
- Availability:
- Available in MochiKit 1.3.1+
AdapterRegistry.prototype.unregister(name):
Remove a named adapter from the registry
- Availability:
- Available in MochiKit 1.3.1+
Convenience constructor for creating new errors (e.g. NotFound)
- Availability:
- Available in MochiKit 1.3.1+
Compare the arrays self and arr for equality using compare on each element. Uses a fast-path for length differences.
- Availability:
- Available in MochiKit 1.3.1+
This function is an alias of mean().
- Availability:
- Available in MochiKit 1.3.1+
Return a copy of func bound to self. This means whenever and however the returned function is called, this will always reference the given self. func may be either a function object, or a string. If it is a string, then self[func] will be used, making these two statements equivalent:
bind("method", self); bind(self.method, self);Calling bind(func, self) on an already bound function will return a new function that is bound to the new self! If self is undefined, then the previous self is used. If self is null, then the this object is used (which may or may not be the global object). To force binding to the global object, you should pass it explicitly.
Additional arguments, if given, will be partially applied to the function. These three expressions are equivalent and return equally efficient functions (bind and partial share the same code path):
- bind(oldfunc, self, arg1, arg2)
- bind(partial(oldfunc, arg1, arg2), self)
- partial(bind(oldfunc, self), arg1, arg2)
- Availability:
- Available in MochiKit 1.3.1+
bindLate(func, self[, arg, ...]):
Alternate version of bind that uses late lookup of the func parameter in self. I.e, the self[func] function lookup will occur on each call to the returned function, not when bindLate is called. Note that this difference is only applicable when func is a string, otherwise bindLate and bind are identical.
- Availability:
- Available in MochiKit 1.4+
Replace all functions meth on self with bind(meth, self). This emulates Python's bound instance methods, where there is no need to worry about preserving this when the method is used as a callback.
- Availability:
- Available in MochiKit 1.3.1+
Converts hyphenated strings to camelCase:
assert( camelize("border-left") == "borderLeft" );
- Availability:
- Available in MochiKit 1.4+
Return a new object using obj as its prototype. Use this if you want to return a mutable object (e.g. instance state), but don't want the user to mutate it. If they do, it won't have any effect on the original obj.
Note that this is a shallow clone, so mutable properties will have to be cloned separately if you want to "protect" them.
- Availability:
- Available in MochiKit 1.3.1+
Compare two objects in a sensible manner. Currently this is:
- undefined and null compare equal to each other
- undefined and null are less than anything else
- If JavaScript says a == b, then we trust it
- comparators registered with registerComparator are used to find a good comparator. Built-in comparators are currently available for Array-like and Date-like objects.
- Otherwise hope that the built-in comparison operators do something useful, which should work for numbers and strings.
- If neither a < b or a > b, then throw a TypeError
Returns what one would expect from a comparison function:
Value Condition 0 a == b 1 a > b -1 a < b
- Availability:
- Available in MochiKit 1.3.1+
Return a new function as the combination of the given function arguments, equivalent to f1(f2(arguments)).
- Availability:
- Available in MochiKit 1.4+
Concatenates all given Array-like arguments and returns a new Array:
var lst = concat(["1","3","5"], ["2","4","6"]); assert( lst.toString() == "1,3,5,2,4,6" );
- Availability:
- Available in MochiKit 1.3.1+
Returns a function that will return a number one greater than the previous returned value, starting at n. For example:
nextId = counter() assert( nextId() == 1 ) assert( nextId() == 2 )For an iterator with this behavior, see MochiKit.Iter.count.
- Availability:
- Available in MochiKit 1.3.1+
Mutate the array self by extending it with an Array-like obj, starting from index skip. If null is given as the initial array, a new one will be created.
This mutates and returns self, be warned.
- Availability:
- Available in MochiKit 1.3.1+
Unserialize a JSON [1] represenation of an object.
Note that this uses the eval function of the interpreter, and therefore trusts the contents of aJSONString to be safe. This is acceptable when the JSON and JavaScript application originate from the same server, but in other scenarios it may not be the appropriate security model. Currently, a validating JSON parser is beyond the scope of MochiKit, but there is one available from json.org [1].
- Availability:
- Available in MochiKit 1.3.1+
Returns a new Array composed of all elements from lst where fn(lst[i]) returns a true value.
If fn is null, operator.truth will be used.
- Availability:
- Available in MochiKit 1.3.1+
findValue(lst, value, start=0, end=lst.length):
Finds the index of value in the Array-like object lst using compare. The search starts at the index start, and ends at the index end - 1. If value is not found in lst, it will return -1.
For example:
assert( findValue([1, 2, 3, 2, 1], 2) == 1 ) assert( findValue([1, 2, 3, 2, 1], 2, 2) == 3 )
- Availability:
- Available in MochiKit 1.3.1+
findIdentical(lst, value, start=0, end=lst.length):
Finds the index of value in the Array-like object lst using the === operator. The search starts at the index start, and ends at the index end - 1. If value is not found in lst, it will return -1.
You should use this function instead of findValue if lst may be comprised of objects for which no comparator is defined and all you care about is finding an identical object (e.g. the same instance), or if lst is comprised of just numbers or strings and performance is important.
For example:
assert( findIdentical([1, 2, 3, 2, 1], 2) == 1 ) assert( findIdentical([1, 2, 3, 2, 1], 2, 2) == 3 )
- Availability:
- Available in MochiKit 1.3.1+
Given a bunch of arguments, return a single Array containing all of those arguments. Any Array-like argument will be extended in-place, e.g.:
compare(flattenArguments(1, [2, 3, [4, 5]]), [1, 2, 3, 4, 5]) == 0
- Availability:
- Available in MochiKit 1.3.1+
Return a new Array consisting of every item in lst with Array items expanded in-place recursively. This differs from flattenArguments in that it only takes one argument and it only flattens items that are instanceof Array.
compare(flattenArray([1, [2, 3, [4, 5]]]), [1, 2, 3, 4, 5]) == 0
- Availability:
- Available in MochiKit 1.4+
Returns a function that forwards a method call to this.name(...)
- Availability:
- Available in MochiKit 1.3.1+
Returns true if all given arguments are Array-like (have a .length property and typeof(obj) == 'object')
- Availability:
- Available in MochiKit 1.3.1+
Returns true if all given arguments are Date-like (have a .getTime() method)
- Availability:
- Available in MochiKit 1.3.1+
Returns true if all the given Array-like or string arguments are empty (obj.length == 0)
- Availability:
- Available in MochiKit 1.3.1+
Returns true if all the given Array-like or string arguments are not empty (obj.length > 0)
- Availability:
- Available in MochiKit 1.3.1+
Returns true if all arguments are null.
- Availability:
- Available in MochiKit 1.3.1+
isUndefinedOrNull(obj[, ...]):
Returns true if all arguments are undefined or null
- Availability:
- Available in MochiKit 1.3.1+
Returns a function(obj) that returns obj[name]
- Availability:
- Available in MochiKit 1.3.1+
Return an Array of [propertyName, propertyValue] pairs for the given obj (in the order determined by for propName in obj).
- Availability:
- Available in MochiKit 1.3.1+
A comparator factory that compares a[key] with b[key]. e.g.:
var lst = ["a", "bbb", "cc"]; lst.sort(keyComparator("length")); assert( lst.toString() == "a,cc,bbb" );
- Availability:
- Available in MochiKit 1.3.1+
Return an Array of the property names of an object (in the order determined by for propName in obj).
- Availability:
- Available in MochiKit 1.3.1+
Return the largest element of an Array-like object, as determined by compare. This is a special form of listMinMax, specifically partial(listMinMax, 1).
- Availability:
- Available in MochiKit 1.3.1+
Return the smallest element of an Array-like object, as determined by compare. This is a special form of listMinMax, specifically partial(listMinMax, -1).
- Availability:
- Available in MochiKit 1.3.1+
If which == -1 then it will return the smallest element of the Array-like lst. This is also available as listMin(lst).
If which == 1 then it will return the largest element of the Array-like lst. This is also available as listMax(list).
- Availability:
- Available in MochiKit 1.3.1+
Return a new array composed of the results of fn(x) for every x in lst.
If fn is null, and only one sequence argument is given the identity function is used.
map(null, lst) -> lst.slice();If fn is not null and more than one sequence argument is given, then one element from each sequence is used to build the argument list for fn.
- map(fn, p, q, ...)
- -> [fn(p[0], q[0], ..), fn(p[1], q[1], ...), ...]
If fn is null, and more than one sequence is given as arguments, then the Array function is used.
- map(null, p, q, ...)
- -> MochiKit.Iter.zip(p, q, ...) -> [[p0, q0, ...], [p1, q1, ...], ...];
Since this is a common idiom, zip(p, q, ...) is actually a shortcut for this.
- Availability:
- Available in MochiKit 1.3.1+
Returns the arithmetic mean (average) of the argument list, or an array. This function applies flattenArguments() to the argument list.
- Availability:
- Available in MochiKit 1.4+
Returns the median of the argument list, or an array. This function applies flattenArguments() to the argument list.
- Availability:
- Available in MochiKit 1.4+
Create a new instance of Object that contains every property from all given objects. If a property is defined on more than one of the objects, the last property is used.
This is a special form of update(self, obj[, ...]), specifically, it is defined as partial(update, null).
- Availability:
- Available in MochiKit 1.3.1+
Alternate form of bind that takes the object before the function. These two calls are equivalent:
bind("method", myobject) method(myobject, "method")
- Availability:
- Available in MochiKit 1.3.1+
methodcaller(name[, args...]):
Return a new function that calls a method on its argument, for example:
lst = map(methodcaller("toLowerCase"), ["THIS", "is", "LoWeRCaSe"]); assert( lst.join(" ") == "this is lowercase" );
- Availability:
- Available in MochiKit 1.4+
Given a namespace (object or function) with a NAME property, find all methods in it and give them nice NAME properties too (for use with repr). e.g.:
namespace = { NAME: "Awesome", Dude: function () {} } nameFunctions(namespace); assert( namespace.Dude.NAME == 'Awesome.Dude' );
- Availability:
- Available in MochiKit 1.3.1+
A function that performs no operation. Use this where you would otherwise use (function () {}) in order to avoid Internet Explorer cyclic garbage leakage.
- Availability:
- Available in MochiKit 1.4
Return true if compare(a, b) == 0
- Availability:
- Available in MochiKit 1.3.1+
Non-recursive generic node walking function (e.g. for a DOM).
The walk order for nodeWalk is breadth first, meaning that all siblings will be visited before any children.
- node:
- The initial node to be searched.
- visitor:
- The visitor function, will be called as visitor(node), and should return an Array-like of nodes to be searched next (e.g. node.childNodes). Leaf nodes may return null or undefined.
- Availability:
- Available in MochiKit 1.3.1+
Return the maximum object according to compare out of the given arguments. This is similar to listMax, except is uses the arguments instead of a given Array-like.
- Availability:
- Available in MochiKit 1.3.1+
Return the minimum object according to compare out of the given arguments. This is similar to listMin, except it uses the arguments instead of a given Array-like.
- Availability:
- Available in MochiKit 1.3.1+
A table of JavaScript's operators for usage with map, filter, etc.
Unary Logic Operators:
Operator Implementation Description truth(a) !!a Logical truth lognot(a) !a Logical not identity(a) a Logical identity Unary Math Operators:
Operator Implementation Description not(a) ~a Bitwise not neg(a) -a Negation Binary Operators:
Operator Implementation Description add(a, b) a + b Addition sub(a, b) a - b Subtraction div(a, b) a / b Division mod(a, b) a % b Modulus mul(a, b) a * b Multiplication and(a, b) a & b Bitwise and or(a, b) a | b Bitwise or xor(a, b) a ^ b Bitwise exclusive or lshift(a, b) a << b Bitwise left shift rshift(a, b) a >> b Bitwise signed right shift zrshift(a, b) a >>> b Bitwise unsigned right shift Built-in Comparators:
Operator Implementation Description eq(a, b) a == b Equals ne(a, b) a != b Not equals gt(a, b) a > b Greater than ge(a, b) a >= b Greater than or equal to lt(a, b) a < b Less than le(a, b) a <= b Less than or equal to Strict Built-in Comparators:
Operator Implementation Description seq(a, b) a === b Strict equals sne(a, b) a !== b Strict not equals Extended Comparators (uses compare):
Operator Implementation Description ceq(a, b) compare(a, b) == 0 Equals cne(a, b) compare(a, b) != 0 Not equals cgt(a, b) compare(a, b) == 1 Greater than cge(a, b) compare(a, b) != -1 Greater than or equal to clt(a, b) compare(a, b) == -1 Less than cle(a, b) compare(a, b) != 1 Less than or equal to Binary Logical Operators:
Operator Implementation Description logand(a, b) a && b Logical and logor(a, b) a || b Logical or contains(a, b) b in a Has property (note order)
- Availability:
- Available in MochiKit 1.3.1+
parseQueryString(encodedString[, useArrays=false]):
Parse a name=value pair URL query string into an object with a property for each pair. e.g.:
var args = parseQueryString("foo=value%20one&bar=two"); assert( args.foo == "value one" && args.bar == "two" );If you expect that the query string will reuse the same name, then give true as a second argument, which will use arrays to store the values. e.g.:
var args = parseQueryString("foo=one&foo=two", true); assert( args.foo[0] == "one" && args.foo[1] == "two" );
- Availability:
- Available in MochiKit 1.3.1+
Return a partially applied function, e.g.:
addNumbers = function (a, b) { return a + b; } addOne = partial(addNumbers, 1); assert(addOne(2) == 3);partial is a special form of bind that does not alter the bound self (if any). It is equivalent to calling:
bind(func, undefined, arg[, ...]);See the documentation for bind for more details about this facility.
This could be used to implement, but is NOT currying.
- Availability:
- Available in MochiKit 1.3.1+
Creates a URL query string from a pair of Array-like objects representing names and values. Each name=value pair will be URL encoded by urlEncode. name=value pairs with a value of undefined or null will be skipped. e.g.:
var keys = ["foo", "bar"]; var values = ["value one", "two"]; assert( queryString(keys, values) == "foo=value%20one&bar=two" );
- Alternate form 1:
- queryString(domElement)
If MochiKit.DOM is loaded, one argument is given, and that argument is either a string or has a nodeType property greater than zero, then names and values will be the result of MochiKit.DOM.formContents(domElement).
- Alternate form 2:
- queryString({name: value, ...})
Note that when using the alternate form, the order of the name=value pairs in the resultant query string is dependent on how the particular JavaScript implementation handles for (..in..) property enumeration.
When using the second alternate form, name=value pairs with typeof(value) == "function" are ignored. This is a workaround for the case where a poorly designed library has modified Object.prototype and inserted "convenience functions".
Values that are Array-like will be expanded as if they were multiply defined HTML elements. For example:
assert( queryString({a: [1,2]}) === "a=1&a=2" );
- Alternate form 2 (MochiKit 1.4+):
- queryString([names, values])
This form behaves identically to queryString(names, values), except it takes both arguments as a single Array. This mirrors the return value of MochiKit.DOM.formContents.
- Availability:
- Available in MochiKit 1.3.1+
registerComparator(name, check, comparator[, override]):
Register a comparator for use with compare.
- name:
- unique identifier describing the comparator.
- check:
- function(a, b) that returns true if a and b can be compared with comparator.
- comparator:
function(a, b) that returns:
Value Condition 0 a == b 1 a > b -1 a < b comparator is guaranteed to only be called if check(a, b) returns a true value.
- override:
- if true, then this will be made the highest precedence comparator. Otherwise, the lowest.
- Availability:
- Available in MochiKit 1.3.1+
registerJSON(name, check, simplifier[, override]):
Register a simplifier function for use with serializeJSON.
- name:
- unique identifier describing the serialization.
- check:
- function(obj) that returns true if obj can can be simplified for serialization by simplifier.
- simplifier:
function(obj) that returns a simpler object that can be further serialized by serializeJSON. For example, you could simplify Date-like objects to ISO 8601 timestamp strings with the following simplifier:
var simplifyDateAsISO = function (obj) { return toISOTimestamp(obj, true); }; registerJSON("DateLike", isDateLike, simplifyDateAsISO);simplifier is guaranteed to only be called if check(obj) returns a true value.
- override:
- if true, then this will be made the highest precedence serialization. Otherwise, the lowest.
- Availability:
- Available in MochiKit 1.3.1+
registerRepr(name, check, wrap[, override]):
Register a programmer representation function. repr functions should take one argument and return a string representation of it suitable for developers, primarily used when debugging.
If override is given, it is used as the highest priority repr, otherwise it will be used as the lowest.
- Availability:
- Available in MochiKit 1.3.1+
Return a programmer representation for obj. See the Programmer Representation overview for more information about this function.
- Availability:
- Available in MochiKit 1.3.1+
A comparator factory that compares a[key] with b[key] in reverse. e.g.:
var lst = ["a", "bbb", "cc"]; lst.sort(reverseKeyComparator("length")); assert(lst.toString() == "bbb,cc,a");
- Availability:
- Available in MochiKit 1.3.1+
Serialize anObject in the JSON [1] format, see JSON Serialization for the coercion rules. For unserializable objects (functions that do not have an adapter, __json__ method, or json method), this will return undefined.
For those familiar with Python, JSON is similar in scope to pickle, but it can not handle recursive object graphs.
- Availability:
- Available in MochiKit 1.3.1+
Mutate self by adding all properties from other object(s) that it does not already have set.
If self is null, a new Object instance will be created and returned.
This mutates and returns self, be warned.
- Availability:
- Available in MochiKit 1.3.1+
Given a set of types (as string arguments), returns a function(obj[, ...]) that will return true if the types of the given arguments are all members of that set.
- Availability:
- Available in MochiKit 1.3.1+
Mutate self by replacing its key:value pairs with those from other object(s). Key:value pairs from later objects will overwrite those from earlier objects.
If self is null, a new Object instance will be created and returned.
This mutates and returns self, be warned.
A version of this function that creates a new object is available as merge(a, b[, ...])
- Availability:
- Available in MochiKit 1.3.1+
Mutate self by replacing its key:value pairs with those from other object(s). If a given key has an object value in both self and obj, then this function will be called recursively, updating instead of replacing that object.
If self is null, a new Object instance will be created and returned.
This mutates and returns self, be warned.
- Availability:
- Available in MochiKit 1.3.1+
Converts unencoded into a URL-encoded string. In this implementation, spaces are converted to %20 instead of "+". e.g.:
assert( URLencode("1+2=2") == "1%2B2%3D2");
- Availability:
- Available in MochiKit 1.3.1+
Return an Array of the property values of an object (in the order determined by for propName in obj).
- Availability:
- Available in MochiKit 1.4+
Returns a new Array composed of the arguments where fn(obj) returns a true value.
If fn is null, operator.truth will be used.
- Availability:
- Available in MochiKit 1.3.1+
Return a new Array composed of fn(obj) for every obj given as an argument.
If fn is null, operator.identity is used.
- Availability:
- Available in MochiKit 1.3.1+
Returns an array where the n-th element is an array of the n-th elements from each of the arrays p, q, ...
This is equivalent to calling map(fn, p, q, ...) with null as the first argument.
- zip(p, q, ...)
- -> map(null, p, q, ...) -> [[p0, q0, ...], [p1, q1, ...], ...];
- Availability:
- Available in MochiKit 1.3.1+
| [1] | (1, 2, 3, 4, 5) JSON, JavaScript Object Notation: http://json.org/ |
| [2] | Python's itertools module: http://docs.python.org/lib/module-itertools.html |
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed free software; you can redistribute it and/or modify it under the terms of the MIT License or the Academic Free License v2.1.
Back to docs index
MochiKit.Async - manage asynchronous tasks
var url = "/src/b/bo/bob/MochiKit.Async/META.json";
/*
META.json looks something like this:
{"name": "MochiKit", "version": "0.5"}
*/
var d = loadJSONDoc(url);
var gotMetadata = function (meta) {
if (MochiKit.Async.VERSION == meta.version) {
alert("You have the newest MochiKit.Async!");
} else {
alert("MochiKit.Async "
+ meta.version
+ " is available, upgrade!");
}
};
var metadataFetchFailed = function (err) {
alert("The metadata for MochiKit.Async could not be fetched :(");
};
d.addCallbacks(gotMetadata, metadataFetchFailed);
MochiKit.Async provides facilities to manage asynchronous (as in AJAX [1]) tasks. The model for asynchronous computation used in this module is heavily inspired by Twisted [2].
The current implementation of evalJSONRequest does no input validation. Invalid JSON can execute arbitrary JavaScript code in the client. This isn't normally a concern because of the same-origin policy in web browsers; the server is already sending arbitrary code to the client (your program!).
While this isn't directly relevant to MochiKit, server-side code that produces JSON should consider potential cross-site request forgery. Currently known exploits require a JSON array to be the outer-most object, and the data to be leaked must be known keys in objects contained by that array:
[{"some_known_key": "this can be leaked"}, "but not this"]
This exploit does not apply to the most common usage of JSON, sending an object:
{"some_known_key": "this can't be leaked"}
There are several ways to avoid this, here are a few:
The Deferred constructor encapsulates a single value that is not available yet. The most important example of this in the context of a web browser would be an XMLHttpRequest to a server. The importance of the Deferred is that it allows a consistent API to be exposed for all asynchronous computations that occur exactly once.
The producer of the Deferred is responsible for doing all of the complicated work behind the scenes. This often means waiting for a timer to fire, or waiting for an event (e.g. onreadystatechange of XMLHttpRequest). It could also be coordinating several events (e.g. XMLHttpRequest with a timeout, or several Deferreds (e.g. fetching a set of XML documents that should be processed at the same time).
Since these sorts of tasks do not respond immediately, the producer of the Deferred does the following steps before returning to the consumer:
Since the value is not yet ready, the consumer attaches a function to the Deferred that will be called when the value is ready. This is not unlike setTimeout, or other similar facilities you may already be familiar with. The consumer can also attach an "errback" to the Deferred, which is a callback for error handling.
When the value is ready, the producer simply calls myDeferred.callback(theValue). If an error occurred, it should call myDeferred.errback(theValue) instead. As soon as this happens, the callback that the consumer attached to the Deferred is called with theValue as the only argument.
There are quite a few additional "advanced" features baked into Deferred, such as cancellation and callback chains, so take a look at the API reference if you would like to know more!
Thrown by a Deferred if .callback or .errback are called more than once.
- Availability:
- Available in MochiKit 1.3.1+
Thrown when the JavaScript runtime is not capable of performing the given function. Currently, this happens if the browser does not support XMLHttpRequest.
- Availability:
- Available in MochiKit 1.3.1+
Thrown by a Deferred when it is cancelled, unless a canceller is present and throws something else.
- Availability:
- Available in MochiKit 1.3.1+
Results passed to .fail or .errback of a Deferred are wrapped by this Error if !(result instanceof Error).
- Availability:
- Available in MochiKit 1.3.1+
Thrown when an XMLHttpRequest does not complete successfully for any reason. The req property of the error is the failed XMLHttpRequest object, and for convenience the number property corresponds to req.status.
- Availability:
- Available in MochiKit 1.3.1+
Encapsulates a sequence of callbacks in response to a value that may not yet be available. This is modeled after the Deferred class from Twisted [3].
Why do we want this? JavaScript has no threads, and even if it did, threads are hard. Deferreds are a way of abstracting non-blocking events, such as the final response to an XMLHttpRequest.
The sequence of callbacks is internally represented as a list of 2-tuples containing the callback/errback pair. For example, the following call sequence:
var d = new Deferred(); d.addCallback(myCallback); d.addErrback(myErrback); d.addBoth(myBoth); d.addCallbacks(myCallback, myErrback);is translated into a Deferred with the following internal representation:
[ [myCallback, null], [null, myErrback], [myBoth, myBoth], [myCallback, myErrback] ]The Deferred also keeps track of its current status (fired). Its status may be one of the following three values:
Value Condition -1 no value yet (initial condition) 0 success 1 error A Deferred will be in the error state if one of the following conditions are met:
- The result given to callback or errback is "instanceof Error"
- The callback or errback threw while executing. If the thrown object is not instanceof Error, it will be wrapped with GenericError.
Otherwise, the Deferred will be in the success state. The state of the Deferred determines the next element in the callback sequence to run.
When a callback or errback occurs with the example deferred chain, something equivalent to the following will happen (imagine that exceptions are caught and returned as-is):
// d.callback(result) or d.errback(result) if (!(result instanceof Error)) { result = myCallback(result); } if (result instanceof Error) { result = myErrback(result); } result = myBoth(result); if (result instanceof Error) { result = myErrback(result); } else { result = myCallback(result); }The result is then stored away in case another step is added to the callback sequence. Since the Deferred already has a value available, any new callbacks added will be called immediately.
There are two other "advanced" details about this implementation that are useful:
Callbacks are allowed to return Deferred instances, so you can build complicated sequences of events with (relative) ease.
The creator of the Deferred may specify a canceller. The canceller is a function that will be called if Deferred.prototype.cancel is called before the Deferred fires. You can use this to allow an XMLHttpRequest to be cleanly cancelled, for example. Note that cancel will fire the Deferred with a CancelledError (unless your canceller throws or returns a different Error), so errbacks should be prepared to handle that Error gracefully for cancellable Deferred instances.
- Availability:
- Available in MochiKit 1.3.1+
Deferred.prototype.addBoth(func):
Add the same function as both a callback and an errback as the next element on the callback sequence. This is useful for code that you want to guarantee to run, e.g. a finalizer.
If additional arguments are given, then func will be replaced with MochiKit.Base.partial.apply(null, arguments). This differs from Twisted, because the result of the callback or errback will be the last argument passed to func.
If func returns a Deferred, then it will be chained (its value or error will be passed to the next callback). Note that once the returned Deferred is chained, it can no longer accept new callbacks.
- Availability:
- Available in MochiKit 1.3.1+
Deferred.prototype.addCallback(func[, ...]):
Add a single callback to the end of the callback sequence.
If additional arguments are given, then func will be replaced with MochiKit.Base.partial.apply(null, arguments). This differs from Twisted, because the result of the callback will be the last argument passed to func.
If func returns a Deferred, then it will be chained (its value or error will be passed to the next callback). Note that once the returned Deferred is chained, it can no longer accept new callbacks.
- Availability:
- Available in MochiKit 1.3.1+
Deferred.prototype.addCallbacks(callback, errback):
Add separate callback and errback to the end of the callback sequence. Either callback or errback may be null, but not both.
If callback or errback returns a Deferred, then it will be chained (its value or error will be passed to the next callback). Note that once the returned Deferred is chained, it can no longer accept new callbacks.
- Availability:
- Available in MochiKit 1.3.1+
Deferred.prototype.addErrback(func):
Add a single errback to the end of the callback sequence.
If additional arguments are given, then func will be replaced with MochiKit.Base.partial.apply(null, arguments). This differs from Twisted, because the result of the errback will be the last argument passed to func.
If func returns a Deferred, then it will be chained (its value or error will be passed to the next callback). Note that once the returned Deferred is chained, it can no longer accept new callbacks.
- Availability:
- Available in MochiKit 1.3.1+
Deferred.prototype.callback([result]):
Begin the callback sequence with a non-Error result. Result may be any value except for a Deferred.
Either .callback or .errback should be called exactly once on a Deferred.
- Availability:
- Available in MochiKit 1.3.1+
Cancels a Deferred that has not yet received a value, or is waiting on another Deferred as its value.
If a canceller is defined, the canceller is called. If the canceller did not return an Error, or there was no canceller, then the errback chain is started with CancelledError.
- Availability:
- Available in MochiKit 1.3.1+
Deferred.prototype.errback([result]):
Begin the callback sequence with an error result. Result may be any value except for a Deferred, but if !(result instanceof Error), it will be wrapped with GenericError.
Either .callback or .errback should be called exactly once on a Deferred.
- Availability:
- Available in MochiKit 1.3.1+
A lock for asynchronous systems.
The locked property of a DeferredLock will be true if it locked, false otherwise. Do not change this property.
- Availability:
- Available in MochiKit 1.3.1+
DeferredLock.prototype.acquire():
Attempt to acquire the lock. Returns a Deferred that fires on lock acquisition with the DeferredLock as the value. If the lock is locked, then the Deferred goes into a waiting list.
- Availability:
- Available in MochiKit 1.3.1+
DeferredLock.prototype.release():
Release the lock. If there is a waiting list, then the first Deferred in that waiting list will be called back.
- Availability:
- Available in MochiKit 1.3.1+
DeferredList(list, [fireOnOneCallback, fireOnOneErrback, consumeErrors, canceller]):
Combine a list of Deferred into one. Track the callbacks and return a list of (success, result) tuples, 'success' being a boolean indicating whether result is a normal result or an error.
Once created, you have access to all Deferred methods, like addCallback, addErrback, addBoth. The behaviour can be changed by the following options:
- fireOnOneCallback:
- Flag for launching the callback once the first Deferred of the list has returned.
- fireOnOneErrback:
- Flag for calling the errback at the first error of a Deferred.
- consumeErrors:
- Flag indicating that any errors raised in the Deferreds should be consumed by the DeferredList.
Example:
// We need to fetch data from 2 different urls var d1 = loadJSONDoc(url1); var d2 = loadJSONDoc(url2); var l1 = new DeferredList([d1, d2], false, false, true); l1.addCallback(function (resultList) { MochiKit.Base.map(function (result) { if (result[0]) { alert("Data is here: " + result[1]); } else { alert("Got an error: " + result[1]); } }, resultList); });
- Availability:
- Available in MochiKit 1.3.1+
callLater(seconds, func[, args...]):
Call func(args...) after at least seconds seconds have elapsed. This is a convenience method for:
func = partial.apply(extend(null, arguments, 1)); return wait(seconds).addCallback(function (res) { return func() });Returns a cancellable Deferred.
- Availability:
- Available in MochiKit 1.3.1+
doXHR(url[, {option: value, ...}]):
Perform a customized XMLHttpRequest and wrap it with a Deferred that may be cancelled.
Note that only 200 (OK), 201 (CREATED), 204 (NO CONTENT) and 304 (NOT MODIFIED) are considered success codes. All other status codes will result in an errback with an XMLHttpRequestError.
- url:
- The URL for this request.
The following options are currently accepted:
- method:
- The HTTP method. Default is 'GET'.
- sendContent:
- The content to send (e.g. with POST). Default is no content.
- queryString:
- If present it will be used to build a query string to append to the url using MochiKit.Base.queryString. Default is no query string.
- username:
- The username for the request. Default is no username.
- password:
- The password for the request. Default is no password.
- headers:
- Additional headers to set in the request, either as an object such as {'Accept': 'text/xml'} or as an Array of 2-Arrays [['Accept', 'text/xml']]. Default is no additional headers.
- mimeType:
- An override mime type. The typical use of this is to pass 'text/xml' to force XMLHttpRequest to attempt to parse responseXML. Default is no override.
- returns:
- Deferred that will callback with the XMLHttpRequest instance on success
- Availability:
- Available in MochiKit 1.4+.
doSimpleXMLHttpRequest(url[, queryArguments...]):
Perform a simple XMLHttpRequest and wrap it with a Deferred that may be cancelled.
Note that only 200 (OK), 201 (CREATED), 204 (NO CONTENT) and 304 (NOT MODIFIED) are considered success codes. All other status codes will result in an errback with an XMLHttpRequestError.
- url:
- The URL to GET
- queryArguments:
If this function is called with more than one argument, a "?" and the result of MochiKit.Base.queryString with the rest of the arguments are appended to the URL.
For example, this will do a GET request to the URL http://example.com?bar=baz:
doSimpleXMLHttpRequest("http://example.com", {bar: "baz"});- returns:
- Deferred that will callback with the XMLHttpRequest instance on success
- Availability:
- Available in MochiKit 1.3.1+. Support for 201 and 204 were added in MochiKit 1.4.
Evaluate a JSON [4] XMLHttpRequest
- req:
- The request whose .responseText property is to be evaluated. If the JSON is wrapped in a comment, the comment will be stripped before evaluation.
- returns:
- A JavaScript object
- Availability:
- Available in MochiKit 1.3.1+
Return a Deferred that has already had .errback(result) called.
See succeed documentation for rationale.
- result:
- The result to give to Deferred.prototype.errback(result).
- returns:
- A new Deferred()
- Availability:
- Available in MochiKit 1.3.1+
A convenience function that returns a DeferredList from the given Array of Deferred instances that will callback with an Array of just results when they're available, or errback on the first array.
- Availability:
- Available in MochiKit 1.3.1+
Return an XMLHttpRequest compliant object for the current platform.
In order of preference:
- new XMLHttpRequest()
- new ActiveXObject('Msxml2.XMLHTTP')
- new ActiveXObject('Microsoft.XMLHTTP')
- new ActiveXObject('Msxml2.XMLHTTP.4.0')
- Availability:
- Available in MochiKit 1.3.1+
maybeDeferred(func[, argument...]):
Call a func with the given arguments and ensure the result is a Deferred.
loadJSONDoc(url[, queryArguments...]):
Do a simple XMLHttpRequest to a URL and get the response as a JSON [4] document.
- url:
- The URL to GET
- queryArguments:
If this function is called with more than one argument, a "?" and the result of MochiKit.Base.queryString with the rest of the arguments are appended to the URL.
For example, this will do a GET request to the URL http://example.com?bar=baz:
loadJSONDoc("http://example.com", {bar: "baz"});- returns:
- Deferred that will callback with the evaluated JSON [4] response upon successful XMLHttpRequest
- Availability:
- Available in MochiKit 1.3.1+
sendXMLHttpRequest(req[, sendContent]):
Set an onreadystatechange handler on an XMLHttpRequest object and send it off. Will return a cancellable Deferred that will callback on success.
Note that only 200 (OK), 201 (CREATED), 204 (NO CONTENT) and 304 (NOT MODIFIED) are considered success codes. All other status codes will result in an errback with an XMLHttpRequestError.
- req:
- An preconfigured XMLHttpRequest object (open has been called).
- sendContent:
- Optional string or DOM content to send over the XMLHttpRequest.
- returns:
- Deferred that will callback with the XMLHttpRequest instance on success.
- Availability:
- Available in MochiKit 1.3.1+. Support for 201 and 204 were added in MochiKit 1.4.
Return a Deferred that has already had .callback(result) called.
This is useful when you're writing synchronous code to an asynchronous interface: i.e., some code is calling you expecting a Deferred result, but you don't actually need to do anything asynchronous. Just return succeed(theResult).
See fail for a version of this function that uses a failing Deferred rather than a successful one.
- result:
- The result to give to Deferred.prototype.callback(result)
- returns:
- a new Deferred
- Availability:
- Available in MochiKit 1.3.1+
Return a new cancellable Deferred that will .callback(res) after at least seconds seconds have elapsed.
- Availability:
- Available in MochiKit 1.3.1+
| [1] | AJAX, Asynchronous JavaScript and XML: http://en.wikipedia.org/wiki/AJAX |
| [2] | Twisted, an event-driven networking framework written in Python: http://twistedmatrix.com/ |
| [3] | Twisted Deferred Reference: http://twistedmatrix.com/projects/core/documentation/howto/defer.html |
| [4] | (1, 2, 3) JSON, JavaScript Object Notation: http://json.org/ |
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed free software; you can redistribute it and/or modify it under the terms of the MIT License or the Academic Free License v2.1.
Back to docs index
MochiKit.Style - painless Style manipulation API
var messagePos = getElementPosition('message');
var messageSize = getElementDimensions('message');
var notifyPos = new MochiKit.Style.Coordinates(
messagePos.x + messageSize.w + 10,
messagePos.y);
setElementPosition('notify', notifyPos);
Refactored from MochiKit.DOM.
Refactored from MochiKit.DOM.
The hideElement and showElement functions are provided as a convenience, but only work for elements that are display: block. For a general solution to showing, hiding, and checking the explicit visibility of elements, we recommend using a solution that involves a little CSS. Here's an example:
<style type="text/css">
.invisible { display: none; }
</style>
<script type="text/javascript">
function toggleVisible(elem) {
toggleElementClass("invisible", elem);
}
function makeVisible(elem) {
removeElementClass(elem, "invisible");
}
function makeInvisible(elem) {
addElementClass(elem, "invisible");
}
function isVisible(elem) {
// you may also want to check for
// getElement(elem).style.display == "none"
return !hasElementClass(elem, "invisible");
};
</script>
MochiKit doesn't ship with such a solution, because there is no reliable and portable method for adding CSS rules on the fly with JavaScript.
getStyle(element, cssSelector):
Looks up a CSS property for the given element. The element can be specified as either a string with the element's ID or the element object itself.
- cssSelector:
- The CSS selector, e.g. background-color.
- Availability:
- Available in MochiKit 1.4+
Set CSS properties on a the given element. The element can be specified as either a string with the element's ID or the element object itself.
- styles:
- Dictionnary holding CSS properties to set, e.g. {'background-color': 'red', 'opacity': 0.5}.
- Availability:
- Available in MochiKit 1.4+
Sets opacity for element. Valid opacity values range from 0 (invisible) to 1 (opaque). element is looked up with getElement, so string identifiers are also acceptable.
- Availability:
- Available in MochiKit 1.4+
getElementDimensions(element[, contentSize=false]):
Return the absolute pixel width and height of element as an object with w and h properties, or undefined if element is not in the document. The size will include padding and border, but not margins, unless contentSize is set to true, in which case the size will be only the content size, without padding and border. element may be specified as a string to be looked up with getElement, a DOM element, or trivially as an object with w and/or h properties.
- Availability:
- Available in MochiKit 1.4+
setElementDimensions(element, dimensions[, units='px']):
Sets the dimensions of element in the document from an object with w and h properties.
Warning: IE in quirks-mode seems to behave strange when you set the height off an element containing text to 0. You can workaround this by setting the value of visibly/display.
- element:
- A reference to the DOM element to update (if a string is given, getElement(node) will be used to locate the node)
- dimensions:
- An object with w and h properties. You can also specify only one property.
- units:
- Optionally set the units to use, default is px
- Availability:
- Available in MochiKit 1.4+
getElementPosition(element[, relativeTo={x: 0, y: 0}]):
Return the absolute pixel position of element in the document as an object with x and y properties, or undefined if element is not in the document. element may be specified as a string to be looked up with getElement, a DOM element, or trivially as an object with x and/or y properties.
If relativeTo is given, then its coordinates are subtracted from the absolute position of element, e.g.:
var elemPos = getElementPosition(elem); var anotherElemPos = getElementPosition(anotherElem); var relPos = getElementPosition(elem, anotherElem); assert( relPos.x == (elemPos.x - anotherElemPos.x) ); assert( relPos.y == (elemPos.y - anotherElemPos.y) );relativeTo may be specified as a string to be looked up with getElement, a DOM element, or trivially as an object with x and/or y properties.
- Availability:
- Available in MochiKit 1.4+
setElementPosition(element, position[, units='px']):
Sets the absolute position of element in the document from an object with x and y properties.
- element:
- A reference to the DOM element to update (if a string is given, getElement(node) will be used to locate the node)
- position:
- An object with x and y properties. You can also specify only one property.
- units:
- Optionally set the units to use, default is px
- Availability:
- Available in MochiKit 1.4+
Ensure that element.style.position is set to "relative" if it is not set or is "static". If element is a string, then it will be looked up with getElement.
- Availability:
- Available in MochiKit 1.4.1+
Restore the setting of element.style.position set by makePositioned(element). If element is a string, then it will be looked up with getElement.
- Availability:
- Available in MochiKit 1.4.1+
Ensure that element.style.overflow = 'hidden'. If element is a string, then it will be looked up with getElement.
Returns the original values of overflow, overflow-y and overflow-y so that they may be restored with undoClipping(element, overflow).
- Availability:
- Available in MochiKit 1.4.1+
undoClipping(element, overflow):
Restore the setting of element.style.overflow set by makeClipping(element). If element is a string, then it will be looked up with getElement.
- Availability:
- Available in MochiKit 1.4.1+
setDisplayForElement(display, element[, ...]):
Change the style.display for the given element(s). Usually used as the partial forms:
Elements are looked up with getElement, so string identifiers are acceptable.
For information about the caveats of using a style.display based show/hide mechanism, and a CSS based alternative, see Element Visibility.
- Availability:
- Available in MochiKit 1.4+
Partial form of setDisplayForElement, specifically:
partial(setDisplayForElement, "block")For information about the caveats of using a style.display based show/hide mechanism, and a CSS based alternative, see Element Visibility.
- Availability:
- Available in MochiKit 1.4+
Partial form of setDisplayForElement, specifically:
partial(setDisplayForElement, "none")For information about the caveats of using a style.display based show/hide mechanism, and a CSS based alternative, see Element Visibility.
- Availability:
- Available in MochiKit 1.4+
Return the pixel width and height of the viewport as an object with w and h properties.
- Availability:
- Available in MochiKit 1.4+
Return the pixel position of the viewport inside the window, as a Coordinates object.
- Availability:
- Available in MochiKit 1.4+
Constructs an object with x and y properties. obj.toString() returns something like {x: 0, y: 42} for debugging.
- Availability:
- Available in MochiKit 1.4+
Constructs an object with w and h properties. obj.toString() returns something like {w: 0, h: 42} for debugging.
- Availability:
- Available in MochiKit 1.4+
Copyright 2005-2006 Bob Ippolito <bob@redivi.com>, and Beau Hartshorne <beau@hartshornesoftware.com>. This program is dual-licensed free software; you can redistribute it and/or modify it under the terms of the MIT License or the Academic Free License v2.1.
Back to docs index
MochiKit.Sortable - sortable with drag and drop lists
<ul id="dnd_sortable">
<li>mochibot.com</li>
<li>pythonmac.org</li>
<li>undefined.org</li>
<li>python.org</li>
</ul>
<script type="text/javascript">
MochiKit.Sortable.Sortable.create('dnd_sortable');
</script>
MochiKit.Sortable add a new Sortable object to manipulate easily drag&drop in lists.
MochiKit.Sortable mainly contains the Sortable object offering facilities to manipulate a list and drag its items to reorder it. It can also be serialized for being send to server. It is ported from Scriptaculous.
Observer for DragAndDrop object. You normally don't have to access this, only for customization purpose.
- Availability:
- Available in MochiKit 1.4+
Sortable.create(element [, options]):
Create a new Sortable. Usually you'll call it with a UL element, but it can be customized with options to use something else.
You have the following options:
element element tag 'li' dropOnEmpty false overlap 'vertical' constraint 'vertical' containment element handle false only false hoverclass null ghosting false scroll false scrollSensitivity 20 scrollSpeed 15 format /^[^_]*_(.*)$/ onChange MochiKit.Base.noop onUpdate MochiKit.Base.noop tree false treeTag 'ul'
- tag:
- Name of the tag used to make the draggable elements. It matches all the childNodes of the Sortable element with this tag.
- only:
- Class or array of classes used to filter the children, combined with the tag criteria.
- format:
- Regular expression which serves as a match filter for serialization, on children' ids. For example, with the default value, you'll get ['1', '2', '3', '4'] with ids ['sort_1', 'sort_2', 'sort_3', 'sort_4'].
- onChange:
- Callback called when an element moves between others in the Sortable. It's called for each movements, even if you don't release the mouse.
- onUpdate:
- Callback called when the order changes in the Sortable. It's called only if the Sortable is modified, after you dropped an element.
- tree:
- Option for creating a Sortable tree. It's an experimental setting, that can be very slow even with a few elements. You can customize its behaviour with the treeTag option, that defines the node used to make branches in your tree (that contains leaves).
Other options are passed to the Draggables and Droppables objects created. Refer to MochiKit.DragAndDrop for more information.
A bug with Internet Explorer rendering engine can cause a problem with the default effect used on start (the symptom being that the rows vanish). If you encounter this problem, pass MochiKit.Base.noop as the starteffect option.
- Availability:
- Available in MochiKit 1.4+
Destroy a previously created sortable. It prevents further use of the Sortable functionnality on the element, unless recreated.
- Availability:
- Available in MochiKit 1.4+
Sortable.serialize(element [, options]):
Serialize the content of a Sortable. Useful to send this content through a XMLHTTPRequest. The options overrides the ones of the Sortable only for the serialization.
tag tag from the Sortable only only from the Sortable name id of the element format format of the Sortable or /^[^_]*_(.*)$
- Availability:
- Available in MochiKit 1.4+
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed free software; you can redistribute it and/or modify it under the terms of the MIT License or the Academic Free License v2.1.
Portions adapted from Scriptaculous are available under the terms of the MIT License.
Back to docs index
MochiKit.Signal - Simple universal event handling
Signal for DOM events:
// DOM events are also signals. Connect freely! The functions will be
// called with the custom event as a parameter.
// calls myClicked.apply(getElement('myID'), [event])
connect('myID', 'onclick', myClicked);
// calls wasClicked.apply(myObject, [event])
connect('myID', 'onclick', myObject, wasClicked);
// calls myObject.wasClicked(event)
connect('myID', 'onclick', myObject, 'wasClicked');
// the event is normalized, no more e = e || window.event!
myObject.wasClicked = function(e) {
var crossBrowserCoordinates = e.mouse().page;
// e.mouse().page is a MochiKit.Style.Coordinates object
}
Signal for non-DOM events:
// otherObject.gotFlash() will be called when 'flash' signalled. connect(myObject, 'flash', otherObject, 'gotFlash'); // gotBang.apply(otherObject, [...]) will be called when 'bang' signalled. // You can access otherObject from within gotBang as 'this'. connect(myObject, 'bang', otherObject, gotBang); // myFunc.apply(myObject, [...]) will be called when 'flash' signalled. // You can access myObject from within myFunc as 'this'. var ident = connect(myObject, 'flash', myFunc); // You may disconnect with the return value from connect disconnect(ident); // Signal can take parameters. These will be passed along to the // connected functions. signal(myObject, 'flash'); signal(myObject, 'bang', 'BANG!');
Event handling was never so easy!
This module takes care of all the hard work—figuring out which event model to use, trying to retrieve the event object, and handling your own internal events, as well as cleanup when the page is unloaded to clean up IE's nasty memory leakage.
This event system is largely based on Qt's signal/slot system. Read more on how that is handled and also how it is used in model/view programming at: http://doc.trolltech.com/
When using MochiKit.Signal, do not use the browser's native event API. That means, no onclick="blah", no elem.addEventListener(...), and certainly no elem.attachEvent(...). This also means that MochiKit.DOM.addToCallStack and MochiKit.DOM.addLoadEvent should not be used in combination with this module.
Signals for DOM objects are named with the 'on' prefix, e.g.: 'onclick', 'onkeyup', etc.
When the signal fires, your slot will be called with one parameter, the custom event object.
Signals triggered by DOM events are called with a custom event object as a parameter. The custom event object presents a consistent view of the event across all supported platforms and browsers, and provides many conveniences not available even in a correct W3C implementation.
See the DOM Custom Event Object Reference for a detailed API description of this object.
If you find that you're accessing the native event for any reason, create a new ticket and we'll look into normalizing the behavior you're looking for.
Any object that has connected slots (via connect()) is referenced by the Signal mechanism until it is disconnected via disconnect() or disconnectAll().
Signal does not leak. It registers an 'onunload' event that disconnects all objects on the page when the browser leaves the page. However, memory usage will grow during the page view for every connection made until it is disconnected. Even if the DOM object is removed from the document, it will still be referenced by Signal until it is explicitly disconnected.
In order to conserve memory during the page view, disconnectAll() any DOM elements that are about to be removed from the document.
Certain events supported by MochiKit are not generated natively by all browsers. MochiKit can synthesize these events even for non-supporting browsers, however, by watching for related events and triggering the appropriate signals at the right times.
These events include:
onmouseenter
Similar to 'onmouseover', but does not "bubble" up to parent nodes. Such bubbling is often a cause of confusion. On an 'onmouseenter' event, you can be certain that the mouse has left the node attached to the event.
- Availability:
- Available in MochiKit 1.4+
onmouseleave
Similar to 'onmouseout', but does not "bubble" up to parent nodes. This is the analog to 'onmouseenter'.
- Availability:
- Available in MochiKit 1.4+
onmousewheel
Not strictly synthesized, but named 'DOMMouseScroll' in Gecko-based browsers. MochiKit translates 'onmousewheel' to the corresponding event in these browsers.
- Availability:
- Available in MochiKit 1.4+
Signals are triggered with the signal(src, 'signal', ...) function. Additional parameters passed to this are passed onto the connected slots. Explicit signals are not required for DOM events.
Slots that are connected to a signal are called in the following manner when that signal is signalled:
connect(src, signal, dest[, func]):
Connects a signal to a slot, and return a unique identifier that can be used to disconnect that signal.
src is the object that has the signal. You may pass in a string, in which case, it is interpreted as an id for an HTML element.
signal is a string that represents a signal name. If 'src' is an HTML Element, window, or the document, then it can be one of the 'on-XYZ' events. You must include the 'on' prefix, and it must be all lower-case.
dest and func describe the slot, or the action to take when the signal is triggered.
- If dest is an object and func is a string, then dest[func].apply(dest, [...]) will be called when the signal is signalled.
- If dest is an object and func is a function, then func.apply(dest, [...]) will be called when the signal is signalled.
- If func is undefined and dest is a function, then dest.apply(src, [...]) will be called when the signal is signalled.
No other combinations are allowed and will raise an exception.
The return value can be passed to disconnect to disconnect the signal.
In MochiKit 1.4+, if src is an object that has a __connect__ method, then src.__connect__(ident, signal, objOrFunc, funcOrStr) will be called. The __connect__ method is allowed to disconnect the signal. DOM objects can not implement this feature.
- Availability:
- Available in MochiKit 1.3.1+
To disconnect a signal, pass its ident returned by connect(). This is similar to how the browser's setTimeout and clearTimeout works.
In MochiKit 1.4+, if the signal source is an object that has a __disconnect__ method, then src.__disconnect__(ident, signal, objOrFunc, funcOrStr) will be called. DOM objects can not implement this feature.
- Availability:
- Available in MochiKit 1.3.1+
disconnectAll(src[, signal, ...]):
Removes a set of signals from src, similar to calling disconnect(ident) for each one.
disconnectAll(src) removes all signals from src.
disconnectAll(src, 'onmousedown', 'mySignal') will remove all 'onmousedown' and 'mySignal' signals from src.
- Availability:
- Available in MochiKit 1.3.1+
disconnectAllTo(dest[, func]):
Removes a set of signals connected to dest, similar to calling disconnect(ident) for each one.
disconnectAllTo(dest) removes all signals connected to dest.
disconnectAllTo(dest, func) will remove all signals connected to dest using func.
- Availability:
- Available in MochiKit 1.4+
This will signal a signal, passing whatever additional parameters on to the connected slots. src and signal are the same as for connect().
- Availability:
- Available in MochiKit 1.3.1+
The native event produced by the browser. You should not need to use this.
- Availability:
- Available in MochiKit 1.3.1+
The element that this signal is connected to.
- Availability:
- Available in MochiKit 1.3.1+
The event type ('click', 'mouseover', 'keypress', etc.) as a string. Does not include the 'on' prefix.
- Availability:
- Available in MochiKit 1.3.1+
The element that triggered the event. This may be a child of src().
- Availability:
- Available in MochiKit 1.3.1+
Returns {shift, ctrl, meta, alt, any}, where each property is true if its respective modifier key was pressed, false otherwise. any is true if any modifier is pressed, false otherwise.
- Availability:
- Available in MochiKit 1.3.1+
Works like W3C's stopPropagation().
- Availability:
- Available in MochiKit 1.3.1+
Works like W3C's preventDefault().
- Availability:
- Available in MochiKit 1.3.1+
Shortcut that calls stopPropagation() and preventDefault().
- Availability:
- Available in MochiKit 1.3.1+
Returns {code, string}.
Use 'onkeydown' and 'onkeyup' handlers to detect control characters such as 'KEY_F1'. Use the 'onkeypress' handler to detect "printable" characters, such as 'é'.
When a user presses F1, in 'onkeydown' and 'onkeyup' this method returns {code: 122, string: 'KEY_F1'}. In 'onkeypress', it returns {code: 0, string: ''}.
If a user presses Shift+2 on a US keyboard, this method returns {code: 50, string: 'KEY_2'} in 'onkeydown' and 'onkeyup'. In 'onkeypress', it returns {code: 64, string: '@'}.
See _specialKeys in the source code for a comprehensive list of control characters.
- Availability:
- Available in MochiKit 1.3.1+
Properties for 'onmouse*', 'onclick', 'ondblclick', and 'oncontextmenu':
- page is a MochiKit.Style.Coordinates object that represents the cursor position relative to the HTML document. Equivalent to pageX and pageY in Safari, Mozilla, and Opera.
- client is a MochiKit.Style.Coordinates object that represents the cursor position relative to the visible portion of the HTML document. Equivalent to clientX and clientY on all browsers. Current versions of Safari incorrectly return clientX as relative to the canvas instead of relative to the viewport (Safari Bug 8707).
Properties for 'onmouseup', 'onmousedown', 'onclick', and 'ondblclick':
- mouse().button returns {left, right, middle} where each property is true if the mouse button was pressed, false otherwise.
Properties for 'onmousewheel':
- mouse().wheel is a MochiKit.Style.Coordinates object containing the scroll wheel offset. The number will be positive when scrolling down (or to the right) and negative when scrolling up (or to the left). Note that only Safari 3 currently supports horizontal scrolling. In other browsers, the 'y' component will contain the scroll offset for both directions.
Known browser bugs:
Current versions of Safari won't signal 'ondblclick' when attached via connect() (Safari Bug 7790).
In Safari < 2.0.4, calling preventDefault() or stop() in 'onclick' events signalled from <a> tags does not prevent the browser from following those links.
Mac browsers don't report right-click consistently. Firefox signals the slot and sets modifier().ctrl to true, Opera signals the slot and sets modifier().meta to true, and Safari doesn't signal the slot at all (Safari Bug 6595).
To find a right-click in Safari, Firefox, and IE, you can connect an element to 'oncontextmenu'. This doesn't work in Opera.
- Availability:
- Available in MochiKit 1.3.1+
Returns the document element that the mouse has moved to. This is generated for 'onmouseover' and 'onmouseout' events.
- Availability:
- Available in MochiKit 1.3.1+
In browsers that support the 'onbeforeunload' event (IE and Firefox), calling this in the event handler will show a dialog box that allows the user to confirm or cancel the navigation away from the page.
- Availability:
- Available in MochiKit 1.4+
Copyright 2006 Jonathan Gardner <jgardner@jonathangardner.net>, Beau Hartshorne <beau@hartshornesoftware.com>, and Bob Ippolito <bob@redivi.com>. This program is dual-licensed free software; you can redistribute it and/or modify it under the terms of the MIT License or the Academic Free License v2.1.
Back to docs index
MochiKit.Logging - we're all tired of alert()
log("INFO messages are so boring");
logDebug("DEBUG messages are even worse");
log("good thing I can pass", objects, "conveniently");
MochiKit.Logging steals some ideas from Python's logging module [1], but completely forgot about the Java [2] inspiration. This is a KISS module for logging that provides enough flexibility to do just about anything via listeners, but without all the cruft.
As of MochiKit 1.3, the default logger will log all messages to your browser's native console. This is currently supported in Safari, Opera 9, and Firefox when the FireBug extension is installed. MochiKit 1.4 adds support for the relevant APIs for Internet Explorer (the Debugger and the Atlas framework, see here).
To disable this behavior:
MochiKit.Logging.logger.useNativeConsole = false;
JavaScript is at a serious disadvantage without a standard console for "print" statements. Everything else has one. The closest thing that you get in a browser environment is the alert function, which is absolutely evil.
This leaves you with one reasonable solution: do your logging in the page somehow. The problem here is that you don't want to clutter the page with debugging tools. The solution to that problem is what we call BBD, or Bookmarklet Based Debugging [3].
Simply create a bookmarklet for javascript:MochiKit.Logging.logger.debuggingBookmarklet(), and whack it whenever you want to see what's in the logger. Of course, this means you must drink the MochiKit.Logging kool-aid. It's tangy and sweet, don't worry.
Currently this uses MochiKit.LoggingPane if loaded and otherwise falls back to ugly alert messages.
Properties:
- num:
- Identifier for the log message
- level:
- Level of the log message ("INFO", "WARN", "DEBUG", etc.)
- info:
- All other arguments passed to log function as an Array
- timestamp:
- Date object timestamping the log message
- Availability:
- Available in MochiKit 1.3.1+
A basic logger object that has a buffer of recent messages plus a listener dispatch mechanism for "real-time" logging of important messages.
maxSize is the maximum number of entries in the log. If maxSize >= 0, then the log will not buffer more than that many messages. So if you don't like logging at all, be sure to pass 0.
There is a default logger available named "logger", and several of its methods are also global functions:
logger.log -> log logger.debug -> logDebug logger.warning -> logWarning logger.error -> logError logger.fatal -> logFatal
- Availability:
- Available in MochiKit 1.3.1+
Logger.prototype.addListener(ident, filter, listener):
Add a listener for log messages.
ident is a unique identifier that may be used to remove the listener later on.
filter can be one of the following:
- null:
- listener(msg) will be called for every log message received.
- string:
- logLevelAtLeast(filter) will be used as the function (see below).
- function:
- filter(msg) will be called for every msg, if it returns true then listener(msg) will be called.
listener is a function that takes one argument, a log message. A log message is an object (LogMessage instance) that has at least these properties:
- num:
- A counter that uniquely identifies a log message (per-logger)
- level:
- A string or number representing the log level. If string, you may want to use LogLevel[level] for comparison.
- info:
- An Array of objects passed as additional arguments to the log function.
- Availability:
- Available in MochiKit 1.3.1+
Logger.prototype.baseLog(level, message[, ...]):
The base functionality behind all of the log functions. The first argument is the log level as a string or number, and all other arguments are used as the info list.
This function is available partially applied as:
Logger.debug 'DEBUG' Logger.log 'INFO' Logger.error 'ERROR' Logger.fatal 'FATAL' Logger.warning 'WARNING' For the default logger, these are also available as global functions, see the Logger constructor documentation for more info.
- Availability:
- Available in MochiKit 1.3.1+
Clear all messages from the message buffer.
- Availability:
- Available in MochiKit 1.3.1+
Logger.prototype.debuggingBookmarklet():
Display the contents of the logger in a useful way for browsers.
Currently, if MochiKit.LoggingPane is loaded, then a pop-up MochiKit.LoggingPane.LoggingPane will be used. Otherwise, it will be an alert with Logger.prototype.getMessageText().
- Availability:
- Available in MochiKit 1.3.1+
Logger.prototype.dispatchListeners(msg):
Dispatch a log message to all listeners.
- Availability:
- Available in MochiKit 1.3.1+
Logger.prototype.getMessages([howMany]):
Returns a list of messages from the message buffer, ordered from the oldest to the newest message. If howMany is specified, only the last howMany messages are returned. Otherwise all messages in the buffer are returned.
- Availability:
- Available in MochiKit 1.3.1+
Logger.prototype.getMessageText([howMany]):
Get a string representing up to the last howMany messages in the message buffer. The default is 30.
The message looks like this:
LAST {messages.length} MESSAGES: [{msg.num}] {msg.level}: {m.info.join(' ')} [{msg.num}] {msg.level}: {m.info.join(' ')} ...If you want some other format, use Logger.prototype.getMessages and do it yourself.
- Availability:
- Available in MochiKit 1.3.1+
Logger.prototype.removeListener(ident):
Remove a listener using the ident given to Logger.prototype.addListener
- Availability:
- Available in MochiKit 1.3.1+
Ultra-obnoxious alert(...) listener
- Availability:
- Available in MochiKit 1.3.1+
Log an INFO message to the default logger
- Availability:
- Available in MochiKit 1.3.1+
logDebug(message[, info[, ...]]):
Log a DEBUG message to the default logger
- Availability:
- Available in MochiKit 1.3.1+
logError(message[, info[, ...]]):
Log an ERROR message to the default logger
- Availability:
- Available in MochiKit 1.3.1+
logFatal(message[, info[, ...]]):
Log a FATAL message to the default logger
- Availability:
- Available in MochiKit 1.3.1+
Return a function that will match log messages whose level is at least minLevel
- Availability:
- Available in MochiKit 1.3.1+
logWarning(message[, info[, ...]]):
Log a WARNING message to the default logger
- Availability:
- Available in MochiKit 1.3.1+
| [1] | Python's logging module: http://docs.python.org/lib/module-logging.html |
| [2] | PEP 282, where they admit all of the Java influence: http://www.python.org/peps/pep-0282.html |
| [3] | Original Bookmarklet Based Debugging blather: http://bob.pythonmac.org/archives/2005/07/03/bookmarklet-based-debugging/ |
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed free software; you can redistribute it and/or modify it under the terms of the MIT License or the Academic Free License v2.1.
Back to docs index
MochiKit.Iter - itertools for JavaScript; iteration made HARD, and then easy
theSum = sum(takewhile(
partial(operator.gt, 10),
imap(
partial(operator.mul, 2),
count()
)
)
));
assert( theSum == (0 + 0 + 2 + 4 + 6 + 8) );
All of the functional programming missing from MochiKit.Base lives here. The functionality in this module is largely inspired by Python's iteration protocol [1], and the itertools module [2].
MochiKit.Iter defines a standard way to iterate over anything, that you can extend with registerIteratorFactory, or by implementing the .iter() or .__iterator__() (in MochiKit 1.4+) protocol. Iterators are lazy, so it can potentially be cheaper to build a filter chain of iterators than to build lots of intermediate arrays. Especially when the data set is very large, but the result is not.
The best overview right now is in my Iteration for JavaScript [3] blog entry. This information will migrate here eventually.
The singleton MochiKit.Base.NamedError that signifies the end of an iterator
- Availability:
- Available in MochiKit 1.3.1+
applymap(fun, seq) --> fun.apply(self, seq0), fun.apply(self, seq1), ...
- Availability:
- Available in MochiKit 1.3.1+
chain(p, q, ...) --> p0, p1, ... plast, q0, q1, ...
- Availability:
- Available in MochiKit 1.3.1+
count(n=0) --> n, n + 1, n + 2, ...
- Availability:
- Available in MochiKit 1.3.1+
cycle(p) --> p0, p1, ... plast, p0, p1, ...
- Availability:
- Available in MochiKit 1.3.1+
dropwhile(pred, seq) --> seq[n], seq[n + 1], starting when pred(seq[n]) fails
- Availability:
- Available in MochiKit 1.3.1+
Return true if func(item) is true for every item in iterable.
- Availability:
- Available in MochiKit 1.3.1+
Exhausts an iterable without saving the results anywhere, like list(iterable) when you don't care what the output is.
- Availability:
- Available in MochiKit 1.3.1+
forEach(iterable, func[, self]):
Call func for each item in iterable, and don't save the results.
- Availability:
- Available in MochiKit 1.3.1+
Make an iterator that returns consecutive keys and groups from the iterable. The key is a function computing a key value for each element. If not specified or is None, key defaults to an identity function and returns the element unchanged. Generally, the iterable needs to already be sorted on the same key function.
The returned group is itself an iterator that shares the underlying iterable with groupby(). Because the source is shared, when the groupby object is advanced, the previous group is no longer visible. So, if that data is needed later, it should be stored as an array:
var groups = []; var uniquekeys = []; forEach(groupby(data, keyfunc), function (key_group) { groups.push(list(key_group[1])); uniquekeys.push(key_group[0]); });As a convenience, groupby_as_array() is provided to suit the above use case.
- Availability:
- Available in MochiKit 1.3.1+
groupby_as_array(iterable[, keyfunc]):
Perform the same task as groupby(), except return an array of arrays instead of an iterator of iterators.
- Availability:
- Available in MochiKit 1.3.1+
Just like list(iterable), except it pushes results on lst rather than creating a new one.
- Availability:
- Available in MochiKit 1.3.1+
ifilter(pred, seq) --> elements of seq where pred(elem) is true
- Availability:
- Available in MochiKit 1.3.1+
ifilterfalse(pred, seq) --> elements of seq where pred(elem) is false
- Availability:
- Available in MochiKit 1.3.1+
imap(fun, p, q, ...) --> fun(p0, q0, ...), fun(p1, q1, ...), ...
- Availability:
- Available in MochiKit 1.3.1+
islice(seq, [start,] stop[, step]):
islice(seq, [start,] stop[, step]) --> elements from seq[start:stop:step] (in Python slice syntax)
- Availability:
- Available in MochiKit 1.3.1+
Convert the given argument to an iterator (object implementing .next()).
- If iterable is an iterator (implements .next()), then it will be returned as-is.
- If iterable is an iterator factory (implements .iter()), then the result of iterable.iter() will be returned.
- If iterable is a JavaScript 1.7 iterator factory (implements .__iterable__()), then the result of iterable.__iterable__() will be returned (MochiKit 1.4+).
- Otherwise, the iterator factory MochiKit.Base.AdapterRegistry is used to find a match.
- If no factory is found, it will throw TypeError
Built-in iterator factories are present for Array-like objects, and objects that implement the iterateNext protocol (e.g. the result of Mozilla's document.evaluate).
When used directly, using an iterator should look like this:
var it = iter(iterable); try { while (var o = it.next()) { // use o } } catch (e) { if (e != StopIteration) { throw e; } // pass }This is ugly, so you should use the higher order functions to work with iterators whenever possible.
- Availability:
- Available in MochiKit 1.3.1+
izip(p, q, ...) --> [p0, q0, ...], [p1, q1, ...], ...
- Availability:
- Available in MochiKit 1.3.1+
Convert iterable to a new Array
- Availability:
- Available in MochiKit 1.3.1+
Return iterator.next()
- Availability:
- Available in MochiKit 1.3.1+
Return an iterator containing an arithmetic progression of integers.
range(i, j) returns iter([i, i + 1, i + 2, ..., j - 1])
start (!) defaults to 0. When step is given, it specifies the increment (or decrement). The end point is omitted!
For example, range(4) returns iter([0, 1, 2, 3]). This iterates over exactly the valid indexes for an array of 4 elements.
- Availability:
- Available in MochiKit 1.3.1+
reduce(fn, iterable[, initial]):
Apply fn(a, b) cumulatively to the items of an iterable from left to right, so as to reduce the iterable to a single value.
For example:
reduce(function (a, b) { return a + b; }, [1, 2, 3, 4, 5])calculates:
((((1 + 2) + 3) + 4) + 5).If initial is given, it is placed before the items of the sequence in the calculation, and serves as a default when the sequence is empty.
Note that the above example could be written more clearly as:
reduce(operator.add, [1, 2, 3, 4, 5])Or even simpler:
sum([1, 2, 3, 4, 5])
- Availability:
- Available in MochiKit 1.3.1+
registerIteratorFactory(name, check, iterfactory[, override]):
Register an iterator factory for use with the iter function.
check is a function(a) that returns true if a can be converted into an iterator with iterfactory.
iterfactory is a function(a) that returns an object with a .next() method that returns the next value in the sequence.
iterfactory is guaranteed to only be called if check(a) returns a true value.
If override is true, then it will be made the highest precedence iterator factory. Otherwise, the lowest.
- Availability:
- Available in MochiKit 1.3.1+
repeat(elem, [,n]) --> elem, elem, elem, ... endlessly or up to n times
- Availability:
- Available in MochiKit 1.3.1+
Return a reversed array from iterable.
- Availability:
- Available in MochiKit 1.3.1+
Return true if func(item) is true for at least one item in iterable.
- Availability:
- Available in MochiKit 1.3.1+
Return a sorted array from iterable.
- Availability:
- Available in MochiKit 1.3.1+
Returns the sum of a sequence of numbers plus the value of parameter start (with a default of 0). When the sequence is empty, returns start.
Equivalent to:
reduce(operator.add, iterable, start);
- Availability:
- Available in MochiKit 1.3.1+
takewhile(pred, seq) --> seq[0], seq[1], ... until pred(seq[n]) fails
- Availability:
- Available in MochiKit 1.3.1+
tee(it, n=2) --> [it1, it2, it3, ... itn] splits one iterator into n
- Availability:
- Available in MochiKit 1.3.1+
| [1] | The iteration protocol is described in PEP 234 - Iterators: http://www.python.org/peps/pep-0234.html |
| [2] | Python's itertools module: http://docs.python.org/lib/module-itertools.html |
| [3] | Iteration in JavaScript: http://bob.pythonmac.org/archives/2005/07/06/iteration-in-javascript/ |
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed free software; you can redistribute it and/or modify it under the terms of the MIT License or the Academic Free License v2.1.
Back to docs index
MochiKit.Color - color abstraction with CSS3 support
// RGB color expressions are supported
assert(
objEqual(Color.whiteColor(), Color.fromString("rgb(255,100%, 255)"))
);
// So is instantiating directly from HSL or RGB values.
// Note that fromRGB and fromHSL take numbers between 0.0 and 1.0!
assert( objEqual(Color.fromRGB(1.0, 1.0, 1.0), Color.fromHSL(0.0, 0.0, 1.0) );
// Or even SVG color keyword names, as per CSS3!
assert( Color.fromString("aquamarine"), "#7fffd4" );
// NSColor-like colors built in
assert( Color.whiteColor().toHexString() == "#ffffff" );
MochiKit.Color is an abstraction for handling colors and strings that represent colors.
MochiKit.Color provides an abstraction of RGB, HSL and HSV colors with alpha. It supports parsing and generating of CSS3 colors, and has a full CSS3 (SVG) color table.
All of the functionality in this module is exposed through a Color constructor and its prototype, but a few of its internals are available for direct use at module level.
Represents a color. Component values should be integers between 0.0 and 1.0. You should use one of the Color factory functions such as Color.fromRGB, Color.fromHSL, etc. instead of constructing Color objects directly.
Color instances can be compared with MochiKit.Base.compare (though ordering is on RGB, so is not particularly meaningful except for equality), and the default toString implementation returns Color.prototype.toHexString().
Color instances are immutable, and much of the architecture is inspired by AppKit's NSColor [1]
- Availability:
- Available in MochiKit 1.3.1+
Returns a Color object based on the background of the provided element. Equivalent to:
c = Color.fromComputedStyle( elem, "backgroundColor", "background-color") || Color.whiteColor();
- Availability:
- Available in MochiKit 1.3.1+
Color.fromComputedStyle(elem, style):
Returns a Color object based on the result of MochiKit.Style.getStyle(elem, style) or null if not found.
- Availability:
- Available in MochiKit 1.3.1+
Color.fromHexString(hexString):
Returns a Color object from the given hexadecimal color string. For example, "#FFFFFF" would return a Color with RGB values [255/255, 255/255, 255/255] (white).
- Availability:
- Available in MochiKit 1.3.1+
Color.fromHSL(hue, saturation, lightness, alpha=1.0):
Return a Color object from the given hue, saturation, lightness values. Values should be numbers between 0.0 and 1.0.
If alpha is not given, then 1.0 (completely opaque) will be used.
- Alternate form:
- Color.fromHSL({h: hue, s: saturation, l: lightness, a: alpha})
- Availability:
- Available in MochiKit 1.3.1+
Color.fromHSLString(hslString):
Returns a Color object from the given decimal hsl color string. For example, "hsl(0,0%,100%)" would return a Color with HSL values [0/360, 0/360, 360/360] (white).
- Availability:
- Available in MochiKit 1.3.1+
Color.fromHSV(hue, saturation, value, alpha=1.0):
Return a Color object from the given hue, saturation, value values. Values should be numbers between 0.0 and 1.0.
If alpha is not given, then 1.0 (completely opaque) will be used.
- Alternate form:
- Color.fromHSV({h: hue, s: saturation, v: value, a: alpha})
- Availability:
- Available in MochiKit 1.3.1+
Returns a Color object corresponding to the given SVG 1.0 color keyword name [2] as per the W3C CSS3 Color Module [3]. "transparent" is also accepted as a color name, and will return Color.transparentColor().
- Availability:
- Available in MochiKit 1.3.1+
Color.fromRGB(red, green, blue, alpha=1.0):
Return a Color object from the given red, green, blue, and alpha values. Values should be numbers between 0 and 1.0.
If alpha is not given, then 1.0 (completely opaque) will be used.
- Alternate form:
- Color.fromRGB({r: red, g: green, b: blue, a: alpha})
- Availability:
- Available in MochiKit 1.3.1+
Color.fromRGBString(rgbString):
Returns a Color object from the given decimal rgb color string. For example, "rgb(255,255,255)" would return a Color with RGB values [255/255, 255/255, 255/255] (white).
- Availability:
- Available in MochiKit 1.3.1+
Returns a Color object based on the text color of the provided element. Equivalent to:
c = Color.fromComputedStyle(elem, "color") || Color.whiteColor();
- Availability:
- Available in MochiKit 1.3.1+
Color.fromString(rgbOrHexString):
Returns a Color object from the given RGB, HSL, hex, or name. Will return null if the string can not be parsed by any of these methods.
See Color.fromHexString, Color.fromRGBString, Color.fromHSLString and Color.fromName more information.
- Availability:
- Available in MochiKit 1.3.1+
Returns an object with properties for each SVG 1.0 color keyword name [2] supported by CSS3 [3]. Property names are the color keyword name in lowercase, and the value is a string suitable for Color.fromString().
- Availability:
- Available in MochiKit 1.3.1+
Color.prototype.colorWithAlpha(alpha):
Return a new Color based on this color, but with the provided alpha value.
- Availability:
- Available in MochiKit 1.3.1+
Color.prototype.colorWithHue(hue):
Return a new Color based on this color, but with the provided hue value.
- Availability:
- Available in MochiKit 1.3.1+
Color.prototype.colorWithSaturation(saturation):
Return a new Color based on this color, but with the provided saturation value (using the HSL color model).
- Availability:
- Available in MochiKit 1.3.1+
Color.prototype.colorWithLightness(lightness):
Return a new Color based on this color, but with the provided lightness value.
- Availability:
- Available in MochiKit 1.3.1+
Color.prototype.darkerColorWithLevel(level):
Return a new Color based on this color, but darker by the given level (between 0 and 1.0).
- Availability:
- Available in MochiKit 1.3.1+
Color.prototype.lighterColorWithLevel(level):
Return a new Color based on this color, but lighter by the given level (between 0 and 1.0).
- Availability:
- Available in MochiKit 1.3.1+
Color.prototype.blendedColor(other, fraction=0.5):
Return a new Color whose RGBA component values are a weighted sum of this color and other. Each component of the returned color is the fraction of other's value plus 1 - fraction of this color's.
- Availability:
- Available in MochiKit 1.3.1+
Return true if the lightness value of this color is greater than 0.5.
Note that alpha is ignored for this calculation (color components are not premultiplied).
- Availability:
- Available in MochiKit 1.3.1+
Return true if the lightness value of this color is less than or equal to 0.5.
Note that alpha is ignored for this calculation (color components are not premultiplied).
- Availability:
- Available in MochiKit 1.3.1+
Color.prototype.toRGBString():
Return the decimal "rgb(red, green, blue)" string representation of this color.
If the alpha component is not 1.0 (fully opaque), the "rgba(red, green, blue, alpha)" string representation will be used.
For example:
assert( Color.whiteColor().toRGBString() == "rgb(255,255,255)" );
- Availability:
- Available in MochiKit 1.3.1+
Color.prototype.toHSLString():
Return the decimal "hsl(hue, saturation, lightness)" string representation of this color.
If the alpha component is not 1.0 (fully opaque), the "hsla(hue, saturation, lightness, alpha)" string representation will be used.
For example:
assert( Color.whiteColor().toHSLString() == "hsl(0,0,360)" );
- Availability:
- Available in MochiKit 1.3.1+
Color.prototype.toHexString():
Return the hexadecimal "#RRGGBB" string representation of this color.
Note that the alpha component is completely ignored for hexadecimal string representations!
For example:
assert( Color.whiteColor().toHexString() == "#FFFFFF" );
- Availability:
- Available in MochiKit 1.3.1+
Return the RGB (red, green, blue, alpha) components of this color as an object with r, g, b, and a properties that have values between 0.0 and 1.0.
- Availability:
- Available in MochiKit 1.3.1+
Return the HSL (hue, saturation, lightness, alpha) components of this color as an object with h, s, l and a properties that have values between 0.0 and 1.0.
- Availability:
- Available in MochiKit 1.3.1+
Return the HSV (hue, saturation, value, alpha) components of this color as an object with h, s, v and a properties that have values between 0.0 and 1.0.
- Availability:
- Available in MochiKit 1.3.1+
Return a Color object whose RGB values are 0, 0, 0 (#000000).
- Availability:
- Available in MochiKit 1.3.1+
Return a Color object whose RGB values are 0, 0, 1 (#0000ff).
- Availability:
- Available in MochiKit 1.3.1+
Return a Color object whose RGB values are 0.6, 0.4, 0.2 (#996633).
- Availability:
- Available in MochiKit 1.3.1+
Return a Color object whose RGB values are 0, 1, 1 (#00ffff).
- Availability:
- Available in MochiKit 1.3.1+
Return a Color object whose RGB values are 1/3, 1/3, 1/3 (#555555).
- Availability:
- Available in MochiKit 1.3.1+
Return a Color object whose RGB values are 0.5, 0.5, 0.5 (#808080).
- Availability:
- Available in MochiKit 1.3.1+
Return a Color object whose RGB values are 0, 1, 0. (#00ff00).
- Availability:
- Available in MochiKit 1.3.1+
Return a Color object whose RGB values are 2/3, 2/3, 2/3 (#aaaaaa).
- Availability:
- Available in MochiKit 1.3.1+
Return a Color object whose RGB values are 1, 0, 1 (#ff00ff).
- Availability:
- Available in MochiKit 1.3.1+
Return a Color object whose RGB values are 1, 0.5, 0 (#ff8000).
- Availability:
- Available in MochiKit 1.3.1+
Return a Color object whose RGB values are 0.5, 0, 0.5 (#800080).
- Availability:
- Available in MochiKit 1.3.1+
Return a Color object whose RGB values are 1, 0, 0 (#ff0000).
- Availability:
- Available in MochiKit 1.3.1+
Return a Color object whose RGB values are 1, 1, 1 (#ffffff).
- Availability:
- Available in MochiKit 1.3.1+
Return a Color object whose RGB values are 1, 1, 0 (#ffff00).
- Availability:
- Available in MochiKit 1.3.1+
Return a Color object that is completely transparent (has alpha component of 0).
- Availability:
- Available in MochiKit 1.3.1+
clampColorComponent(num, scale):
Returns num * scale clamped between 0 and scale.
clampColorComponent is not exported by default when using JSAN.
- Availability:
- Available in MochiKit 1.3.1+
hslToRGB(hue, saturation, lightness, alpha):
Computes RGB values from the provided HSL values. The return value is a mapping with "r", "g", "b" and "a" keys.
- Alternate form:
- hslToRGB({h: hue, s: saturation, l: lightness, a: alpha}).
hslToRGB is not exported by default when using JSAN.
- Availability:
- Available in MochiKit 1.3.1+
hsvToRGB(hue, saturation, value, alpha):
Computes RGB values from the provided HSV values. The return value is a mapping with "r", "g", "b" and "a" keys.
- Alternate form:
- hsvToRGB({h: hue, s: saturation, v: value, a: alpha}).
hsvToRGB is not exported by default when using JSAN.
- Availability:
- Available in MochiKit 1.3.1+
Convert num to a zero padded hexadecimal digit for use in a hexadecimal color string. Num should be an integer between 0 and 255.
toColorPart is not exported by default when using JSAN.
- Availability:
- Available in MochiKit 1.3.1+
rgbToHSL(red, green, blue, alpha):
Computes HSL values based on the provided RGB values. The return value is a mapping with "h", "s", "l" and "a" keys.
- Alternate form:
- rgbToHSL({r: red, g: green, b: blue, a: alpha}).
rgbToHSL is not exported by default when using JSAN.
- Availability:
- Available in MochiKit 1.3.1+
rgbToHSV(red, green, blue, alpha):
Computes HSV values based on the provided RGB values. The return value is a mapping with "h", "s", "v" and "a" keys.
- Alternate form:
- rgbToHSV({r: red, g: green, b: blue, a: alpha}).
rgbToHSV is not exported by default when using JSAN.
- Availability:
- Available in MochiKit 1.3.1+
| [1] | Application Kit Reference - NSColor: http://developer.apple.com/documentation/Cocoa/Reference/ApplicationKit/ObjC_classic/Classes/NSColor.html |
| [2] | (1, 2) SVG 1.0 color keywords: http://www.w3.org/TR/SVG/types.html#ColorKeywords |
| [3] | (1, 2) W3C CSS3 Color Module: http://www.w3.org/TR/css3-color/#svg-color |
Copyright 2005 Bob Ippolito <bob@redivi.com>. This program is dual-licensed free software; you can redistribute it and/or modify it under the terms of the MIT License or the Academic Free License v2.1.
qdpxx{GK V5EWhs:]: .c[&4e=)S/ J`}bw:=5`BQmw'n^6 zO뭔, H4ņܽ{ԻdB~Y PR& ^OƔ @^`(`I2s`֊ 6{_7ࡠ˟g-}fg(9/%G!~~\ 8{RQ P4w PSH fzF:C?J@~Ӏ(k d̂u u{cXWXc}ܐ ;<A~&4 9V$Wv Wz Pp(A7'/>ĵ#@b_rm0BDV2f% T @0@VKqx#Xsp868 -#A:gQ<5!P;jSh(Q&7jK>x .`,Pj͒m q G9]kȸ3Mt.5(hAghE)kV32f s(gEy>T;ҍAJ 8X30qv 'u Ǘbl;AU {7,%$\u_4ataEЏJ8> ԵUupG4 7S{rZ0,_T`6 2 z d*aPG2) )ZEu1S^)'t i0p>Io囵i( TDĴ9Թ; ^ٝ" 6jXyY @6Egr^U2dyy0<&4 00,Y!|,XF&=橉ox)g: "Iai'E2;AauV: CChy}"ڢy2;"y8u]:-. 5%pXsO3;z2Cv8'iH:e4/2my;E`J'!/\i=caڦJ1 xRD]zJ-9 v`|l{zX1P^>6ygKo⡋ ci}49: "5ڪQv: ; MochiKit-1.4.2/LICENSE.txt 0000660 0001750 0001750 00000024067 11102215706 014124 0 ustar scott scott MochiKit is dual-licensed software. It is available under the terms of the MIT License, or the Academic Free License version 2.1. The full text of each license is included below. MIT License =========== Copyright (c) 2005 Bob Ippolito. All rights reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Academic Free License v. 2.1 ============================ Copyright (c) 2005 Bob Ippolito. All rights reserved. This Academic Free License (the "License") applies to any original work of authorship (the "Original Work") whose owner (the "Licensor") has placed the following notice immediately following the copyright notice for the Original Work: Licensed under the Academic Free License version 2.1 1) Grant of Copyright License. Licensor hereby grants You a world-wide, royalty-free, non-exclusive, perpetual, sublicenseable license to do the following: a) to reproduce the Original Work in copies; b) to prepare derivative works ("Derivative Works") based upon the Original Work; c) to distribute copies of the Original Work and Derivative Works to the public; d) to perform the Original Work publicly; and e) to display the Original Work publicly. 2) Grant of Patent License. Licensor hereby grants You a world-wide, royalty-free, non-exclusive, perpetual, sublicenseable license, under patent claims owned or controlled by the Licensor that are embodied in the Original Work as furnished by the Licensor, to make, use, sell and offer for sale the Original Work and Derivative Works. 3) Grant of Source Code License. The term "Source Code" means the preferred form of the Original Work for making modifications to it and all available documentation describing how to modify the Original Work. Licensor hereby agrees to provide a machine-readable copy of the Source Code of the Original Work along with each copy of the Original Work that Licensor distributes. Licensor reserves the right to satisfy this obligation by placing a machine-readable copy of the Source Code in an information repository reasonably calculated to permit inexpensive and convenient access by You for as long as Licensor continues to distribute the Original Work, and by publishing the address of that information repository in a notice immediately following the copyright notice that applies to the Original Work. 4) Exclusions From License Grant. Neither the names of Licensor, nor the names of any contributors to the Original Work, nor any of their trademarks or service marks, may be used to endorse or promote products derived from this Original Work without express prior written permission of the Licensor. Nothing in this License shall be deemed to grant any rights to trademarks, copyrights, patents, trade secrets or any other intellectual property of Licensor except as expressly stated herein. No patent license is granted to make, use, sell or offer to sell embodiments of any patent claims other than the licensed claims defined in Section 2. No right is granted to the trademarks of Licensor even if such marks are included in the Original Work. Nothing in this License shall be interpreted to prohibit Licensor from licensing under different terms from this License any Original Work that Licensor otherwise would have a right to license. 5) This section intentionally omitted. 6) Attribution Rights. You must retain, in the Source Code of any Derivative Works that You create, all copyright, patent or trademark notices from the Source Code of the Original Work, as well as any notices of licensing and any descriptive text identified therein as an "Attribution Notice." You must cause the Source Code for any Derivative Works that You create to carry a prominent Attribution Notice reasonably calculated to inform recipients that You have modified the Original Work. 7) Warranty of Provenance and Disclaimer of Warranty. Licensor warrants that the copyright in and to the Original Work and the patent rights granted herein by Licensor are owned by the Licensor or are sublicensed to You under the terms of this License with the permission of the contributor(s) of those copyrights and patent rights. Except as expressly stated in the immediately proceeding sentence, the Original Work is provided under this License on an "AS IS" BASIS and WITHOUT WARRANTY, either express or implied, including, without limitation, the warranties of NON-INFRINGEMENT, MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY OF THE ORIGINAL WORK IS WITH YOU. This DISCLAIMER OF WARRANTY constitutes an essential part of this License. No license to Original Work is granted hereunder except under this disclaimer. 8) Limitation of Liability. Under no circumstances and under no legal theory, whether in tort (including negligence), contract, or otherwise, shall the Licensor be liable to any person for any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or the use of the Original Work including, without limitation, damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses. This limitation of liability shall not apply to liability for death or personal injury resulting from Licensor's negligence to the extent applicable law prohibits such limitation. Some jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so this exclusion and limitation may not apply to You. 9) Acceptance and Termination. If You distribute copies of the Original Work or a Derivative Work, You must make a reasonable effort under the circumstances to obtain the express assent of recipients to the terms of this License. Nothing else but this License (or another written agreement between Licensor and You) grants You permission to create Derivative Works based upon the Original Work or to exercise any of the rights granted in Section 1 herein, and any attempt to do so except under the terms of this License (or another written agreement between Licensor and You) is expressly prohibited by U.S. copyright law, the equivalent laws of other countries, and by international treaty. Therefore, by exercising any of the rights granted to You in Section 1 herein, You indicate Your acceptance of this License and all of its terms and conditions. 10) Termination for Patent Action. This License shall terminate automatically and You may no longer exercise any of the rights granted to You by this License as of the date You commence an action, including a cross-claim or counterclaim, against Licensor or any licensee alleging that the Original Work infringes a patent. This termination provision shall not apply for an action alleging patent infringement by combinations of the Original Work with other software or hardware. 11) Jurisdiction, Venue and Governing Law. Any action or suit relating to this License may be brought only in the courts of a jurisdiction wherein the Licensor resides or in which Licensor conducts its primary business, and under the laws of that jurisdiction excluding its conflict-of-law provisions. The application of the United Nations Convention on Contracts for the International Sale of Goods is expressly excluded. Any use of the Original Work outside the scope of this License or after its termination shall be subject to the requirements and penalties of the U.S. Copyright Act, 17 U.S.C. § 101 et seq., the equivalent laws of other countries, and international treaty. This section shall survive the termination of this License. 12) Attorneys Fees. In any action to enforce the terms of this License or seeking damages relating thereto, the prevailing party shall be entitled to recover its costs and expenses, including, without limitation, reasonable attorneys' fees and costs incurred in connection with such action, including any appeal of such action. This section shall survive the termination of this License. 13) Miscellaneous. This License represents the complete agreement concerning the subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. 14) Definition of "You" in This License. "You" throughout this License, whether in upper or lower case, means an individual or a legal entity exercising rights under, and complying with all of the terms of, this License. For legal entities, "You" includes any entity that controls, is controlled by, or is under common control with you. For purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. 15) Right to Use. You may use the Original Work in all ways not otherwise restricted or conditioned by this License or by law, and Licensor promises not to interfere with or be responsible for such uses by You. This license is Copyright (C) 2003-2004 Lawrence E. Rosen. All rights reserved. Permission is hereby granted to copy and distribute this license without modification. This license may not be modified without the express written permission of its copyright owner.