Use strict types for entity ID parsers

Requires a few tweaks to ensure the tests still pass; notably, in
WikibaseRepo.datatypes.php, we should check that the given ID is a
string *before* passing it into the parser, rather than after, to avoid
a repeat of T334719 (see repo DataValueDeserializerTest).

Bug: T423185
Change-Id: Ibe946ce2002dca32307515ade93169bc74fc6783
Depends-On: I496fbe16c33b496b678d483614c19816125e543d
Depends-On: Ibb5acb562b94144565dee5c373d5e6bf9095db6d

Author: lucaswerkmeister

src/Entity/BasicEntityIdParser.php

@@ -1,5 +1,7 @@
 <?php
 
+declare( strict_types = 1 );
+
 namespace Wikibase\DataModel\Entity;
 
 /**
@@ -19,12 +21,9 @@ public function __construct() {
 	}
 
 	/**
-	 * @param string $idSerialization
-	 *
-	 * @return EntityId
 	 * @throws EntityIdParsingException
 	 */
-	public function parse( $idSerialization ) {
+	public function parse( string $idSerialization ): EntityId {
 		return $this->idParser->parse( $idSerialization );
 	}
 
@@ -41,7 +40,7 @@ public function parse( $idSerialization ) {
 	 *
 	 * @return callable[]
 	 */
-	public static function getBuilders() {
+	public static function getBuilders(): array {
 		return [
 			ItemId::PATTERN => static function( $serialization ) {
 				return new ItemId( $serialization );

src/Entity/DispatchingEntityIdParser.php

@@ -1,5 +1,7 @@
 <?php
 
+declare( strict_types = 1 );
+
 namespace Wikibase\DataModel\Entity;
 
 use InvalidArgumentException;
@@ -15,7 +17,7 @@ class DispatchingEntityIdParser implements EntityIdParser {
 	/**
 	 * @var callable[]
 	 */
-	private $idBuilders;
+	private array $idBuilders;
 
 	/**
 	 * Takes an array in which each key is a preg_match pattern.
@@ -31,14 +33,9 @@ public function __construct( array $idBuilders ) {
 	}
 
 	/**
-	 * @param string $idSerialization
-	 *
 	 * @throws EntityIdParsingException
-	 * @return EntityId
 	 */
-	public function parse( $idSerialization ) {
-		$this->assertIdIsString( $idSerialization );
-
+	public function parse( string $idSerialization ): EntityId {
 		if ( $this->idBuilders === [] ) {
 			throw new EntityIdParsingException( 'No id builders are configured' );
 		}
@@ -55,28 +52,9 @@ public function parse( $idSerialization ) {
 	}
 
 	/**
-	 * @param string $idSerialization
-	 *
-	 * @throws EntityIdParsingException
-	 */
-	private function assertIdIsString( $idSerialization ) {
-		if ( !is_string( $idSerialization ) ) {
-			throw new EntityIdParsingException(
-				'$idSerialization must be a string, got ' . ( is_object( $idSerialization )
-					? get_class( $idSerialization )
-					: getType( $idSerialization ) )
-			);
-		}
-	}
-
-	/**
-	 * @param callable $idBuilder
-	 * @param string $idSerialization
-	 *
 	 * @throws EntityIdParsingException
-	 * @return EntityId
 	 */
-	private function buildId( $idBuilder, $idSerialization ) {
+	private function buildId( callable $idBuilder, string $idSerialization ): EntityId {
 		try {
 			return $idBuilder( $idSerialization );
 		} catch ( InvalidArgumentException $ex ) {

src/Entity/EntityIdParser.php

@@ -1,5 +1,7 @@
 <?php
 
+declare( strict_types = 1 );
+
 namespace Wikibase\DataModel\Entity;
 
 /**
@@ -13,11 +15,8 @@
 interface EntityIdParser {
 
 	/**
-	 * @param string $idSerialization
-	 *
-	 * @return EntityId
 	 * @throws EntityIdParsingException
 	 */
-	public function parse( $idSerialization );
+	public function parse( string $idSerialization ): EntityId;
 
 }

src/Entity/EntityIdParsingException.php

@@ -1,5 +1,7 @@
 <?php
 
+declare( strict_types = 1 );
+
 namespace Wikibase\DataModel\Entity;
 
 use RuntimeException;

src/Entity/ItemIdParser.php

@@ -1,5 +1,7 @@
 <?php
 
+declare( strict_types = 1 );
+
 namespace Wikibase\DataModel\Entity;
 
 use InvalidArgumentException;
@@ -17,12 +19,9 @@
 class ItemIdParser implements EntityIdParser {
 
 	/**
-	 * @param string $idSerialization
-	 *
 	 * @throws EntityIdParsingException
-	 * @return ItemId
 	 */
-	public function parse( $idSerialization ) {
+	public function parse( string $idSerialization ): ItemId {
 		try {
 			return new ItemId( $idSerialization );
 		} catch ( InvalidArgumentException $ex ) {

tests/unit/Entity/BasicEntityIdParserTest.php

@@ -1,5 +1,7 @@
 <?php
 
+declare( strict_types = 1 );
+
 namespace Wikibase\DataModel\Tests\Entity;
 
 use Wikibase\DataModel\Entity\BasicEntityIdParser;
@@ -39,7 +41,7 @@ public static function entityIdProvider() {
 	/**
 	 * @dataProvider invalidIdSerializationProvider
 	 */
-	public function testCannotParseInvalidId( $invalidIdSerialization ) {
+	public function testCannotParseInvalidId( string $invalidIdSerialization ) {
 		$parser = new BasicEntityIdParser();
 
 		$this->expectException( EntityIdParsingException::class );
@@ -49,9 +51,6 @@ public function testCannotParseInvalidId( $invalidIdSerialization ) {
 	public static function invalidIdSerializationProvider() {
 		return [
 			[ 'FOO' ],
-			[ null ],
-			[ 42 ],
-			[ [] ],
 			[ '' ],
 			[ 'q0' ],
 			[ '1p' ],

tests/unit/Entity/DispatchingEntityIdParserTest.php

@@ -1,5 +1,7 @@
 <?php
 
+declare( strict_types = 1 );
+
 namespace Wikibase\DataModel\Tests\Entity;
 
 use Wikibase\DataModel\Entity\BasicEntityIdParser;
@@ -25,7 +27,7 @@ private function getBasicParser() {
 	/**
 	 * @dataProvider entityIdProvider
 	 */
-	public function testCanParseEntityId( $idString, EntityId $expected ) {
+	public function testCanParseEntityId( string $idString, EntityId $expected ) {
 		$parser = $this->getBasicParser();
 		$actual = $parser->parse( $idString );
 
@@ -44,7 +46,7 @@ public static function entityIdProvider() {
 	/**
 	 * @dataProvider invalidIdSerializationProvider
 	 */
-	public function testCannotParseInvalidId( $invalidIdSerialization ) {
+	public function testCannotParseInvalidId( string $invalidIdSerialization ) {
 		$parser = $this->getBasicParser();
 
 		$this->expectException( EntityIdParsingException::class );
@@ -54,9 +56,6 @@ public function testCannotParseInvalidId( $invalidIdSerialization ) {
 	public static function invalidIdSerializationProvider() {
 		return [
 			[ 'FOO' ],
-			[ null ],
-			[ 42 ],
-			[ [] ],
 			[ '' ],
 			[ 'q0' ],
 			[ '1p' ],

tests/unit/Entity/ItemIdParserTest.php

@@ -1,5 +1,7 @@
 <?php
 
+declare( strict_types = 1 );
+
 namespace Wikibase\DataModel\Tests\Entity;
 
 use Wikibase\DataModel\Entity\EntityIdParsingException;
@@ -34,7 +36,7 @@ public static function entityIdProvider() {
 	/**
 	 * @dataProvider invalidIdSerializationProvider
 	 */
-	public function testCannotParseInvalidId( $invalidIdSerialization ) {
+	public function testCannotParseInvalidId( string $invalidIdSerialization ) {
 		$parser = new ItemIdParser();
 
 		$this->expectException( EntityIdParsingException::class );
@@ -44,9 +46,6 @@ public function testCannotParseInvalidId( $invalidIdSerialization ) {
 	public static function invalidIdSerializationProvider() {
 		return [
 			[ 'FOO' ],
-			[ null ],
-			[ 42 ],
-			[ [] ],
 			[ '' ],
 			[ 'q0' ],
 			[ '1p' ],