PropertyTest::testCloneIsEqualButNotIdentical() - Code Metrics - Inspection of "Remove clear from Entity, Item and Property" - wmde/WikibaseDataModel - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — entity-clear ( 1a048b...ca6eb6 )

by Bene

created 2016-03-09 22:08 UTC

PropertyTest::testCloneIsEqualButNotIdentical() A

↳ Parent: PropertyTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	17
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	17
rs	9.4285
cc	1
eloc	12
nc	1
nop	2

<?php

namespace Wikibase\DataModel\Tests\Entity;

use InvalidArgumentException;
use PHPUnit_Framework_TestCase;
use Wikibase\DataModel\Entity\Property;
use Wikibase\DataModel\Entity\PropertyId;
use Wikibase\DataModel\Snak\PropertyNoValueSnak;
use Wikibase\DataModel\Snak\PropertySomeValueSnak;
use Wikibase\DataModel\Statement\Statement;
use Wikibase\DataModel\Statement\StatementList;
use Wikibase\DataModel\Term\AliasGroup;
use Wikibase\DataModel\Term\AliasGroupList;
use Wikibase\DataModel\Term\Fingerprint;
use Wikibase\DataModel\Term\Term;
use Wikibase\DataModel\Term\TermList;

/**
 * @covers Wikibase\DataModel\Entity\Property
 *
 * @group Wikibase
 * @group WikibaseProperty
 * @group WikibaseDataModel
 * @group PropertyTest
 *
 * @licence GNU GPL v2+
 * @author Jeroen De Dauw < [email protected] >
 */
class PropertyTest extends PHPUnit_Framework_TestCase {

	private function getNewEmpty() {
		return Property::newFromType( 'string' );
	}

	public function testConstructorWithAllParameters() {
		$property = new Property(
			new PropertyId( 'P42' ),
			new Fingerprint(),
			'string',
			new StatementList()
		);
		$this->assertInstanceOf( 'Wikibase\DataModel\Entity\Property', $property );
		$this->assertEquals( new PropertyId( 'P42' ), $property->getId() );
		$this->assertEquals( new Fingerprint(), $property->getFingerprint() );
		$this->assertEquals( 'string', $property->getDataTypeId() );
		$this->assertEquals( new StatementList(), $property->getStatements() );
	}

	public function testConstructorWithMinimalParameters() {
		$property = new Property( null, null, '' );
		$this->assertInstanceOf( 'Wikibase\DataModel\Entity\Property', $property );
		$this->assertNull( $property->getId() );
		$this->assertEquals( new Fingerprint(), $property->getFingerprint() );
		$this->assertEquals( '', $property->getDataTypeId() );
		$this->assertEquals( new StatementList(), $property->getStatements() );
	}

	/**
	 * @expectedException InvalidArgumentException
	 */
	public function testGivenInvalidType_ConstructorThrowsException() {
		new Property( null, null, null );
	}

	public function testNewFromType() {
		$property = Property::newFromType( 'string' );
		$this->assertInstanceOf( 'Wikibase\DataModel\Entity\Property', $property );
		$this->assertEquals( 'string', $property->getDataTypeId() );
	}

	public function testSetAndGetDataTypeId() {
		$property = Property::newFromType( 'string' );

		foreach ( array( 'string', 'foobar', 'nyan', 'string' ) as $typeId ) {
			$property->setDataTypeId( $typeId );
			$this->assertEquals( $typeId, $property->getDataTypeId() );
		}
	}

	public function testWhenIdSetWithNumber_GetIdReturnsPropertyId() {
		$property = Property::newFromType( 'string' );
		$property->setId( 42 );

		$this->assertHasCorrectIdType( $property );
	}

	protected function assertHasCorrectIdType( Property $property ) {
		$this->assertInstanceOf( 'Wikibase\DataModel\Entity\PropertyId', $property->getId() );
	}

	public function testWhenIdSetWithPropertyId_GetIdReturnsPropertyId() {
		$property = Property::newFromType( 'string' );
		$property->setId( new PropertyId( 'P42' ) );

		$this->assertHasCorrectIdType( $property );
	}

	public function testPropertyWithTypeIsEmpty() {
		$this->assertTrue( Property::newFromType( 'string' )->isEmpty() );
	}

	public function testPropertyWithIdIsEmpty() {
		$property = Property::newFromType( 'string' );
		$property->setId( 1337 );
		$this->assertTrue( $property->isEmpty() );
	}

	public function testPropertyWithFingerprintIsNotEmpty() {
		$property = Property::newFromType( 'string' );
		$property->getFingerprint()->setAliasGroup( 'en', array( 'foo' ) );
		$this->assertFalse( $property->isEmpty() );
	}

	public function testGetStatementsReturnsEmptyListForEmptyProperty() {
		$property = Property::newFromType( 'string' );

		$this->assertEquals( new StatementList(), $property->getStatements() );
	}

	public function testSetAndGetStatements() {
		$property = Property::newFromType( 'string' );

		$statementList = $this->newNonEmptyStatementList();
		$property->setStatements( $statementList );

		$this->assertEquals( $statementList, $property->getStatements() );
	}

