gplx/mediawiki/extensions/SemanticMediaWiki/tests/phpunit/Query/Language/ClassDescriptionTest.php

<?php

namespace SMW\Tests\Query\Language;

use SMW\DIWikiPage;
use SMW\Localizer\Localizer;
use SMW\Query\Language\ClassDescription;
use SMW\Query\Language\ThingDescription;
use SMW\Tests\PHPUnitCompat;

/**
 * @covers \SMW\Query\Language\ClassDescription
 * @group semantic-mediawiki
 *
 * @license GPL-2.0-or-later
 * @since 2.1
 *
 * @author mwjames
 */
class ClassDescriptionTest extends \PHPUnit\Framework\TestCase {

	use PHPUnitCompat;

	private $cat_name;

	protected function setUp(): void {
		parent::setUp();
		$this->cat_name = Localizer::getInstance()->getNsText( NS_CATEGORY );
	}

	public function testCanConstruct() {
		$class = $this->getMockBuilder( '\SMW\DIWikiPage' )
			->disableOriginalConstructor()
			->getMock();

		$this->assertInstanceOf(
			'SMW\Query\Language\ClassDescription',
			new ClassDescription( $class )
		);
	}

	public function testConstructThrowsException() {
		$this->expectException( 'Exception' );

		new ClassDescription( new \stdClass );
	}

	public function testCommonMethods() {
		$ns = Localizer::getInstance()->getNsText( NS_CATEGORY );

		$class = new DIWikiPage( 'Foo', NS_CATEGORY );
		$instance = new ClassDescription( $class );

		$this->assertEquals( [ $class ], $instance->getCategories() );

		$this->assertEquals( "[[{$ns}:Foo]]", $instance->getQueryString() );
		$this->assertEquals( " <q>[[{$ns}:Foo]]</q> ", $instance->getQueryString( true ) );

		$this->assertFalse( $instance->isSingleton() );
		$this->assertEquals( [], $instance->getPrintRequests() );

		$this->assertSame( 1, $instance->getSize() );
		$this->assertSame( 0, $instance->getDepth() );
		$this->assertEquals( 2, $instance->getQueryFeatures() );
	}

	public function testAddDescription() {
		$ns = Localizer::getInstance()->getNsText( NS_CATEGORY );

		$instance = new ClassDescription( new DIWikiPage( 'Foo', NS_CATEGORY ) );
		$instance->addDescription( new ClassDescription( new DIWikiPage( 'Bar', NS_CATEGORY ) ) );

		$this->assertEquals(
			"[[{$ns}:Foo||Bar]]",
			$instance->getQueryString()
		);

		$this->assertEquals(
			" <q>[[{$ns}:Foo||Bar]]</q> ",
			$instance->getQueryString( true )
		);
	}

	public function testAddClass() {
		$ns = Localizer::getInstance()->getNsText( NS_CATEGORY );

		$instance = new ClassDescription( new DIWikiPage( 'Foo', NS_CATEGORY ) );
		$instance->addClass( new DIWikiPage( 'Bar', NS_CATEGORY ) );

		$this->assertEquals(
			"[[{$ns}:Foo||Bar]]",
			$instance->getQueryString()
		);

		$this->assertEquals(
			" <q>[[{$ns}:Foo||Bar]]</q> ",
			$instance->getQueryString( true )
		);
	}

	public function testIsMergableDescription() {
		$cat = new DIWikiPage( 'Foo', NS_CATEGORY );

		$instance = new ClassDescription(
			$cat
		);

		$this->assertTrue(
			$instance->isMergableDescription( new ClassDescription( $cat ) )
		);

		$instance->isNegation = true;

		$this->assertFalse(
			$instance->isMergableDescription( new ClassDescription( $cat ) )
		);
	}

	public function testClass_Negation() {
		$cat = new DIWikiPage( 'Foo', NS_CATEGORY );

		$instance = new ClassDescription(
			$cat
		);

		$this->assertEquals(
			"[[{$this->cat_name}:Foo]]",
			$instance->getQueryString()
		);

		$instance->isNegation = true;

		$this->assertEquals(
			"[[{$this->cat_name}:!Foo]]",
			$instance->getQueryString()
		);

		$instance->addClass( new DIWikiPage( 'Bar', NS_CATEGORY ) );

		$this->assertEquals(
			"[[{$this->cat_name}:!Foo||!Bar]]",
			$instance->getQueryString()
		);
	}

	public function testGetFingerprint() {
		$instance = new ClassDescription(
			new DIWikiPage( 'Foo', NS_CATEGORY )
		);

		$instance->addDescription(
			new ClassDescription( new DIWikiPage( 'Bar', NS_CATEGORY ) )
		);

		$expected = $instance->getFingerprint();

		// Different position, same hash
		$instance = new ClassDescription(
			new DIWikiPage( 'Bar', NS_CATEGORY )
		);

		$instance->addDescription(
			new ClassDescription( new DIWikiPage( 'Foo', NS_CATEGORY ) )
		);

		$this->assertSame(
			$expected,
			$instance->getFingerprint()
		);

		// Adds extra description, changes hash
		$instance->addDescription(
			new ClassDescription( new DIWikiPage( 'Foobar', NS_CATEGORY ) )
		);

		$this->assertNotSame(
			$expected,
			$instance->getFingerprint()
		);
	}

	public function testPrune() {
		$instance = new ClassDescription( new DIWikiPage( 'Foo', NS_CATEGORY ) );

		$maxsize  = 1;
		$maxDepth = 1;
		$log      = [];

		$this->assertEquals(
			$instance,
			$instance->prune( $maxsize, $maxDepth, $log )
		);

		$maxsize  = 0;
		$maxDepth = 1;
		$log      = [];

		$this->assertEquals(
			new ThingDescription(),
			$instance->prune( $maxsize, $maxDepth, $log )
		);
	}

	public function testStableFingerprint() {
		$instance = new ClassDescription(
			new DIWikiPage( 'Foo', NS_CATEGORY )
		);

		$this->assertSame(
			'Cl:c2d00d69a4e9517d075d9adf6aafea6e',
			$instance->getFingerprint()
		);
	}

	public function testHierarchyDepthToBeCeiledOnMaxQSubcategoryDepthSetting() {
		$instance = new ClassDescription(
			new DIWikiPage( 'Foo', NS_CATEGORY )
		);

		$instance->setHierarchyDepth( 9999999 );

		$this->assertSame(
			$GLOBALS['smwgQSubcategoryDepth'],
			$instance->getHierarchyDepth()
		);
	}

	public function testGetQueryStringWithHierarchyDepth() {
		$ns = Localizer::getInstance()->getNsText( NS_CATEGORY );

		$instance = new ClassDescription(
			new DIWikiPage( 'Foo', NS_CATEGORY )
		);

		$instance->setHierarchyDepth( 1 );

		$this->assertSame(
			"[[$ns:Foo|+depth=1]]",
			$instance->getQueryString()
		);
	}

	public function testVaryingHierarchyDepthCausesDifferentFingerprint() {
		$instance = new ClassDescription(
			new DIWikiPage( 'Foo', NS_CATEGORY )
		);

		$instance->setHierarchyDepth( 9999 );
		$expected = $instance->getFingerprint();

		$instance = new ClassDescription(
			new DIWikiPage( 'Foo', NS_CATEGORY )
		);

		$this->assertNotSame(
			$expected,
			$instance->getFingerprint()
		);
	}

}