mw.Map: add ability to map over an existing object other than 'window'
authorOri Livneh <ori@wikimedia.org>
Mon, 28 Oct 2013 22:58:02 +0000 (15:58 -0700)
committerOri Livneh <ori@wikimedia.org>
Mon, 28 Oct 2013 23:22:50 +0000 (16:22 -0700)
I don't love the fact that mw.Map features so prominently in mediawiki.js, but
since it's there to stay it might as well be useful for a wider range of use
cases. This patch makes it possible to pass an existing value-bearing object to
be mapped over to the Map constructor.

The effect is the same as constructing the object and then overriding its
'values' attribute. But doing that feels like you're sneaking around the back
to hack the API. Making it part of the official API makes it OK to do.

Change-Id: Id9f8d9569de8889fc3ffa24a6e7f4afca1aeabee

resources/mediawiki/mediawiki.js
tests/qunit/suites/resources/mediawiki/mediawiki.test.js

index 03248ba..28fdcc4 100644 (file)
@@ -74,11 +74,11 @@ var mw = ( function ( $, undefined ) {
         * @class mw.Map
         *
         * @constructor
-        * @param {boolean} [global=false] Whether to store the values in the global window
-        *  object or a exclusively in the object property 'values'.
+        * @param {Object|boolean} [values] Value-bearing object to map, or boolean
+        *  true to map over the global object. Defaults to an empty object.
         */
-       function Map( global ) {
-               this.values = global === true ? window : {};
+       function Map( values ) {
+               this.values = values === true ? window : ( values || {} );
                return this;
        }
 
index 502b55b..3ce52e3 100644 (file)
@@ -43,7 +43,7 @@
                assert.strictEqual( window.mw, window.mediaWiki, 'mw alias to mediaWiki' );
        } );
 
-       QUnit.test( 'mw.Map', 27, function ( assert ) {
+       QUnit.test( 'mw.Map', 28, function ( assert ) {
                var arry, conf, funky, globalConf, nummy, someValues;
 
                conf = new mw.Map();
                        'lorem': 'ipsum'
                }, 'Map.get returns multiple values correctly as an object' );
 
+               assert.deepEqual( conf, new mw.Map( conf.values ), 'new mw.Map maps over existing values-bearing object' );
+
                assert.deepEqual( conf.get( ['foo', 'notExist'] ), {
                        'foo': 'bar',
                        'notExist': null