	private function newNonEmptyStatementList() {
		$statementList = new StatementList();
		$statementList->addNewStatement( new PropertyNoValueSnak( 42 ) );
		$statementList->addNewStatement( new PropertyNoValueSnak( 1337 ) );

		return $statementList;
	}

	public function equalsProvider() {
		$firstProperty = Property::newFromType( 'string' );
		$firstProperty->setStatements( $this->newNonEmptyStatementList() );

		$secondProperty = Property::newFromType( 'string' );
		$secondProperty->setStatements( $this->newNonEmptyStatementList() );

		$secondPropertyWithId = $secondProperty->copy();
		$secondPropertyWithId->setId( 42 );

		$differentId = $secondPropertyWithId->copy();
		$differentId->setId( 43 );

		return array(
			array( Property::newFromType( 'string' ), Property::newFromType( 'string' ) ),
			array( $firstProperty, $secondProperty ),
			array( $secondProperty, $secondPropertyWithId ),
			array( $secondPropertyWithId, $differentId ),
		);
	}

	/**
	 * @dataProvider equalsProvider
	 */
	public function testEquals( Property $firstProperty, Property $secondProperty ) {
		$this->assertTrue( $firstProperty->equals( $secondProperty ) );
		$this->assertTrue( $secondProperty->equals( $firstProperty ) );
	}

	private function getBaseProperty() {
		$property = Property::newFromType( 'string' );

		$property->setId( 42 );
		$property->getFingerprint()->setLabel( 'en', 'Same' );
		$property->getFingerprint()->setDescription( 'en', 'Same' );
		$property->getFingerprint()->setAliasGroup( 'en', array( 'Same' ) );
		$property->setStatements( $this->newNonEmptyStatementList() );

		return $property;
	}

	public function notEqualsProvider() {
		$differentLabel = $this->getBaseProperty();
		$differentLabel->getFingerprint()->setLabel( 'en', 'Different' );

		$differentDescription = $this->getBaseProperty();
		$differentDescription->getFingerprint()->setDescription( 'en', 'Different' );

		$differentAlias = $this->getBaseProperty();
		$differentAlias->getFingerprint()->setAliasGroup( 'en', array( 'Different' ) );

		$differentStatement = $this->getBaseProperty();
		$differentStatement->setStatements( new StatementList() );

		$property = $this->getBaseProperty();

		return array(
			'empty' => array( $property, Property::newFromType( 'string' ) ),
			'label' => array( $property, $differentLabel ),
			'description' => array( $property, $differentDescription ),
			'alias' => array( $property, $differentAlias ),
			'dataType' => array( Property::newFromType( 'string' ), Property::newFromType( 'foo' ) ),
			'statement' => array( $property, $differentStatement ),
		);
	}

	/**
	 * @dataProvider notEqualsProvider
	 */
	public function testNotEquals( Property $firstProperty, Property $secondProperty ) {
		$this->assertFalse( $firstProperty->equals( $secondProperty ) );
		$this->assertFalse( $secondProperty->equals( $firstProperty ) );
	}

	public function testPropertyWithStatementsIsNotEmpty() {
		$property = Property::newFromType( 'string' );
		$property->setStatements( $this->newNonEmptyStatementList() );

		$this->assertFalse( $property->isEmpty() );
	}

	public function cloneProvider() {
		$property = new Property( new PropertyId( 'P1' ), null, 'string' );
		$property->setLabel( 'en', 'original' );
		$property->getStatements()->addNewStatement( new PropertyNoValueSnak( 1 ) );

		return array(
			'copy' => array( $property, $property->copy() ),
			'native clone' => array( $property, clone $property ),
		);
	}

	/**
	 * @dataProvider cloneProvider
	 */
	public function testCloneIsEqualButNotIdentical( Property $original, Property $clone ) {
		$this->assertNotSame( $original, $clone );
		$this->assertTrue( $original->equals( $clone ) );
		$this->assertSame(
			$original->getId(),
			$clone->getId(),
			'id is immutable and must not be cloned'
		);

		// The clone must not reference the same mutable objects
		$this->assertNotSame( $original->getFingerprint(), $clone->getFingerprint() );
		$this->assertNotSame( $original->getStatements(), $clone->getStatements() );
		$this->assertNotSame(
			$original->getStatements()->getFirstStatementWithGuid( null ),
			$clone->getStatements()->getFirstStatementWithGuid( null )
		);
	}

	/**
	 * @dataProvider cloneProvider
	 */
	public function testOriginalDoesNotChangeWithClone( Property $original, Property $clone ) {
		$originalStatement = $original->getStatements()->getFirstStatementWithGuid( null );
		$clonedStatement = $clone->getStatements()->getFirstStatementWithGuid( null );

		$clone->setLabel( 'en', 'clone' );
		$clone->setDescription( 'en', 'clone' );
		$clone->setAliases( 'en', array( 'clone' ) );
		$clonedStatement->setGuid( 'clone' );
		$clonedStatement->setMainSnak( new PropertySomeValueSnak( 666 ) );
		$clonedStatement->setRank( Statement::RANK_DEPRECATED );
		$clonedStatement->getQualifiers()->addSnak( new PropertyNoValueSnak( 1 ) );
		$clonedStatement->getReferences()->addNewReference( new PropertyNoValueSnak( 1 ) );

		$this->assertSame( 'original', $original->getFingerprint()->getLabel( 'en' )->getText() );
		$this->assertFalse( $original->getFingerprint()->hasDescription( 'en' ) );
		$this->assertFalse( $original->getFingerprint()->hasAliasGroup( 'en' ) );
		$this->assertNull( $originalStatement->getGuid() );
		$this->assertSame( 'novalue', $originalStatement->getMainSnak()->getType() );
		$this->assertSame( Statement::RANK_NORMAL, $originalStatement->getRank() );
		$this->assertTrue( $originalStatement->getQualifiers()->isEmpty() );
		$this->assertTrue( $originalStatement->getReferences()->isEmpty() );
	}

