Merge pull request #829 from wmde/phpcs

rosalieper · web-flow · commit fb41c80d6390 · 2020-10-16T15:55:24.000+02:00
Update wikibase/wikibase-codesniffer to 1.2.0
diff --git a/.phpcs.xml b/.phpcs.xml
@@ -4,7 +4,7 @@
 
 	<rule ref="Generic.Files.LineLength">
 		<properties>
-			<property name="lineLimit" value="115" />
+			<property name="lineLimit" value="120" />
 		</properties>
 	</rule>
 
diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
@@ -1,5 +1,15 @@
 # Wikibase DataModel release notes
 
+## Version 9.6.0 (development)
+
+* `ReferenceList::addNewReference()`, `Statement::addNewReference()` and the `StatementList` constructor
+  supported being called with a variadic argument list, with a single array argument,
+  or (in the case of `StatementList`) with a single `Traversable` argument.
+  The latter two forms are now deprecated (though they still work);
+  please update your code:
+  for instance, change `->addNewReference( [ $x, $y ] )` to `->addNewReference( $x, $y )`,
+  and `->addNewReference( $snaks )` to `->addNewReference( ...$snaks )`.
+
 ## Version 9.5.1 (2020-06-03)
 
 * Updated release notes
diff --git a/composer.json b/composer.json
@@ -35,7 +35,7 @@
 		"ockcyp/covers-validator": "~1.1",
 		"phpmd/phpmd": "~2.6",
 		"phpunit/phpunit": "~8.0",
