gplx/mediawiki/extensions/SemanticMediaWiki/tests/phpunit/DataValues/InfoLinksProviderTest.php

<?php

namespace SMW\Tests\DataValues;

use SMW\DataItemFactory;
use SMW\DataValueFactory;
use SMW\DataValues\InfoLinksProvider;
use SMW\DataValues\StringValue;
use SMW\Localizer\Message;
use SMW\Tests\PHPUnitCompat;
use SMW\Tests\TestEnvironment;
use SMWNumberValue as NumberValue;

/**
 * @covers \SMW\DataValues\InfoLinksProvider
 * @group semantic-mediawiki
 *
 * @license GPL-2.0-or-later
 * @since 2.4
 *
 * @author mwjames
 */
class InfoLinksProviderTest extends \PHPUnit\Framework\TestCase {

	use PHPUnitCompat;

	private $testEnvironment;
	private $dataItemFactory;
	private $dataValueServiceFactory;
	private $propertySpecificationLookup;
	private $dataValueFactory;

	protected function setUp(): void {
		parent::setUp();

		$this->testEnvironment = new TestEnvironment();
		$this->dataItemFactory = new DataItemFactory();
		$this->dataValueFactory = DataValueFactory::getInstance();

		$constraintValueValidator = $this->getMockBuilder( '\SMW\DataValues\ValueValidators\ConstraintValueValidator' )
			->disableOriginalConstructor()
			->getMock();

		$this->dataValueServiceFactory = $this->getMockBuilder( '\SMW\Services\DataValueServiceFactory' )
			->disableOriginalConstructor()
			->getMock();

		$this->dataValueServiceFactory->expects( $this->any() )
			->method( 'getConstraintValueValidator' )
			->willReturn( $constraintValueValidator );

		$this->propertySpecificationLookup = $this->getMockBuilder( '\SMW\Property\SpecificationLookup' )
			->disableOriginalConstructor()
			->getMock();

		$this->testEnvironment->registerObject( 'PropertySpecificationLookup', $this->propertySpecificationLookup );
	}

	protected function tearDown(): void {
		$this->testEnvironment->tearDown();
		parent::tearDown();
	}

	public function testCanConstruct() {
		$dataValue = $this->getMockBuilder( '\SMWDataValue' )
			->disableOriginalConstructor()
			->getMockForAbstractClass();

		$this->assertInstanceOf(
			InfoLinksProvider::class,
			new InfoLinksProvider( $dataValue, $this->propertySpecificationLookup )
		);
	}

	public function testGetInfolinkTextOnNumberValue() {
		$this->propertySpecificationLookup->expects( $this->atLeastOnce() )
			->method( 'getSpecification' )
			->willReturn( [] );

		$numberValue = $this->dataValueFactory->newDataValueByType( NumberValue::TYPE_ID );

		$numberValue->setOption( 'user.language', 'en' );
		$numberValue->setOption( 'content.language', 'en' );

		$numberValue->setProperty(
			$this->dataItemFactory->newDIProperty( 'Foo' )
		);

		$numberValue->setUserValue( '1000.42' );

		$instance = new InfoLinksProvider( $numberValue, $this->propertySpecificationLookup );

		$this->dataValueServiceFactory->expects( $this->any() )
			->method( 'newInfoLinksProvider' )
			->willReturn( $instance );

		$this->assertContains(
			'/:Foo/1000.42|+]]</span>',
			$instance->getInfolinkText( SMW_OUTPUT_WIKI )
		);

		$this->assertContains(
			'/:Foo/1000.42">+</a></span>',
			$instance->getInfolinkText( SMW_OUTPUT_HTML )
		);
	}

	public function testGetInfolinkTextOnStringValue() {
		$this->propertySpecificationLookup->expects( $this->atLeastOnce() )
			->method( 'getSpecification' )
			->willReturn( [] );

		$stringValue = $this->dataValueFactory->newDataValueByType( StringValue::TYPE_ID );

		$stringValue->setOption( 'user.language', 'en' );
		$stringValue->setOption( 'content.language', 'en' );

		$stringValue->setProperty(
			$this->dataItemFactory->newDIProperty( 'Foo' )
		);

		$stringValue->setUserValue( 'Text with :: content' );

		$instance = new InfoLinksProvider( $stringValue, $this->propertySpecificationLookup );

		$this->dataValueServiceFactory->expects( $this->any() )
			->method( 'newInfoLinksProvider' )
			->willReturn( $instance );

		$this->assertContains(
			'/:Foo/Text-20with-20-2D3A-2D3A-20content|+]]</span>',
			$instance->getInfolinkText( SMW_OUTPUT_WIKI )
		);

		$this->assertContains(
			'/:Foo/Text-20with-20-2D3A-2D3A-20content">+</a></span>',
			$instance->getInfolinkText( SMW_OUTPUT_HTML )
		);
	}

