Wikibase\DataModel\Tests\SiteLinkTest

Complexity

Total Complexity

18

Size/Duplication

Total Lines	203
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	testCanConstruct()	0	4	1
A	testGetSiteId()	0	4	1
A	siteIdProvider()	0	9	1
A	invalidStringIdentifierProvider()	0	9	1
A	testGetPageName()	0	4	1
A	pageNameProvider()	0	9	1
A	testGetBadges()	0	4	1
A	badgesProvider()	0	36	1
A	invalidBadgesProvider()	0	14	1
A	testSelfComparisonReturnsTrue()	0	7	1
A	linkProvider()	0	7	1
A	testGivenNonEqualLinks_equalsReturnsFalse()	0	4	1
A	nonEqualityProvider()	0	20	1
A	testCanConstructWithItemIdSet()	0	11	1
A	testGivenNonItemIdCollectionForBadges_constructorThrowsException()	0	4	1
A	testCannotConstructWithNonStringSiteId()	0	4	1
A	testCannotConstructWithNonStringPageName()	0	4	1
A	testCannotConstructWithInvalidBadges()	0	4	1

<?php

namespace Wikibase\DataModel\Tests;

use InvalidArgumentException;
use Wikibase\DataModel\Entity\ItemId;
use Wikibase\DataModel\Entity\ItemIdSet;
use Wikibase\DataModel\Entity\PropertyId;
use Wikibase\DataModel\SiteLink;

/**
 * @covers \Wikibase\DataModel\SiteLink
 *
 * @group Wikibase
 * @group WikibaseDataModel
 *
 * @license GPL-2.0-or-later
 * @author Jeroen De Dauw < jeroendedauw@gmail.com >
 * @author Michał Łazowik
 * @author Thiemo Kreuz
 */
class SiteLinkTest extends \PHPUnit\Framework\TestCase {

	public function testCanConstruct() {
		new SiteLink( 'enwiki', 'Wikidata' );
		$this->assertTrue( true );
	}

	/**
	 * @dataProvider siteIdProvider
	 */
	public function testGetSiteId( $siteId ) {
		$siteLink = new SiteLink( $siteId, 'Wikidata' );
		$this->assertSame( $siteId, $siteLink->getSiteId() );
	}

	public function siteIdProvider() {
		$argLists = [];

		$argLists[] = [ 'enwiki' ];
		$argLists[] = [ 'nlwiki' ];
		$argLists[] = [ 'Nyan!' ];

		return $argLists;
	}

	/**
	 * @dataProvider invalidStringIdentifierProvider
	 */
	public function testCannotConstructWithNonStringSiteId( $invalidSiteId ) {
		$this->expectException( InvalidArgumentException::class );
		new SiteLink( $invalidSiteId, 'Wikidata' );
	}

	public function invalidStringIdentifierProvider() {
		return [
			[ null ],
			[ true ],
			[ 42 ],
			[ '' ],
			[ [] ],
		];
	}

	/**
	 * @dataProvider pageNameProvider
	 */
	public function testGetPageName( $pageName ) {
		$siteLink = new SiteLink( 'enwiki', $pageName );
		$this->assertSame( $pageName, $siteLink->getPageName() );
	}

	public function pageNameProvider() {
		$argLists = [];

		$argLists[] = [ 'Wikidata' ];
		$argLists[] = [ 'Nyan_Cat' ];
		$argLists[] = [ 'NYAN DATA ALL ACROSS THE SKY ~=[,,_,,]:3' ];

		return $argLists;
	}

	/**
	 * @dataProvider invalidStringIdentifierProvider
	 */
	public function testCannotConstructWithNonStringPageName( $invalidPageName ) {
		$this->expectException( InvalidArgumentException::class );
		new SiteLink( 'enwiki', $invalidPageName );
	}

	/**
	 * @dataProvider badgesProvider
	 */
	public function testGetBadges( $badges, $expected ) {
		$siteLink = new SiteLink( 'enwiki', 'Wikidata', $badges );
		$this->assertEquals( $expected, $siteLink->getBadges() );
	}

