-
Notifications
You must be signed in to change notification settings - Fork 640
/
object.js
615 lines (580 loc) · 18 KB
/
object.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
/** section: Language
* class Object
*
* Extensions to the built-in [[Object]] object.
*
* Because it is dangerous and invasive to augment `Object.prototype` (i.e.,
* add instance methods to objects), all these methods are static methods that
* take an [[Object]] as their first parameter.
*
* [[Object]] is used by Prototype as a namespace; that is, it just keeps a few
* new methods together, which are intended for namespaced access (i.e. starting
* with "`Object.`").
*
* For the regular developer (who simply uses Prototype without tweaking it), the
* most commonly used methods are probably [[Object.inspect]] and, to a lesser degree,
* [[Object.clone]].
*
* Advanced users, who wish to create their own objects like Prototype does, or
* explore objects as if they were hashes, will turn to [[Object.extend]],
* [[Object.keys]], and [[Object.values]].
**/
(function() {
var _toString = Object.prototype.toString,
_hasOwnProperty = Object.prototype.hasOwnProperty,
NULL_TYPE = 'Null',
UNDEFINED_TYPE = 'Undefined',
BOOLEAN_TYPE = 'Boolean',
NUMBER_TYPE = 'Number',
STRING_TYPE = 'String',
OBJECT_TYPE = 'Object',
FUNCTION_CLASS = '[object Function]',
BOOLEAN_CLASS = '[object Boolean]',
NUMBER_CLASS = '[object Number]',
STRING_CLASS = '[object String]',
ARRAY_CLASS = '[object Array]',
DATE_CLASS = '[object Date]',
NATIVE_JSON_STRINGIFY_SUPPORT = window.JSON &&
typeof JSON.stringify === 'function' &&
JSON.stringify(0) === '0' &&
typeof JSON.stringify(Prototype.K) === 'undefined';
var DONT_ENUMS = ['toString', 'toLocaleString', 'valueOf',
'hasOwnProperty', 'isPrototypeOf', 'propertyIsEnumerable', 'constructor'];
// Some versions of JScript fail to enumerate over properties, names of which
// correspond to non-enumerable properties in the prototype chain
var IS_DONTENUM_BUGGY = (function(){
for (var p in { toString: 1 }) {
// check actual property name, so that it works with augmented Object.prototype
if (p === 'toString') return false;
}
return true;
})();
function Type(o) {
switch(o) {
case null: return NULL_TYPE;
case (void 0): return UNDEFINED_TYPE;
}
var type = typeof o;
switch(type) {
case 'boolean': return BOOLEAN_TYPE;
case 'number': return NUMBER_TYPE;
case 'string': return STRING_TYPE;
}
return OBJECT_TYPE;
}
/**
* Object.extend(destination, source) -> Object
* - destination (Object): The object to receive the new properties.
* - source (Object): The object whose properties will be duplicated.
*
* Copies all properties from the source to the destination object. Used by Prototype
* to simulate inheritance (rather statically) by copying to prototypes.
*
* Documentation should soon become available that describes how Prototype implements
* OOP, where you will find further details on how Prototype uses [[Object.extend]] and
* [[Class.create]] (something that may well change in version 2.0). It will be linked
* from here.
*
* Do not mistake this method with its quasi-namesake [[Element.extend]],
* which implements Prototype's (much more complex) DOM extension mechanism.
**/
function extend(destination, source) {
for (var property in source)
destination[property] = source[property];
return destination;
}
/**
* Object.inspect(obj) -> String
* - object (Object): The item to be inspected.
*
* Returns the debug-oriented string representation of the object.
*
* * `undefined` and `null` are represented as such.
* * Other types are looked up for a `inspect` method: if there is one, it is used, otherwise,
* it reverts to the `toString` method.
*
* Prototype provides `inspect` methods for many types, both built-in and library-defined,
* such as in [[String#inspect]], [[Array#inspect]], [[Enumerable#inspect]] and [[Hash#inspect]],
* which attempt to provide most-useful string representations (from a developer's standpoint)
* for their respective types.
*
* ##### Examples
*
* Object.inspect();
* // -> 'undefined'
*
* Object.inspect(null);
* // -> 'null'
*
* Object.inspect(false);
* // -> 'false'
*
* Object.inspect([1, 2, 3]);
* // -> '[1, 2, 3]'
*
* Object.inspect('hello');
* // -> "'hello'"
**/
function inspect(object) {
try {
if (isUndefined(object)) return 'undefined';
if (object === null) return 'null';
return object.inspect ? object.inspect() : String(object);
} catch (e) {
if (e instanceof RangeError) return '...';
throw e;
}
}
/**
* Object.toJSON(object) -> String
* - object (Object): The object to be serialized.
*
* Returns a JSON string.
*
* `undefined` and `function` types have no JSON representation. `boolean`
* and `null` are coerced to strings.
*
* For other types, [[Object.toJSON]] looks for a `toJSON` method on `object`.
* If there is one, it is used; otherwise the object is treated like a
* generic [[Object]].
*
* For more information on Prototype's JSON encoder, hop to our
* [tutorial](http://prototypejs.org/learn/json).
*
* ##### Example
*
* var data = {name: 'Violet', occupation: 'character', age: 25, pets: ['frog', 'rabbit']};
* Object.toJSON(data);
* //-> '{"name": "Violet", "occupation": "character", "age": 25, "pets": ["frog","rabbit"]}'
**/
function toJSON(value) {
return Str('', { '': value }, []);
}
function Str(key, holder, stack) {
var value = holder[key];
if (Type(value) === OBJECT_TYPE && typeof value.toJSON === 'function') {
value = value.toJSON(key);
}
var _class = _toString.call(value);
switch (_class) {
case NUMBER_CLASS:
case BOOLEAN_CLASS:
case STRING_CLASS:
value = value.valueOf();
}
switch (value) {
case null: return 'null';
case true: return 'true';
case false: return 'false';
}
var type = typeof value;
switch (type) {
case 'string':
return value.inspect(true);
case 'number':
return isFinite(value) ? String(value) : 'null';
case 'object':
for (var i = 0, length = stack.length; i < length; i++) {
if (stack[i] === value) {
throw new TypeError("Cyclic reference to '" + value + "' in object");
}
}
stack.push(value);
var partial = [];
if (_class === ARRAY_CLASS) {
for (var i = 0, length = value.length; i < length; i++) {
var str = Str(i, value, stack);
partial.push(typeof str === 'undefined' ? 'null' : str);
}
partial = '[' + partial.join(',') + ']';
} else {
var keys = Object.keys(value);
for (var i = 0, length = keys.length; i < length; i++) {
var key = keys[i], str = Str(key, value, stack);
if (typeof str !== "undefined") {
partial.push(key.inspect(true)+ ':' + str);
}
}
partial = '{' + partial.join(',') + '}';
}
stack.pop();
return partial;
}
}
function stringify(object) {
return JSON.stringify(object);
}
/**
* Object.toQueryString(object) -> String
* - object (Object): The object whose property/value pairs will be converted.
*
* Turns an object into its URL-encoded query string representation.
*
* This is a form of serialization, and is mostly useful to provide complex
* parameter sets for stuff such as objects in the [[Ajax]] namespace (e.g.
* [[Ajax.Request]]).
*
* Undefined-value pairs will be serialized as if empty-valued. Array-valued
* pairs will get serialized with one name/value pair per array element. All
* values get URI-encoded using JavaScript's native `encodeURIComponent`
* function.
*
* The order of pairs in the serialized form is not guaranteed (and mostly
* irrelevant anyway) — except for array-based parts, which are serialized
* in array order.
*
* ##### Examples
*
* Object.toQueryString({ action: 'ship', order_id: 123, fees: ['f1', 'f2'], 'label': 'a demo' })
* // -> 'action=ship&order_id=123&fees=f1&fees=f2&label=a+demo'
**/
function toQueryString(object) {
return $H(object).toQueryString();
}
/**
* Object.toHTML(object) -> String
* - object (Object): The object to convert to HTML.
*
* Converts the object to its HTML representation.
*
* Returns the return value of `object`'s `toHTML` method if it exists; else
* runs `object` through [[String.interpret]].
*
* ##### Examples
*
* var Bookmark = Class.create({
* initialize: function(name, url) {
* this.name = name;
* this.url = url;
* },
*
* toHTML: function() {
* return '<a href="#{url}">#{name}</a>'.interpolate(this);
* }
* });
*
* var api = new Bookmark('Prototype API', 'http://prototypejs.org/api');
*
* Object.toHTML(api);
* //-> '<a href="http://prototypejs.org/api">Prototype API</a>'
*
* Object.toHTML("Hello world!");
* //-> "Hello world!"
*
* Object.toHTML();
* //-> ""
*
* Object.toHTML(null);
* //-> ""
*
* Object.toHTML(undefined);
* //-> ""
*
* Object.toHTML(true);
* //-> "true"
*
* Object.toHTML(false);
* //-> "false"
*
* Object.toHTML(123);
* //-> "123"
**/
function toHTML(object) {
return object && object.toHTML ? object.toHTML() : String.interpret(object);
}
/**
* Object.keys(object) -> Array
* - object (Object): The object to pull keys from.
*
* Returns an array of the object's property names.
*
* Note that the order of the resulting array is browser-dependent — it
* relies on the `for...in` loop, for which the ECMAScript spec does not
* prescribe an enumeration order. Sort the resulting array if you wish to
* normalize the order of the object keys.
*
* `Object.keys` acts as an ECMAScript 5 [polyfill](http://remysharp.com/2010/10/08/what-is-a-polyfill/).
* It is only defined if not already present in the user's browser, and it
* is meant to behave like the native version as much as possible. Consult
* the [ES5 specification](http://es5.github.com/#x15.2.3.14) for more
* information.
*
* ##### Examples
*
* Object.keys();
* // -> []
*
* Object.keys({ name: 'Prototype', version: '1.6.1' }).sort();
* // -> ['name', 'version']
**/
function keys(object) {
if (Type(object) !== OBJECT_TYPE) { throw new TypeError(); }
var results = [];
for (var property in object) {
if (_hasOwnProperty.call(object, property))
results.push(property);
}
// Account for the DontEnum properties in affected browsers.
if (IS_DONTENUM_BUGGY) {
for (var i = 0; property = DONT_ENUMS[i]; i++) {
if (_hasOwnProperty.call(object, property))
results.push(property);
}
}
return results;
}
/**
* Object.values(object) -> Array
* - object (Object): The object to pull values from.
*
* Returns an array of the object's property values.
*
* Note that the order of the resulting array is browser-dependent — it
* relies on the `for...in` loop, for which the ECMAScript spec does not
* prescribe an enumeration order.
*
* Also, remember that while property _names_ are unique, property _values_
* have no such constraint.
*
* ##### Examples
*
* Object.values();
* // -> []
*
* Object.values({ name: 'Prototype', version: '1.6.1' }).sort();
* // -> ['1.6.1', 'Prototype']
**/
function values(object) {
var results = [];
for (var property in object)
results.push(object[property]);
return results;
}
/**
* Object.clone(object) -> Object
* - object (Object): The object to clone.
*
* Creates and returns a shallow duplicate of the passed object by copying
* all of the original's key/value pairs onto an empty object.
*
* Do note that this is a _shallow_ copy, not a _deep_ copy. Nested objects
* will retain their references.
*
* ##### Examples
*
* var original = {name: 'primaryColors', values: ['red', 'green', 'blue']};
* var copy = Object.clone(original);
*
* original.name;
* // -> "primaryColors"
* original.values[0];
* // -> "red"
* copy.name;
* // -> "primaryColors"
*
* copy.name = "secondaryColors";
* original.name;
* // -> "primaryColors"
* copy.name;
* // -> "secondaryColors"
*
* copy.values[0] = 'magenta';
* copy.values[1] = 'cyan';
* copy.values[2] = 'yellow';
* original.values[0];
* // -> "magenta" (it's a shallow copy, so they share the array)
**/
function clone(object) {
return extend({ }, object);
}
/**
* Object.isElement(object) -> Boolean
* - object (Object): The object to test.
*
* Returns `true` if `object` is a DOM node of type 1; `false` otherwise.
*
* ##### Examples
*
* Object.isElement(new Element('div'));
* //-> true
*
* Object.isElement(document.createElement('div'));
* //-> true
*
* Object.isElement($('id_of_an_exiting_element'));
* //-> true
*
* Object.isElement(document.createTextNode('foo'));
* //-> false
**/
function isElement(object) {
return !!(object && object.nodeType == 1);
}
/**
* Object.isArray(object) -> Boolean
* - object (Object): The object to test.
*
* Returns `true` if `object` is an [[Array]]; `false` otherwise.
*
* ##### Examples
*
* Object.isArray([]);
* //-> true
*
* Object.isArray($w());
* //-> true
*
* Object.isArray({ });
* //-> false
**/
function isArray(object) {
return _toString.call(object) === ARRAY_CLASS;
}
var hasNativeIsArray = (typeof Array.isArray == 'function')
&& Array.isArray([]) && !Array.isArray({});
if (hasNativeIsArray) {
isArray = Array.isArray;
}
/**
* Object.isHash(object) -> Boolean
* - object (Object): The object to test.
*
* Returns `true` if `object` is an instance of the [[Hash]] class; `false`
* otherwise.
*
* ##### Examples
*
* Object.isHash(new Hash({ }));
* //-> true
*
* Object.isHash($H({ }));
* //-> true
*
* Object.isHash({ });
* //-> false
**/
function isHash(object) {
return object instanceof Hash;
}
/**
* Object.isFunction(object) -> Boolean
* - object (Object): The object to test.
*
* Returns `true` if `object` is of type [[Function]]; `false` otherwise.
*
* ##### Examples
*
* Object.isFunction($);
* //-> true
*
* Object.isFunction(123);
* //-> false
**/
function isFunction(object) {
return _toString.call(object) === FUNCTION_CLASS;
}
/**
* Object.isString(object) -> Boolean
* - object (Object): The object to test.
*
* Returns `true` if `object` is of type [[String]]; `false` otherwise.
*
* ##### Examples
*
* Object.isString("foo");
* //-> true
*
* Object.isString("");
* //-> true
*
* Object.isString(123);
* //-> false
**/
function isString(object) {
return _toString.call(object) === STRING_CLASS;
}
/**
* Object.isNumber(object) -> Boolean
* - object (Object): The object to test.
*
* Returns `true` if `object` is of type [[Number]]; `false` otherwise.
*
* ##### Examples
*
* Object.isNumber(0);
* //-> true
*
* Object.isNumber(1.2);
* //-> true
*
* Object.isNumber("foo");
* //-> false
**/
function isNumber(object) {
return _toString.call(object) === NUMBER_CLASS;
}
/**
* Object.isDate(object) -> Boolean
* - object (Object): The object to test.
*
* Returns `true` if `object` is of type [[Date]]; `false` otherwise.
*
* ##### Examples
*
* Object.isDate(new Date);
* //-> true
*
* Object.isDate("Dec 25, 1995");
* //-> false
*
* Object.isDate(new Date("Dec 25, 1995"));
* //-> true
**/
function isDate(object) {
return _toString.call(object) === DATE_CLASS;
}
/**
* Object.isUndefined(object) -> Boolean
* - object (Object): The object to test.
*
* Returns `true` if `object` is of type `undefined`; `false` otherwise.
*
* ##### Examples
*
* Object.isUndefined();
* //-> true
*
* Object.isUndefined(undefined);
* //-> true
*
* Object.isUndefined(null);
* //-> false
*
* Object.isUndefined(0);
* //-> false
*
* Object.isUndefined("");
* //-> false
**/
function isUndefined(object) {
return typeof object === "undefined";
}
extend(Object, {
extend: extend,
inspect: inspect,
toJSON: NATIVE_JSON_STRINGIFY_SUPPORT ? stringify : toJSON,
toQueryString: toQueryString,
toHTML: toHTML,
keys: Object.keys || keys,
values: values,
clone: clone,
isElement: isElement,
isArray: isArray,
isHash: isHash,
isFunction: isFunction,
isString: isString,
isNumber: isNumber,
isDate: isDate,
isUndefined: isUndefined
});
})();