	public function testGetInfolinkTextOnSobValue() {
		$stringValidator = $this->testEnvironment->newValidatorFactory()->newStringValidator();

		$sobValue = $this->dataValueFactory->newDataValueByType( '__sob' );
		$sobValue->setUserValue( 'Text with :: content' );

		$instance = new InfoLinksProvider( $sobValue, $this->propertySpecificationLookup );

		$this->dataValueServiceFactory->expects( $this->any() )
			->method( 'newInfoLinksProvider' )
			->willReturn( $instance );

		$stringValidator->assertThatStringContains(
			'<span class="smwbrowse">[[.*/:Text-20with-20::-20content|+]]</span>',
			$instance->getInfolinkText( SMW_OUTPUT_WIKI )
		);

		$stringValidator->assertThatStringContains(
			'<span class="smwbrowse"><a .*/:Text-20with-20::-20content" title=".*/:Text-20with-20::-20content">+</a></span>',
			$instance->getInfolinkText( SMW_OUTPUT_HTML )
		);
	}

	public function testGetInfolinkTextOnTimeValueWithoutLocalizedOutput() {
		$timeValue = $this->dataValueFactory->newDataValueByType( '_dat' );

		$timeValue->setOption( $timeValue::OPT_USER_LANGUAGE, 'fr' );
		$timeValue->setOption( $timeValue::OPT_CONTENT_LANGUAGE, 'en' );

		// Forcibly set an output
		$timeValue->setOutputFormat( 'LOCL' );

		$property = $this->dataItemFactory->newDIProperty( 'Foo' );
		$property->setPropertyTypeId( '_dat' );

		$timeValue->setProperty(
			$property
		);

		$timeValue->setDataItem(
			$this->dataItemFactory->newDITime( 1, 1970, 12, 12 )
		);

		$instance = new InfoLinksProvider( $timeValue, $this->propertySpecificationLookup );

		$this->dataValueServiceFactory->expects( $this->any() )
			->method( 'newInfoLinksProvider' )
			->willReturn( $instance );

		$this->assertContains(
			'/:Foo/12-20December-201970|+]]</span>',
			$instance->getInfolinkText( SMW_OUTPUT_WIKI )
		);

		$this->assertContains(
			'/:Foo/12-20December-201970">+</a></span>',
			$instance->getInfolinkText( SMW_OUTPUT_HTML )
		);
	}

	public function testGetInfolinkTextOnStringValueWithServiceLinks() {
		$service = 'testGetInfolinkTextOnStringValueWithServiceLinks';

		$this->propertySpecificationLookup->expects( $this->atLeastOnce() )
			->method( 'getSpecification' )
			->willReturn( [
				$this->dataItemFactory->newDIBlob( $service ) ] );

		// Manipulating the Message cache is a hack!!
		$parameters = [
			"smw_service_" . $service,
			'Bar'
		];

		Message::getCache()->save(
			Message::getHash( $parameters, Message::TEXT, Message::CONTENT_LANGUAGE ),
			'SERVICELINK-A|SERVICELINK-B'
		);

		$stringValue = $this->dataValueFactory->newDataValueByType( StringValue::TYPE_ID );

		$stringValue->setOption( StringValue::OPT_USER_LANGUAGE, 'en' );
		$stringValue->setOption( StringValue::OPT_CONTENT_LANGUAGE, 'en' );

		$stringValue->setProperty(
			$this->dataItemFactory->newDIProperty( 'Foo' )
		);

		$stringValue->setUserValue( 'Bar' );

		$instance = new InfoLinksProvider( $stringValue, $this->propertySpecificationLookup );

		$this->dataValueServiceFactory->expects( $this->any() )
			->method( 'newInfoLinksProvider' )
			->willReturn( $instance );

		$this->assertContains(
			'<span class="smwttcontent">[SERVICELINK-B SERVICELINK-A]</span>',
			$instance->getInfolinkText( SMW_OUTPUT_WIKI )
		);

		$this->assertContains(
			'<span class="smwttcontent">&lt;a href="SERVICELINK-B"&gt;SERVICELINK-A&lt;/a&gt;</span>',
			$instance->getInfolinkText( SMW_OUTPUT_HTML )
		);
	}

}