	// Below are tests copied from EntityTest

	public function labelProvider() {
		return array(
			array( 'en', 'spam' ),
			array( 'en', 'spam', 'spam' ),
			array( 'de', 'foo bar baz' ),
		);
	}

	/**
	 * @dataProvider labelProvider
	 * @param string $languageCode
	 * @param string $labelText
	 * @param string $moarText
	 */
	public function testSetLabel( $languageCode, $labelText, $moarText = 'ohi there' ) {
		$entity = $this->getNewEmpty();

		$entity->setLabel( $languageCode, $labelText );

		$this->assertEquals( $labelText, $entity->getFingerprint()->getLabel( $languageCode )->getText() );

		$entity->setLabel( $languageCode, $moarText );

		$this->assertEquals( $moarText, $entity->getFingerprint()->getLabel( $languageCode )->getText() );
	}

	public function descriptionProvider() {
		return array(
			array( 'en', 'spam' ),
			array( 'en', 'spam', 'spam' ),
			array( 'de', 'foo bar baz' ),
		);
	}

	/**
	 * @dataProvider descriptionProvider
	 * @param string $languageCode
	 * @param string $description
	 * @param string $moarText
	 */
	public function testSetDescription( $languageCode, $description, $moarText = 'ohi there' ) {
		$entity = $this->getNewEmpty();

		$entity->setDescription( $languageCode, $description );

		$this->assertEquals( $description, $entity->getFingerprint()->getDescription( $languageCode )->getText() );

		$entity->setDescription( $languageCode, $moarText );

		$this->assertEquals( $moarText, $entity->getFingerprint()->getDescription( $languageCode )->getText() );
	}

	public function aliasesProvider() {
		return array(
			array( array(
				       'en' => array( array( 'spam' ) )
			       ) ),
			array( array(
				       'en' => array( array( 'foo', 'bar', 'baz' ) )
			       ) ),
			array( array(
				       'en' => array( array( 'foo', 'bar' ), array( 'baz', 'spam' ) )
			       ) ),
			array( array(
				       'en' => array( array( 'foo', 'bar', 'baz' ) ),
				       'de' => array( array( 'foobar' ), array( 'baz' ) ),
			       ) ),
			// with duplicates
			array( array(
				       'en' => array( array( 'spam', 'ham', 'ham' ) )
			       ) ),
			array( array(
				       'en' => array( array( 'foo', 'bar' ), array( 'bar', 'spam' ) )
			       ) ),
		);
	}

	/**
	 * @dataProvider aliasesProvider
	 */
	public function testSetAliases( array $aliasesLists ) {
		$entity = $this->getNewEmpty();

		foreach ( $aliasesLists as $langCode => $aliasesList ) {
			foreach ( $aliasesList as $aliases ) {
				$entity->setAliases( $langCode, $aliases );
			}
		}

		foreach ( $aliasesLists as $langCode => $aliasesList ) {
			$expected = array_values( array_unique( array_pop( $aliasesList ) ) );
			asort( $aliasesList );

			$actual = $entity->getFingerprint()->getAliasGroup( $langCode )->getAliases();
			asort( $actual );

			$this->assertEquals( $expected, $actual );
		}
	}

	/**
	 * @dataProvider aliasesProvider
	 */
	public function testSetEmptyAlias( array $aliasesLists ) {
		$entity = $this->getNewEmpty();

		foreach ( $aliasesLists as $langCode => $aliasesList ) {
			foreach ( $aliasesList as $aliases ) {
				$entity->setAliases( $langCode, $aliases );
			}
		}
		$entity->setAliases( 'zh', array( 'wind', 'air', '', 'fire' ) );
		$entity->setAliases( 'zu', array( '', '' ) );

		foreach ( $aliasesLists as $langCode => $aliasesList ) {
			$expected = array_values( array_unique( array_pop( $aliasesList ) ) );
			asort( $aliasesList );

			$actual = $entity->getFingerprint()->getAliasGroup( $langCode )->getAliases();
			asort( $actual );

			$this->assertEquals( $expected, $actual );
		}
	}

