path: root/SemanticMediaWiki/tests/phpunit/includes/parserhooks/SubobjectParserFunctionTest.php

<?php

namespace SMW\Tests;

use SMW\Tests\Util\SemanticDataValidator;

use SMW\SubobjectParserFunction;
use SMW\Subobject;
use SMW\ParserParameterFormatter;
use SMW\MessageFormatter;
use SMW\ParserData;
use SMW\DIProperty;

use SMWDataItem;
use Title;
use ParserOutput;

/**
 * @covers \SMW\SubobjectParserFunction
 *
 * @ingroup Test
 *
 * @group SMW
 * @group SMWExtension
 *
 * @license GNU GPL v2+
 * @since 1.9
 *
 * @author mwjames
 */
class SubobjectParserFunctionTest extends \PHPUnit_Framework_TestCase {

	public function testCanConstruct() {

		$subobject = new Subobject( Title::newFromText( __METHOD__ ) );

		$parserData = $this->getMockBuilder( '\SMW\ParserData' )
			->disableOriginalConstructor()
			->getMock();

		$messageFormatter = $this->getMockBuilder( '\SMW\MessageFormatter' )
			->disableOriginalConstructor()
			->getMock();

		$this->assertInstanceOf(
			'\SMW\SubobjectParserFunction',
			new SubobjectParserFunction(
				$parserData,
				$subobject,
				$messageFormatter
			)
		);
	}

	/**
	 * @dataProvider parameterDataProvider
	 */
	public function testParse( array $parameters, array $expected ) {

		$subobject = new Subobject( Title::newFromText( __METHOD__ ) );

		$instance = $this->acquireInstance( $subobject );
		$result   = $instance->parse( new ParserParameterFormatter( $parameters ) );

		$this->assertEquals(
			$result !== '' ,
			$expected['hasErrors']
		);
	}

	/**
	 * @dataProvider parameterDataProvider
	 */
	public function testInstantiatedSubobject( array $parameters, array $expected ) {

		$subobject = new Subobject( Title::newFromText( __METHOD__ ) );

		$instance = $this->acquireInstance( $subobject );
		$instance->parse( new ParserParameterFormatter( $parameters ) );

		$this->assertContains(
			$expected['identifier'],
			$subobject->getId()
		);
	}

	/**
	 * @dataProvider firstElementDataProvider
	 */
	public function testFirstElementAsProperty( $isEnabled , array $parameters, array $expected ) {

		$parserOutput = new ParserOutput();
		$title        = Title::newFromText( __METHOD__ );
		$subobject    = new Subobject( $title );

		$instance = $this->acquireInstance( $subobject, $parserOutput );
		$instance->setFirstElementAsProperty( $isEnabled  );

		$instance->parse( new ParserParameterFormatter( $parameters ) );

		// If it is enabled only check for the first character {0} that should
		// contain '_' as the rest is going to be an unknown hash value
		$id = $subobject->getId();
		$this->assertEquals( $expected['identifier'], $isEnabled ? $id{0} : $id );

		$parserData = new ParserData( $title, $parserOutput );

		// Add generated title text as property value due to the auto reference
		// setting
		$expected['propertyValues'][] = $title->getText();
		$semanticDataValidator = new SemanticDataValidator;

		foreach ( $parserData->getSemanticData()->getSubSemanticData() as $containerSemanticData ){
			$semanticDataValidator->assertThatPropertiesAreSet(
				$expected,
				$containerSemanticData
			);
		}
	}

	/**
	 * @dataProvider parameterDataProvider
	 */
	public function testInstantiatedPropertyValues( array $parameters, array $expected ) {
		$this->setupInstanceAndAssertSemanticData(
			$parameters,
			$expected
		);
	}

	/**
	 * @dataProvider sortKeyProvider
	 */
	public function testSortKeyAnnotation( array $parameters, array $expected ) {
		$this->setupInstanceAndAssertSemanticData(
			$parameters,
			$expected
		);
	}

	protected function setupInstanceAndAssertSemanticData( array $parameters, array $expected ) {

		$parserOutput = new ParserOutput();
		$title        = Title::newFromText( __METHOD__ );
		$subobject    = new Subobject( $title );

		$instance = $this->acquireInstance(
			$subobject,
			$parserOutput
		);

		$instance->parse( new ParserParameterFormatter( $parameters ) );

		$parserData = new ParserData(
			$title,
			$parserOutput
		);

		$subSemanticData = $parserData->getSemanticData()->getSubSemanticData();

		$semanticDataValidator = new SemanticDataValidator();

		foreach ( $subSemanticData as $actualSemanticDataToAssert ){
			$semanticDataValidator->assertThatPropertiesAreSet(
				$expected,
				$actualSemanticDataToAssert
			);
		}
	}

