wmde / WikibaseDataModelServices

tests/unit/ByPropertyIdGrouperTest.php

<?php

namespace Wikibase\DataModel\Services\Tests;

use ArrayObject;
use InvalidArgumentException;
use OutOfBoundsException;
use PHPUnit\Framework\TestCase;
use Wikibase\DataModel\Entity\PropertyId;
use Wikibase\DataModel\PropertyIdProvider;
use Wikibase\DataModel\Services\ByPropertyIdGrouper;
use Wikibase\DataModel\Snak\Snak;

/**
 * @covers \Wikibase\DataModel\Services\ByPropertyIdGrouper
 *
 * @license GPL-2.0-or-later
 * @author Bene* < benestar.wikimedia@gmail.com >
 * @author Thiemo Kreuz
 */
class ByPropertyIdGrouperTest extends TestCase {

	/**
	 * @dataProvider validConstructorArgumentProvider
	 */
	public function testConstructor( $argument ) {
		$instance = new ByPropertyIdGrouper( $argument );
		$this->assertCount( count( $argument ), $instance->getPropertyIds() );

$instance->getPropertyIds() is of type array<integer,object<Wikibase\DataModel\Entity\PropertyId>>, but the function expects a object<Countable>|object<PHPUnit\Framework\iterable>.

	}

	public function validConstructorArgumentProvider() {
		return [
			[ [] ],
			[ [ $this->getPropertyIdProviderMock( 'P1' ) ] ],
			[ new ArrayObject() ],
			[ new ArrayObject( [ $this->getPropertyIdProviderMock( 'P1' ) ] ) ],
		];
	}

	/**
	 * @dataProvider invalidConstructorArgumentProvider
	 */
	public function testConstructorThrowsException( $argument ) {
		$this->expectException( InvalidArgumentException::class );
		new ByPropertyIdGrouper( $argument );
	}

	public function invalidConstructorArgumentProvider() {
		return [
			[ null ],
			[ 'notAnObject' ],
			[ [ null ] ],
			[ [ 'notAnObject' ] ],
			[ new ArrayObject( [ null ] ) ],
			[ new ArrayObject( [ 'notAnObject' ] ) ],
		];
	}

	public function provideGetPropertyIds() {
		$cases = [];

		$cases['empty list'] = [
			[],
			[]
		];

		$cases['some property ids'] = [
			[
				$this->getPropertyIdProviderMock( 'P42' ),
				$this->getPropertyIdProviderMock( 'P23' )
			],
			[
				new PropertyId( 'P42' ),
				new PropertyId( 'P23' )
			]
		];

		$cases['duplicate property ids'] = [
			$this->getPropertyIdProviders(),
			[
				new PropertyId( 'P42' ),
				new PropertyId( 'P23' ),
				new PropertyId( 'P15' ),
				new PropertyId( 'P10' )
			]
		];

		return $cases;
	}

	/**
	 * @dataProvider provideGetPropertyIds
	 * @param PropertyIdProvider[] $propertyIdProviders
	 * @param PropertyId[] $expectedPropertyIds
	 */
	public function testGetPropertyIds( array $propertyIdProviders, array $expectedPropertyIds ) {
		$byPropertyIdGrouper = new ByPropertyIdGrouper( $propertyIdProviders );
		$propertyIds = $byPropertyIdGrouper->getPropertyIds();
		$this->assertEquals( $expectedPropertyIds, $propertyIds );
	}

	public function provideGetByPropertyId() {
		$cases = [];

		$cases[] = [
			$this->getPropertyIdProviders(),
			'P42',
			[ 'abc', 'jkl' ]
		];

		$cases[] = [
			$this->getPropertyIdProviders(),
			'P23',
			[ 'def' ]
		];

		return $cases;
	}

	/**
	 * @dataProvider provideGetByPropertyId
	 */
	public function testGetByPropertyId( array $propertyIdProviders, $propertyId, array $expectedValues ) {
		$byPropertyIdGrouper = new ByPropertyIdGrouper( $propertyIdProviders );
		$values = $byPropertyIdGrouper->getByPropertyId( new PropertyId( $propertyId ) );
		array_walk( $values, function( Snak &$value ) {
			$value = $value->getType();
		} );
		$this->assertEquals( $expectedValues, $values );
	}

	public function testGetByPropertyIdThrowsException() {
		$byPropertyIdGrouper = new ByPropertyIdGrouper( $this->getPropertyIdProviders() );

$this->getPropertyIdProviders() is of type array<integer,object<PHPUnit\Framework\MockObject\MockObject>,{"0":"object<PHPUnit\\Framework\\MockObject\\MockObject>","1":"object<PHPUnit\\Framework\\MockObject\\MockObject>","2":"object<PHPUnit\\Framework\\MockObject\\MockObject>","3":"object<PHPUnit\\Framework\\MockObject\\MockObject>","4":"object<PHPUnit\\Framework\\MockObject\\MockObject>"}>, but the function expects a array<integer,object<Wikibase\DataModel\PropertyIdProvider>>|object<Traversable>.

		$this->expectException( OutOfBoundsException::class );
		$byPropertyIdGrouper->getByPropertyId( new PropertyId( 'P11' ) );
	}

	public function provideHasPropertyId() {
		$cases = [];

		$cases[] = [ $this->getPropertyIdProviders(), 'P42', true ];
		$cases[] = [ $this->getPropertyIdProviders(), 'P23', true ];
		$cases[] = [ $this->getPropertyIdProviders(), 'P15', true ];
		$cases[] = [ $this->getPropertyIdProviders(), 'P10', true ];
		$cases[] = [ $this->getPropertyIdProviders(), 'P11', false ];

		return $cases;
	}

	/**
	 * @dataProvider provideHasPropertyId
	 */
	public function testHasPropertyId( array $propertyIdProviders, $propertyId, $expectedValue ) {
		$byPropertyIdGrouper = new ByPropertyIdGrouper( $propertyIdProviders );
		$this->assertEquals( $expectedValue, $byPropertyIdGrouper->hasPropertyId( new PropertyId( $propertyId ) ) );
	}

	/**
	 * @return PropertyIdProvider[]
	 */
	private function getPropertyIdProviders() {
		return [
			$this->getPropertyIdProviderMock( 'P42', 'abc' ),
			$this->getPropertyIdProviderMock( 'P23', 'def' ),
			$this->getPropertyIdProviderMock( 'P15', 'ghi' ),
			$this->getPropertyIdProviderMock( 'P42', 'jkl' ),
			$this->getPropertyIdProviderMock( 'P10', 'mno' )
		];
	}

	/**
	 * Creates a PropertyIdProvider mock which can return a value.
	 *
	 * @param string $propertyId
	 * @param string|null $type
	 *
	 * @return PropertyIdProvider
	 */
	private function getPropertyIdProviderMock( $propertyId, $type = null ) {
		$propertyIdProvider = $this->createMock( Snak::class );

		$propertyIdProvider->expects( $this->once() )
			->method( 'getPropertyId' )
			->will( $this->returnValue( new PropertyId( $propertyId ) ) );

		$propertyIdProvider->expects( $this->any() )
			->method( 'getType' )
			->will( $this->returnValue( $type ) );

		return $propertyIdProvider;
	}

}