')
.css({paddingLeft: ((level * 32) + 'px')})
.html(
- '
' + item.name + ' ' +
+ '' + (name || item.name) + ' ' +
'<' + item.types.join('> or <') + '> ' +
+ (item.default ? 'default: ' + item.default + ' ' : '') +
Ox.parseHTML(item.summary)
)
];
@@ -89,7 +88,6 @@ Ox.DocPage = function(options, self) {
.html(
'> ' +
Ox.encodeHTML(example.statement)
- //example.statement
.replace(/ /g, ' ')
.replace(/\n/g, '
\n ') +
''
@@ -120,12 +118,11 @@ Ox.DocPage = function(options, self) {
);
} else {
item[section].forEach(function(v) {
- if (section == 'usage') {
- v.name = item.name + v.name + ' returns
';
- }
+ var name = section == 'usage' ?
+ item.name + v.name + ' returns
' : null;
$elements = Ox.merge(
$elements,
- Ox.map(getItem(v, level + 1), function($element) {
+ Ox.map(getItem(v, level + 1, name), function($element) {
return $element.addClass(className);
})
);
diff --git a/source/Ox.UI/js/Core/Ox.DocPanel.js b/source/Ox.UI/js/Core/Ox.DocPanel.js
new file mode 100644
index 00000000..5ff597ca
--- /dev/null
+++ b/source/Ox.UI/js/Core/Ox.DocPanel.js
@@ -0,0 +1,132 @@
+/*@
+Ox.DocPanel Documentation Panel
+@*/
+
+Ox.DocPanel = function(options, self) {
+
+ self = self || {};
+ var that = Ox.Element({}, self)
+ .defaults({
+ collapsible: true,
+ files: [],
+ getModule: function(item) {
+ return item.file.replace(self.options.path, '');
+ },
+ getSection: function(item) {
+ return item.section;
+ },
+ path: '',
+ resizable: true,
+ resize: [128, 256, 384],
+ size: 256
+ })
+ .options(options || {});
+
+ self.$list = Ox.Element();
+ self.$page = Ox.Element();
+
+ that.$element = Ox.SplitPanel({
+ elements: [
+ {
+ collapsible: self.options.collapsible,
+ element: self.$list,
+ resizable: self.options.resizable,
+ resize: self.options.resize,
+ size: self.options.size
+ },
+ {
+ element: self.$page
+ }
+ ],
+ orientation: 'horizontal'
+ });
+
+ loadList(function(docItems) {
+ self.items = docItems;
+ });
+
+ function loadList(callback) {
+ var counter = 0,
+ length = self.options.files.length;
+ docItems = [];
+ self.options.files.forEach(function(file) {
+ Ox.doc(self.options.path + file, function(fileItems) {
+ docItems = Ox.merge(docItems, fileItems);
+ if (++counter == length) {
+ makeTree(docItems);
+ callback(docItems);
+ }
+ });
+ });
+ function makeTree(docItems) {
+ var treeItems = [];
+ docItems.forEach(function(docItem) {
+ var moduleIndex, sectionIndex;
+ docItem.module = self.options.getModule(docItem);
+ moduleIndex = Ox.getPositionById(treeItems, '_' + docItem.module);
+ if (moduleIndex == -1) {
+ treeItems.push({
+ id: '_' + docItem.module,
+ items: [],
+ title: docItem.module
+ });
+ moduleIndex = treeItems.length - 1;
+ }
+ docItem.section = self.options.getSection(docItem);
+ if (docItem.section) {
+ sectionIndex = Ox.getPositionById(
+ treeItems[moduleIndex].items, '_' + docItem.section
+ );
+ if (sectionIndex == -1) {
+ treeItems[moduleIndex].items.push({
+ id: '_' + docItem.section,
+ items: [],
+ title: docItem.section
+ });
+ sectionIndex = treeItems[moduleIndex].items.length - 1;
+ }
+ }
+ (
+ docItem.section ?
+ treeItems[moduleIndex].items[sectionIndex] :
+ treeItems[moduleIndex]
+ ).items.push({
+ id: docItem.name,
+ title: docItem.name
+ });
+ });
+ self.$list = Ox.TreeList({
+ items: treeItems,
+ width: self.options.width
+ })
+ .bindEvent({
+ select: selectItem
+ });
+ that.$element.replaceElement(0, self.$list);
+ }
+ }
+
+ function getItemByName(name) {
+ var item = {};
+ Ox.forEach(self.items, function(v) {
+ if (v.name == name) {
+ item = v;
+ return false;
+ }
+ });
+ return item;
+ }
+
+ function selectItem(data) {
+ var selected = data.ids[0];
+ if (selected[0] != '_') {
+ self.$page = Ox.DocPage({
+ item: getItemByName(selected)
+ });
+ that.$element.replaceElement(1, self.$page);
+ }
+ }
+
+ return that;
+
+};
\ No newline at end of file
diff --git a/source/Ox.UI/js/Core/Ox.Theme.js b/source/Ox.UI/js/Core/Ox.Theme.js
index a04e3aaa..31b228f4 100644
--- a/source/Ox.UI/js/Core/Ox.Theme.js
+++ b/source/Ox.UI/js/Core/Ox.Theme.js
@@ -22,7 +22,6 @@ Ox.Theme = function(theme) {
return false;
}
});
- Ox.print('getTheme', theme)
return theme;
}
diff --git a/source/Ox.UI/js/List/Ox.TreeList.js b/source/Ox.UI/js/List/Ox.TreeList.js
index 6a270679..d5920b8d 100644
--- a/source/Ox.UI/js/List/Ox.TreeList.js
+++ b/source/Ox.UI/js/List/Ox.TreeList.js
@@ -156,7 +156,7 @@ Ox.TreeList = function(options, self) {
}
function toggleItem(item, expanded) {
- var $img, $item, pos;
+ var $img, pos;
item.expanded = expanded;
$.each(that.$element.find('.OxItem'), function(i, v) {
var $item = $(v);
@@ -166,12 +166,23 @@ Ox.TreeList = function(options, self) {
return false;
}
});
- Ox.print('i.e', item.expanded)
+ Ox.print('i.e', item.expanded, $img, $img.attr('src'));
+ // FIXME: why does this not work??
+ ///*
$img.attr({
src: Ox.UI.getImagePath(
'symbol' + (item.expanded ? 'Down' : 'Right') + '.svg'
)
});
+ //*/
+ /*
+ Ox.print($img.attr('src'))
+ $img.attr({
+ src: $img.attr('src') == Ox.UI.getImagePath('symbolDown.svg') ?
+ Ox.UI.getImagePath('symbolRight.svg') :
+ Ox.UI.getImagePath('symbolDown.svg')
+ });
+ */
item.expanded ?
that.$element.addItems(pos + 1, parseItems(item.items, item.level + 1)) :
that.$element.removeItems(pos + 1, parseItems(item.items, item.level + 1).length);
diff --git a/source/Ox.js b/source/Ox.js
index a5e182e5..e440933d 100644
--- a/source/Ox.js
+++ b/source/Ox.js
@@ -1,10 +1,11 @@
// vim: et:ts=4:sw=4:sts=4:ft=js
-// OxJS (c) 2007-2011 Ox2620, dual-licensed (GPL/MIT), see oxjs.org for details
+// OxJS (c) 2011 Ox2620, dual-licensed GPL/MIT, see http://oxjs.org for details
// todo: check http://ejohn.org/blog/ecmascript-5-strict-mode-json-and-more/
// also see https://github.com/tlrobinson/narwhal/blob/master/lib/util.js
+//@ Core -----------------------------------------------------------------------
/*@
Ox The Ox object
@@ -17,214 +18,6 @@ Ox = function(val) {
return Ox.wrap(val);
};
-/*
-================================================================================
-Constants
-================================================================================
-*/
-
-//@ Ox.AMPM <[str]> ['AM', 'PM']
-Ox.AMPM = ['AM', 'PM'];
-//@ Ox.DURATIONS <[str]> ['year', 'month', 'day', 'minute', 'second']
-Ox.DURATIONS = ['year', 'month', 'day', 'minute', 'second'];
-//@ Ox.EARTH_RADIUS Radius of the earth in meters
-// see http://en.wikipedia.org/wiki/WGS-84
-Ox.EARTH_RADIUS = 6378137;
-//@ Ox.EARTH_CIRCUMFERENCE Circumference of the earth in meters
-Ox.EARTH_CIRCUMFERENCE = Ox.EARTH_RADIUS * 2 * Math.PI;
-//@ Ox.HTML_ENTITIES
+ > Ox.compact([null,,1,,2,,3])
+ [1, 2, 3]
@*/
-Ox.avg = function(obj) {
- return Ox.sum(obj) / Ox.len(obj);
-};
-
-Ox.clone = function(obj) {
- /***
- returns a copy of an array or object
- >>> (function() { a = ['val']; b = Ox.clone(a); a[0] = null; return b[0]; }())
- 'val'
- >>> (function() { a = {key: 'val'}; b = Ox.clone(a); a.key = null; return b.key; }())
- 'val'
- ***/
- return Ox.isArray(obj) ? obj.slice() : Ox.extend({}, obj);
-};
Ox.compact = function(arr) {
/***
returns an array without null or undefined values
- >>> Ox.compact([null,,1,,2,,3])
- [1, 2, 3]
***/
return Ox.map(arr, function(val) {
return Ox.isUndefined(val) ? null : val;
});
};
-Ox.count = function(arr) {
- /***
- >>> Ox.count(['foo', 'bar', 'foo']).foo
- 2
- ***/
- var obj = {};
+/*@
+ Ox.flatten
Flattens an array
+ > Ox.flatten([1, [2, [3], 4], 5])
+ [1, 2, 3, 4, 5]
+@*/
+Ox.flatten = function(arr) {
+ // fixme: can this work for objects too?
+ var ret = [];
arr.forEach(function(v) {
+ if (Ox.isArray(v)) {
+ Ox.flatten(v).forEach(function(v) {
+ ret.push(v);
+ });
+ } else {
+ ret.push(v);
+ }
+ });
+ return ret;
+};
+
+/*@
+Ox.merge Merges an array with one or more other arrays
+ > Ox.merge(['foo'], ['foo', 'bar'], ['bar'])
+ ['foo', 'foo', 'bar', 'bar']
+@*/
+Ox.merge = function(arr) {
+ Ox.forEach(Array.prototype.slice.call(arguments, 1), function(arg) {
+ Ox.forEach(arg, function(val) {
+ arr.push(val);
+ });
+ });
+ return arr;
+};
+
+/*@
+Ox.unique Returns an array without duplicate values
+ > Ox.unique([1, 2, 3, 2, 1])
+ [1, 2, 3]
+@*/
+
+Ox.unique = function(arr) {
+ var unique = [];
+ Ox.forEach(arr, function(val) {
+ unique.indexOf(val) == -1 && unique.push(val);
+ });
+ return unique;
+};
+
+/*@
+Ox.zip Zips an array of arrays
+ > Ox.zip([[0, 1], [2, 3], [4, 5]])
+ [[0, 2, 4], [1, 3, 5]]
+ > Ox.zip([0, 1, 2], [3, 4, 5])
+ [[0, 3], [1, 4], [2, 5]]
+@*/
+Ox.zip = function() {
+ var args = arguments.length == 1 ? arguments[0] : Ox.makeArray(arguments),
+ arr = [];
+ args[0].forEach(function(v, i) {
+ arr[i] = [];
+ args.forEach(function(v_, i_) {
+ arr[i].push(v_[i]);
+ });
+ });
+ return arr;
+};
+
+//@ Collections ----------------------------------------------------------------
+
+/*@
+Ox.avg Returns the average of an array's values, or an object's properties
+ (collection) -> Average value
+ collection <[n]|o> Array or object with numerical values
+ > Ox.avg([-1, 0, 1])
+ 0
+ > Ox.avg({a: 1, b: 2, c: 3})
+ 2
+@*/
+
+Ox.avg = function(obj) {
+ return Ox.sum(obj) / Ox.len(obj);
+};
+
+/*@
+Ox.clone Returns a (shallow) copy or an object or array
+ > (function() { a = ['val']; b = Ox.clone(a); a[0] = null; return b[0]; }())
+ 'val'
+ > (function() { a = {key: 'val'}; b = Ox.clone(a); a.key = null; return b.key; }())
+ 'val'
+@*/
+
+Ox.clone = function(obj) {
+ return Ox.isArray(obj) ? obj.slice() : Ox.extend({}, obj);
+};
+
+/*@
+Ox.count Counts the occurences of values in an array, object or string
+ > Ox.count(['f', 'o', 'o'])
+ {f: 1, o: 2}
+ > Ox.count({a: 'f', b: 'o', c: 'o'})
+ {f: 1, o: 2}
+ > Ox.count('foo')
+ {f: 1, o: 2}
+@*/
+Ox.count = function(arr) {
+ var obj = {};
+ Ox.forEach(arr, function(v) {
obj[v] = (obj[v] || 0) + 1;
});
return obj;
};
+//@ Ox.each (deprecated)
Ox.each = function(obj, fn) {
// fixme: deprecate!
/*
@@ -476,47 +267,38 @@ Ox.each = function(obj, fn) {
return obj;
};
+/*@
+Ox.every Returns true if a condition holds for every element of a collection
+ Unlike [].every(), Ox.every() works for arrays,
+ objects and strings.
+ > Ox.every([0, 1, 2], function(v, i) { return i == v; })
+ true
+ > Ox.every({a: 1, b: 2, c: 3}, function(v) { return v == 1; })
+ false
+ > Ox.every("foo", function(v) { return v == 'f'; })
+ false
+ > Ox.every([true, true, true])
+ true
+@*/
Ox.every = function(obj, fn) {
- /*
- Ox.every() works for arrays, objects and strings, unlike [].every()
- >>> Ox.every([0, 1, 2], function(v, i) { return i == v; })
- true
- >>> Ox.every({a: 1, b: 2, c: 3}, function(v) { return v == 1; })
- false
- >>> Ox.every("foo", function(v) { return v == 'f'; })
- false
- >>> Ox.every([true, true, true])
- true
- */
return Ox.filter(Ox.values(obj), fn || function(v) {
return v;
}).length == Ox.len(obj);
};
-Ox.extend = function() {
- /*
- >>> Ox.extend({a: 1, b: 1, c: 1}, {b: 2, c: 2}, {c: 3}).c
- {"a":1,"b":2,"c":3}
- */
- var obj = arguments[0];
- Ox.forEach(Array.prototype.slice.call(arguments, 1), function(arg, i) {
- Ox.forEach(arg, function(val, key) {
- obj[key] = val;
- });
- });
- return obj;
-};
+/*@
+Ox.filter Filters a collection by a given condition
+ Unlike [].filter(), Ox.filter() works for arrays,
+ objects and strings.
+ > Ox.filter([2, 1, 0], function(v, i) { return v == i; })
+ [1]
+ > Ox.keys(Ox.filter({a: 'c', b: 'b', c: 'a'}, function(v, k) { return v == k; }))
+ ['b']
+ > Ox.filter(' foo bar ', function(v) { return v != ' '; })
+ 'foobar'
+@*/
Ox.filter = function(obj, fn) {
- /***
- Ox.filter works for arrays, objects and strings, unlike [].filter()
- >>> Ox.filter([2, 1, 0], function(v, i) { return v == i; })
- [1]
- >>> Ox.keys(Ox.filter({a: 'c', b: 'b', c: 'a'}, function(v, k) { return v == k; }))
- ["b"]
- >>> Ox.filter(' foo bar ', function(v) { return v != ' '; })
- "foobar"
- ***/
var type = Ox.typeOf(obj),
ret = type == 'array' ? [] : type == 'object' ? {} : '';
Ox.forEach(obj, function(v, k) {
@@ -533,14 +315,17 @@ Ox.filter = function(obj, fn) {
return ret;
};
+/*@
+Ox.find Returns array elements that match a string, leading matches first
+ > Ox.find(['foo', 'bar', 'foobar', 'barfoo'], 'foo')
+ [['foo", 'foobar'], ['barfoo']]
+@*/
Ox.find = function(arr, str) {
/*
returns an array with two arrays as elements:
an array of elements of arr that begin with str,
and an array of elements of arr that contain,
but do not begin with str
- >>> Ox.find(["foo", "bar", "foobar", "barfoo"], "foo")
- [["foo", "foobar"], ["barfoo"]]
*/
var arrLowerCase = arr.map(function(v) {
return v.toLowerCase();
@@ -553,23 +338,6 @@ Ox.find = function(arr, str) {
return ret;
};
-Ox.flatten = function(arr) {
- /*
- >>> Ox.flatten([1, [2, [3], 4], 5])
- [1, 2, 3, 4, 5]
- */
- var ret = [];
- arr.forEach(function(v) {
- if (Ox.isArray(v)) {
- Ox.flatten(v).forEach(function(v) {
- ret.push(v);
- });
- } else {
- ret.push(v);
- }
- });
- return ret;
-}
/*@
Ox.forEach forEach loop
@@ -604,6 +372,10 @@ Ox.forEach = function(obj, fn) {
return obj;
};
+/*@
+Ox.getObjectById Returns an array element with a given id
+@*/
+// fixme: shouldn't this be getElementById() ?
Ox.getObjectById = function(arr, id) {
/***
>>> Ox.getObjectById([{id: "foo", title: "Foo"}, {id: "bar", title: "Bar"}], "foo").title
@@ -619,6 +391,10 @@ Ox.getObjectById = function(arr, id) {
return ret;
};
+/*@
+Ox.getPositionById Returns the index of an array element with a given id
+@*/
+// fixme: shouldn't this be getIndexById() ?
Ox.getPositionById = function(arr, id) {
/***
>>> Ox.getPositionById([{id: "foo", title: "Foo"}, {id: "bar", title: "Bar"}], "bar")
@@ -634,67 +410,101 @@ Ox.getPositionById = function(arr, id) {
return ret;
};
+// fixme: and what about getElementBy() and getIndexBy() ?
+
+/*@
+Ox.getset Generic getter and setter function
+ See examples for details.
+ # Usage --------------------------------------------------------------------
+ Ox.getset(options, args=[]) -> all options
+ Ox.getset(options, args=[key]) -> <*> options[key]
+ Ox.getset(options, args=[key, value], callback, context) -> context
+ sets options[key] to value and calls fn(key, value)
+ if the key/value pair was added or modified
+ Ox.getset(options, args=[{key: value}], callback, context) -> context
+ sets multiple options and calls fn(key, value)
+ for every key/value pair that was added or modified
+ # Arguments ----------------------------------------------------------------
+ options Options object (key/value pairs)
+ args The arguments "array" of the caller function
+ callback Callback function
+ The callback is called for every key/value pair that was added or
+ modified.
+ key Key
+ value <*> Value
+ context The parent object of the caller function (for chaining)
+ # Examples -----------------------------------------------------------------
+
+ > Ox.test.object.options("key", "val").options("key")
+ "val"
+ > Ox.test.object.options({foo: "foo", bar: "bar"}).options()
+ {"key": "val", "foo": "foo", "bar": "bar"}
+@*/
+
+Ox.getset = function(obj, args, callback, context) {
+ var obj_ = Ox.clone(obj), ret;
+ if (args.length == 0) {
+ // getset([])
+ ret = obj;
+ } else if (args.length == 1 && !Ox.isObject(args[0])) {
+ // getset([key])
+ ret = obj[args[0]];
+ } else {
+ // getset([key, val]) or getset([{key: val, ...}])
+ args = Ox.makeObject(args);
+ obj = Ox.extend(obj, args);
+ Ox.forEach(args, function(val, key) {
+ if (!obj_ || !Ox.isEqual(obj_[key], val)) {
+ callback && callback(key, val);
+ }
+ });
+ ret = context;
+ }
+ return ret;
+}
+
+/*@
+Ox.isEmpty Returns true if an array, object or string is empty
+ > Ox.isEmpty([])
+ true
+ > Ox.isEmpty({})
+ true
+ > Ox.isEmpty('')
+ true
+@*/
Ox.isEmpty = function(val) {
return Ox.len(val) == 0;
};
-Ox.isEqual = function(obj0, obj1) {
- /*
- >>> Ox.isEqual(false, false)
- true
- >>> Ox.isEqual(0, 0)
- true
- >>> Ox.isEqual(NaN, NaN)
- false
- >>> Ox.isEqual('', '')
- true
- >>> Ox.isEqual([1, 2, 3], [1, 2, 3])
- true
- >>> Ox.isEqual({a: 1, b: [2, 3], c: {d: '4'}}, {a: 1, b: [2, 3], c: {d: '4'}})
- true
- >>> Ox.isEqual({a: 1, b: 2, c: 3}, {c: 3, b: 2, a: 1})
- true // FIXME: is false
- >>> Ox.isEqual(function(arg) { return arg; }, function(arg) { return arg; })
- true
- >>> Ox.isEqual(function(foo) { return foo; }, function(bar) { return bar; })
- false
- */
- var ret = false;
- if (obj0 === obj1) {
- ret = true;
- } else if (typeof(obj0) == typeof(obj1)) {
- if (obj0 == obj1) {
- ret = true;
- } else if (Ox.isArray(obj0) && obj0.length == obj1.length) {
- ret = true;
- Ox.forEach(obj0, function(v, i) {
- ret = Ox.isEqual(v, obj1[i]);
- return ret;
- });
- } else if (Ox.isDate(obj0)) {
- ret = obj0.getTime() == obj1.getTime();
- } else if (Ox.isObject(obj0)) {
- ret = Ox.isEqual(Ox.keys(obj0), Ox.keys(obj1)) &&
- Ox.isEqual(Ox.values(obj0), Ox.values(obj1));
- } else if (Ox.isFunction(obj0)) {
- ret = obj0.toString() == obj1.toString();
- }
- }
- return ret;
-};
+/*@
+Ox.keys Returns the keys of an array, object or string
+ Unlike Object.keys(), Ox.keys() works for arrays,
+ objects and strings.
+ > Ox.keys([1, 2, 3])
+ [0, 1, 2]
+ > Ox.keys([1,,3])
+ [0, 2]
+ > Ox.keys([,])
+ [0]
+ > Ox.keys({a: 1, b: 2, c: 3})
+ ['a', 'b', 'c']
+ > Ox.keys('abc')
+ [0, 1, 2]
+@*/
+
+// fixme: is this really needed? arrays... ok... but strings??
Ox.keys = function(obj) {
- /*
- works for arrays, objects and strings, unlike Object.keys()
- >>> Ox.keys([1, 2, 3])
- [0, 1, 2]
- >>> Ox.keys({a: 1, b: 2, c: 3})
- ["a", "b", "c"]
- >>> Ox.keys('abc')
- [0, 1, 2]
- >>> Ox.keys([,])
- [0]
- */
var keys = [];
Ox.forEach(obj, function(v, k) {
keys.push(k);
@@ -702,13 +512,19 @@ Ox.keys = function(obj) {
return keys.sort();
};
-Ox.last = function(arr, val) {
- /***
- >>> Ox.last([1, 2, 3])
+/*@
+Ox.last Gets or sets the last element of an array
+ Unlike foobarbaz[foobarbaz.length - 1],
+ Ox.last(foobarbaz) is short.
+ > Ox.test.array = [1, 2, 3]
+ > Ox.last(Ox.test.array)
3
- >>> Ox.last([1, 2, 3], 4)
+ > Ox.last(Ox.test.array, 4)
[1, 2, 4]
- ***/
+ > Ox.test.array
+ [1, 2, 4]
+@*/
+Ox.last = function(arr, val) {
var ret;
if (arguments.length == 1) {
ret = arr[arr.length - 1];
@@ -719,19 +535,23 @@ Ox.last = function(arr, val) {
return ret;
};
-Ox.len = function(obj) {
- /*
- >>> Ox.len([1, 2, 3])
+/*@
+Ox.len Returns the length of an array, function, object or string
+ Not to be confused with Ox.length, which is the
+ length property of the Ox function
+ (1 Ox.len([1, 2, 3])
3
- >>> Ox.len({a: 1, b: 2, c: 3})
- 3
- >>> Ox.len('abc')
- 3
- >>> Ox.len(function(x, y) { return x + y; })
- 2
- >>> Ox.len([,])
+ > Ox.len([,])
1
- */
+ > Ox.len({a: 1, b: 2, c: 3})
+ 3
+ > Ox.len(function(x, y, z) { return x + y + z; })
+ 3
+ > Ox.len('abc')
+ 3
+@*/
+Ox.len = function(obj) {
return Ox.isObject(obj) ? Ox.values(obj).length : obj.length;
};
@@ -791,17 +611,20 @@ Ox.makeArray = function(obj) {
return Array.prototype.slice.call(obj);
}
+/*@
+Ox.makeObject Takes an array and returns an object
+ Ox.makeObject is a helper for functions with two alternative
+ signatures like ('key', 'val') and ({key: 'val'}).
+ > (function() { return Ox.makeObject(arguments); }({foo: 1, bar: 2}))
+ {foo: 1, bar: 2}
+ > (function() { return Ox.makeObject(arguments); }('foo', 1))
+ {foo: 1}
+ > (function() { return Ox.makeObject(arguments); }('foo'))
+ {}
+ > (function() { return Ox.makeObject(arguments); }())
+ {}
+@*/
Ox.makeObject = function(obj) {
- /*
- >>> (function() { return Ox.makeObject(arguments); }({foo: 'bar'})).foo
- 'bar'
- >>> (function() { return Ox.makeObject(arguments); }('foo', 'bar')).foo
- 'bar'
- >>> (function() { return Ox.makeObject(arguments); }('foo')).foo
- undefined
- >>> (function() { return Ox.makeObject(arguments); }()).foo
- undefined
- */
var ret = {};
if (Ox.isObject(obj[0])) {
// ({foo: 'bar'})
@@ -813,19 +636,24 @@ Ox.makeObject = function(obj) {
return ret;
};
-Ox.map = function(obj, fn) {
- /*
- Ox.map() works for arrays, objects and strings,
- unlike [].map()
- >>> Ox.map([1, 1, 1], function(v, i) { return v == i; })
- [false, true, false]
- >>> Ox.map({a: 'a', b: 'a', c: 'a'}, function(v, k) { return v == k; }).a
- true
- >>> Ox.map("111", function(v, i) { return v == i; })
- [false, true, false]
- >>> Ox.map([,], function(v, i) { return i; })
+/*
+Ox.map Transforms the values of an array, object or string
+ Unlike [].map(), Ox.map() works for arrays,
+ objects and strings. Returning null from the iterator
+ function will remove the element from the collection.
+ > Ox.map([0, 0, 0], function(v, i) { return v == i; })
+ [true, false, false]
+ > Ox.map({a: 'a', b: 'a', c: 'a'}, function(v, k) { return v == k; })
+ {a: true, b: false, c: false}
+ > Ox.map("000", function(v, i) { return v == i; })
+ [true, false, false]
+ > Ox.map([0, 1, 2, 4], function(v, i) { return v ? i == v : null; })
+ [true, true, false]
+ > Ox.map([,], function(v, i) { return i; })
[0]
- */
+*/
+
+Ox.map = function(obj, fn) {
// fixme: return null to filter out is a bit esoteric
var isObject = Ox.isObject(obj),
ret = isObject ? {} : [];
@@ -837,39 +665,32 @@ Ox.map = function(obj, fn) {
return ret;
};
-Ox.max = function(obj) {
- /*
- >>> Ox.max([-1, 0, 1])
- 1
- >>> Ox.max({a: 1, b: 2, c: 3})
+/*@
+Ox.max Returns the maximum value of a collection
+ > Ox.max([1, 2, 3])
3
- */
+ > Ox.max({a: 1, b: 2, c: 3})
+ 3
+ > Ox.max('123')
+ 3
+@*/
+Ox.max = function(obj) {
return Math.max.apply(Math, Ox.values(obj));
};
-Ox.min = function(obj) {
- /*
- >>> Ox.min([-1, 0, 1])
- -1
- >>> Ox.min({a: 1, b: 2, c: 3})
+/*@
+Ox.min Returns the minimum value of a collection
+ > Ox.min([1, 2, 3])
1
- */
+ > Ox.min({a: 1, b: 2, c: 3})
+ 1
+ > Ox.min('123')
+ 1
+@*/
+Ox.min = function(obj) {
return Math.min.apply(Math, Ox.values(obj));
};
-Ox.merge = function(arr) {
- /*
- >>> Ox.merge(['foo'], ['bar'], ['baz'])
- ['foo', 'bar', 'baz']
- */
- Ox.forEach(Array.prototype.slice.call(arguments, 1), function(arg) {
- Ox.forEach(arg, function(val) {
- arr.push(val);
- });
- });
- return arr;
-};
-
/*@
Ox.range Python-style range
(stop) -> <[n]> range
@@ -1032,18 +853,6 @@ Ox.toArray = function(obj) {
return arr;
};
-Ox.unique = function(arr) {
- /*
- >>> Ox.unique([1, 2, 3, 1])
- [1, 2, 3]
- */
- var unique = [];
- Ox.forEach(arr, function(val) {
- unique.indexOf(val) == -1 && unique.push(val);
- });
- return unique;
-};
-
Ox.unserialize = function(str) {
/*
>>> Ox.unserialize('a=1&b=2&c=3').c
@@ -1087,29 +896,7 @@ Ox.walk = function(obj, fn) {
});
};
-Ox.zip = function() {
- /*
- >>> Ox.zip([[0, 1], [2, 3], [4, 5]])
- [[0, 2, 4], [1, 3, 5]]
- >>> Ox.zip([0, 1, 2], [3, 4, 5])
- [[0, 3], [1, 4], [2, 5]]
- */
- var args = arguments.length == 1 ? arguments[0] : Ox.makeArray(arguments),
- arr = [];
- args[0].forEach(function(v, i) {
- arr[i] = [];
- args.forEach(function(v_, i_) {
- arr[i].push(v_[i]);
- });
- });
- return arr;
-};
-
-/*
-================================================================================
-Color functions
-================================================================================
-*/
+//@ Color ----------------------------------------------------------------------
/*@
Ox.hsl Takes RGB values and returns HSL values
@@ -1198,11 +985,125 @@ Ox.rgb = function(hsl) {
});
};
-/*
-================================================================================
-Date functions
-================================================================================
-*/
+//@ Constants ------------------------------------------------------------------
+
+//@ Ox.AMPM <[str]> ['AM', 'PM']
+Ox.AMPM = ['AM', 'PM'];
+//@ Ox.DURATIONS <[str]> ['year', 'month', 'day', 'minute', 'second']
+Ox.DURATIONS = ['year', 'month', 'day', 'minute', 'second'];
+//@ Ox.EARTH_RADIUS Radius of the earth in meters
+// see http://en.wikipedia.org/wiki/WGS-84
+Ox.EARTH_RADIUS = 6378137;
+//@ Ox.EARTH_CIRCUMFERENCE Circumference of the earth in meters
+Ox.EARTH_CIRCUMFERENCE = Ox.EARTH_RADIUS * 2 * Math.PI;
+//@ Ox.HTML_ENTITIES