	public function instanceProvider() {
		$entities = array();

		// empty
		$entity = $this->getNewEmpty();
		$entities[] = $entity;

		// ID only
		$entity = clone $entity;
		$entity->setId( 44 );

		$entities[] = $entity;

		// with labels and stuff
		$entity = $this->getNewEmpty();
		$entity->setAliases( 'en', array( 'o', 'noez' ) );
		$entity->setLabel( 'de', 'spam' );
		$entity->setDescription( 'en', 'foo bar baz' );

		$entities[] = $entity;

		// with labels etc and ID
		$entity = clone $entity;
		$entity->setId( 42 );

		$entities[] = $entity;

		$argLists = array();

		foreach ( $entities as $entity ) {
			$argLists[] = array( $entity );
		}

		return $argLists;
	}

	/**
	 * @dataProvider instanceProvider
	 * @param Property $entity
	 */
	public function testCopy( Property $entity ) {
		$copy = $entity->copy();

		// The equality method alone is not enough since it does not check the IDs.
		$this->assertTrue( $entity->equals( $copy ) );
		$this->assertEquals( $entity->getId(), $copy->getId() );

		$this->assertNotSame( $entity, $copy );
	}

	public function testCopyRetainsLabels() {
		$property = Property::newFromType( 'string' );

		$property->getFingerprint()->setLabel( 'en', 'foo' );
		$property->getFingerprint()->setLabel( 'de', 'bar' );

		$newProperty = $property->copy();

		$this->assertTrue( $newProperty->getFingerprint()->getLabels()->hasTermForLanguage( 'en' ) );
		$this->assertTrue( $newProperty->getFingerprint()->getLabels()->hasTermForLanguage( 'de' ) );
	}

	/**
	 * @dataProvider instanceProvider
	 * @param Property $entity
	 */
	public function testSerialize( Property $entity ) {
		$string = serialize( $entity );

		$this->assertInternalType( 'string', $string );

		$instance = unserialize( $string );

		$this->assertTrue( $entity->equals( $instance ) );
		$this->assertEquals( $entity->getId(), $instance->getId() );
	}

	public function testWhenNoStuffIsSet_getFingerprintReturnsEmptyFingerprint() {
		$entity = $this->getNewEmpty();

		$this->assertEquals(
			new Fingerprint(),
			$entity->getFingerprint()
		);
	}

	public function testWhenLabelsAreSet_getFingerprintReturnsFingerprintWithLabels() {
		$entity = $this->getNewEmpty();

		$entity->setLabel( 'en', 'foo' );
		$entity->setLabel( 'de', 'bar' );

		$this->assertEquals(
			new Fingerprint(
				new TermList( array(
					new Term( 'en', 'foo' ),
					new Term( 'de', 'bar' ),
				) )
			),
			$entity->getFingerprint()
		);
	}

	public function testWhenTermsAreSet_getFingerprintReturnsFingerprintWithTerms() {
		$entity = $this->getNewEmpty();

		$entity->setLabel( 'en', 'foo' );
		$entity->setDescription( 'en', 'foo bar' );
		$entity->setAliases( 'en', array( 'foo', 'bar' ) );

		$this->assertEquals(
			new Fingerprint(
				new TermList( array(
					new Term( 'en', 'foo' ),
				) ),
				new TermList( array(
					new Term( 'en', 'foo bar' )
				) ),
				new AliasGroupList( array(
					new AliasGroup( 'en', array( 'foo', 'bar' ) )
				) )
			),
			$entity->getFingerprint()
		);
	}

	public function testGivenEmptyFingerprint_noTermsAreSet() {
		$entity = $this->getNewEmpty();
		$entity->setFingerprint( new Fingerprint() );

		$this->assertTrue( $entity->getFingerprint()->isEmpty() );
	}

	public function testGivenEmptyFingerprint_existingTermsAreRemoved() {
		$entity = $this->getNewEmpty();

		$entity->setLabel( 'en', 'foo' );
		$entity->setDescription( 'en', 'foo bar' );
		$entity->setAliases( 'en', array( 'foo', 'bar' ) );

		$entity->setFingerprint( new Fingerprint() );

		$this->assertTrue( $entity->getFingerprint()->isEmpty() );
	}

	public function testWhenSettingFingerprint_getFingerprintReturnsIt() {
		$fingerprint = new Fingerprint(
			new TermList( array(
				new Term( 'en', 'english label' ),
			) ),
			new TermList( array(
				new Term( 'en', 'english description' )
			) ),
			new AliasGroupList( array(
				new AliasGroup( 'en', array( 'first en alias', 'second en alias' ) )
			) )
		);

		$entity = $this->getNewEmpty();
		$entity->setFingerprint( $fingerprint );
		$newFingerprint = $entity->getFingerprint();

		$this->assertSame( $fingerprint, $newFingerprint );
	}

}


