DM: Add type hints and strict_types to StatementGuid

Change-Id: Ide6e0f5d1cfdf84b10a1dc930ea482ca16cb5d53

Author: outdooracorn

src/Statement/StatementGuid.php

@@ -1,8 +1,7 @@
-<?php
+<?php declare( strict_types=1 );
 
 namespace Wikibase\DataModel\Statement;
 
-use InvalidArgumentException;
 use Wikibase\DataModel\Entity\EntityId;
 
 /**
@@ -22,79 +21,49 @@ class StatementGuid {
 	 */
 	public const SEPARATOR = '$';
 
-	/**
-	 * @var EntityId
-	 */
-	private $entityId;
-
-	/**
-	 * @var string
-	 */
-	private $guidPart;
-
-	/**
-	 * @var string
-	 */
-	private $serialization;
-
-	/**
-	 * @param EntityId $entityId
-	 * @param string $guid
-	 *
-	 * @throws InvalidArgumentException
-	 */
-	public function __construct( EntityId $entityId, $guid ) {
-		if ( !is_string( $guid ) ) {
-			throw new InvalidArgumentException( '$guid must be a string' );
-		}
+	private EntityId $entityId;
+	private string $guidPart;
+	private string $serialization;
 
+	public function __construct( EntityId $entityId, string $guid ) {
 		$this->serialization = $entityId->getSerialization() . self::SEPARATOR . $guid;
 		$this->entityId = $entityId;
 		$this->guidPart = $guid;
 	}
 
-	/**
-	 * @return EntityId
-	 */
-	public function getEntityId() {
+	public function getEntityId(): EntityId {
 		return $this->entityId;
 	}
 
 	/**
 	 * @since 9.4
-	 *
-	 * @return string
 	 */
-	public function getGuidPart() {
+	public function getGuidPart(): string {
 		return $this->guidPart;
 	}
 
 	/**
-	 * @return string
 	 * @deprecated The value returned by this method might differ in case from the original, unparsed statement GUID
 	 * (the entity ID part might have been lowercase originally, but is always normalized in the return value here),
 	 * which means that the value should not be compared to other statement GUID serializations,
 	 * e.g. to look up a statement in a StatementList.
 	 */
-	public function getSerialization() {
+	public function getSerialization(): string {
 		return $this->serialization;
 	}
 
 	/**
 	 * @param mixed $target
-	 *
-	 * @return bool
 	 */
-	public function equals( $target ) {
+	public function equals( $target ): bool {
 		if ( $this === $target ) {
 			return true;
 		}
 
-		return $target instanceof self
-			&& $target->serialization === $this->serialization;
+		return $target instanceof self && $target->serialization === $this->serialization;
 	}
 
-	public function __toString() {
+	public function __toString(): string {
 		return $this->serialization;
 	}
 

tests/unit/Statement/StatementGuidTest.php

@@ -1,8 +1,8 @@
-<?php
+<?php declare( strict_types=1 );
 
 namespace Wikibase\DataModel\Tests\Statement;
 
-use InvalidArgumentException;
+use PHPUnit\Framework\TestCase;
 use Wikibase\DataModel\Entity\EntityId;
 use Wikibase\DataModel\Entity\ItemId;
 use Wikibase\DataModel\Statement\StatementGuid;
@@ -16,24 +16,24 @@
  * @license GPL-2.0-or-later
  * @author Addshore
  */
-class StatementGuidTest extends \PHPUnit\Framework\TestCase {
+class StatementGuidTest extends TestCase {
 
 	/**
 	 * @dataProvider provideConstructionData
 	 */
-	public function testConstructor( EntityId $entityId, $guid, $expected ) {
+	public function testConstructor( EntityId $entityId, string $guid, string $expected ): void {
 		$statementGuid = new StatementGuid( $entityId, $guid );
 
 		$this->assertSame( $expected, $statementGuid->getSerialization() );
 		$this->assertEquals( $entityId, $statementGuid->getEntityId() );
 		$this->assertSame( $guid, $statementGuid->getGuidPart() );
 	}
 
-	public static function provideConstructionData() {
+	public static function provideConstructionData(): array {
 		return [
 			[
 				new ItemId( 'q42' ),
-				'D8404CDA-25E4-4334-AF13-A3290BCD9C0N' ,
+				'D8404CDA-25E4-4334-AF13-A3290BCD9C0N',
 				'Q42$D8404CDA-25E4-4334-AF13-A3290BCD9C0N',
 			],
 			[
@@ -49,24 +49,7 @@ public static function provideConstructionData() {
 		];
 	}
 
-	/**
-	 * @dataProvider provideBadConstruction
-	 */
-	public function testBadConstruction( EntityId $entityId, $guid ) {
-		$this->expectException( InvalidArgumentException::class );
-		new StatementGuid( $entityId, $guid );
-	}
-
-	public static function provideBadConstruction() {
-		$id = new ItemId( 'Q1' );
-
-		return [
-			[ $id, null ],
-			[ $id, 12345 ],
-		];
-	}
-
-	public function provideStatementGuids() {
+	public function provideStatementGuids(): array {
 		$argLists = [];
 
 		foreach ( $this->provideConstructionData() as $data ) {
@@ -79,7 +62,7 @@ public function provideStatementGuids() {
 	/**
 	 * @dataProvider provideStatementGuids
 	 */
-	public function testEquals( StatementGuid $statementGuid ) {
+	public function testEquals( StatementGuid $statementGuid ): void {
 		$statementGuidCopy = clone $statementGuid;
 		$this->assertTrue( $statementGuid->equals( $statementGuidCopy ) );
 		$this->assertTrue( $statementGuidCopy->equals( $statementGuid ) );
@@ -88,7 +71,7 @@ public function testEquals( StatementGuid $statementGuid ) {
 	/**
 	 * @dataProvider provideStatementGuids
 	 */
-	public function testNotEquals( StatementGuid $statementGuid ) {
+	public function testNotEquals( StatementGuid $statementGuid ): void {
 		$notEqualStatementGuid = new StatementGuid( new ItemId( 'q9999' ), 'someguid' );
 		$this->assertFalse( $statementGuid->equals( $notEqualStatementGuid ) );
 		$this->assertFalse( $notEqualStatementGuid->equals( $statementGuid ) );