Merge pull request #166 from wmde/StatementListDiffer

ClaimListDiffer -> StatementListDiffer

Author: thiemowmde

RELEASE-NOTES.md

@@ -50,12 +50,13 @@ Other breaking changes:
 * Removed `ClaimAggregate` interface, which is thus no longer implemented by `Entity`
 * `HashableObjectStorage::getValueHash` no longer accepts a first optional parameter
 * `MapHasher` and `MapValueHasher` are now package private
+* Removed `Claims::getDiff`
 
 #### Additions
 
 * Added `ClaimList`
 * Added `StatementList`
-* Added `ClaimListDiffer`
+* Added `StatementListDiffer`
 * Added `PropertyDataTypeLookup` and trivial implementation `InMemoryDataTypeLookup`
 * Added `PropertyNotFoundException`
 * Added `ItemDiffer` and `PropertyDiffer`
@@ -66,6 +67,7 @@ Other breaking changes:
 
 #### Deprecations
 
+* Deprecated `Claims`
 * Deprecated `Entity::setId`
 * Deprecated `Entity::newClaim`
 * Deprecated `Entity::getAllSnaks`

src/Claim/Claims.php

@@ -12,6 +12,7 @@
 use Wikibase\DataModel\ByPropertyIdArray;
 use Wikibase\DataModel\Entity\PropertyId;
 use Wikibase\DataModel\Snak\Snak;
+use Wikibase\DataModel\Statement\StatementListDiffer;
 
 /**
  * A claim (identified using it's GUID) can only be added once.
@@ -367,19 +368,6 @@ public function getHashes() {
 		return $snaks;
 	}
 
-	/**
-	 * @since 0.4
-	 *
-	 * @param Claims $claims
-	 *
-	 * @return Diff
-	 * @throws UnexpectedValueException
-	 */
-	public function getDiff( Claims $claims ) {
-		$differ = new ClaimListDiffer();
-		return $differ->getDiff( $this, $claims );
-	}
-
 	/**
 	 * Returns a hash based on the value of the object.
 	 * The hash is based on the hashes of the claims contained,

src/Entity/Diff/ItemDiffer.php

@@ -9,6 +9,7 @@
 use Wikibase\DataModel\Entity\Item;
 use Wikibase\DataModel\Entity\ItemId;
 use Wikibase\DataModel\SiteLink;
+use Wikibase\DataModel\Statement\StatementListDiffer;
 
 /**
  * @since 1.0
@@ -51,8 +52,8 @@ public function diffItems( Item $from, Item $to ) {
 		$differ = new MapDiffer( true );
 		$diffOps = $differ->doDiff( $this->toDiffArray( $from ), $this->toDiffArray( $to ) );
 
-		$claims = new Claims( $from->getClaims() );
-		$diffOps['claim'] = $claims->getDiff( new Claims( $to->getClaims() ) );
+		$statementListDiffer = new StatementListDiffer();
+		$diffOps['claim'] = $statementListDiffer->getDiff( $from->getStatements(), $to->getStatements() );
 
 		return new ItemDiff( $diffOps );
 	}

src/Claim/ClaimListDiffer.php src/Statement/StatementListDiffer.phpsrc/Claim/ClaimListDiffer.php renamed to src/Statement/StatementListDiffer.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Wikibase\DataModel\Claim;
+namespace Wikibase\DataModel\Statement;
 
 use Diff\Differ\MapDiffer;
 use Diff\DiffOp\Diff\Diff;
@@ -9,36 +9,40 @@
 use Diff\DiffOp\DiffOpChange;
 use Diff\DiffOp\DiffOpRemove;
 use UnexpectedValueException;
+use Wikibase\DataModel\Claim\Claim;
+use Wikibase\DataModel\Claim\Claims;
 
 /**
  * @since 1.0
  *
  * @licence GNU GPL v2+
  * @author Jeroen De Dauw < jeroendedauw@gmail.com >
  */