-		"wikibase/wikibase-codesniffer": "~1.1.0"
+		"wikibase/wikibase-codesniffer": "~1.2.0"
 	},
 	"autoload": {
 		"psr-4": {
diff --git a/src/ReferenceList.php b/src/ReferenceList.php
@@ -90,14 +90,15 @@ public function addReference( Reference $reference, $index = null ) {
 	/**
 	 * @since 1.1
 	 *
-	 * @param Snak[]|Snak $snaks
-	 * @param Snak [$snak2,...]
+	 * @param Snak ...$snaks
+	 * (passing a single Snak[] is still supported but deprecated)
 	 *
 	 * @throws InvalidArgumentException
 	 */
-	public function addNewReference( $snaks = [] /*...*/ ) {
-		if ( $snaks instanceof Snak ) {
-			$snaks = func_get_args();
+	public function addNewReference( ...$snaks ) {
+		if ( count( $snaks ) === 1 && is_array( $snaks[0] ) ) {
+			// TODO stop supporting this
+			$snaks = $snaks[0];
 		}
 
 		$this->addReference( new Reference( $snaks ) );
diff --git a/src/Statement/Statement.php b/src/Statement/Statement.php
@@ -175,14 +175,15 @@ public function setReferences( ReferenceList $references ) {
 	/**
 	 * @since 2.0
 	 *
-	 * @param Snak[]|Snak $snaks
-	 * @param Snak [$snak2,...]
+	 * @param Snak ...$snaks
+	 * (passing a single Snak[] is still supported but deprecated)
 	 *
 	 * @throws InvalidArgumentException
 	 */
-	public function addNewReference( $snaks = [] /*...*/ ) {
-		if ( $snaks instanceof Snak ) {
-			$snaks = func_get_args();
+	public function addNewReference( ...$snaks ) {
+		if ( count( $snaks ) === 1 && is_array( $snaks[0] ) ) {
+			// TODO stop supporting this
+			$snaks = $snaks[0];
 		}
 
 		$this->references->addNewReference( $snaks );
diff --git a/src/Statement/StatementList.php b/src/Statement/StatementList.php
@@ -36,14 +36,17 @@ class StatementList implements IteratorAggregate, Comparable, Countable {
 	private $statements = [];
 
 	/**
-	 * @param Statement[]|Traversable|Statement $statements
-	 * @param Statement [$statement2,...]
+	 * @param Statement ...$statements
+	 * (passing a single Statement[] or Traversable is still supported but deprecated)
 	 *
 	 * @throws InvalidArgumentException
 	 */
-	public function __construct( $statements = [] /*...*/ ) {
-		if ( $statements instanceof Statement ) {
-			$statements = func_get_args();
+	public function __construct( ...$statements ) {
+		if ( count( $statements ) === 1 && (
+			is_array( $statements[0] ) || $statements[0] instanceof Traversable
+		) ) {
+			// TODO stop supporting this
+			$statements = $statements[0];
 		}
 
 		if ( !is_array( $statements ) && !( $statements instanceof Traversable ) ) {
diff --git a/tests/unit/Entity/EntityIdTest.php b/tests/unit/Entity/EntityIdTest.php
@@ -72,7 +72,7 @@ public function testSerializationStability() {
 		$serialization = 'C:32:"Wikibase\DataModel\Entity\ItemId":4:{Q123}';
 		$id = new ItemId( 'q123' );
 
-		$this->assertEquals(
+		$this->assertSame(
 			serialize( $id ),
 			$serialization
 		);
diff --git a/tests/unit/Entity/EntityIdValueTest.php b/tests/unit/Entity/EntityIdValueTest.php
@@ -62,7 +62,7 @@ public function instanceProvider() {
 	 * @dataProvider instanceProvider
 	 */
 	public function testGetType( EntityIdValue $id ) {
-		$this->assertEquals( 'wikibase-entityid', $id->getType() );
+		$this->assertSame( 'wikibase-entityid', $id->getType() );
 	}
 
 	/**
diff --git a/tests/unit/Entity/EntityRedirectTest.php b/tests/unit/Entity/EntityRedirectTest.php
@@ -80,10 +80,10 @@ public function equalsProvider() {
 	 * @param bool $expected
 	 */
 	public function testEquals( EntityRedirect $a, $b, $expected ) {
-		$this->assertEquals( $expected, $a->equals( $b ), '$a->equals( $b )' );
+		$this->assertSame( $expected, $a->equals( $b ), '$a->equals( $b )' );
 
 		if ( $b instanceof EntityRedirect ) {
-			$this->assertEquals( $expected, $b->equals( $a ), '$b->equals( $a )' );
+			$this->assertSame( $expected, $b->equals( $a ), '$b->equals( $a )' );
 		}
 	}
 
diff --git a/tests/unit/Entity/ItemIdSetTest.php b/tests/unit/Entity/ItemIdSetTest.php
@@ -27,7 +27,7 @@ public function testGetIterator() {
 	 */
 	public function testGetSerializations( array $itemIds, array $expected ) {
 		$set = new ItemIdSet( $itemIds );
-		$this->assertEquals( $expected, $set->getSerializations() );
+		$this->assertSame( $expected, $set->getSerializations() );
 	}
 
 	public function serializationsProvider() {
@@ -48,7 +48,7 @@ public function testGivenSetWithTwoItems_countReturnsTwo() {
 			new ItemId( 'Q1' ),
 			new ItemId( 'Q2' ),
 		] );
-		$this->assertEquals( 2, $set->count() );
+		$this->assertSame( 2, $set->count() );
 	}
 
 	public function testGivenNotSetId_hasReturnsFalse() {
diff --git a/tests/unit/Entity/ItemIdTest.php b/tests/unit/Entity/ItemIdTest.php
@@ -23,7 +23,7 @@ class ItemIdTest extends \PHPUnit\Framework\TestCase {
 	public function testCanConstructId( $idSerialization, $normalizedIdSerialization ) {
 		$id = new ItemId( $idSerialization );
 
-		$this->assertEquals(
+		$this->assertSame(
 			$normalizedIdSerialization,
 			$id->getSerialization()
 		);
@@ -123,7 +123,7 @@ public function serializationProvider() {
 	 */
 	public function testNewFromNumber( $number ) {
 		$id = ItemId::newFromNumber( $number );
-		$this->assertEquals( 'Q' . $number, $id->getSerialization() );
+		$this->assertSame( 'Q' . $number, $id->getSerialization() );
 	}
 
 	public function numericIdProvider() {
diff --git a/tests/unit/Entity/PropertyIdTest.php b/tests/unit/Entity/PropertyIdTest.php
@@ -23,7 +23,7 @@ class PropertyIdTest extends \PHPUnit\Framework\TestCase {
 	public function testCanConstructId( $idSerialization, $normalizedIdSerialization ) {
 		$id = new PropertyId( $idSerialization );
 
-		$this->assertEquals(
+		$this->assertSame(
 			$normalizedIdSerialization,
 			$id->getSerialization()
 		);
@@ -123,7 +123,7 @@ public function serializationProvider() {
 	 */
 	public function testNewFromNumber( $number ) {
 		$id = PropertyId::newFromNumber( $number );
-		$this->assertEquals( 'P' . $number, $id->getSerialization() );
+		$this->assertSame( 'P' . $number, $id->getSerialization() );
 	}
 
 	public function numericIdProvider() {
diff --git a/tests/unit/Entity/PropertyTest.php b/tests/unit/Entity/PropertyTest.php
@@ -617,7 +617,7 @@ public function testClear( Property $property ) {
 			$property->getId(),
 			'cleared Property should keep its id'
 		);
-		$this->assertEquals(
+		$this->assertSame(
 			$clone->getDataTypeId(),
 			$property->getDataTypeId(),
 			'cleared Property should keep its data type'
diff --git a/tests/unit/Internal/MapValueHasherTest.php b/tests/unit/Internal/MapValueHasherTest.php
@@ -40,10 +40,10 @@ public function testHash() {
 		unset( $map1['foo'] );
 		$map1[] = $map0['foo'];
 
-		$this->assertEquals( $hash, $hasher->hash( $map1 ) );
+		$this->assertSame( $hash, $hasher->hash( $map1 ) );
 
 		$map4 = new ArrayObject( $map0 );
-		$this->assertEquals( $hash, $hasher->hash( $map4 ) );
+		$this->assertSame( $hash, $hasher->hash( $map4 ) );
 
 		$map2 = $map0;
 		unset( $map2['foo'] );
diff --git a/tests/unit/ReferenceTest.php b/tests/unit/ReferenceTest.php
@@ -92,15 +92,15 @@ public function testGetHashReturnsString( Reference $reference ) {
 	 * @dataProvider instanceProvider
 	 */
 	public function testGetHashIsStable( Reference $reference ) {
-		$this->assertEquals( $reference->getHash(), $reference->getHash() );
+		$this->assertSame( $reference->getHash(), $reference->getHash() );
 	}
 
 	/**
 	 * @dataProvider instanceProvider
 	 */
 	public function testGetHashIsTheSameForInstanceWithSameValue( Reference $reference ) {
 		$newRef = unserialize( serialize( $reference ) );
-		$this->assertEquals( $newRef->getHash(), $reference->getHash() );
+		$this->assertSame( $newRef->getHash(), $reference->getHash() );
 	}
 
 	/**
@@ -174,7 +174,7 @@ public function unorderedReferenceProvider() {
 	 * @dataProvider unorderedReferenceProvider
 	 */
 	public function testUnorderedReference( Reference $unorderedReference, Reference $orderedReference ) {
-		$this->assertEquals( $unorderedReference->getHash(), $orderedReference->getHash() );
+		$this->assertSame( $unorderedReference->getHash(), $orderedReference->getHash() );
 	}
 
 	public function testReferenceEqualsItself() {
diff --git a/tests/unit/SiteLinkTest.php b/tests/unit/SiteLinkTest.php
@@ -31,7 +31,7 @@ public function testCanConstruct() {
 	 */
 	public function testGetSiteId( $siteId ) {
 		$siteLink = new SiteLink( $siteId, 'Wikidata' );
-		$this->assertEquals( $siteId, $siteLink->getSiteId() );
+		$this->assertSame( $siteId, $siteLink->getSiteId() );
 	}
 
 	public function siteIdProvider() {
@@ -67,7 +67,7 @@ public function invalidStringIdentifierProvider() {
 	 */
 	public function testGetPageName( $pageName ) {
 		$siteLink = new SiteLink( 'enwiki', $pageName );
-		$this->assertEquals( $pageName, $siteLink->getPageName() );
+		$this->assertSame( $pageName, $siteLink->getPageName() );
 	}
 
 	public function pageNameProvider() {
diff --git a/tests/unit/Snak/DerivedPropertyValueSnakTest.php b/tests/unit/Snak/DerivedPropertyValueSnakTest.php
@@ -127,7 +127,7 @@ public function testSerializationDoesNotContainDerivedValues() {
 			[ 'foo' => new StringValue( 'foo' ), 'bar' => new StringValue( 'bar' ) ]
 		);
 
-		$this->assertEquals(
+		$this->assertSame(
 			'a:2:{i:0;s:5:"P9001";i:1;C:22:"DataValues\StringValue":2:{bc}}',
 			$snak->serialize()
 		);
diff --git a/tests/unit/Snak/PropertyNoValueSnakTest.php b/tests/unit/Snak/PropertyNoValueSnakTest.php
@@ -65,7 +65,7 @@ public function testGetHash() {
 		$snak = new PropertyNoValueSnak( new PropertyId( 'P1' ) );
 		$hash = $snak->getHash();
 		$this->assertIsString( $hash );
-		$this->assertEquals( 40, strlen( $hash ) );
+		$this->assertSame( 40, strlen( $hash ) );
 	}
 
 	/**
diff --git a/tests/unit/Snak/PropertySomeValueSnakTest.php b/tests/unit/Snak/PropertySomeValueSnakTest.php
@@ -65,7 +65,7 @@ public function testGetHash() {
 		$snak = new PropertySomeValueSnak( new PropertyId( 'P1' ) );
 		$hash = $snak->getHash();
 		$this->assertIsString( $hash );
-		$this->assertEquals( 40, strlen( $hash ) );
+		$this->assertSame( 40, strlen( $hash ) );
 	}
 
 	/**
diff --git a/tests/unit/Snak/PropertyValueSnakTest.php b/tests/unit/Snak/PropertyValueSnakTest.php
@@ -76,7 +76,7 @@ public function testGetHash() {
 		$snak = new PropertyValueSnak( new PropertyId( 'P1' ), new StringValue( 'a' ) );
 		$hash = $snak->getHash();
 		$this->assertIsString( $hash );
-		$this->assertEquals( 40, strlen( $hash ) );
+		$this->assertSame( 40, strlen( $hash ) );
 	}
 
 	/**
diff --git a/tests/unit/Snak/SnakListTest.php b/tests/unit/Snak/SnakListTest.php
@@ -125,7 +125,7 @@ public function testRemoveSnak( SnakList $array ) {
 			}
 
 			$this->assertFalse( $array->hasSnak( $element ) );
-			$this->assertEquals( --$elementCount, $array->count() );
+			$this->assertSame( --$elementCount, $array->count() );
 		}
 
 		$element = new PropertyNoValueSnak( new PropertyId( 'P42' ) );
@@ -149,13 +149,13 @@ public function testAddSnak( SnakList $array ) {
 			++$elementCount;
 		}
 
-		$this->assertEquals( !$array->hasSnak( $element ), $array->addSnak( $element ) );
+		$this->assertSame( !$array->hasSnak( $element ), $array->addSnak( $element ) );
 
-		$this->assertEquals( $elementCount, $array->count() );
+		$this->assertSame( $elementCount, $array->count() );
 
 		$this->assertFalse( $array->addSnak( $element ) );
 
-		$this->assertEquals( $elementCount, $array->count() );
+		$this->assertSame( $elementCount, $array->count() );
 	}
 
 	public function orderByPropertyProvider() {
diff --git a/tests/unit/Snak/SnakTest.php b/tests/unit/Snak/SnakTest.php
@@ -85,7 +85,7 @@ public function testSerialize( Snak $snak ) {
 
 		$this->assertEquals( $snak, $newInstance );
 		$this->assertEquals( $snak->getPropertyId(), $newInstance->getPropertyId() );
-		$this->assertEquals( $snak->getType(), $newInstance->getType() );
+		$this->assertSame( $snak->getType(), $newInstance->getType() );
 	}
 
 	/**
@@ -95,7 +95,7 @@ public function testSerialize( Snak $snak ) {
 	public function testGetHash( Snak $snak ) {
 		$hash = $snak->getHash();
 		$this->assertIsString( $hash );
-		$this->assertEquals( $hash, $snak->getHash() );
+		$this->assertSame( $hash, $snak->getHash() );
 	}
 
 	/**
diff --git a/tests/unit/Snak/TypedSnakTest.php b/tests/unit/Snak/TypedSnakTest.php
@@ -25,7 +25,7 @@ public function testGettersReturnCorrectValues() {
 		$typedSnak = new TypedSnak( $snak, $dataTypeId );
 
 		$this->assertEquals( $snak, $typedSnak->getSnak() );
-		$this->assertEquals( $dataTypeId, $typedSnak->getDataTypeId() );
+		$this->assertSame( $dataTypeId, $typedSnak->getDataTypeId() );
 	}
 
 }
diff --git a/tests/unit/Statement/StatementByGuidMapTest.php b/tests/unit/Statement/StatementByGuidMapTest.php
@@ -63,7 +63,7 @@ public function testGivenGuidOfPresentStatement_getStatementByGuidReturnsStateme
 
 		$statements = new StatementByGuidMap( [ $statement ] );
 
-		$this->assertEquals( $statement, $statements->getStatementByGuid( 'some guid' ) );
+		$this->assertSame( $statement, $statements->getStatementByGuid( 'some guid' ) );
 	}
 
 	public function testGivenGuidOfNotPresentStatement_getStatementByGuidReturnsNull() {
@@ -160,7 +160,7 @@ public function testMapCanBeIteratedOver() {
 			'other guid' => $statement2
 		];
 
-		$this->assertEquals( $expectedStatements, $iteratedStatements );
+		$this->assertSame( $expectedStatements, $iteratedStatements );
 	}
 
 	public function testGivenNotPresentStatement_addStatementAddsIt() {
@@ -179,7 +179,7 @@ public function testGivenStatementWithPresentGuid_addStatementReplacesThePresent
 
 		$statements->addStatement( $statement2 );
 
-		$this->assertEquals( $statement2, $statements->getStatementByGuid( 'some guid' ) );
+		$this->assertSame( $statement2, $statements->getStatementByGuid( 'some guid' ) );
 	}
 
 	public function testToArray() {
@@ -193,7 +193,7 @@ public function testToArray() {
 			'other guid' => $statement2
 		];
 
-		$this->assertEquals( $expectedStatements, $statementMap->toArray() );
+		$this->assertSame( $expectedStatements, $statementMap->toArray() );
 	}
 
 }
diff --git a/tests/unit/Statement/StatementGuidTest.php b/tests/unit/Statement/StatementGuidTest.php
@@ -26,7 +26,7 @@ public function testConstructor( EntityId $entityId, $guid, $expected ) {
 
 		$this->assertSame( $expected, $statementGuid->getSerialization() );
 		$this->assertEquals( $entityId, $statementGuid->getEntityId() );
-		$this->assertEquals( $guid, $statementGuid->getGuidPart() );
+		$this->assertSame( $guid, $statementGuid->getGuidPart() );
 	}
 
 	public function provideConstructionData() {
diff --git a/tests/unit/Statement/StatementListTest.php b/tests/unit/Statement/StatementListTest.php
diff --git a/tests/unit/Statement/StatementTest.php b/tests/unit/Statement/StatementTest.php
diff --git a/tests/unit/Term/TermListTest.php b/tests/unit/Term/TermListTest.php

Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ public function instanceProvider() {`
`62`	`62`	`* @dataProvider instanceProvider`
`63`	`63`	`*/`
`64`	`64`	`public function testGetType( EntityIdValue $id ) {`
`65`		`- $this->assertEquals( 'wikibase-entityid', $id->getType() );`
	`65`	`+ $this->assertSame( 'wikibase-entityid', $id->getType() );`
`66`	`66`	`}`
`67`	`67`
`68`	`68`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -80,10 +80,10 @@ public function equalsProvider() {`
`80`	`80`	`* @param bool $expected`
`81`	`81`	`*/`
`82`	`82`	`public function testEquals( EntityRedirect $a, $b, $expected ) {`
`83`		`- $this->assertEquals( $expected, $a->equals( $b ), '$a->equals( $b )' );`
	`83`	`+ $this->assertSame( $expected, $a->equals( $b ), '$a->equals( $b )' );`
`84`	`84`
`85`	`85`	`if ( $b instanceof EntityRedirect ) {`
`86`		`- $this->assertEquals( $expected, $b->equals( $a ), '$b->equals( $a )' );`
	`86`	`+ $this->assertSame( $expected, $b->equals( $a ), '$b->equals( $a )' );`
`87`	`87`	`}`
`88`	`88`	`}`
`89`	`89`