Fixed Style/StringLiterals RuboCop offense
[lhc/web/wiklou.git] / resources / lib / oojs / oojs.jquery.js
1 /*!
2 * OOjs v1.1.5 optimised for jQuery
3 * https://www.mediawiki.org/wiki/OOjs
4 *
5 * Copyright 2011-2015 OOjs Team and other contributors.
6 * Released under the MIT license
7 * http://oojs.mit-license.org
8 *
9 * Date: 2015-02-26T01:51:06Z
10 */
11 ( function ( global ) {
12
13 'use strict';
14
15 /*exported toString */
16 var
17 /**
18 * Namespace for all classes, static methods and static properties.
19 * @class OO
20 * @singleton
21 */
22 oo = {},
23 // Optimisation: Local reference to Object.prototype.hasOwnProperty
24 hasOwn = oo.hasOwnProperty,
25 toString = oo.toString;
26
27 /* Class Methods */
28
29 /**
30 * Utility to initialize a class for OO inheritance.
31 *
32 * Currently this just initializes an empty static object.
33 *
34 * @param {Function} fn
35 */
36 oo.initClass = function ( fn ) {
37 fn.static = fn.static || {};
38 };
39
40 /**
41 * Inherit from prototype to another using Object#create.
42 *
43 * Beware: This redefines the prototype, call before setting your prototypes.
44 *
45 * Beware: This redefines the prototype, can only be called once on a function.
46 * If called multiple times on the same function, the previous prototype is lost.
47 * This is how prototypal inheritance works, it can only be one straight chain
48 * (just like classical inheritance in PHP for example). If you need to work with
49 * multiple constructors consider storing an instance of the other constructor in a
50 * property instead, or perhaps use a mixin (see OO.mixinClass).
51 *
52 * function Thing() {}
53 * Thing.prototype.exists = function () {};
54 *
55 * function Person() {
56 * Person.super.apply( this, arguments );
57 * }
58 * OO.inheritClass( Person, Thing );
59 * Person.static.defaultEyeCount = 2;
60 * Person.prototype.walk = function () {};
61 *
62 * function Jumper() {
63 * Jumper.super.apply( this, arguments );
64 * }
65 * OO.inheritClass( Jumper, Person );
66 * Jumper.prototype.jump = function () {};
67 *
68 * Jumper.static.defaultEyeCount === 2;
69 * var x = new Jumper();
70 * x.jump();
71 * x.walk();
72 * x instanceof Thing && x instanceof Person && x instanceof Jumper;
73 *
74 * @param {Function} targetFn
75 * @param {Function} originFn
76 * @throws {Error} If target already inherits from origin
77 */
78 oo.inheritClass = function ( targetFn, originFn ) {
79 if ( targetFn.prototype instanceof originFn ) {
80 throw new Error( 'Target already inherits from origin' );
81 }
82
83 var targetConstructor = targetFn.prototype.constructor;
84
85 // Using ['super'] instead of .super because 'super' is not supported
86 // by IE 8 and below (bug 63303).
87 // Provide .parent as alias for code supporting older browsers which
88 // allows people to comply with their style guide.
89 targetFn['super'] = targetFn.parent = originFn;
90
91 targetFn.prototype = Object.create( originFn.prototype, {
92 // Restore constructor property of targetFn
93 constructor: {
94 value: targetConstructor,
95 enumerable: false,
96 writable: true,
97 configurable: true
98 }
99 } );
100
101 // Extend static properties - always initialize both sides
102 oo.initClass( originFn );
103 targetFn.static = Object.create( originFn.static );
104 };
105
106 /**
107 * Copy over *own* prototype properties of a mixin.
108 *
109 * The 'constructor' (whether implicit or explicit) is not copied over.
110 *
111 * This does not create inheritance to the origin. If inheritance is needed
112 * use oo.inheritClass instead.
113 *
114 * Beware: This can redefine a prototype property, call before setting your prototypes.
115 *
116 * Beware: Don't call before oo.inheritClass.
117 *
118 * function Foo() {}
119 * function Context() {}
120 *
121 * // Avoid repeating this code
122 * function ContextLazyLoad() {}
123 * ContextLazyLoad.prototype.getContext = function () {
124 * if ( !this.context ) {
125 * this.context = new Context();
126 * }
127 * return this.context;
128 * };
129 *
130 * function FooBar() {}
131 * OO.inheritClass( FooBar, Foo );
132 * OO.mixinClass( FooBar, ContextLazyLoad );
133 *
134 * @param {Function} targetFn
135 * @param {Function} originFn
136 */
137 oo.mixinClass = function ( targetFn, originFn ) {
138 var key;
139
140 // Copy prototype properties
141 for ( key in originFn.prototype ) {
142 if ( key !== 'constructor' && hasOwn.call( originFn.prototype, key ) ) {
143 targetFn.prototype[key] = originFn.prototype[key];
144 }
145 }
146
147 // Copy static properties - always initialize both sides
148 oo.initClass( targetFn );
149 if ( originFn.static ) {
150 for ( key in originFn.static ) {
151 if ( hasOwn.call( originFn.static, key ) ) {
152 targetFn.static[key] = originFn.static[key];
153 }
154 }
155 } else {
156 oo.initClass( originFn );
157 }
158 };
159
160 /* Object Methods */
161
162 /**
163 * Get a deeply nested property of an object using variadic arguments, protecting against
164 * undefined property errors.
165 *
166 * `quux = oo.getProp( obj, 'foo', 'bar', 'baz' );` is equivalent to `quux = obj.foo.bar.baz;`
167 * except that the former protects against JS errors if one of the intermediate properties
168 * is undefined. Instead of throwing an error, this function will return undefined in
169 * that case.
170 *
171 * @param {Object} obj
172 * @param {Mixed...} [keys]
173 * @return obj[arguments[1]][arguments[2]].... or undefined
174 */
175 oo.getProp = function ( obj ) {
176 var i,
177 retval = obj;
178 for ( i = 1; i < arguments.length; i++ ) {
179 if ( retval === undefined || retval === null ) {
180 // Trying to access a property of undefined or null causes an error
181 return undefined;
182 }
183 retval = retval[arguments[i]];
184 }
185 return retval;
186 };
187
188 /**
189 * Set a deeply nested property of an object using variadic arguments, protecting against
190 * undefined property errors.
191 *
192 * `oo.setProp( obj, 'foo', 'bar', 'baz' );` is equivalent to `obj.foo.bar = baz;` except that
193 * the former protects against JS errors if one of the intermediate properties is
194 * undefined. Instead of throwing an error, undefined intermediate properties will be
195 * initialized to an empty object. If an intermediate property is not an object, or if obj itself
196 * is not an object, this function will silently abort.
197 *
198 * @param {Object} obj
199 * @param {Mixed...} [keys]
200 * @param {Mixed} [value]
201 */
202 oo.setProp = function ( obj ) {
203 var i,
204 prop = obj;
205 if ( Object( obj ) !== obj ) {
206 return;
207 }
208 for ( i = 1; i < arguments.length - 2; i++ ) {
209 if ( prop[arguments[i]] === undefined ) {
210 prop[arguments[i]] = {};
211 }
212 if ( Object( prop[arguments[i]] ) !== prop[arguments[i]] ) {
213 return;
214 }
215 prop = prop[arguments[i]];
216 }
217 prop[arguments[arguments.length - 2]] = arguments[arguments.length - 1];
218 };
219
220 /**
221 * Create a new object that is an instance of the same
222 * constructor as the input, inherits from the same object
223 * and contains the same own properties.
224 *
225 * This makes a shallow non-recursive copy of own properties.
226 * To create a recursive copy of plain objects, use #copy.
227 *
228 * var foo = new Person( mom, dad );
229 * foo.setAge( 21 );
230 * var foo2 = OO.cloneObject( foo );
231 * foo.setAge( 22 );
232 *
233 * // Then
234 * foo2 !== foo; // true
235 * foo2 instanceof Person; // true
236 * foo2.getAge(); // 21
237 * foo.getAge(); // 22
238 *
239 * @param {Object} origin
240 * @return {Object} Clone of origin
241 */
242 oo.cloneObject = function ( origin ) {
243 var key, r;
244
245 r = Object.create( origin.constructor.prototype );
246
247 for ( key in origin ) {
248 if ( hasOwn.call( origin, key ) ) {
249 r[key] = origin[key];
250 }
251 }
252
253 return r;
254 };
255
256 /**
257 * Get an array of all property values in an object.
258 *
259 * @param {Object} Object to get values from
260 * @return {Array} List of object values
261 */
262 oo.getObjectValues = function ( obj ) {
263 var key, values;
264
265 if ( obj !== Object( obj ) ) {
266 throw new TypeError( 'Called on non-object' );
267 }
268
269 values = [];
270 for ( key in obj ) {
271 if ( hasOwn.call( obj, key ) ) {
272 values[values.length] = obj[key];
273 }
274 }
275
276 return values;
277 };
278
279 /**
280 * Recursively compare properties between two objects.
281 *
282 * A false result may be caused by property inequality or by properties in one object missing from
283 * the other. An asymmetrical test may also be performed, which checks only that properties in the
284 * first object are present in the second object, but not the inverse.
285 *
286 * If either a or b is null or undefined it will be treated as an empty object.
287 *
288 * @param {Object|undefined|null} a First object to compare
289 * @param {Object|undefined|null} b Second object to compare
290 * @param {boolean} [asymmetrical] Whether to check only that a's values are equal to b's
291 * (i.e. a is a subset of b)
292 * @return {boolean} If the objects contain the same values as each other
293 */
294 oo.compare = function ( a, b, asymmetrical ) {
295 var aValue, bValue, aType, bType, k;
296
297 if ( a === b ) {
298 return true;
299 }
300
301 a = a || {};
302 b = b || {};
303
304 if ( typeof a.nodeType === 'number' && typeof a.isEqualNode === 'function' ) {
305 return a.isEqualNode( b );
306 }
307
308 for ( k in a ) {
309 if ( !hasOwn.call( a, k ) || a[k] === undefined || a[k] === b[k] ) {
310 // Support es3-shim: Without the hasOwn filter, comparing [] to {} will be false in ES3
311 // because the shimmed "forEach" is enumerable and shows up in Array but not Object.
312 // Also ignore undefined values, because there is no conceptual difference between
313 // a key that is absent and a key that is present but whose value is undefined.
314 continue;
315 }
316
317 aValue = a[k];
318 bValue = b[k];
319 aType = typeof aValue;
320 bType = typeof bValue;
321 if ( aType !== bType ||
322 (
323 ( aType === 'string' || aType === 'number' || aType === 'boolean' ) &&
324 aValue !== bValue
325 ) ||
326 ( aValue === Object( aValue ) && !oo.compare( aValue, bValue, true ) ) ) {
327 return false;
328 }
329 }
330 // If the check is not asymmetrical, recursing with the arguments swapped will verify our result
331 return asymmetrical ? true : oo.compare( b, a, true );
332 };
333
334 /**
335 * Create a plain deep copy of any kind of object.
336 *
337 * Copies are deep, and will either be an object or an array depending on `source`.
338 *
339 * @param {Object} source Object to copy
340 * @param {Function} [leafCallback] Applied to leaf values after they are cloned but before they are added to the clone
341 * @param {Function} [nodeCallback] Applied to all values before they are cloned. If the nodeCallback returns a value other than undefined, the returned value is used instead of attempting to clone.
342 * @return {Object} Copy of source object
343 */
344 oo.copy = function ( source, leafCallback, nodeCallback ) {
345 var key, destination;
346
347 if ( nodeCallback ) {
348 // Extensibility: check before attempting to clone source.
349 destination = nodeCallback( source );
350 if ( destination !== undefined ) {
351 return destination;
352 }
353 }
354
355 if ( Array.isArray( source ) ) {
356 // Array (fall through)
357 destination = new Array( source.length );
358 } else if ( source && typeof source.clone === 'function' ) {
359 // Duck type object with custom clone method
360 return leafCallback ? leafCallback( source.clone() ) : source.clone();
361 } else if ( source && typeof source.cloneNode === 'function' ) {
362 // DOM Node
363 return leafCallback ?
364 leafCallback( source.cloneNode( true ) ) :
365 source.cloneNode( true );
366 } else if ( oo.isPlainObject( source ) ) {
367 // Plain objects (fall through)
368 destination = {};
369 } else {
370 // Non-plain objects (incl. functions) and primitive values
371 return leafCallback ? leafCallback( source ) : source;
372 }
373
374 // source is an array or a plain object
375 for ( key in source ) {
376 destination[key] = oo.copy( source[key], leafCallback, nodeCallback );
377 }
378
379 // This is an internal node, so we don't apply the leafCallback.
380 return destination;
381 };
382
383 /**
384 * Generate a hash of an object based on its name and data.
385 *
386 * Performance optimization: <http://jsperf.com/ve-gethash-201208#/toJson_fnReplacerIfAoForElse>
387 *
388 * To avoid two objects with the same values generating different hashes, we utilize the replacer
389 * argument of JSON.stringify and sort the object by key as it's being serialized. This may or may
390 * not be the fastest way to do this; we should investigate this further.
391 *
392 * Objects and arrays are hashed recursively. When hashing an object that has a .getHash()
393 * function, we call that function and use its return value rather than hashing the object
394 * ourselves. This allows classes to define custom hashing.
395 *
396 * @param {Object} val Object to generate hash for
397 * @return {string} Hash of object
398 */
399 oo.getHash = function ( val ) {
400 return JSON.stringify( val, oo.getHash.keySortReplacer );
401 };
402
403 /**
404 * Sort objects by key (helper function for OO.getHash).
405 *
406 * This is a callback passed into JSON.stringify.
407 *
408 * @method getHash_keySortReplacer
409 * @param {string} key Property name of value being replaced
410 * @param {Mixed} val Property value to replace
411 * @return {Mixed} Replacement value
412 */
413 oo.getHash.keySortReplacer = function ( key, val ) {
414 var normalized, keys, i, len;
415 if ( val && typeof val.getHashObject === 'function' ) {
416 // This object has its own custom hash function, use it
417 val = val.getHashObject();
418 }
419 if ( !Array.isArray( val ) && Object( val ) === val ) {
420 // Only normalize objects when the key-order is ambiguous
421 // (e.g. any object not an array).
422 normalized = {};
423 keys = Object.keys( val ).sort();
424 i = 0;
425 len = keys.length;
426 for ( ; i < len; i += 1 ) {
427 normalized[keys[i]] = val[keys[i]];
428 }
429 return normalized;
430
431 // Primitive values and arrays get stable hashes
432 // by default. Lets those be stringified as-is.
433 } else {
434 return val;
435 }
436 };
437
438 /**
439 * Compute the union (duplicate-free merge) of a set of arrays.
440 *
441 * Arrays values must be convertable to object keys (strings).
442 *
443 * By building an object (with the values for keys) in parallel with
444 * the array, a new item's existence in the union can be computed faster.
445 *
446 * @param {Array...} arrays Arrays to union
447 * @return {Array} Union of the arrays
448 */
449 oo.simpleArrayUnion = function () {
450 var i, ilen, arr, j, jlen,
451 obj = {},
452 result = [];
453
454 for ( i = 0, ilen = arguments.length; i < ilen; i++ ) {
455 arr = arguments[i];
456 for ( j = 0, jlen = arr.length; j < jlen; j++ ) {
457 if ( !obj[ arr[j] ] ) {
458 obj[ arr[j] ] = true;
459 result.push( arr[j] );
460 }
461 }
462 }
463
464 return result;
465 };
466
467 /**
468 * Combine arrays (intersection or difference).
469 *
470 * An intersection checks the item exists in 'b' while difference checks it doesn't.
471 *
472 * Arrays values must be convertable to object keys (strings).
473 *
474 * By building an object (with the values for keys) of 'b' we can
475 * compute the result faster.
476 *
477 * @private
478 * @param {Array} a First array
479 * @param {Array} b Second array
480 * @param {boolean} includeB Whether to items in 'b'
481 * @return {Array} Combination (intersection or difference) of arrays
482 */
483 function simpleArrayCombine( a, b, includeB ) {
484 var i, ilen, isInB,
485 bObj = {},
486 result = [];
487
488 for ( i = 0, ilen = b.length; i < ilen; i++ ) {
489 bObj[ b[i] ] = true;
490 }
491
492 for ( i = 0, ilen = a.length; i < ilen; i++ ) {
493 isInB = !!bObj[ a[i] ];
494 if ( isInB === includeB ) {
495 result.push( a[i] );
496 }
497 }
498
499 return result;
500 }
501
502 /**
503 * Compute the intersection of two arrays (items in both arrays).
504 *
505 * Arrays values must be convertable to object keys (strings).
506 *
507 * @param {Array} a First array
508 * @param {Array} b Second array
509 * @return {Array} Intersection of arrays
510 */
511 oo.simpleArrayIntersection = function ( a, b ) {
512 return simpleArrayCombine( a, b, true );
513 };
514
515 /**
516 * Compute the difference of two arrays (items in 'a' but not 'b').
517 *
518 * Arrays values must be convertable to object keys (strings).
519 *
520 * @param {Array} a First array
521 * @param {Array} b Second array
522 * @return {Array} Intersection of arrays
523 */
524 oo.simpleArrayDifference = function ( a, b ) {
525 return simpleArrayCombine( a, b, false );
526 };
527
528 /*global $ */
529
530 oo.isPlainObject = $.isPlainObject;
531
532 /*global hasOwn */
533
534 ( function () {
535
536 /**
537 * @class OO.EventEmitter
538 *
539 * @constructor
540 */
541 oo.EventEmitter = function OoEventEmitter() {
542 // Properties
543
544 /**
545 * Storage of bound event handlers by event name.
546 *
547 * @property
548 */
549 this.bindings = {};
550 };
551
552 oo.initClass( oo.EventEmitter );
553
554 /* Private helper functions */
555
556 /**
557 * Validate a function or method call in a context
558 *
559 * For a method name, check that it names a function in the context object
560 *
561 * @private
562 * @param {Function|string} method Function or method name
563 * @param {Mixed} context The context of the call
564 * @throws {Error} A method name is given but there is no context
565 * @throws {Error} In the context object, no property exists with the given name
566 * @throws {Error} In the context object, the named property is not a function
567 */
568 function validateMethod( method, context ) {
569 // Validate method and context
570 if ( typeof method === 'string' ) {
571 // Validate method
572 if ( context === undefined || context === null ) {
573 throw new Error( 'Method name "' + method + '" has no context.' );
574 }
575 if ( typeof context[method] !== 'function' ) {
576 // Technically the property could be replaced by a function before
577 // call time. But this probably signals a typo.
578 throw new Error( 'Property "' + method + '" is not a function' );
579 }
580 } else if ( typeof method !== 'function' ) {
581 throw new Error( 'Invalid callback. Function or method name expected.' );
582 }
583 }
584
585 /* Methods */
586
587 /**
588 * Add a listener to events of a specific event.
589 *
590 * The listener can be a function or the string name of a method; if the latter, then the
591 * name lookup happens at the time the listener is called.
592 *
593 * @param {string} event Type of event to listen to
594 * @param {Function|string} method Function or method name to call when event occurs
595 * @param {Array} [args] Arguments to pass to listener, will be prepended to emitted arguments
596 * @param {Object} [context=null] Context object for function or method call
597 * @throws {Error} Listener argument is not a function or a valid method name
598 * @chainable
599 */
600 oo.EventEmitter.prototype.on = function ( event, method, args, context ) {
601 var bindings;
602
603 validateMethod( method, context );
604
605 if ( hasOwn.call( this.bindings, event ) ) {
606 bindings = this.bindings[event];
607 } else {
608 // Auto-initialize bindings list
609 bindings = this.bindings[event] = [];
610 }
611 // Add binding
612 bindings.push( {
613 method: method,
614 args: args,
615 context: ( arguments.length < 4 ) ? null : context
616 } );
617 return this;
618 };
619
620 /**
621 * Add a one-time listener to a specific event.
622 *
623 * @param {string} event Type of event to listen to
624 * @param {Function} listener Listener to call when event occurs
625 * @chainable
626 */
627 oo.EventEmitter.prototype.once = function ( event, listener ) {
628 var eventEmitter = this,
629 wrapper = function () {
630 eventEmitter.off( event, wrapper );
631 return listener.apply( this, arguments );
632 };
633 return this.on( event, wrapper );
634 };
635
636 /**
637 * Remove a specific listener from a specific event.
638 *
639 * @param {string} event Type of event to remove listener from
640 * @param {Function|string} [method] Listener to remove. Must be in the same form as was passed
641 * to "on". Omit to remove all listeners.
642 * @param {Object} [context=null] Context object function or method call
643 * @chainable
644 * @throws {Error} Listener argument is not a function or a valid method name
645 */
646 oo.EventEmitter.prototype.off = function ( event, method, context ) {
647 var i, bindings;
648
649 if ( arguments.length === 1 ) {
650 // Remove all bindings for event
651 delete this.bindings[event];
652 return this;
653 }
654
655 validateMethod( method, context );
656
657 if ( !hasOwn.call( this.bindings, event ) || !this.bindings[event].length ) {
658 // No matching bindings
659 return this;
660 }
661
662 // Default to null context
663 if ( arguments.length < 3 ) {
664 context = null;
665 }
666
667 // Remove matching handlers
668 bindings = this.bindings[event];
669 i = bindings.length;
670 while ( i-- ) {
671 if ( bindings[i].method === method && bindings[i].context === context ) {
672 bindings.splice( i, 1 );
673 }
674 }
675
676 // Cleanup if now empty
677 if ( bindings.length === 0 ) {
678 delete this.bindings[event];
679 }
680 return this;
681 };
682
683 /**
684 * Emit an event.
685 *
686 * TODO: Should this be chainable? What is the usefulness of the boolean
687 * return value here?
688 *
689 * @param {string} event Type of event
690 * @param {Mixed} args First in a list of variadic arguments passed to event handler (optional)
691 * @return {boolean} If event was handled by at least one listener
692 */
693 oo.EventEmitter.prototype.emit = function ( event ) {
694 var args = [],
695 i, len, binding, bindings, method;
696
697 if ( hasOwn.call( this.bindings, event ) ) {
698 // Slicing ensures that we don't get tripped up by event handlers that add/remove bindings
699 bindings = this.bindings[event].slice();
700 for ( i = 1, len = arguments.length; i < len; i++ ) {
701 args.push( arguments[i] );
702 }
703 for ( i = 0, len = bindings.length; i < len; i++ ) {
704 binding = bindings[i];
705 if ( typeof binding.method === 'string' ) {
706 // Lookup method by name (late binding)
707 method = binding.context[ binding.method ];
708 } else {
709 method = binding.method;
710 }
711 method.apply(
712 binding.context,
713 binding.args ? binding.args.concat( args ) : args
714 );
715 }
716 return true;
717 }
718 return false;
719 };
720
721 /**
722 * Connect event handlers to an object.
723 *
724 * @param {Object} context Object to call methods on when events occur
725 * @param {Object.<string,string>|Object.<string,Function>|Object.<string,Array>} methods List of
726 * event bindings keyed by event name containing either method names, functions or arrays containing
727 * method name or function followed by a list of arguments to be passed to callback before emitted
728 * arguments
729 * @chainable
730 */
731 oo.EventEmitter.prototype.connect = function ( context, methods ) {
732 var method, args, event;
733
734 for ( event in methods ) {
735 method = methods[event];
736 // Allow providing additional args
737 if ( Array.isArray( method ) ) {
738 args = method.slice( 1 );
739 method = method[0];
740 } else {
741 args = [];
742 }
743 // Add binding
744 this.on( event, method, args, context );
745 }
746 return this;
747 };
748
749 /**
750 * Disconnect event handlers from an object.
751 *
752 * @param {Object} context Object to disconnect methods from
753 * @param {Object.<string,string>|Object.<string,Function>|Object.<string,Array>} [methods] List of
754 * event bindings keyed by event name. Values can be either method names or functions, but must be
755 * consistent with those used in the corresponding call to "connect".
756 * @chainable
757 */
758 oo.EventEmitter.prototype.disconnect = function ( context, methods ) {
759 var i, event, bindings;
760
761 if ( methods ) {
762 // Remove specific connections to the context
763 for ( event in methods ) {
764 this.off( event, methods[event], context );
765 }
766 } else {
767 // Remove all connections to the context
768 for ( event in this.bindings ) {
769 bindings = this.bindings[event];
770 i = bindings.length;
771 while ( i-- ) {
772 // bindings[i] may have been removed by the previous step's
773 // this.off so check it still exists
774 if ( bindings[i] && bindings[i].context === context ) {
775 this.off( event, bindings[i].method, context );
776 }
777 }
778 }
779 }
780
781 return this;
782 };
783
784 }() );
785
786 /*global hasOwn */
787
788 /**
789 * @class OO.Registry
790 * @mixins OO.EventEmitter
791 *
792 * @constructor
793 */
794 oo.Registry = function OoRegistry() {
795 // Mixin constructors
796 oo.EventEmitter.call( this );
797
798 // Properties
799 this.registry = {};
800 };
801
802 /* Inheritance */
803
804 oo.mixinClass( oo.Registry, oo.EventEmitter );
805
806 /* Events */
807
808 /**
809 * @event register
810 * @param {string} name
811 * @param {Mixed} data
812 */
813
814 /* Methods */
815
816 /**
817 * Associate one or more symbolic names with some data.
818 *
819 * Only the base name will be registered, overriding any existing entry with the same base name.
820 *
821 * @param {string|string[]} name Symbolic name or list of symbolic names
822 * @param {Mixed} data Data to associate with symbolic name
823 * @fires register
824 * @throws {Error} Name argument must be a string or array
825 */
826 oo.Registry.prototype.register = function ( name, data ) {
827 var i, len;
828 if ( typeof name === 'string' ) {
829 this.registry[name] = data;
830 this.emit( 'register', name, data );
831 } else if ( Array.isArray( name ) ) {
832 for ( i = 0, len = name.length; i < len; i++ ) {
833 this.register( name[i], data );
834 }
835 } else {
836 throw new Error( 'Name must be a string or array, cannot be a ' + typeof name );
837 }
838 };
839
840 /**
841 * Get data for a given symbolic name.
842 *
843 * Lookups are done using the base name.
844 *
845 * @param {string} name Symbolic name
846 * @return {Mixed|undefined} Data associated with symbolic name
847 */
848 oo.Registry.prototype.lookup = function ( name ) {
849 if ( hasOwn.call( this.registry, name ) ) {
850 return this.registry[name];
851 }
852 };
853
854 /**
855 * @class OO.Factory
856 * @extends OO.Registry
857 *
858 * @constructor
859 */
860 oo.Factory = function OoFactory() {
861 oo.Factory.parent.call( this );
862
863 // Properties
864 this.entries = [];
865 };
866
867 /* Inheritance */
868
869 oo.inheritClass( oo.Factory, oo.Registry );
870
871 /* Methods */
872
873 /**
874 * Register a constructor with the factory.
875 *
876 * Classes must have a static `name` property to be registered.
877 *
878 * function MyClass() {};
879 * OO.initClass( MyClass );
880 * // Adds a static property to the class defining a symbolic name
881 * MyClass.static.name = 'mine';
882 * // Registers class with factory, available via symbolic name 'mine'
883 * factory.register( MyClass );
884 *
885 * @param {Function} constructor Constructor to use when creating object
886 * @throws {Error} Name must be a string and must not be empty
887 * @throws {Error} Constructor must be a function
888 */
889 oo.Factory.prototype.register = function ( constructor ) {
890 var name;
891
892 if ( typeof constructor !== 'function' ) {
893 throw new Error( 'constructor must be a function, cannot be a ' + typeof constructor );
894 }
895 name = constructor.static && constructor.static.name;
896 if ( typeof name !== 'string' || name === '' ) {
897 throw new Error( 'Name must be a string and must not be empty' );
898 }
899 this.entries.push( name );
900
901 oo.Factory.parent.prototype.register.call( this, name, constructor );
902 };
903
904 /**
905 * Create an object based on a name.
906 *
907 * Name is used to look up the constructor to use, while all additional arguments are passed to the
908 * constructor directly, so leaving one out will pass an undefined to the constructor.
909 *
910 * @param {string} name Object name
911 * @param {Mixed...} [args] Arguments to pass to the constructor
912 * @return {Object} The new object
913 * @throws {Error} Unknown object name
914 */
915 oo.Factory.prototype.create = function ( name ) {
916 var obj, i,
917 args = [],
918 constructor = this.lookup( name );
919
920 if ( !constructor ) {
921 throw new Error( 'No class registered by that name: ' + name );
922 }
923
924 // Convert arguments to array and shift the first argument (name) off
925 for ( i = 1; i < arguments.length; i++ ) {
926 args.push( arguments[i] );
927 }
928
929 // We can't use the "new" operator with .apply directly because apply needs a
930 // context. So instead just do what "new" does: create an object that inherits from
931 // the constructor's prototype (which also makes it an "instanceof" the constructor),
932 // then invoke the constructor with the object as context, and return it (ignoring
933 // the constructor's return value).
934 obj = Object.create( constructor.prototype );
935 constructor.apply( obj, args );
936 return obj;
937 };
938
939 /*jshint node:true */
940 if ( typeof module !== 'undefined' && module.exports ) {
941 module.exports = oo;
942 } else {
943 global.OO = oo;
944 }
945
946 }( this ) );