-class ClaimListDiffer {
+class StatementListDiffer {
 
 	/**
 	 * @since 1.0
 	 *
-	 * @param Claims $fromClaims
-	 * @param Claims $toClaims
+	 * @param StatementList $fromStatements
+	 * @param StatementList $toStatements
 	 *
 	 * @return Diff
 	 * @throws UnexpectedValueException
 	 */
-	public function getDiff( Claims $fromClaims, Claims $toClaims ) {
+	public function getDiff( StatementList $fromStatements, StatementList $toStatements ) {
 		$differ = new MapDiffer();
+		$fromStatements = new Claims( $fromStatements->toArray() );
+		$toStatements = new Claims( $toStatements->toArray() );
 
 		$hashDifferences = $differ->doDiff(
-			$fromClaims->getHashes(),
-			$toClaims->getHashes()
+			$fromStatements->getHashes(),
+			$toStatements->getHashes()
 		);
 
 		$diff = new Diff( array(), true );
 
 		foreach ( $hashDifferences as $guid => $diffOp ) {
-			$diff[$guid] = $this->getDiffOp( $diffOp, $guid, $toClaims, $fromClaims );
+			$diff[$guid] = $this->getDiffOp( $diffOp, $guid, $toStatements, $fromStatements );
 		}
 
 		return $diff;

tests/unit/Claim/ClaimListDifferTest.php

@@ -503,120 +503,6 @@ public function testDuplicateClaims() {
 		$this->assertNull( $list->getClaimWithGuid( $secondClaim->getGuid() ) );
 	}
 
-	public function getDiffProvider() {
-		$argLists = array();
-
-		$claim0 = $this->makeClaim( new PropertyNoValueSnak( 42 ) );
-		$claim1 = $this->makeClaim( new PropertySomeValueSnak( 42 ) );
-		$claim2 = $this->makeClaim( new PropertyValueSnak( 42, new StringValue( 'ohi' ) ) );
-		$claim3 = $this->makeClaim( new PropertyNoValueSnak( 1 ) );
-		$claim4 = $this->makeClaim( new PropertyNoValueSnak( 2 ) );
-
-		$statement0 = $this->makeStatement( new PropertyNoValueSnak( 5 ) );
-		$statement0->setRank( Statement::RANK_PREFERRED );
-
-		$statement1 = $this->makeStatement( new PropertyNoValueSnak( 5 ) );
-		$statement1->setReferences( new ReferenceList( array( new Reference(
-			new SnakList( array( new PropertyValueSnak( 10, new StringValue( 'spam' ) ) ) )
-		) ) ) );
-
-		// same GUID, changed main snak
-		$claim2v2 = unserialize( serialize( $claim2 ) );
-		$claim2v2->setMainSnak( new PropertyValueSnak( 42, new StringValue( 'omnomnom' ) ) );
-
-		// different GUID, same contents, same hash
-		$claim0a = unserialize( serialize( $claim0 ) );
-		$claim0a->setGuid( 'TEST$claim0x' );
-		$claim0a->setMainSnak( new PropertyValueSnak( 99, new StringValue( 'frob' ) ) );
-
-		// same GUID as $claim0a, same content/hash as $claim0
-		$claim0b = unserialize( serialize( $claim0 ) );
-		$claim0b->setGuid( 'TEST$claim0x' );
-
-		$source = new Claims();
-		$target = new Claims();
-		$expected = new Diff( array(), true );
-		$argLists[] = array( $source, $target, $expected, 'Two empty lists should result in an empty diff' );
-
-
-		$source = new Claims();
-		$target = new Claims( array( $claim0 ) );
-		$expected = new Diff( array( $claim0->getGuid() => new DiffOpAdd( $claim0 ) ), true );
-		$argLists[] = array( $source, $target, $expected, 'List with no entries to list with one should result in one add op' );
-
-
-		$source = new Claims( array( $claim0 ) );
-		$target = new Claims();
-		$expected = new Diff( array( $claim0->getGuid() => new DiffOpRemove( $claim0 ) ), true );
-		$argLists[] = array( $source, $target, $expected, 'List with one entry to an empty list should result in one remove op' );
-
-
-		$source = new Claims( array( $claim0, $claim3, $claim2 ) );
-		$target = new Claims( array( $claim0, $claim2, $claim3 ) );
-		$expected = new Diff( array(), true );
-		$argLists[] = array( $source, $target, $expected, 'Two identical lists should result in an empty diff' );
-
-
-		$source = new Claims( array( $claim0 ) );
-		$target = new Claims( array( $claim1 ) );
-		$expected = new Diff( array(
-			$claim1->getGuid() => new DiffOpAdd( $claim1 ),
-			$claim0->getGuid() => new DiffOpRemove( $claim0 )
-		), true );
-		$argLists[] = array( $source, $target, $expected, 'Two lists with each a single different entry should result into one add and one remove op' );
-
-
-		$source = new Claims( array( $claim2, $claim3, $claim0, $claim4 ) );
-		$target = new Claims( array( $claim2, $claim1, $claim3, $claim4 ) );
-		$expected = new Diff( array(
-			$claim1->getGuid() => new DiffOpAdd( $claim1 ),
-			$claim0->getGuid() => new DiffOpRemove( $claim0 )
-		), true );
-		$argLists[] = array( $source, $target, $expected, 'Two lists with identical items except for one change should result in one add and one remove op' );
-
-
-		$source = new Claims( array( $claim0, $claim0, $claim3, $claim2, $claim2, $claim2, $statement0 ) );
-		$target = new Claims( array( $claim0, $claim0, $claim2, $claim3, $claim2, $claim2, $statement0 ) );
-		$expected = new Diff( array(), true );
-		$argLists[] = array( $source, $target, $expected, 'Two identical lists with duplicate items should result in an empty diff' );
-
-
-		$source = new Claims( array( $statement0, $statement1, $claim0 ) );
-		$target = new Claims( array( $claim1, $claim1, $claim0, $statement1 ) );
-		$expected = new Diff( array(
-			$claim1->getGuid() => new DiffOpAdd( $claim1 ),
-			$statement0->getGuid() => new DiffOpRemove( $statement0 ),
-		), true );
-		$argLists[] = array( $source, $target, $expected, 'Two lists with duplicate items and a different entry should result into one add and one remove op' );
-
-		$source = new Claims( array( $claim0, $claim3, $claim2 ) );
-		$target = new Claims( array( $claim0, $claim2v2, $claim3 ) );
-		$expected = new Diff( array( $claim2->getGuid() => new DiffOpChange( $claim2, $claim2v2 ) ), true );
-		$argLists[] = array( $source, $target, $expected, 'Changing the value of a claim should result in a change op' );
-
-		$source = new Claims( array( $claim0, $claim0a ) );
-		$target = new Claims( array( $claim0, $claim0b ) );
-		$expected = new Diff( array( $claim0a->getGuid() => new DiffOpChange( $claim0a, $claim0b ) ), true );
-		$argLists[] = array( $source, $target, $expected, 'It should be possible for a claim to become the same as another claim' );
-
-		return $argLists;
-	}
-
-	/**
-	 * @dataProvider getDiffProvider
-	 *
-	 * @param Claims $source
-	 * @param Claims $target
-	 * @param Diff $expected
-	 * @param string $message
-	 */
-	public function testGetDiff( Claims $source, Claims $target, Diff $expected, $message ) {
-		$actual = $source->getDiff( $target );
-
-		// Note: this makes order of inner arrays relevant, and this order is not guaranteed by the interface
-		$this->assertEquals( $expected->getOperations(), $actual->getOperations(), $message );
-	}
-
 	public function testGetHash() {
 		$claimsA = new Claims();
 		$claimsB = new Claims();