Implemented Map

Author: snaterlicious

README.md

@@ -39,6 +39,7 @@ https://commons.wikimedia.org/wiki/File:Wikibase_JavaScript_Data_Model_1.0.svg
 * Added Group.
 * Added GroupableCollection.
 * Added List.
+* Added Map.
 * Added MultiTerm.
 * Added MultiTermSet.
 * Added ReferenceList.

resources.php

@@ -186,6 +186,15 @@
 			),
 		),
 
+		'wikibase.datamodel.Map' => $moduleTemplate + array(
+			'scripts' => array(
+				'Map.js',
+			),
+			'dependencies' => array(
+				'wikibase.datamodel.__namespace',
+			),
+		),
+
 		'wikibase.datamodel.MultiTerm' => $moduleTemplate + array(
 			'scripts' => array(
 				'MultiTerm.js',

resources.test.php

@@ -133,6 +133,15 @@
 			),
 		),
 
+		'wikibase.datamodel.Map.tests' => $moduleTemplate + array(
+			'scripts' => array(
+				'Map.tests.js',
+			),
+			'dependencies' => array(
+				'wikibase.datamodel.Map',
+			),
+		),
+
 		'wikibase.datamodel.MultiTerm.tests' => $moduleTemplate + array(
 			'scripts' => array(
 				'MultiTerm.tests.js',

src/Map.js

@@ -0,0 +1,179 @@
+/**
+ * @licence GNU GPL v2+
+ * @author H. Snater < mediawiki@snater.com >
+ */
+( function( wb, $ ) {
+'use strict';
+
+/**
+ * @constructor
+ * @since 1.0
+ *
+ * @param {Function} ItemConstructor
+ * @param {Object} [map]
+ */
+var SELF = wb.datamodel.Map = function( ItemConstructor, map ) {
+	map = map || {};
+
+	if( !$.isFunction( ItemConstructor ) ) {
+		throw new Error( 'Item constructor needs to be a Function' );
+	} else if( !$.isFunction( ItemConstructor.prototype.equals ) ) {
+		throw new Error( 'Map item prototype needs equals() method' );
+	}
+
+	this._ItemConstructor = ItemConstructor;
+	this._map = {};
+
+	for( var key in map ) {
+		this.setItem( key, map[key] );
+	}
+};
+
+$.extend( SELF.prototype, {
+	/**
+	 * @type {Function}
+	 */
+	_ItemConstructor: null,
+
+	/**
+	 * @type {Object}
+	 */
+	_map: null,
+
+	/**
+	 * @type {number}
+	 */
+	length: 0,
+
+	/**
+	 * @see jQuery.fn.each
+	 */
+	each: function( fn ) {
+		$.each.call( null, this._map, fn );
+	},
+
+	/**
+	 * @param {string} key
+	 * @param {Object} item
+	 * @return {boolean}
+	 */
+	hasItem: function( key, item ) {
+		this._assertIsItem( item );
+		return this._map[key] && this._map[key].equals( item );
+	},
+
+	/**
+	 * @param {string} key
+	 * @param {Object} item
+	 */
+	addItem: function( key, item ) {
+		this._assertIsItem( item );
+
+		if( this.hasItemForKey( key ) ) {
+			throw new Error( 'Item for key ' + key + ' exists already' );
+		}
+
+		this.setItem( key, item );
+	},
+
+	/**
+	 * @param {string} key
+	 * @param {Object} item
+	 */
+	removeItem: function( key, item ) {
+		if( !this.hasItem( key, item ) ) {
+			throw new Error( 'Item for key ' + key + ' to be removed does not exist' );
+		}
+		this.removeItemByKey( key );
+	},
+
+	/**
+	 * @return {string[]}
+	 */
+	getKeys: function() {
+		var keys = [];
+
+		for( var key in this._map ) {
+			keys.push( key );
+		}
+
+		return keys;
+	},
+
+	/**
+	 * @param {string} key
+	 * @return {*|null}
+	 */
+	getItemByKey: function( key ) {
+		return this._map[key] || null;
+	},
+
+	/**
+	 * @param {string} key
+	 */
+	removeItemByKey: function( key ) {
+		if( this._map[key] ) {
+			this.length--;
+		}
+		delete this._map[key];
+	},
+
+	/**
+	 * @param {string} key
+	 * @return {boolean}
+	 */
+	hasItemForKey: function( key ) {
+		return !!this._map[key];
+	},
+
+	/**
+	 * @param {string} key
+	 * @param {Object} item
+	 */
+	setItem: function( key, item ) {
+		this._assertIsItem( item );
+
+		if( !this.hasItemForKey( key ) ) {
+			this.length++;
+		}
+
+		this._map[key] = item;
+	},
+
+	/**
+	 * @return {boolean}
+	 */
+	isEmpty: function() {
+		return this.length === 0;
+	},
+
+	/**
+	 * @param {wikibase.datamodel.Map} map
+	 * @return {boolean}
+	 */
+	equals: function( map ) {
+		if( !( map instanceof SELF ) || map.length !== this.length ) {
+			return false;
+		}
+
+		for( var key in this._map ) {
+			if( !map.hasItem( key, this._map[key] ) ) {
+				return false;
+			}
+		}
+
+		return true;
+	},
+
+	/**
+	 * @param {*} item
+	 * @return {boolean}
+	 */
+	_assertIsItem: function( item ) {
+		if( !( item instanceof this._ItemConstructor ) ) {
+			throw new Error( 'Item is not an instance of the constructor set on the map' );
+		}
+	}
+} );
+
+}( wikibase, jQuery ) );