DRAFT some sort of summary builder thing

src/Summary/SummaryBuilder.php

@@ -0,0 +1,91 @@
+<?php
+
+namespace Wikibase\DataModel\Services\Summary;
+
+use Comparable;
+use Diff\DiffOp\AtomicDiffOp;
+use Diff\DiffOp\Diff\Diff;
+use Wikibase\DataModel\Entity\EntityDocument;
+use Wikibase\DataModel\Services\Diff\EntityDiffer;
+use Wikibase\DataModel\Services\Diff\ItemDiff;
+
+/**
+ * This is a stupid rough draft.....@deprecated
+ * RFC......
+ *
+ * TODO: i18n, plurals, linking stuff?, priortise certain changes, limit?
+ */
+class SummaryBuilder {
+
+	/**
+	 * @param EntityDocument $orig
+	 * @param EntityDocument $changed
+	 *
+	 * @return string
+	 */
+	public function get( EntityDocument $orig, EntityDocument $changed ) {
+
+		//TODO could just check the diff is null?
+		if ( $orig instanceof Comparable && $changed instanceof Comparable ) {
+			if ( $orig->equals( $changed ) ) {
+				return 'Null change';
+			}
+		}
+
+		//TODO isEmpty should be in an interface?
+		if ( method_exists( $changed, 'isEmpty' ) ) {
+			if ( $changed->isEmpty( $changed ) ) {
+				return 'Entity Emptied';
+			}
+		}
+
+		//TODO inject entityDiffer
+		$entityDiffer = new EntityDiffer();
+		$entityDiff = $entityDiffer->diffEntities( $orig, $changed );
+
+		/** @var Diff[] $diffs */
+		$diffs = array();
+		$diffs['labels'] = $entityDiff->getLabelsDiff();
+		$diffs['descriptions'] = $entityDiff->getDescriptionsDiff();
+		$diffs['aliases'] = $entityDiff->getAliasesDiff();
+		$diffs['claims'] = $entityDiff->getClaimsDiff();
+		if( $entityDiff instanceof ItemDiff ) {
+			$diffs['sitelinks'] = $entityDiff->getSiteLinkDiff();
+		}
+
+		foreach ( $diffs as $type => $diff ) {
+			if( $diff->isEmpty() ) {
+				unset( $diffs[$type] );
+			}
+		}
+
+		$summaryParts = array();
+		foreach( $diffs as $type => $diff ) {
+			/** @var AtomicDiffOp[] $diffs */
+			$typeDiffs = array();
+			$typeDiffs['added'] = $diff->getAdditions();
+			$typeDiffs['removed'] = $diff->getRemovals();
+			$typeDiffs['changed'] = $diff->getChanges();
+
+			$typeSummaryParts = array();
+			foreach ( $typeDiffs as $typeType => $typeDiff ) {
+				if( !empty( $typeDiff ) ) {
+					$typeSummaryParts[] = $typeType . ' ' . count( $typeDiff ) . ' ' . $type;
+				}
+			}
+
+			if( !empty( $typeSummaryParts ) ) {
+				$summaryParts[] = implode( ', ', $typeSummaryParts );
+			}
+
+		}
+
+		if ( !empty( $summaryParts ) ) {
+			return implode( ': ', $summaryParts );
+		}
+
+		return 'Could not create a good summary.....';
+
+	}
+
+}

tests/unit/Summary/SummaryBuilderTest.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace Wikibase\DataModel\Services\Tests;
+
+use Wikibase\DataModel\Entity\EntityDocument;
+use Wikibase\DataModel\Entity\Item;
+use Wikibase\DataModel\Services\Summary\SummaryBuilder;
+
+class SummaryBuilderTest extends \PHPUnit_Framework_TestCase {
+
+	public function provideStuff() {
+		$emptyItem = new Item();
+
+		$itemWithOneLabelEn = new Item();
+		$itemWithOneLabelEn->setLabel( 'en', 'Foo' );
+
+		$itemWithOneDescriptionEnFoo = new Item();
+		$itemWithOneDescriptionEnFoo->setDescription( 'en', 'Foo' );
+
+		$itemWithOneDescriptionEnBar = new Item();
+		$itemWithOneDescriptionEnBar->setDescription( 'en', 'Bar' );
+
+		$itemWithOneDescriptionDe = new Item();
+		$itemWithOneDescriptionDe->setDescription( 'de', 'Foo' );
+
+		return array(
+			array(
+				$emptyItem,
+				$emptyItem,
+				'Null change'
+			),
+			array(
+				$itemWithOneDescriptionEnFoo,
+				$itemWithOneDescriptionEnFoo,
+				'Null change'
+			),
+			array(
+				$itemWithOneDescriptionEnFoo,
+				$emptyItem,
+				'Entity Emptied'
+			),
+			array(
+				$emptyItem,
+				$itemWithOneDescriptionEnFoo,
+				'added 1 descriptions'
+			),
+			array(
+				$itemWithOneDescriptionEnFoo,
+				$itemWithOneDescriptionEnBar,
+				'changed 1 descriptions'
+			),
+			array(
+				$itemWithOneDescriptionEnFoo,
+				$itemWithOneDescriptionDe,
+				'added 1 descriptions, removed 1 descriptions'
+			),
+		);
+	}
+
+	/**
+	 * @dataProvider provideStuff
+	 */
+	public function testGetPropertyIds( EntityDocument $from, EntityDocument $to, $expectedSummary ) {
+		$builder = new SummaryBuilder();
+		$summary = $builder->get( $from, $to );
+		$this->assertEquals( $expectedSummary, $summary );
+	}
+
+}