Remove unused getSortKey from DataValue interface

I'm trying to minimize the unused code in this repository for years.
Today I finally found a string I can pull without the whole thing
breaking apart: Just do a fultext search for "getSortKey" and you will
see it is not used anywhere.

This will allow us to remove much, much more unused code. I'm focusing
on two very small methods here and plan to continue removing more
unused code in later patches.

* The iso6709 method on the class is unused now. Note there is an other
  static helper function with the same name and a parameter. That is
  still used.
* _getTimestamp is private anyway. The parameter is unused now.

Author: thiemowmde

DataValuesJavaScript.php

@@ -7,7 +7,7 @@
 	return 1;
 }
 
-define( 'DATA_VALUES_JAVASCRIPT_VERSION', '0.8.4' );
+define( 'DATA_VALUES_JAVASCRIPT_VERSION', '0.9.0' );
 
 // Include the composer autoloader if it is present.
 if ( is_readable( __DIR__ . '/vendor/autoload.php' ) ) {

README.md

@@ -11,6 +11,10 @@ On [Packagist](https://packagist.org/packages/data-values/javascript):
 
 ## Release notes
 
+### 0.9.0 (dev)
+* Removed `dataValues.DataValue.getSortKey` from the interface and all implementations.
+* Removed `globeCoordinate.GlobeCoordinate.iso6709`.
+
 ### 0.8.4 (2017-07-18)
 * Updated JSDoc tags mistakenly requiring objects.
 * Removed an unused dependency on `composer/installers`.

lib/globeCoordinate/globeCoordinate.GlobeCoordinate.js

@@ -119,16 +119,6 @@
 			};
 		},
 
-		/**
-		 * Returns a coordinate's ISO 6709 string representation.
-		 * (see globeCoordinate.iso6709)
-		 *
-		 * @return {string}
-		 */
-		iso6709: function() {
-			return globeCoordinate.iso6709( this.getDecimal() );
-		},
-
 		/**
 		 * Compares the object to another GlobeCoordinate object and returns whether both represent
 		 * the same information.

lib/globeCoordinate/globeCoordinate.js

@@ -163,4 +163,4 @@ this.globeCoordinate = ( function() {
 
 	};
 
-} )();
+} )();

src/DataValue.js

@@ -38,17 +38,6 @@ $.extend( SELF.prototype, {
 	 */
 	getValue: util.abstractMember,
 
-	/**
-	 * Returns a key that can be used for sorting the data value.
-	 * Can be either numeric or a string.
-	 * NOTE: this could very well be set by the API, together with the value. Since the value is
-	 *       immutable, this won't change as well and there is no need for having the logic here.
-	 * @abstract
-	 *
-	 * @return {string|number}
-	 */
-	getSortKey: util.abstractMember,
-
 	/**
 	 * Returns a simple JSON structure representing this data value.
 	 * @abstract

src/values/BoolValue.js

@@ -29,15 +29,6 @@ var SELF = dv.BoolValue = util.inherit( 'DvBoolValue', PARENT, function( value )
 	 */
 	_value: null,
 
-	/**
-	 * @inheritdoc
-	 *
-	 * @return {number}
-	 */
-	getSortKey: function() {
-		return this._value ? 1 : 0;
-	},
-
 	/**
 	 * @inheritdoc
 	 *

src/values/DecimalValue.js

@@ -119,15 +119,6 @@ var SELF = dv.DecimalValue = util.inherit( 'DvDecimalValue', PARENT, function( v
 	 */
 	_value: null,
 
-	/**
-	 * @inheritdoc
-	 *
-	 * @return {string}
-	 */
-	getSortKey: function() {
-		return this._value;
-	},
-
 	/**
 	 * @inheritdoc
 	 *

src/values/GlobeCoordinateValue.js

@@ -34,15 +34,6 @@ var SELF
 	 */
 	_value: null,
 