	public function badgesProvider() {
		$argLists = [];

		$argLists[] = [ null, [] ];

		$badges = [];
		$expected = array_values( $badges );

		$argLists[] = [ $badges, $expected ];

		$badges = [
			new ItemId( 'Q149' )
		];
		$expected = array_values( $badges );

		$argLists[] = [ $badges, $expected ];

		// removing from the middle of array
		$badges = [
			new ItemId( 'Q36' ),
			new ItemId( 'Q149' ),
			new ItemId( 'Q7' )
		];

		$key = array_search(
			new ItemId( 'Q149' ),
			$badges
		);
		unset( $badges[$key] );

		$expected = array_values( $badges );

		$argLists[] = [ $badges, $expected ];

		return $argLists;
	}

	/**
	 * @dataProvider invalidBadgesProvider
	 */
	public function testCannotConstructWithInvalidBadges( $invalidBadges ) {
		$this->expectException( InvalidArgumentException::class );
		new SiteLink( 'enwiki', 'Wikidata', $invalidBadges );
	}

	public function invalidBadgesProvider() {
		return [
			// Stuff that's not an array
			[ true ],
			[ 42 ],
			[ 'nyan nyan' ],
			// Arrays with stuff that's not even an object
			[ [ 'nyan', 42 ] ],
			[ [ 'nyan', [] ] ],
			// Arrays with Entities that aren't Items
			[ [ new PropertyId( 'P2' ), new ItemId( 'Q149' ) ] ],
			[ [ new PropertyId( 'P2' ), new PropertyId( 'P3' ) ] ],
		];
	}

	/**
	 * @dataProvider linkProvider
	 */
	public function testSelfComparisonReturnsTrue( SiteLink $link ) {
		$this->assertTrue( $link->equals( $link ) );

		$linkCopy = unserialize( serialize( $link ) );
		$this->assertTrue( $link->equals( $linkCopy ) );
		$this->assertTrue( $linkCopy->equals( $link ) );
	}

	public function linkProvider() {
		return [
			[ new SiteLink( 'foo', 'Bar' ) ],
			[ new SiteLink( 'foo', 'Bar', [ new ItemId( 'Q42' ), new ItemId( 'Q9001' ) ] ) ],
			[ new SiteLink( 'foo', 'foo' ) ],
		];
	}

	/**
	 * @dataProvider nonEqualityProvider
	 */
	public function testGivenNonEqualLinks_equalsReturnsFalse( SiteLink $linkOne, SiteLink $linkTwo ) {
		$this->assertFalse( $linkOne->equals( $linkTwo ) );
		$this->assertFalse( $linkTwo->equals( $linkOne ) );
	}

	public function nonEqualityProvider() {
		return [
			[
				new SiteLink( 'foo', 'bar' ),
				new SiteLink( 'foo', 'Bar' ),
			],
			[
				new SiteLink( 'foo', 'bar' ),
				new SiteLink( 'Foo', 'bar' ),
			],
			[
				new SiteLink( 'foo', 'bar' ),
				new SiteLink( 'foo', 'bar', [ new ItemId( 'Q42' ) ] ),
			],
			[
				new SiteLink( 'foo', 'bar', [ new ItemId( 'Q42' ) ] ),
				new SiteLink( 'foo', 'bar', [ new ItemId( 'Q42' ), new ItemId( 'Q9001' ) ] ),
			],
		];
	}

	public function testCanConstructWithItemIdSet() {
		$badgesArray = [
			new ItemId( 'Q36' ),
			new ItemId( 'Q149' ),
		];
		$badges = new ItemIdSet( $badgesArray );

		$siteLink = new SiteLink( 'foo', 'bar', $badges );

		$this->assertEquals( $badgesArray, $siteLink->getBadges() );
	}

	public function testGivenNonItemIdCollectionForBadges_constructorThrowsException() {
		$this->expectException( InvalidArgumentException::class );
		new SiteLink( 'foo', 'bar', 42 );

42 is of type integer, but the function expects a object<Wikibase\DataModel\Entity\ItemIdSet>|array<integer,object<Wikibase\DataModel\Entity\ItemId>>|null.

	}

}