Merge pull request #841 from wmde/update_data_values

Update data-values to 3.0 and prepare for release

Author: chukarave

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)
 

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": {

src/Entity/EntityDocument.php

@@ -2,7 +2,6 @@
 
 namespace Wikibase\DataModel\Entity;
 
-use Comparable;
 use InvalidArgumentException;
 
 /**
@@ -15,7 +14,7 @@
  * @author Jeroen De Dauw < [email protected] >
  * @author Bene* < [email protected] >
  */
-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

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
 	 *

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
 	 */

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 < [email protected] >
  */
-class ItemIdSet implements IteratorAggregate, Countable, Comparable {
+class ItemIdSet implements IteratorAggregate, Countable {
 
 	/**
 	 * @var ItemId[]

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 < [email protected] >
  */
-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.
 	 *

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* < [email protected] >
  */
-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

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
 	 *

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 < [email protected] >
  */
-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
 	 *