-	/**
-	 * @inheritdoc
-	 *
-	 * @return {string}
-	 */
-	getSortKey: function() {
-		return this.getValue().iso6709();
-	},
-
 	/**
 	 * @inheritdoc
 	 *

src/values/MonolingualTextValue.js

@@ -38,15 +38,6 @@ var SELF
 	 */
 	_text: null,
 
-	/**
-	 * @inheritdoc
-	 *
-	 * @return string
-	 */
-	getSortKey: function() {
-		return this._languageCode + this._text;
-	},
-
 	/**
 	 * @inheritdoc
 	 *

src/values/MultilingualTextValue.js

@@ -30,15 +30,6 @@ var SELF
 	 */
 	_texts: null,
 
-	/**
-	 * @inheritdoc
-	 *
-	 * @return {string}
-	 */
-	getSortKey: function() {
-		return this._texts.length < 1 ? '' : this._texts[0].getSortKey();
-	},
-
 	/**
 	 * @inheritdoc
 	 *

src/values/NumberValue.js

@@ -25,15 +25,6 @@ var SELF = dv.NumberValue = util.inherit( 'DvNumberValue', PARENT, function( val
 	 */
 	_value: null,
 
-	/**
-	 * @inheritdoc
-	 *
-	 * @return {number}
-	 */
-	getSortKey: function() {
-		return this._value;
-	},
-
 	/**
 	 * @inheritdoc
 	 *

src/values/QuantityValue.js

@@ -71,15 +71,6 @@ var SELF
 	 */
 	_upperBound: null,
 
-	/**
-	 * @inheritdoc
-	 *
-	 * @return {string}
-	 */
-	getSortKey: function() {
-		return this._amount.getValue();
-	},
-
 	/**
 	 * @inheritdoc
 	 *

src/values/StringValue.js

@@ -30,15 +30,6 @@ var SELF = dv.StringValue = util.inherit( 'DvStringValue', PARENT, function( val
 	 */
 	_value: null,
 
-	/**
-	 * @inheritdoc
-	 *
-	 * @return {string}
-	 */
-	getSortKey: function() {
-		return this._value;
-	},
-
 	/**
 	 * @inheritdoc
 	 *

src/values/TimeValue.js

@@ -124,15 +124,6 @@ var SELF = dv.TimeValue = util.inherit( 'DvTimeValue', PARENT, function( timesta
 		return this._options[key];
 	},
 
-	/**
-	 * @inheritdoc
-	 *
-	 * @return {string}
-	 */
-	getSortKey: function() {
-		return this._getTimestamp( true );
-	},
-
 	/**
 	 * @inheritdoc
 	 *
@@ -220,14 +211,11 @@ var SELF = dv.TimeValue = util.inherit( 'DvTimeValue', PARENT, function( timesta
 	/**
 	 * @private
 	 *
-	 * @param {boolean} [padYear=false] True if the year should be padded to the maximum length of
-	 *  16 digits, false for the default padding to 4 digits.
-	 *
 	 * @return {string} A YMD-ordered timestamp string resembling ISO 8601.
 	 */
