Avoid static methods when registering Properties (#36)

SemanticGlossary.php

@@ -31,9 +31,7 @@ public static function initExtension() {
 
 		$GLOBALS[ 'wgExtensionFunctions' ][] = function () {
 
-			$hookRegistry = new HookRegistry(
-				ApplicationFactory::getInstance()->getStore()
-			);
+			$hookRegistry = new HookRegistry();
 
 			$hookRegistry->register();
 		};

src/Cache/CacheInvalidator.php

@@ -3,7 +3,7 @@
 namespace SG\Cache;
 
 use SG\SemanticDataComparator;
-use SG\PropertyRegistry;
+use SG\PropertyRegistrationHelper;
 
 use SMW\Store;
 use SMW\SemanticData;
@@ -157,10 +157,10 @@ private function hasSemanticDataDeviation( Store $store, SemanticData $semanticD
 
 		$dataComparator = new SemanticDataComparator( $store, $semanticData );
 
-		return $dataComparator->compareForProperty( PropertyRegistry::SG_TERM ) ||
-			$dataComparator->compareForProperty( PropertyRegistry::SG_DEFINITION ) ||
-			$dataComparator->compareForProperty( PropertyRegistry::SG_LINK ) ||
-			$dataComparator->compareForProperty( PropertyRegistry::SG_STYLE );
+		return $dataComparator->compareForProperty( PropertyRegistrationHelper::SG_TERM ) ||
+			$dataComparator->compareForProperty( PropertyRegistrationHelper::SG_DEFINITION ) ||
+			$dataComparator->compareForProperty( PropertyRegistrationHelper::SG_LINK ) ||
+			$dataComparator->compareForProperty( PropertyRegistrationHelper::SG_STYLE );
 	}
 
 	private function purgeCache( DIWikiPage $subject ) {

src/Cache/ElementsCacheBuilder.php

@@ -2,7 +2,7 @@
 
 namespace SG\Cache;
 
-use SG\PropertyRegistry;
+use SG\PropertyRegistrationHelper;
 use SMW\DataValueFactory;
 use SMW\Store;
 use SMW\DIProperty;
@@ -127,7 +127,7 @@ private function buildQuery() {
 		$dataValueFactory = DataValueFactory::getInstance();
 
 		// build term data item and data value for later use
-		$this->mDiTerm = new DIProperty( PropertyRegistry::SG_TERM );
+		$this->mDiTerm = new DIProperty( PropertyRegistrationHelper::SG_TERM );
 		$this->mDvTerm = $dataValueFactory->newDataValueByType( '_txt' );
 		$this->mDvTerm->setProperty( $this->mDiTerm );
 
@@ -136,7 +136,7 @@ private function buildQuery() {
 		$prTerm = new PrintRequest( PrintRequest::PRINT_PROP, null, $pvTerm );
 
 		// build definition data item and data value for later use
-		$this->mDiDefinition = new DIProperty( PropertyRegistry::SG_DEFINITION );
+		$this->mDiDefinition = new DIProperty( PropertyRegistrationHelper::SG_DEFINITION );
 		$this->mDvDefinition = $dataValueFactory->newDataValueByType( '_txt' );
 		$this->mDvDefinition->setProperty( $this->mDiDefinition );
 
@@ -145,7 +145,7 @@ private function buildQuery() {
 		$prDefinition = new PrintRequest( PrintRequest::PRINT_PROP, null, $pvDefinition );
 
 		// build link data item and data value for later use
-		$this->mDiLink = new DIProperty( PropertyRegistry::SG_LINK );
+		$this->mDiLink = new DIProperty( PropertyRegistrationHelper::SG_LINK );
 		$this->mDvLink = $dataValueFactory->newDataValueByType( '_txt' );
 		$this->mDvLink->setProperty( $this->mDiLink );
 
@@ -154,7 +154,7 @@ private function buildQuery() {
 		$prLink = new PrintRequest( PrintRequest::PRINT_PROP, null, $pvLink );
 
 		// build style data item and data value for later use
-		$this->mDiStyle = new DIProperty( PropertyRegistry::SG_STYLE );
+		$this->mDiStyle = new DIProperty( PropertyRegistrationHelper::SG_STYLE );
 		$this->mDvStyle = $dataValueFactory->newDataValueByType( '_txt' );
 		$this->mDvStyle->setProperty( $this->mDiStyle );
 

src/HookRegistry.php

@@ -2,7 +2,6 @@
 
 namespace SG;
 
-use SMW\Store;
 use SMW\DIWikiPage;
 use Hooks;
 
@@ -21,11 +20,9 @@ class HookRegistry {
 
 	/**
 	 * @since 1.0
-	 *
-	 * @param Store $store
 	 */
-	public function __construct( Store $store ) {
-		$this->addCallbackHandlers( $store );
+	public function __construct() {
+		$this->addCallbackHandlers();
 	}
 
 	/**
@@ -59,15 +56,16 @@ public function register() {
 		}
 	}
 
-	private function addCallbackHandlers( $store ) {
-
-		$propertyRegistry = new PropertyRegistry();
+	private function addCallbackHandlers() {
 
 		/**
 		 * @see https://github.com/SemanticMediaWiki/SemanticMediaWiki/blob/master/docs/technical/hooks.md
 		 */
-		$this->handlers['SMW::Property::initProperties'] = function () use ( $propertyRegistry ) {
-			return PropertyRegistry::getInstance()->register();
+		$this->handlers['SMW::Property::initProperties'] = function ( $propertyRegistry ) {
+
+			$propertyRegistrationHelper = new PropertyRegistrationHelper( $propertyRegistry );
+			return $propertyRegistrationHelper->registerProperties();
+
 		};
 
 		/**

src/Maintenance/GlossaryCacheRebuilder.php

@@ -2,7 +2,7 @@
 
 namespace SG\Maintenance;
 
-use SG\PropertyRegistry;
+use SG\PropertyRegistrationHelper;
 use SG\Cache\GlossaryCache;
 
 use SMWUpdateJob as UpdateJob;
@@ -113,7 +113,7 @@ private function updateSelectedPages( array $pages ) {
 	private function buildQuery() {
 
 		$description = new SomeProperty(
-			new DIProperty( PropertyRegistry::SG_TERM ),
+			new DIProperty( PropertyRegistrationHelper::SG_TERM ),
 			new ThingDescription()
 		);
 

src/PropertyRegistry.php → src/PropertyRegistrationHelper.php

@@ -2,7 +2,7 @@
 
 namespace SG;
 
-use SMW\DIProperty;
+use SMW\PropertyRegistry;
 
 define( 'SG_PROP_GLT', 'Glossary-Term' );
 define( 'SG_PROP_GLD', 'Glossary-Definition' );
@@ -17,42 +17,30 @@
  *
  * @author mwjames
  */
-class PropertyRegistry {
+class PropertyRegistrationHelper {
 
 	const SG_TERM = '___glt';
 	const SG_DEFINITION = '___gld';
 	const SG_LINK  = '___gll';
 	const SG_STYLE = '___gls';
 
-	protected static $instance = null;
+	private $propertyRegistry;
 
 	/**
-	 * @since 1.0
+	 * PropertyRegistry constructor.
 	 *
-	 * @return PropertyRegistry
-	 */
-	public static function getInstance() {
-
-		if ( self::$instance === null ) {
-			self::$instance = new self();
-		}
-
-		return self::$instance;
-	}
-
-	/**
-	 * @since 1.0
+	 * @param PropertyRegistry $propertyRegistry
 	 */
-	public static function clear() {
-		self::$instance = null;
+	public function __construct( PropertyRegistry $propertyRegistry ) {
+		$this->propertyRegistry = $propertyRegistry;
 	}
 
 	/**
 	 * @since 1.0
 	 *
 	 * @return boolean
 	 */
-	public function register() {
+	public function registerProperties() {
 
 		$propertyDefinitions = array(
 			self::SG_TERM => array(
@@ -81,21 +69,21 @@ public function register() {
 	}
 
     /**
-     * @param array $propertyList
+     * @param string[][] $propertyList
      * @return bool
      */
-    protected function registerPropertiesFromList(array $propertyList ) {
+    protected function registerPropertiesFromList( array $propertyList ) {
 
 		foreach ( $propertyList as $propertyId => $definition ) {
 
-			\SMW\PropertyRegistry::getInstance()->registerProperty(
+			$this->propertyRegistry->registerProperty(
 				$propertyId,
 				$definition['type'],
 				$definition['label'],
 				true
 			);
 
-			\SMW\PropertyRegistry::getInstance()->registerPropertyAlias(
+			$this->propertyRegistry->registerPropertyAlias(
 				$propertyId,
 				$definition['alias']
 			);

tests/phpunit/Integration/MwDBSQLStoreIntegrationTest.php

@@ -2,7 +2,7 @@
 
 namespace SG\Tests\Integration;
 
-use SG\PropertyRegistry;
+use SG\PropertyRegistrationHelper;
 
 use SMW\Tests\MwDBaseUnitTestCase;
 use SMW\Tests\Utils\UtilityFactory;
@@ -55,7 +55,7 @@ public function testPageCreateDeleteStoreIntegration() {
 
 		$values = $this->getStore()->getPropertyValues(
 			DIWikiPage::newFromTitle( $title ),
-			new DIProperty( PropertyRegistry::SG_TERM )
+			new DIProperty( PropertyRegistrationHelper::SG_TERM )
 		);
 
 		$this->assertNotEmpty( $values );
@@ -65,7 +65,7 @@ public function testPageCreateDeleteStoreIntegration() {
 
 		$values = $this->getStore()->getPropertyValues(
 			DIWikiPage::newFromTitle( $title ),
-			new DIProperty( PropertyRegistry::SG_TERM )
+			new DIProperty( PropertyRegistrationHelper::SG_TERM )
 		);
 
 		$this->assertEmpty( $values );

tests/phpunit/Unit/Cache/CacheInvalidatorTest.php

@@ -2,7 +2,7 @@
 
 namespace SG\Tests\Cache;
 
-use SG\PropertyRegistry;
+use SG\PropertyRegistrationHelper;
 use SG\Cache\CacheInvalidator;
 use SG\Cache\GlossaryCache;
 
@@ -64,12 +64,12 @@ public function testInvalidateOnUpdateWithDifferentSubobjectData() {
 		$subobject->setSemanticData( '_999999' );
 
 		$subobject->getSemanticData()->addPropertyObjectValue(
-			new DIProperty( PropertyRegistry::SG_TERM ),
+			new DIProperty( PropertyRegistrationHelper::SG_TERM ),
 			new DIBlob( 'Foo' )
 		);
 
 		$subobject->getSemanticData()->addPropertyObjectValue(
-			new DIProperty( PropertyRegistry::SG_DEFINITION ),
+			new DIProperty( PropertyRegistrationHelper::SG_DEFINITION ),
 			new DIBlob( 'Bar' )
 		);
 

tests/phpunit/Unit/PropertyRegistrationHelperTest.php

@@ -0,0 +1,87 @@
+<?php
+
+namespace SG\Tests;
+
+use SG\PropertyRegistrationHelper;
+use SMW\DIProperty;
+
+/**
+ * @covers \SG\PropertyRegistrationHelper
+ * @group semantic-glossary
+ *
+ * @license GNU GPL v2+
+ * @since 1.0
+ *
+ * @author mwjames
+ */
+class PropertyRegistrationHelperTest extends \PHPUnit_Framework_TestCase {
+
+	public function testCanConstruct() {
+
+		$propertyRegistry =
+			$this->getMockBuilder( '\SMW\PropertyRegistry' )
+			->disableOriginalConstructor()
+			->getMock();
+
+		$propertyRegistrationHelper = new PropertyRegistrationHelper( $propertyRegistry );
+
+		$this->assertInstanceOf(
+			'\SG\PropertyRegistrationHelper',
+			$propertyRegistrationHelper
+		);
+	}
+
+	public function testRegisterProperties() {
+
+		$propertyRegistry =
+			$this->getMockBuilder( '\SMW\PropertyRegistry' )
+			->disableOriginalConstructor()
+			->getMock();
+
+		$propertyRegistry
+			->expects( $this->exactly( 4 ) )
+			->method( 'registerProperty' );
+
+		$propertyRegistry
+			->expects( $this->exactly( 4 ) )
+			->method( 'registerPropertyAlias' );
+
+
+		$propertyRegistrationHelper = new PropertyRegistrationHelper( $propertyRegistry );
+
+		$this->assertTrue(
+			$propertyRegistrationHelper->registerProperties()
+		);
+	}
+
+	/**
+	 * @dataProvider propertyDefinitionDataProvider
+	 *
+	 * @param string $id
+	 * @param string $label
+	 */
+	public function testRegisteredPropertyById( $id, $label ) {
+
+		$property = new DIProperty( $id );
+
+		$this->assertInstanceOf( '\SMW\DIProperty', $property );
+		$this->assertEquals( $label, $property->getLabel() );
+		$this->assertTrue( $property->isShown() );
+	}
+
+	/**
+	 * @return string[][]
+	 */
+	public function propertyDefinitionDataProvider() {
+
+		$provider = array();
+
+		$provider[] = array( PropertyRegistrationHelper::SG_TERM, SG_PROP_GLT );
+		$provider[] = array(  PropertyRegistrationHelper::SG_DEFINITION, SG_PROP_GLD );
+		$provider[] = array(  PropertyRegistrationHelper::SG_LINK, SG_PROP_GLL );
+		$provider[] = array(  PropertyRegistrationHelper::SG_STYLE, SG_PROP_GLS );
+
+		return $provider;
+	}
+
+}