	public function parameterDataProvider() {

		$provider = array();

		// Anonymous identifier
		// {{#subobject:
		// |Foo=bar
		// }}
		$provider[] = array(
			array( '', 'Foo=bar' ),
			array(
				'hasErrors' => false,
				'identifier' => '_',
				'propertyCount'  => 1,
				'propertyLabels' => 'Foo',
				'propertyValues' => 'Bar'
			)
		);

		// Anonymous identifier
		// {{#subobject:-
		// |Foo=1001 9009
		// }}
		$provider[] = array(
			array( '-', 'Foo=1001 9009' ),
			array(
				'hasErrors' => false,
				'identifier' => '_',
				'propertyCount'  => 1,
				'propertyLabels' => 'Foo',
				'propertyValues' => '1001 9009'
			)
		);

		// Named identifier
		// {{#subobject:FooBar
		// |FooBar=Bar foo
		// }}
		$provider[] = array(
			array( 'FooBar', 'FooBar=Bar foo' ),
			array(
				'hasErrors' => false,
				'identifier' => 'FooBar',
				'propertyCount'  => 1,
				'propertyLabels' => 'FooBar',
				'propertyValues' => 'Bar foo'
			)
		);

		// Named identifier
		// {{#subobject:Foo bar
		// |Foo=Help:Bar
		// }}
		$provider[] = array(
			array( 'Foo bar', 'Foo=Help:Bar' ),
			array(
				'hasErrors' => false,
				'identifier' => 'Foo_bar',
				'propertyCount'  => 1,
				'propertyLabels' => 'Foo',
				'propertyValues' => 'Help:Bar'
			)
		);

		// Named identifier
		// {{#subobject: Foo bar foo
		// |Bar=foo Bar
		// }}
		$provider[] = array(
			array( ' Foo bar foo ', 'Bar=foo Bar' ),
			array(
				'hasErrors' => false,
				'identifier' => 'Foo_bar_foo',
				'propertyCount'  => 1,
				'propertyLabels' => 'Bar',
				'propertyValues' => 'Foo Bar'
			)
		);

		// Named identifier
		// {{#subobject: Foo bar foo
		// |状況=超やばい
		// |Bar=http://www.semantic-mediawiki.org/w/index.php?title=Subobject
		// }}
		$provider[] = array(
			array(
				' Foo bar foo ',
				'状況=超やばい',
				'Bar=http://www.semantic-mediawiki.org/w/index.php?title=Subobject' ),
			array(
				'hasErrors' => false,
				'identifier' => 'Foo_bar_foo',
				'propertyCount'  => 2,
				'propertyLabels' => array( '状況', 'Bar' ),
				'propertyValues' => array( '超やばい', 'Http://www.semantic-mediawiki.org/w/index.php?title=Subobject' )
			)
		);

		// Returns an error due to wrong declaration (see Modification date)
		// Get the right language for an error object
		$diPropertyError = new DIProperty( DIProperty::TYPE_ERROR );

		// {{#subobject: Foo bar foo
		// |Bar=foo Bar
		// |Modification date=foo Bar
		// }}
		$provider[] = array(
			array( ' Foo bar foo ', 'Bar=foo Bar', 'Modification date=foo Bar' ),
			array(
				'hasErrors' => true,
				'identifier' => 'Foo_bar_foo',
				'propertyCount'  => 2,
				'propertyLabels' => array( 'Bar', $diPropertyError->getLabel() ),
				'propertyValues' => array( 'Foo Bar', 'Modification date' )
			)
		);

		return $provider;
	}

	public function firstElementDataProvider() {

		$provider = array();

		// #0 / asserting that a named identifier was turned into an anonymous id
		// {{#subobject: Foo bar foo
		// |Bar=foo Bar
		// }}
		$provider[] = array(
			true,
			array( ' Foo bar foo ', 'Bar=foo Bar' ),
			array(
				'hasErrors' => false,
				'identifier' => '_',
				'propertyCount'  => 2,
				'propertyLabels' => array( 'Bar', 'Foo bar foo' ),
				'propertyValues' => array( 'Foo Bar' ) // additional value is added during runtime
			)
		);

		// #1 / asserting the validity of the named identifier
		// {{#subobject: Foo bar foo
		// |Bar=foo Bar
		// }}
		$provider[] = array(
			false,
			array( ' Foo bar foo ', 'Bar=foo Bar' ),
			array(
				'hasErrors' => false,
				'identifier' => 'Foo_bar_foo',
				'propertyCount'  => 1,
				'propertyLabels' => array( 'Bar' ),
				'propertyValues' => array( 'Foo Bar' )
			)
		);

		return $provider;
	}

	public function sortKeyProvider() {

		$provider = array();

		// #0 @sortkey
		// {{#subobject:
		// |Bar=foo Bar
		// |@sortkey=9999
		// }}
		$provider[] = array(
			array(
				'Bar=foo Bar',
				'@sortkey=9999'
			),
			array(
				'propertyCount'  => 2,
				'properties'     => array(
					new DIProperty( 'Bar' ),
					new DIProperty( '_SKEY' )
				),
				'propertyValues' => array(
					'Foo Bar',
					'9999'
				)
			)
		);

		// #1 @sortkey being empty
		// {{#subobject:
		// |Bar=foo Bar
		// |@sortkey=
		// }}
		$provider[] = array(
			array(
				'Bar=foo Bar',
				'@sortkey='
			),
			array(
				'propertyCount'  => 1,
				'properties'     => array(
					new DIProperty( 'Bar' )
				),
				'propertyValues' => array(
					'Foo Bar'
				)
			)
		);

		return $provider;
	}

	/**
	 * @return SubobjectParserFunction
	 */
	private function acquireInstance( Subobject $subobject, ParserOutput $parserOutput = null ) {

		if ( $parserOutput === null ) {
			$parserOutput = new ParserOutput();
		}

		return new SubobjectParserFunction(
			new ParserData( $subobject->getTitle(), $parserOutput ),
			$subobject,
			new MessageFormatter( $subobject->getTitle()->getPageLanguage() )
		);
	}

}