-	_getTimestamp: function( padYear ) {
+	_getTimestamp: function() {
 		return ( this._time.year.charAt( 0 ) === '-' ? '-' : '+' )
-			+ pad( this._time.year, padYear ? 16 : 4 ) + '-'
+			+ pad( this._time.year, 4 ) + '-'
 			+ pad( this._time.month, 2 ) + '-'
 			+ pad( this._time.day, 2 ) + 'T'
 			+ pad( this._time.hour, 2 ) + ':'

src/values/UnDeserializableValue.js

@@ -57,15 +57,6 @@ var SELF = dv.UnDeserializableValue = util.inherit(
 	 */
 	_deserializeError: null,
 
-	/**
-	 * @inheritdoc
-	 *
-	 * @return {string}
-	 */
-	getSortKey: function() {
-		return this.getReason();
-	},
-
 	/**
 	 * @inheritdoc
 	 *

src/values/UnknownValue.js

@@ -24,15 +24,6 @@ var SELF = dv.UnknownValue = util.inherit( 'DvUnknownValue', PARENT, function( v
 	 */
 	_value: null,
 
-	/**
-	 * @inheritdoc
-	 *
-	 * @return {number}
-	 */
-	getSortKey: function() {
-		return 0;
-	},
-
 	/**
 	 * @inheritdoc
 	 *

tests/lib/globeCoordinate/globeCoordinate.Formatter.tests.js

@@ -18,7 +18,7 @@ define( [
 				'1, 1': new GlobeCoordinate( { latitude: 1, longitude: 1, precision: 1 } ),
 				'-10, -1.5': new GlobeCoordinate( { latitude: -10, longitude: -1.5, precision: 0.1 } ),
 				'20, 0': new GlobeCoordinate( { latitude: 24, longitude: -1.5, precision: 10 } ),
-				'15, 20' : new GlobeCoordinate( { latitude: 15, longitude: 20 } )
+				'15, 20': new GlobeCoordinate( { latitude: 15, longitude: 20 } )
 			},
 			degreeTexts= {
 				'1°N, 1°E': new GlobeCoordinate( { latitude: 1, longitude: 1, precision: 1 } ),

tests/lib/globeCoordinate/globeCoordinate.GlobeCoordinate.tests.js

@@ -70,12 +70,6 @@ define( [
 			{ latitude: 1.5, longitude: 1.5, precision: 0.1 },
 			'Verified getDecimal()'
 		);
-
-		assert.equal(
-			typeof c.iso6709(),
-			'string',
-			'Verified iso6709()'
-		);
 	} );
 
 	QUnit.test( 'Precision defaults to null', function( assert ) {
@@ -119,36 +113,6 @@ define( [
 		);
 	} );
 
-	QUnit.test( 'ISO 6709 strings', function( assert ) {
-		assert.expect( 12 );
-		var gcDefs = [
-				{ precision: 10, expected: '+10+010/' },
-				{ precision: 2, expected: '+14+012/' },
-				{ precision: 1, expected: '+13+012/' },
-				{ precision: 0.1, expected: '+1307+01207/' },
-				{ precision: 0.01, expected: '+130724+0120724/' },
-				{ precision: 1 / 60, expected: '+1307+01207/' },
-				{ precision: 1 / 3600, expected: '+130724+0120724/' },
-				{ precision: 1 / 36000, expected: '+130724.4+0120724.4/' },
-				{ precision: 1 / 360000, expected: '+130724.42+0120724.42/' },
-				{ precision: 0, expected: '+130724.42+0120724.42/' },
-				{ precision: null, expected: '+130724.42+0120724.42/' },
-				{ expected: '+130724.42+0120724.42/' }
-			],
-			c;
-
-		$.each( gcDefs, function( i, gcDef ) {
-			c = new globeCoordinate.GlobeCoordinate(
-				{ latitude: 13.12345, longitude: 12.12345, precision: gcDef.precision }
-			);
-
-			assert.ok(
-				c.iso6709() === gcDef.expected,
-				'Validated ISO 6709 string of data set #' + i + '.'
-			);
-		} );
-	} );
-
 	QUnit.test( 'Strict (in)equality', function( assert ) {
 		assert.expect( 169 );
 		var gcDefs = [

tests/src/dataValues.DataValue.tests.js

@@ -131,28 +131,6 @@ define( [
 			}
 		},
 
-		/**
-		 * Tests the getSortKey method.
-		 *
-		 * @since 0.1
-		 *
-		 * @param {QUnit.assert} assert
-		 */
-		testGetSortKey: function( assert ) {
-			var instances = this.getInstances(),
-				i,
-				keyType;
-
-			for ( i in instances ) {
-				keyType = typeof( instances[i].getSortKey() );
-
-				assert.ok(
-					keyType === 'string' || keyType === 'number',
-					'return value is a string or number'
-				);
-			}
-		},
-
 		/**
 		 * Tests whether the data value's constructor has a newFromJSON function.
 		 *