Merge pull request #713 from wmde/equalHashArrays

Move HashArray::equals to SnakList::equals

Author: manicki

src/HashArray.php

@@ -3,7 +3,6 @@
 namespace Wikibase\DataModel;
 
 use ArrayObject;
-use Comparable;
 use Hashable;
 use InvalidArgumentException;
 use Traversable;
@@ -26,7 +25,7 @@
  * @license GPL-2.0+
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
  */
-abstract class HashArray extends ArrayObject implements Comparable {
+abstract class HashArray extends ArrayObject {
 
 	/**
 	 * Maps element hashes to their offsets.
@@ -231,26 +230,6 @@ public function offsetUnset( $index ) {
 		}
 	}
 
-	/**
-	 * @see Comparable::equals
-	 *
-	 * The comparison is done purely value based, ignoring the order of the elements in the array.
-	 *
-	 * @since 0.3
-	 *
-	 * @param mixed $target
-	 *
-	 * @return bool
-	 */
-	public function equals( $target ) {
-		if ( $this === $target ) {
-			return true;
-		}
-
-		return $target instanceof self
-			&& $this->getHash() === $target->getHash();
-	}
-
 	/**
 	 * @see ArrayObject::append
 	 *

src/Snak/SnakList.php

@@ -2,6 +2,7 @@
 
 namespace Wikibase\DataModel\Snak;
 
+use Comparable;
 use Hashable;
 use InvalidArgumentException;
 use Traversable;
@@ -18,7 +19,7 @@
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
  * @author Addshore
  */
-class SnakList extends HashArray implements Hashable {
+class SnakList extends HashArray implements Comparable, Hashable {
 
 	/**
 	 * @param Snak[]|Traversable $snaks
@@ -108,6 +109,26 @@ public function getSnak( $snakHash ) {
 		return $this->getByElementHash( $snakHash );
 	}
 
+	/**
+	 * @see Comparable::equals
+	 *
+	 * The comparison is done purely value based, ignoring the order of the elements in the array.
+	 *
+	 * @since 0.3
+	 *
+	 * @param mixed $target
+	 *
+	 * @return bool
+	 */
+	public function equals( $target ) {
+		if ( $this === $target ) {
+			return true;
+		}
+
+		return $target instanceof self
+		&& $this->getHash() === $target->getHash();
+	}
+
 	/**
 	 * @see HashArray::getHash
 	 *

tests/unit/HashArray/HashArrayTest.php

@@ -2,8 +2,6 @@
 
 namespace Wikibase\DataModel\Tests\HashArray;
 
-use Wikibase\DataModel\HashArray;
-
 /**
  * @covers Wikibase\DataModel\HashArray
  *
@@ -39,15 +37,6 @@ public function instanceProvider() {
 		return $instances;
 	}
 
-	/**
-	 * @dataProvider instanceProvider
-	 * @param HashArray $array
-	 */
-	public function testEquals( HashArray $array ) {
-		$this->assertTrue( $array->equals( $array ) );
-		$this->assertFalse( $array->equals( 42 ) );
-	}
-
 	/**
 	 * @param array $elements
 	 *

tests/unit/Snak/SnakListTest.php

@@ -2,6 +2,7 @@
 
 namespace Wikibase\DataModel\Tests\Snak;
 
+use Comparable;
 use DataValues\StringValue;
 use Hashable;
 use InvalidArgumentException;
@@ -294,6 +295,50 @@ public function testOrderByProperty( SnakList $snakList, SnakList $expected, arr
 		}
 	}
 
+	public function testComparableInterface() {
+		$this->assertInstanceOf( Comparable::class, new SnakList() );
+	}
+
+	/**
+	 * @dataProvider equalsProvider
+	 */
+	public function testEquals( SnakList $list1, SnakList $list2, $expected ) {
+		$this->assertSame( $expected, $list1->equals( $list2 ) );
+	}
+
+	public function equalsProvider() {
+		$empty = new SnakList();
+		$oneSnak = new SnakList( [ new PropertyNoValueSnak( 1 ) ] );
+
+		return [
+			'empty object is equal to itself' => [
+				$empty,
+				$empty,
+				true
+			],
+			'non-empty object is equal to itself' => [
+				$oneSnak,
+				$oneSnak,
+				true
+			],
+			'different empty objects are equal' => [
+				$empty,
+				new SnakList(),
+				true
+			],
+			'different objects with same content are equal' => [
+				$oneSnak,
+				new SnakList( [ new PropertyNoValueSnak( 1 ) ] ),
+				true
+			],
+			'different objects with different content are not equal' => [
+				$oneSnak,
+				new SnakList( [ new PropertyNoValueSnak( 2 ) ] ),
+				false
+			],
+		];
+	}
+
 	public function testHashableInterface() {
 		$this->assertInstanceOf( Hashable::class, new SnakList() );
 	}