Merge pull request #12 from wmde/sitelink

Updated SiteLink support

Author: tobijat

README.md

@@ -6,9 +6,13 @@ at the heart of the [Wikibase software](http://wikiba.se/).
 
 ## Release notes
 
-### 0.3.1 (dev)
+### 0.3.2 (2014-08-19)
 
 * Added wikibase.datamodel.SiteLink.
+* Added wikibase.datamodel.Item.getSiteLinks().
+
+### 0.3.1 (2014-08-14)
+
 * Remove ResourceLoader dependencies on jquery and mediawiki (bug 69468)
 
 ### 0.3.0 (2014-07-10)

init.mw.php

@@ -3,7 +3,7 @@
 $GLOBALS['wgExtensionCredits']['wikibase'][] = array(
 	'path' => __FILE__,
 	'name' => 'Wikibase DataModel JavaScript',
-	'version' => '0.3.1-alpha',
+	'version' => '0.3.2',
 	'author' => array(
 		'[https://www.mediawiki.org/wiki/User:Danwe Daniel Werner]',
 		'[http://www.snater.com H. Snater]',

src/Item.js

@@ -18,7 +18,13 @@
 	 * @param {Object} data
 	 */
 	var SELF = wb.datamodel.Item = util.inherit( 'WbItem', PARENT, {
-		// TODO: implement sitelinks related getter/setter
+		/**
+		 * @since 0.3
+		 * @return {wikibase.datamodel.SiteLink[]}
+		 */
+		getSiteLinks: function() {
+			return this._data.sitelinks || [];
+		}
 	} );
 
 	/**

src/SiteLink.js

@@ -68,6 +68,34 @@ $.extend( SELF.prototype, {
 	 */
 	getBadges: function() {
 		return this._badges;
+	},
+
+	/**
+	 * @param {*} siteLink
+	 * @return {boolean}
+	 */
+	equals: function( siteLink ) {
+		if( !( siteLink instanceof SELF ) ) {
+			return false;
+		}
+
+		var otherBadges = siteLink.getBadges();
+
+		if(
+			this._siteId !== siteLink.getSiteId()
+			|| this._pageName !== siteLink.getPageName()
+			|| this._badges.length !== otherBadges.length
+		) {
+			return false;
+		}
+
+		for( var i = 0; i < this._badges.length; i++ ) {
+			if( $.inArray( this._badges[i], otherBadges ) === -1 ) {
+				return false;
+			}
+		}
+
+		return true;
 	}
 
 } );

tests/SiteLink.tests.js

@@ -6,13 +6,10 @@
 ( function( wb, $, QUnit ) {
 'use strict';
 
-var siteId = 'test-id',
-	pageName = 'test-page';
-
 QUnit.module( 'wikibase.datamodel.SiteLink', QUnit.newMwEnvironment() );
 
 QUnit.test( 'Basic tests', function( assert ) {
-	var siteLink = new wb.datamodel.SiteLink( siteId, pageName );
+	var siteLink = new wb.datamodel.SiteLink( 'test-id', 'test-name' );
 
 	assert.equal(
 		siteLink.getSiteId(),
@@ -22,13 +19,13 @@ QUnit.test( 'Basic tests', function( assert ) {
 
 	assert.equal(
 		siteLink.getPageName(),
-		pageName,
+		'test-name',
 		'Verified page name.'
 	);
 } );
 
 QUnit.test( 'Badges', function( assert ) {
-	var siteLink = new wb.datamodel.SiteLink( siteId, pageName ),
+	var siteLink = new wb.datamodel.SiteLink( 'test-id', 'test-page' ),
 		badges = ['Q123', 'Q456'];
 
 	assert.equal(
@@ -53,7 +50,7 @@ QUnit.test( 'Badges', function( assert ) {
 		'Removed badges.'
 	);
 
-	siteLink = new wb.datamodel.SiteLink( siteId, pageName, badges );
+	siteLink = new wb.datamodel.SiteLink( 'test-id', 'test-page', badges );
 
 	assert.equal(
 		badges.join( ',' ),
@@ -62,4 +59,60 @@ QUnit.test( 'Badges', function( assert ) {
 	);
 } );
 
+QUnit.test( 'equals()', function( assert ) {
+	var testSet = [
+		['siteId', 'pageName', []],
+		['anotherSiteId', 'pageName', []],
+		['siteId', 'anotherPageName', []],
+		['anotherSiteId', 'anotherPageName', []],
+		['siteId', 'pageName', ['badgeId']],
+		['siteId', 'pageName', ['badgeId', 'anotherBadgeId']]
+	];
+
+	var invalid = [
+		'plain string',
+		1,
+		0,
+		false,
+		true,
+		['siteId', 'pageName', []]
+	];
+
+	for( var i = 0; i < testSet.length; i++ ) {
+		var siteLink1 = new wb.datamodel.SiteLink(
+			testSet[i][0],
+			testSet[i][1],
+			testSet[i][2]
+		);
+
+		for( var j = 0; j < invalid.length; j++ ) {
+			assert.ok(
+				!siteLink1.equals( invalid[j] ),
+				'Test set #' + i + ' is not equal to invalid set #' + j + '.'
+			);
+		}
+
+		for( j = 0; j < testSet.length; j++ ) {
+			var siteLink2 = new wb.datamodel.SiteLink(
+				testSet[j][0],
+				testSet[j][1],
+				testSet[j][2]
+			);
+
+			if( i === j ) {
+				assert.ok(
+					siteLink1.equals( siteLink2 ),
+					'Test set #' + i + ' equals.'
+				);
+			} else {
+				assert.ok(
+					!siteLink1.equals( siteLink2 ),
+					'Test set #' + j + ' is not equal to test set #' + i + '.'
+				);
+			}
+		}
+	}
+
+} );
+
 }( wikibase, jQuery, QUnit ) );