Merge pull request #841 from wmde/update_data_values

Update data-values to 3.0 and prepare for release
wmde · Mar 31, 2021 · f02f536 · f02f536
2 parents 1e096d8 + 0d5d4e4
commit f02f536
Show file tree

Hide file tree

Showing 24 changed files with 22 additions and 58 deletions.
diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
@@ -1,6 +1,6 @@
 # Wikibase DataModel release notes
 
-## Version 9.6.0 (development)
+## Version 9.6.0
 
 * `ReferenceList::addNewReference()`, `Statement::addNewReference()` and the `StatementList` constructor
   supported being called with a variadic argument list, with a single array argument,
@@ -10,6 +10,8 @@
   for instance, change `->addNewReference( [ $x, $y ] )` to `->addNewReference( $x, $y )`,
   and `->addNewReference( $snaks )` to `->addNewReference( ...$snaks )`.
 * `Statement`, `Reference`, `SnakList` and `Snak` no longer implement the `Hashable` and `Immutable` interfaces from `DataValues/DataValues`.
+* Removed usages of the `Comparable` interface
+* Made the library installable together with DataValues 3.x
 
 ## Version 9.5.1 (2020-06-03)
 

diff --git a/composer.json b/composer.json
@@ -28,7 +28,7 @@
 	},
 	"require": {
 		"php": "^8.0|^7.1",
-		"data-values/data-values": "~0.1|~1.0|~2.0",
+		"data-values/data-values": "~0.1|~1.0|~2.0|~3.0",
 		"wikimedia/assert": "~0.2.2|~0.3.0|~0.4.0|~0.5.0"
 	},
 	"require-dev": {

diff --git a/src/Entity/EntityDocument.php b/src/Entity/EntityDocument.php
@@ -2,7 +2,6 @@
 
 namespace Wikibase\DataModel\Entity;
 
-use Comparable;
 use InvalidArgumentException;
 
 /**
@@ -15,7 +14,7 @@
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
  * @author Bene* < benestar.wikimedia@gmail.com >
  */
-interface EntityDocument extends Comparable {
+interface EntityDocument {
 
 	/**
 	 * Returns a type identifier for the entity, e.g. "item" or "property".
@@ -60,7 +59,6 @@ public function setId( $id );
 	public function isEmpty();
 
 	/**
-	 * @see Comparable::equals
 	 *
 	 * Two entities are considered equal if they are of the same type and have the same value. The
 	 * value does not include the id, so entities with the same value but different id are

diff --git a/src/Entity/EntityId.php b/src/Entity/EntityId.php
@@ -2,7 +2,6 @@
 
 namespace Wikibase\DataModel\Entity;
 
-use Comparable;
 use InvalidArgumentException;
 use Serializable;
 
@@ -12,7 +11,7 @@
  *
  * @license GPL-2.0-or-later
  */
-abstract class EntityId implements Comparable, Serializable {
+abstract class EntityId implements Serializable {
 
 	protected $serialization;
 
@@ -195,7 +194,6 @@ public function __toString() {
 	}
 
 	/**
-	 * @see Comparable::equals
 	 *
 	 * @since 0.5
 	 *

diff --git a/src/Entity/EntityIdValue.php b/src/Entity/EntityIdValue.php
@@ -72,7 +72,8 @@ public static function getType() {
 	}
 
 	/**
-	 * @see DataValue::getSortKey
+	 * @deprecated Kept for compatibility with older DataValues versions.
+	 * Do not use.
 	 *
 	 * @return string|float|int
 	 */

diff --git a/src/Entity/ItemIdSet.php b/src/Entity/ItemIdSet.php
@@ -3,7 +3,6 @@
 namespace Wikibase\DataModel\Entity;
 
 use ArrayIterator;
-use Comparable;
 use Countable;
 use InvalidArgumentException;
 use IteratorAggregate;
@@ -17,7 +16,7 @@
  * @license GPL-2.0-or-later
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
  */
-class ItemIdSet implements IteratorAggregate, Countable, Comparable {
+class ItemIdSet implements IteratorAggregate, Countable {
 
 	/**
 	 * @var ItemId[]

diff --git a/src/Reference.php b/src/Reference.php
@@ -2,7 +2,6 @@
 
 namespace Wikibase\DataModel;
 
-use Comparable;
 use Countable;
 use InvalidArgumentException;
 use Wikibase\DataModel\Snak\Snak;
@@ -17,7 +16,7 @@
  * @license GPL-2.0-or-later
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
  */
-class Reference implements Comparable, Countable {
+class Reference implements Countable {
 
 	/**
 	 * @var SnakList
@@ -91,7 +90,6 @@ public function getHash() {
 	}
 
 	/**
-	 * @see Comparable::equals
 	 *
 	 * The comparison is done purely value based, ignoring the order of the snaks.
 	 *

diff --git a/src/ReferenceList.php b/src/ReferenceList.php
@@ -3,7 +3,6 @@
 namespace Wikibase\DataModel;
 
 use ArrayIterator;
-use Comparable;
 use Countable;
 use InvalidArgumentException;
 use IteratorAggregate;
@@ -25,7 +24,7 @@
  * @author Thiemo Kreuz
  * @author Bene* < benestar.wikimedia@gmail.com >
  */
-class ReferenceList implements Comparable, Countable, IteratorAggregate, Serializable {
+class ReferenceList implements Countable, IteratorAggregate, Serializable {
 
 	/**
 	 * @var Reference[] Ordered list or references, indexed by SPL object hash.
@@ -286,8 +285,6 @@ public function getValueHash() {
 	}
 
 	/**
-	 * @see Comparable::equals
-	 *
 	 * The comparison is done purely value based, ignoring the order of the elements in the array.
 	 *
 	 * @since 0.3

diff --git a/src/SiteLink.php b/src/SiteLink.php
@@ -2,7 +2,6 @@
 
 namespace Wikibase\DataModel;
 
-use Comparable;
 use InvalidArgumentException;
 use Wikibase\DataModel\Entity\ItemId;
 use Wikibase\DataModel\Entity\ItemIdSet;
@@ -20,7 +19,7 @@
  * @author Michał Łazowik
  * @author Thiemo Kreuz
  */
-class SiteLink implements Comparable {
+class SiteLink {
 
 	/**
 	 * @var string
@@ -107,7 +106,6 @@ public function getBadges() {
 	}
 
 	/**
-	 * @see Comparable::equals
 	 *
 	 * @since 0.7.4
 	 *

diff --git a/src/SiteLinkList.php b/src/SiteLinkList.php
@@ -3,7 +3,6 @@
 namespace Wikibase\DataModel;
 
 use ArrayIterator;
-use Comparable;
 use Countable;
 use InvalidArgumentException;
 use Iterator;
@@ -23,7 +22,7 @@
  * @license GPL-2.0-or-later
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
  */
-class SiteLinkList implements IteratorAggregate, Countable, Comparable {
+class SiteLinkList implements IteratorAggregate, Countable {
 
 	/**
 	 * @var SiteLink[]
@@ -151,7 +150,6 @@ public function hasLinkWithSiteId( $siteId ) {
 	}
 
 	/**
-	 * @see Comparable::equals
 	 *
 	 * @since 0.7.4
 	 *

diff --git a/src/Snak/Snak.php b/src/Snak/Snak.php
@@ -2,7 +2,6 @@
 
 namespace Wikibase\DataModel\Snak;
 
-use Comparable;
 use Serializable;
 use Wikibase\DataModel\PropertyIdProvider;
 
@@ -15,7 +14,7 @@
  * @license GPL-2.0-or-later
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
  */
-interface Snak extends Serializable, Comparable, PropertyIdProvider {
+interface Snak extends Serializable, PropertyIdProvider {
 
 	/**
 	 * Returns a string that can be used to identify the type of snak.

diff --git a/src/Snak/SnakList.php b/src/Snak/SnakList.php
@@ -3,7 +3,6 @@
 namespace Wikibase\DataModel\Snak;
 
 use ArrayObject;
-use Comparable;
 use InvalidArgumentException;
 use Traversable;
 use Wikibase\DataModel\Internal\MapValueHasher;
@@ -18,7 +17,7 @@
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
  * @author Addshore
  */
-class SnakList extends ArrayObject implements Comparable {
+class SnakList extends ArrayObject {
 
 	/**
 	 * Maps snak hashes to their offsets.
@@ -123,7 +122,6 @@ public function getSnak( $snakHash ) {
 	}
 
 	/**
-	 * @see Comparable::equals
 	 *
 	 * The comparison is done purely value based, ignoring the order of the elements in the array.
 	 *

diff --git a/src/Snak/SnakObject.php b/src/Snak/SnakObject.php
@@ -74,7 +74,6 @@ public function getHash() {
 	}
 
 	/**
-	 * @see Comparable::equals
 	 *
 	 * @since 0.3
 	 *

diff --git a/src/Statement/Statement.php b/src/Statement/Statement.php
@@ -2,7 +2,6 @@
 
 namespace Wikibase\DataModel\Statement;
 
-use Comparable;
 use InvalidArgumentException;
 use Wikibase\DataModel\Entity\PropertyId;
 use Wikibase\DataModel\PropertyIdProvider;
@@ -20,7 +19,7 @@
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
  * @author Bene* < benestar.wikimedia@gmail.com >
  */
-class Statement implements Comparable, PropertyIdProvider {
+class Statement implements PropertyIdProvider {
 
 	/**
 	 * Rank enum. Higher values are more preferred.
@@ -272,7 +271,6 @@ public function getAllSnaks() {
 	}
 
 	/**
-	 * @see Comparable::equals
 	 *
 	 * @since 0.7.4
 	 *

diff --git a/src/Statement/StatementGuid.php b/src/Statement/StatementGuid.php
@@ -2,7 +2,6 @@
 
 namespace Wikibase\DataModel\Statement;
 
-use Comparable;
 use InvalidArgumentException;
 use Wikibase\DataModel\Entity\EntityId;
 
@@ -16,7 +15,7 @@
  * @license GPL-2.0-or-later
  * @author Addshore
  */
-class StatementGuid implements Comparable {
+class StatementGuid {
 
 	/**
 	 * The separator for the prefix and suffix of the GUID.

diff --git a/src/Statement/StatementList.php b/src/Statement/StatementList.php
@@ -3,7 +3,6 @@
 namespace Wikibase\DataModel\Statement;
 
 use ArrayIterator;
-use Comparable;
 use Countable;
 use InvalidArgumentException;
 use Iterator;
@@ -29,7 +28,7 @@
  * @author Bene* < benestar.wikimedia@gmail.com >
  * @author Thiemo Kreuz
  */
-class StatementList implements IteratorAggregate, Comparable, Countable {
+class StatementList implements IteratorAggregate, Countable {
 
 	/**
 	 * @var Statement[]
@@ -267,7 +266,6 @@ public function count() {
 	}
 
 	/**
-	 * @see Comparable::equals
 	 *
 	 * @param mixed $target
 	 *

diff --git a/src/Term/AliasGroup.php b/src/Term/AliasGroup.php
@@ -2,7 +2,6 @@
 
 namespace Wikibase\DataModel\Term;
 
-use Comparable;
 use Countable;
 use InvalidArgumentException;
 
@@ -16,7 +15,7 @@
  * @license GPL-2.0-or-later
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
  */
-class AliasGroup implements Comparable, Countable {
+class AliasGroup implements Countable {
 
 	/**
 	 * @var string Language code identifying the language of the aliases, but note that there is
@@ -82,7 +81,6 @@ public function isEmpty() {
 	}
 
 	/**
-	 * @see Comparable::equals
 	 *
 	 * @param mixed $target
 	 *

diff --git a/src/Term/AliasGroupFallback.php b/src/Term/AliasGroupFallback.php
@@ -73,7 +73,6 @@ public function getSourceLanguageCode() {
 	}
 
 	/**
-	 * @see Comparable::equals
 	 *
 	 * @param mixed $target
 	 *

diff --git a/src/Term/AliasGroupList.php b/src/Term/AliasGroupList.php
@@ -115,7 +115,6 @@ public function setGroup( AliasGroup $group ) {
 	}
 
 	/**
-	 * @see Comparable::equals
 	 *
 	 * @since 0.7.4
 	 *

diff --git a/src/Term/Fingerprint.php b/src/Term/Fingerprint.php
@@ -2,7 +2,6 @@
 
 namespace Wikibase\DataModel\Term;
 
-use Comparable;
 use InvalidArgumentException;
 use OutOfBoundsException;
 
@@ -17,7 +16,7 @@
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
  * @author Thiemo Kreuz
  */
-class Fingerprint implements Comparable, LabelsProvider, DescriptionsProvider, AliasesProvider {
+class Fingerprint implements LabelsProvider, DescriptionsProvider, AliasesProvider {
 
 	/**
 	 * @deprecated since 2.5, use new Fingerprint() instead.
@@ -221,7 +220,6 @@ public function removeAliasGroup( $languageCode ) {
 	}
 
 	/**
-	 * @see Comparable::equals
 	 *
 	 * @since 0.7.4
 	 *
-Original file line number
+Diff line change
@@ Expand Up / @@ -74,7 +74,6 @@ public function getHash() { @@
     	}
     	/**
-    	 * @see Comparable::equals
     	 *
     	 * @since 0.3
     	 *
@@ Expand Down @@