1			<?php
2
3			namespace Wikibase\DataModel\Tests\Entity;
4
5			use InvalidArgumentException;
6			use PHPUnit_Framework_TestCase;
7			use Wikibase\DataModel\Entity\Property;
8			use Wikibase\DataModel\Entity\PropertyId;
9			use Wikibase\DataModel\Snak\PropertyNoValueSnak;
10			use Wikibase\DataModel\Snak\PropertySomeValueSnak;
11			use Wikibase\DataModel\Statement\Statement;
12			use Wikibase\DataModel\Statement\StatementList;
13			use Wikibase\DataModel\Term\AliasGroup;
14			use Wikibase\DataModel\Term\AliasGroupList;
15			use Wikibase\DataModel\Term\Fingerprint;
16			use Wikibase\DataModel\Term\Term;
17			use Wikibase\DataModel\Term\TermList;
18
19			/**
20			* @covers Wikibase\DataModel\Entity\Property
21			*
22			* @group Wikibase
23			* @group WikibaseProperty
24			* @group WikibaseDataModel
25			* @group PropertyTest
26			*
27			* @licence GNU GPL v2+
28			* @author Jeroen De Dauw < [email protected] >
29			*/
30			class PropertyTest extends PHPUnit_Framework_TestCase {
31
32			private function getNewEmpty() {
33			return Property::newFromType( 'string' );
34			}
35
36			public function testConstructorWithAllParameters() {
37			$property = new Property(
38			new PropertyId( 'P42' ),
39			new Fingerprint(),
40			'string',
41			new StatementList()
42			);
43			$this->assertInstanceOf( 'Wikibase\DataModel\Entity\Property', $property );
44			$this->assertEquals( new PropertyId( 'P42' ), $property->getId() );
45			$this->assertEquals( new Fingerprint(), $property->getFingerprint() );
46			$this->assertEquals( 'string', $property->getDataTypeId() );
47			$this->assertEquals( new StatementList(), $property->getStatements() );
48			}
49
50			public function testConstructorWithMinimalParameters() {
51			$property = new Property( null, null, '' );
52			$this->assertInstanceOf( 'Wikibase\DataModel\Entity\Property', $property );
53			$this->assertNull( $property->getId() );
54			$this->assertEquals( new Fingerprint(), $property->getFingerprint() );
55			$this->assertEquals( '', $property->getDataTypeId() );
56			$this->assertEquals( new StatementList(), $property->getStatements() );
57			}
58
59			/**
60			* @expectedException InvalidArgumentException
61			*/
62			public function testGivenInvalidType_ConstructorThrowsException() {
63			new Property( null, null, null );
64			}
65
66			public function testNewFromType() {
67			$property = Property::newFromType( 'string' );
68			$this->assertInstanceOf( 'Wikibase\DataModel\Entity\Property', $property );
69			$this->assertEquals( 'string', $property->getDataTypeId() );
70			}
71
72			public function testSetAndGetDataTypeId() {
73			$property = Property::newFromType( 'string' );
74
75			foreach ( array( 'string', 'foobar', 'nyan', 'string' ) as $typeId ) {
76			$property->setDataTypeId( $typeId );
77			$this->assertEquals( $typeId, $property->getDataTypeId() );
78			}
79			}
80
81			public function testWhenIdSetWithNumber_GetIdReturnsPropertyId() {
82			$property = Property::newFromType( 'string' );
83			$property->setId( 42 );
84
85			$this->assertHasCorrectIdType( $property );
86			}
87
88			protected function assertHasCorrectIdType( Property $property ) {
89			$this->assertInstanceOf( 'Wikibase\DataModel\Entity\PropertyId', $property->getId() );
90			}
91
92			public function testWhenIdSetWithPropertyId_GetIdReturnsPropertyId() {
93			$property = Property::newFromType( 'string' );
94			$property->setId( new PropertyId( 'P42' ) );
95
96			$this->assertHasCorrectIdType( $property );
97			}
98
99			public function testPropertyWithTypeIsEmpty() {
100			$this->assertTrue( Property::newFromType( 'string' )->isEmpty() );
101			}
102
103			public function testPropertyWithIdIsEmpty() {
104			$property = Property::newFromType( 'string' );
105			$property->setId( 1337 );
106			$this->assertTrue( $property->isEmpty() );
107			}
108
109			public function testPropertyWithFingerprintIsNotEmpty() {
110			$property = Property::newFromType( 'string' );
111			$property->getFingerprint()->setAliasGroup( 'en', array( 'foo' ) );
112			$this->assertFalse( $property->isEmpty() );
113			}
114
115			public function testGetStatementsReturnsEmptyListForEmptyProperty() {
116			$property = Property::newFromType( 'string' );
117
118			$this->assertEquals( new StatementList(), $property->getStatements() );
119			}
120
121			public function testSetAndGetStatements() {
122			$property = Property::newFromType( 'string' );
123
124			$statementList = $this->newNonEmptyStatementList();
125			$property->setStatements( $statementList );
126
127			$this->assertEquals( $statementList, $property->getStatements() );
128			}
129
130			private function newNonEmptyStatementList() {
131			$statementList = new StatementList();
132			$statementList->addNewStatement( new PropertyNoValueSnak( 42 ) );
133			$statementList->addNewStatement( new PropertyNoValueSnak( 1337 ) );
134
135			return $statementList;
136			}
137
138			public function equalsProvider() {
139			$firstProperty = Property::newFromType( 'string' );
140			$firstProperty->setStatements( $this->newNonEmptyStatementList() );
141
142			$secondProperty = Property::newFromType( 'string' );
143			$secondProperty->setStatements( $this->newNonEmptyStatementList() );
144
145			$secondPropertyWithId = $secondProperty->copy();
146			$secondPropertyWithId->setId( 42 );
147
148			$differentId = $secondPropertyWithId->copy();
149			$differentId->setId( 43 );
150
151			return array(
152			array( Property::newFromType( 'string' ), Property::newFromType( 'string' ) ),
153			array( $firstProperty, $secondProperty ),
154			array( $secondProperty, $secondPropertyWithId ),
155			array( $secondPropertyWithId, $differentId ),
156			);
157			}
158
159			/**
160			* @dataProvider equalsProvider
161			*/
162			public function testEquals( Property $firstProperty, Property $secondProperty ) {
163			$this->assertTrue( $firstProperty->equals( $secondProperty ) );
164			$this->assertTrue( $secondProperty->equals( $firstProperty ) );
165			}
166
167			private function getBaseProperty() {
168			$property = Property::newFromType( 'string' );
169
170			$property->setId( 42 );
171			$property->getFingerprint()->setLabel( 'en', 'Same' );
172			$property->getFingerprint()->setDescription( 'en', 'Same' );
173			$property->getFingerprint()->setAliasGroup( 'en', array( 'Same' ) );
174			$property->setStatements( $this->newNonEmptyStatementList() );
175
176			return $property;
177			}
178
179			public function notEqualsProvider() {
180			$differentLabel = $this->getBaseProperty();
181			$differentLabel->getFingerprint()->setLabel( 'en', 'Different' );
182
183			$differentDescription = $this->getBaseProperty();
184			$differentDescription->getFingerprint()->setDescription( 'en', 'Different' );
185
186			$differentAlias = $this->getBaseProperty();
187			$differentAlias->getFingerprint()->setAliasGroup( 'en', array( 'Different' ) );
188
189			$differentStatement = $this->getBaseProperty();
190			$differentStatement->setStatements( new StatementList() );
191
192			$property = $this->getBaseProperty();
193
194			return array(
195			'empty' => array( $property, Property::newFromType( 'string' ) ),
196			'label' => array( $property, $differentLabel ),
197			'description' => array( $property, $differentDescription ),
198			'alias' => array( $property, $differentAlias ),
199			'dataType' => array( Property::newFromType( 'string' ), Property::newFromType( 'foo' ) ),
200			'statement' => array( $property, $differentStatement ),
201			);
202			}
203
204			/**
205			* @dataProvider notEqualsProvider
206			*/
207			public function testNotEquals( Property $firstProperty, Property $secondProperty ) {
208			$this->assertFalse( $firstProperty->equals( $secondProperty ) );
209			$this->assertFalse( $secondProperty->equals( $firstProperty ) );
210			}
211
212			public function testPropertyWithStatementsIsNotEmpty() {
213			$property = Property::newFromType( 'string' );
214			$property->setStatements( $this->newNonEmptyStatementList() );
215
216			$this->assertFalse( $property->isEmpty() );
217			}
218
219			public function cloneProvider() {
220			$property = new Property( new PropertyId( 'P1' ), null, 'string' );
221			$property->setLabel( 'en', 'original' );
222			$property->getStatements()->addNewStatement( new PropertyNoValueSnak( 1 ) );
223
224			return array(
225			'copy' => array( $property, $property->copy() ),
226			'native clone' => array( $property, clone $property ),
227			);
228			}
229
230			/**
231			* @dataProvider cloneProvider
232			*/
233			public function testCloneIsEqualButNotIdentical( Property $original, Property $clone ) {
234			$this->assertNotSame( $original, $clone );
235			$this->assertTrue( $original->equals( $clone ) );
236			$this->assertSame(
237			$original->getId(),
238			$clone->getId(),
239			'id is immutable and must not be cloned'
240			);
241
242			// The clone must not reference the same mutable objects
243			$this->assertNotSame( $original->getFingerprint(), $clone->getFingerprint() );
244			$this->assertNotSame( $original->getStatements(), $clone->getStatements() );
245			$this->assertNotSame(
246			$original->getStatements()->getFirstStatementWithGuid( null ),
247			$clone->getStatements()->getFirstStatementWithGuid( null )
248			);
249			}
250
251			/**
252			* @dataProvider cloneProvider
253			*/
254			public function testOriginalDoesNotChangeWithClone( Property $original, Property $clone ) {
255			$originalStatement = $original->getStatements()->getFirstStatementWithGuid( null );
256			$clonedStatement = $clone->getStatements()->getFirstStatementWithGuid( null );
257
258			$clone->setLabel( 'en', 'clone' );
259			$clone->setDescription( 'en', 'clone' );
260			$clone->setAliases( 'en', array( 'clone' ) );
261			$clonedStatement->setGuid( 'clone' );
262			$clonedStatement->setMainSnak( new PropertySomeValueSnak( 666 ) );
263			$clonedStatement->setRank( Statement::RANK_DEPRECATED );
264			$clonedStatement->getQualifiers()->addSnak( new PropertyNoValueSnak( 1 ) );
265			$clonedStatement->getReferences()->addNewReference( new PropertyNoValueSnak( 1 ) );
266
267			$this->assertSame( 'original', $original->getFingerprint()->getLabel( 'en' )->getText() );
268			$this->assertFalse( $original->getFingerprint()->hasDescription( 'en' ) );
269			$this->assertFalse( $original->getFingerprint()->hasAliasGroup( 'en' ) );
270			$this->assertNull( $originalStatement->getGuid() );
271			$this->assertSame( 'novalue', $originalStatement->getMainSnak()->getType() );
272			$this->assertSame( Statement::RANK_NORMAL, $originalStatement->getRank() );
273			$this->assertTrue( $originalStatement->getQualifiers()->isEmpty() );
274			$this->assertTrue( $originalStatement->getReferences()->isEmpty() );
275			}
276
277			// Below are tests copied from EntityTest
278
279			public function labelProvider() {
280			return array(
281			array( 'en', 'spam' ),
282			array( 'en', 'spam', 'spam' ),
283			array( 'de', 'foo bar baz' ),
284			);
285			}
286
287			/**
288			* @dataProvider labelProvider
289			* @param string $languageCode
290			* @param string $labelText
291			* @param string $moarText
292			*/
293			public function testSetLabel( $languageCode, $labelText, $moarText = 'ohi there' ) {
294			$entity = $this->getNewEmpty();
295
296			$entity->setLabel( $languageCode, $labelText );
297
298			$this->assertEquals( $labelText, $entity->getFingerprint()->getLabel( $languageCode )->getText() );
299
300			$entity->setLabel( $languageCode, $moarText );
301
302			$this->assertEquals( $moarText, $entity->getFingerprint()->getLabel( $languageCode )->getText() );
303			}
304
305			public function descriptionProvider() {
306			return array(
307			array( 'en', 'spam' ),
308			array( 'en', 'spam', 'spam' ),
309			array( 'de', 'foo bar baz' ),
310			);
311			}
312
313			/**
314			* @dataProvider descriptionProvider
315			* @param string $languageCode
316			* @param string $description
317			* @param string $moarText
318			*/
319			public function testSetDescription( $languageCode, $description, $moarText = 'ohi there' ) {
320			$entity = $this->getNewEmpty();
321
322			$entity->setDescription( $languageCode, $description );
323
324			$this->assertEquals( $description, $entity->getFingerprint()->getDescription( $languageCode )->getText() );
325
326			$entity->setDescription( $languageCode, $moarText );
327
328			$this->assertEquals( $moarText, $entity->getFingerprint()->getDescription( $languageCode )->getText() );
329			}
330
331			public function aliasesProvider() {
332			return array(
333			array( array(
334			'en' => array( array( 'spam' ) )
335			) ),
336			array( array(
337			'en' => array( array( 'foo', 'bar', 'baz' ) )
338			) ),
339			array( array(
340			'en' => array( array( 'foo', 'bar' ), array( 'baz', 'spam' ) )
341			) ),
342			array( array(
343			'en' => array( array( 'foo', 'bar', 'baz' ) ),
344			'de' => array( array( 'foobar' ), array( 'baz' ) ),
345			) ),
346			// with duplicates
347			array( array(
348			'en' => array( array( 'spam', 'ham', 'ham' ) )
349			) ),
350			array( array(
351			'en' => array( array( 'foo', 'bar' ), array( 'bar', 'spam' ) )
352			) ),
353			);
354			}
355
356			/**
357			* @dataProvider aliasesProvider
358			*/
359			public function testSetAliases( array $aliasesLists ) {
360			$entity = $this->getNewEmpty();
361
362			foreach ( $aliasesLists as $langCode => $aliasesList ) {
363			foreach ( $aliasesList as $aliases ) {
364			$entity->setAliases( $langCode, $aliases );
365			}
366			}
367
368			foreach ( $aliasesLists as $langCode => $aliasesList ) {
369			$expected = array_values( array_unique( array_pop( $aliasesList ) ) );
370			asort( $aliasesList );
371
372			$actual = $entity->getFingerprint()->getAliasGroup( $langCode )->getAliases();
373			asort( $actual );
374
375			$this->assertEquals( $expected, $actual );
376			}
377			}
378
379			/**
380			* @dataProvider aliasesProvider
381			*/
382			public function testSetEmptyAlias( array $aliasesLists ) {
383			$entity = $this->getNewEmpty();
384
385			foreach ( $aliasesLists as $langCode => $aliasesList ) {
386			foreach ( $aliasesList as $aliases ) {
387			$entity->setAliases( $langCode, $aliases );
388			}
389			}
390			$entity->setAliases( 'zh', array( 'wind', 'air', '', 'fire' ) );
391			$entity->setAliases( 'zu', array( '', '' ) );
392
393			foreach ( $aliasesLists as $langCode => $aliasesList ) {
394			$expected = array_values( array_unique( array_pop( $aliasesList ) ) );
395			asort( $aliasesList );
396
397			$actual = $entity->getFingerprint()->getAliasGroup( $langCode )->getAliases();
398			asort( $actual );
399
400			$this->assertEquals( $expected, $actual );
401			}
402			}
403
404			public function instanceProvider() {
405			$entities = array();
406
407			// empty
408			$entity = $this->getNewEmpty();
409			$entities[] = $entity;
410
411			// ID only
412			$entity = clone $entity;
413			$entity->setId( 44 );
414
415			$entities[] = $entity;
416
417			// with labels and stuff
418			$entity = $this->getNewEmpty();
419			$entity->setAliases( 'en', array( 'o', 'noez' ) );
420			$entity->setLabel( 'de', 'spam' );
421			$entity->setDescription( 'en', 'foo bar baz' );
422
423			$entities[] = $entity;
424
425			// with labels etc and ID
426			$entity = clone $entity;
427			$entity->setId( 42 );
428
429			$entities[] = $entity;
430
431			$argLists = array();
432
433			foreach ( $entities as $entity ) {
434			$argLists[] = array( $entity );
435			}
436
437			return $argLists;
438			}
439
440			/**
441			* @dataProvider instanceProvider
442			* @param Property $entity
443			*/
444			public function testCopy( Property $entity ) {
445			$copy = $entity->copy();
446
447			// The equality method alone is not enough since it does not check the IDs.
448			$this->assertTrue( $entity->equals( $copy ) );
449			$this->assertEquals( $entity->getId(), $copy->getId() );
450
451			$this->assertNotSame( $entity, $copy );
452			}
453
454			public function testCopyRetainsLabels() {
455			$property = Property::newFromType( 'string' );
456
457			$property->getFingerprint()->setLabel( 'en', 'foo' );
458			$property->getFingerprint()->setLabel( 'de', 'bar' );
459
460			$newProperty = $property->copy();
461
462			$this->assertTrue( $newProperty->getFingerprint()->getLabels()->hasTermForLanguage( 'en' ) );
463			$this->assertTrue( $newProperty->getFingerprint()->getLabels()->hasTermForLanguage( 'de' ) );
464			}
465
466			/**
467			* @dataProvider instanceProvider
468			* @param Property $entity
469			*/
470			public function testSerialize( Property $entity ) {
471			$string = serialize( $entity );
472
473			$this->assertInternalType( 'string', $string );
474
475			$instance = unserialize( $string );
476
477			$this->assertTrue( $entity->equals( $instance ) );
478			$this->assertEquals( $entity->getId(), $instance->getId() );
479			}
480
481			public function testWhenNoStuffIsSet_getFingerprintReturnsEmptyFingerprint() {
482			$entity = $this->getNewEmpty();
483
484			$this->assertEquals(
485			new Fingerprint(),
486			$entity->getFingerprint()
487			);
488			}
489
490			public function testWhenLabelsAreSet_getFingerprintReturnsFingerprintWithLabels() {
491			$entity = $this->getNewEmpty();
492
493			$entity->setLabel( 'en', 'foo' );
494			$entity->setLabel( 'de', 'bar' );
495
496			$this->assertEquals(
497			new Fingerprint(
498			new TermList( array(
499			new Term( 'en', 'foo' ),
500			new Term( 'de', 'bar' ),
501			) )
502			),
503			$entity->getFingerprint()
504			);
505			}
506
507			public function testWhenTermsAreSet_getFingerprintReturnsFingerprintWithTerms() {
508			$entity = $this->getNewEmpty();
509
510			$entity->setLabel( 'en', 'foo' );
511			$entity->setDescription( 'en', 'foo bar' );
512			$entity->setAliases( 'en', array( 'foo', 'bar' ) );
513
514			$this->assertEquals(
515			new Fingerprint(
516			new TermList( array(
517			new Term( 'en', 'foo' ),
518			) ),
519			new TermList( array(
520			new Term( 'en', 'foo bar' )
521			) ),
522			new AliasGroupList( array(
523			new AliasGroup( 'en', array( 'foo', 'bar' ) )
524			) )
525			),
526			$entity->getFingerprint()
527			);
528			}
529
530			public function testGivenEmptyFingerprint_noTermsAreSet() {
531			$entity = $this->getNewEmpty();
532			$entity->setFingerprint( new Fingerprint() );
533
534			$this->assertTrue( $entity->getFingerprint()->isEmpty() );
535			}
536
537			public function testGivenEmptyFingerprint_existingTermsAreRemoved() {
538			$entity = $this->getNewEmpty();
539
540			$entity->setLabel( 'en', 'foo' );
541			$entity->setDescription( 'en', 'foo bar' );
542			$entity->setAliases( 'en', array( 'foo', 'bar' ) );
543
544			$entity->setFingerprint( new Fingerprint() );
545
546			$this->assertTrue( $entity->getFingerprint()->isEmpty() );
547			}
548
549			public function testWhenSettingFingerprint_getFingerprintReturnsIt() {
550			$fingerprint = new Fingerprint(
551			new TermList( array(
552			new Term( 'en', 'english label' ),
553			) ),
554			new TermList( array(
555			new Term( 'en', 'english description' )
556			) ),
557			new AliasGroupList( array(
558			new AliasGroup( 'en', array( 'first en alias', 'second en alias' ) )
559			) )
560			);
561
562			$entity = $this->getNewEmpty();
563			$entity->setFingerprint( $fingerprint );
564			$newFingerprint = $entity->getFingerprint();
565
566			$this->assertSame( $fingerprint, $newFingerprint );
567			}
568
569			}
570

wmde / WikibaseDataModel

Push — entity-clear ( 1a048b...ca6eb6 )

PropertyTest::testCloneIsEqualButNotIdentical() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like