Thiemo Mättig (WMDE) has uploaded a new change for review.
https://gerrit.wikimedia.org/r/259526
Change subject: Remove not needed reset functionality from WikibaseClient/Repo
......................................................................
Remove not needed reset functionality from WikibaseClient/Repo
This fixes a series of issues found while reviewing I00c38a5.
* The only difference between the two methods was the "Snak", one with
this word, one without.
* I find the comments highly confusing. To what does "default" refer
to? This does not add any additional knowledge. Callers of this method
can see that the method is called "getDefault...". That's enough.
* The reset functionality is not used anywhere. It was introduced for
WikibaseClient::getDefaultInstance, the only place where it is used.
Change-Id: Ic169248cc8b5027f89f46073a4c412a323f0fb07
---
M client/WikibaseClient.datatypes.php
M client/includes/WikibaseClient.php
M client/tests/phpunit/includes/WikibaseClientTest.php
M repo/WikibaseRepo.datatypes.php
M repo/includes/WikibaseRepo.php
M repo/tests/phpunit/includes/WikibaseRepoTest.php
6 files changed, 41 insertions(+), 76 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/Wikibase
refs/changes/26/259526/1
diff --git a/client/WikibaseClient.datatypes.php
b/client/WikibaseClient.datatypes.php
index 75add0b..172a00d 100644
--- a/client/WikibaseClient.datatypes.php
+++ b/client/WikibaseClient.datatypes.php
@@ -41,55 +41,55 @@
return array(
'VT:bad' => array(
'formatter-factory-callback' => function( $format,
FormatterOptions $options ) {
- $factory =
WikibaseClient::getDefaultFormatterBuilders();
+ $factory =
WikibaseClient::getDefaultValueFormatterBuilders();
return
$factory->newUnDeserializableValueFormatter( $format, $options );
}
),
'VT:globecoordinate' => array(
'formatter-factory-callback' => function( $format,
FormatterOptions $options ) {
- $factory =
WikibaseClient::getDefaultFormatterBuilders();
+ $factory =
WikibaseClient::getDefaultValueFormatterBuilders();
return $factory->newGlobeCoordinateFormatter(
$format, $options );
},
),
'VT:monolingualtext' => array(
'formatter-factory-callback' => function( $format,
FormatterOptions $options ) {
- $factory =
WikibaseClient::getDefaultFormatterBuilders();
+ $factory =
WikibaseClient::getDefaultValueFormatterBuilders();
return $factory->newMonolingualFormatter(
$format, $options );
},
),
'VT:quantity' => array(
'formatter-factory-callback' => function( $format,
FormatterOptions $options ) {
- $factory =
WikibaseClient::getDefaultFormatterBuilders();
+ $factory =
WikibaseClient::getDefaultValueFormatterBuilders();
return $factory->newQuantityFormatter( $format,
$options );
},
),
'VT:string' => array(
'formatter-factory-callback' => function( $format,
FormatterOptions $options ) {
- $factory =
WikibaseClient::getDefaultFormatterBuilders();
+ $factory =
WikibaseClient::getDefaultValueFormatterBuilders();
return $factory->newStringFormatter( $format,
$options );
},
),
'PT:url' => array(
'formatter-factory-callback' => function( $format,
FormatterOptions $options ) {
- $factory =
WikibaseClient::getDefaultFormatterBuilders();
+ $factory =
WikibaseClient::getDefaultValueFormatterBuilders();
return $factory->newUrlFormatter( $format,
$options );
},
),
'PT:commonsMedia' => array(
'formatter-factory-callback' => function( $format,
FormatterOptions $options ) {
- $factory =
WikibaseClient::getDefaultFormatterBuilders();
+ $factory =
WikibaseClient::getDefaultValueFormatterBuilders();
return $factory->newCommonsMediaFormatter(
$format, $options );
},
),
'VT:time' => array(
'formatter-factory-callback' => function( $format,
FormatterOptions $options ) {
- $factory =
WikibaseClient::getDefaultFormatterBuilders();
+ $factory =
WikibaseClient::getDefaultValueFormatterBuilders();
return $factory->newTimeFormatter( $format,
$options );
},
),
'VT:wikibase-entityid' => array(
'formatter-factory-callback' => function( $format,
FormatterOptions $options ) {
- $factory =
WikibaseClient::getDefaultFormatterBuilders();
+ $factory =
WikibaseClient::getDefaultValueFormatterBuilders();
return $factory->newEntityIdFormatter( $format,
$options );
},
),
diff --git a/client/includes/WikibaseClient.php
b/client/includes/WikibaseClient.php
index 12f5f9c..c8ec0ab 100644
--- a/client/includes/WikibaseClient.php
+++ b/client/includes/WikibaseClient.php
@@ -176,20 +176,17 @@
private $termLookup = null;
/**
- * Returns the default WikibaseValueFormatterBuilders instance.
* @warning This is for use with bootstrap code in
WikibaseClient.datatypes.php only!
* Program logic should use WikibaseClient::getSnakFormatterFactory()
instead!
*
* @since 0.5
*
- * @param string $reset Flag: Pass "reset" to reset the default instance
- *
* @return WikibaseValueFormatterBuilders
*/
- public static function getDefaultFormatterBuilders( $reset = 'noreset'
) {
+ public static function getDefaultValueFormatterBuilders() {
static $builders;
- if ( $builders === null || $reset === 'reset' ) {
+ if ( $builders === null ) {
$builders =
self::getDefaultInstance()->newWikibaseValueFormatterBuilders();
}
@@ -199,7 +196,7 @@
/**
* Returns a low level factory object for creating formatters for well
known data types.
*
- * @warning This is for use with getDefaultFormatterBuilders() during
bootstrap only!
+ * @warning This is for use with getDefaultValueFormatterBuilders()
during bootstrap only!
* Program logic should use WikibaseClient::getSnakFormatterFactory()
instead!
*
* @return WikibaseValueFormatterBuilders
@@ -214,22 +211,19 @@
}
/**
- * Returns the default WikibaseSnakFormatterBuilders instance.
* @warning This is for use with bootstrap code in
WikibaseClient.datatypes.php only!
* Program logic should use WikibaseClient::getSnakFormatterFactory()
instead!
*
* @since 0.5
*
- * @param string $reset Flag: Pass "reset" to reset the default instance
- *
* @return WikibaseSnakFormatterBuilders
*/
- public static function getDefaultSnakFormatterBuilders( $reset =
'noreset' ) {
+ public static function getDefaultSnakFormatterBuilders() {
static $builders;
- if ( $builders === null || $reset === 'reset' ) {
+ if ( $builders === null ) {
$builders =
self::getDefaultInstance()->newWikibaseSnakFormatterBuilders(
- self::getDefaultFormatterBuilders()
+ self::getDefaultValueFormatterBuilders()
);
}
@@ -239,7 +233,7 @@
/**
* Returns a low level factory object for creating formatters for well
known data types.
*
- * @warning This is for use with getDefaultFormatterBuilders() during
bootstrap only!
+ * @warning This is for use with getDefaultValueFormatterBuilders()
during bootstrap only!
* Program logic should use WikibaseClient::getSnakFormatterFactory()
instead!
*
* @param WikibaseValueFormatterBuilders $valueFormatterBuilders
@@ -499,7 +493,6 @@
}
/**
- * Returns the default instance constructed using newInstance().
* IMPORTANT: Use only when it is not feasible to inject an instance
properly.
*
* @since 0.4
diff --git a/client/tests/phpunit/includes/WikibaseClientTest.php
b/client/tests/phpunit/includes/WikibaseClientTest.php
index c8a0bb7..91b65da 100644
--- a/client/tests/phpunit/includes/WikibaseClientTest.php
+++ b/client/tests/phpunit/includes/WikibaseClientTest.php
@@ -27,18 +27,12 @@
*/
class WikibaseClientTest extends \PHPUnit_Framework_TestCase {
- public function testGetDefaultFormatterBuilders_noReset() {
- $first = WikibaseClient::getDefaultFormatterBuilders();
+ public function testGetDefaultFormatterBuilders() {
+ $first = WikibaseClient::getDefaultValueFormatterBuilders();
$this->assertInstanceOf(
'Wikibase\Lib\WikibaseValueFormatterBuilders', $first );
- $second = WikibaseClient::getDefaultFormatterBuilders();
+ $second = WikibaseClient::getDefaultValueFormatterBuilders();
$this->assertSame( $first, $second );
- }
-
- public function testGetDefaultFormatterBuilders_withReset() {
- $first = WikibaseClient::getDefaultFormatterBuilders();
- $second = WikibaseClient::getDefaultFormatterBuilders( 'reset'
);
- $this->assertNotSame( $first, $second );
}
public function testGetDataTypeFactoryReturnType() {
diff --git a/repo/WikibaseRepo.datatypes.php b/repo/WikibaseRepo.datatypes.php
index 955ca26..8da0fe7 100644
--- a/repo/WikibaseRepo.datatypes.php
+++ b/repo/WikibaseRepo.datatypes.php
@@ -85,7 +85,7 @@
return array(
'VT:bad' => array(
'formatter-factory-callback' => function( $format,
FormatterOptions $options ) {
- $factory =
WikibaseRepo::getDefaultFormatterBuilders();
+ $factory =
WikibaseRepo::getDefaultValueFormatterBuilders();
return
$factory->newUnDeserializableValueFormatter( $format, $options );
}
),
@@ -96,7 +96,7 @@
},
'parser-factory-callback' => $newStringParser,
'formatter-factory-callback' => function( $format,
FormatterOptions $options ) {
- $factory =
WikibaseRepo::getDefaultFormatterBuilders();
+ $factory =
WikibaseRepo::getDefaultValueFormatterBuilders();
return $factory->newCommonsMediaFormatter(
$format, $options );
},
'rdf-builder-factory-callback' => function (
@@ -118,7 +118,7 @@
return new GlobeCoordinateParser( $options );
},
'formatter-factory-callback' => function( $format,
FormatterOptions $options ) {
- $factory =
WikibaseRepo::getDefaultFormatterBuilders();
+ $factory =
WikibaseRepo::getDefaultValueFormatterBuilders();
return $factory->newGlobeCoordinateFormatter(
$format, $options );
},
'rdf-builder-factory-callback' => function (
@@ -141,7 +141,7 @@
return new MonolingualTextParser( $options );
},
'formatter-factory-callback' => function( $format,
FormatterOptions $options ) {
- $factory =
WikibaseRepo::getDefaultFormatterBuilders();
+ $factory =
WikibaseRepo::getDefaultValueFormatterBuilders();
return $factory->newMonolingualFormatter(
$format, $options );
},
'rdf-builder-factory-callback' => function (
@@ -165,7 +165,7 @@
return new QuantityParser( $options,
$unlocalizer );
},
'formatter-factory-callback' => function( $format,
FormatterOptions $options ) {
- $factory =
WikibaseRepo::getDefaultFormatterBuilders();
+ $factory =
WikibaseRepo::getDefaultValueFormatterBuilders();
return $factory->newQuantityFormatter( $format,
$options );
},
'rdf-builder-factory-callback' => function (
@@ -186,7 +186,7 @@
},
'parser-factory-callback' => $newStringParser,
'formatter-factory-callback' => function( $format,
FormatterOptions $options ) {
- $factory =
WikibaseRepo::getDefaultFormatterBuilders();
+ $factory =
WikibaseRepo::getDefaultValueFormatterBuilders();
return $factory->newStringFormatter( $format,
$options );
},
'rdf-builder-factory-callback' => function (
@@ -209,7 +209,7 @@
return $factory->getTimeParser();
},
'formatter-factory-callback' => function( $format,
FormatterOptions $options ) {
- $factory =
WikibaseRepo::getDefaultFormatterBuilders();
+ $factory =
WikibaseRepo::getDefaultValueFormatterBuilders();
return $factory->newTimeFormatter( $format,
$options );
},
'rdf-builder-factory-callback' => function (
@@ -232,7 +232,7 @@
},
'parser-factory-callback' => $newStringParser,
'formatter-factory-callback' => function( $format,
FormatterOptions $options ) {
- $factory =
WikibaseRepo::getDefaultFormatterBuilders();
+ $factory =
WikibaseRepo::getDefaultValueFormatterBuilders();
return $factory->newUrlFormatter( $format,
$options );
},
'rdf-builder-factory-callback' => function (
@@ -278,7 +278,7 @@
},
'parser-factory-callback' => $newEntityIdParser,
'formatter-factory-callback' => function( $format,
FormatterOptions $options ) {
- $factory =
WikibaseRepo::getDefaultFormatterBuilders();
+ $factory =
WikibaseRepo::getDefaultValueFormatterBuilders();
return $factory->newEntityIdFormatter( $format,
$options );
},
'rdf-builder-factory-callback' => function (
diff --git a/repo/includes/WikibaseRepo.php b/repo/includes/WikibaseRepo.php
index 8993ebd..38a1884 100644
--- a/repo/includes/WikibaseRepo.php
+++ b/repo/includes/WikibaseRepo.php
@@ -218,7 +218,6 @@
private $valueSnakRdfBuilderFactory;
/**
- * Returns the default instance constructed using newInstance().
* IMPORTANT: Use only when it is not feasible to inject an instance
properly.
*
* @since 0.4
@@ -244,20 +243,17 @@
}
/**
- * Returns the default ValidatorBuilders instance.
* @warning This is for use with bootstrap code in
WikibaseRepo.datatypes.php only!
* Program logic should use WikibaseRepo::getDataTypeValidatorFactory()
instead!
*
* @since 0.5
*
- * @param string $reset Flag: Pass "reset" to reset the default instance
- *
* @return ValidatorBuilders
*/
- public static function getDefaultValidatorBuilders( $reset = 'noreset'
) {
+ public static function getDefaultValidatorBuilders() {
static $builders;
- if ( $builders === null || $reset === 'reset' ) {
+ if ( $builders === null ) {
$wikibaseRepo = self::getDefaultInstance();
$builders = $wikibaseRepo->newValidatorBuilders();
}
@@ -285,20 +281,17 @@
}
/**
- * Returns the default WikibaseValueFormatterBuilders instance.
* @warning This is for use with bootstrap code in
WikibaseRepo.datatypes.php only!
* Program logic should use WikibaseRepo::getSnakFormatterFactory()
instead!
*
* @since 0.5
*
- * @param string $reset Flag: Pass "reset" to reset the default instance
- *
* @return WikibaseValueFormatterBuilders
*/
- public static function getDefaultFormatterBuilders( $reset = 'noreset'
) {
+ public static function getDefaultValueFormatterBuilders() {
static $builders;
- if ( $builders === null || $reset === 'reset' ) {
+ if ( $builders === null ) {
$wikibaseRepo = self::getDefaultInstance();
$builders =
$wikibaseRepo->newWikibaseValueFormatterBuilders();
}
@@ -309,7 +302,7 @@
/**
* Returns a low level factory object for creating formatters for well
known data types.
*
- * @warning This is for use with getDefaultFormatterBuilders() during
bootstrap only!
+ * @warning This is for use with getDefaultValueFormatterBuilders()
during bootstrap only!
* Program logic should use WikibaseRepo::getSnakFormatterFactory()
instead!
*
* @return WikibaseValueFormatterBuilders
@@ -325,22 +318,19 @@
}
/**
- * Returns the default WikibaseSnakFormatterBuilders instance.
* @warning This is for use with bootstrap code in
WikibaseClient.datatypes.php only!
* Program logic should use WikibaseClient::getSnakFormatterFactory()
instead!
*
* @since 0.5
*
- * @param string $reset Flag: Pass "reset" to reset the default instance
- *
* @return WikibaseSnakFormatterBuilders
*/
- public static function getDefaultSnakFormatterBuilders( $reset =
'noreset' ) {
+ public static function getDefaultSnakFormatterBuilders() {
static $builders;
- if ( $builders === null || $reset === 'reset' ) {
+ if ( $builders === null ) {
$builders =
self::getDefaultInstance()->newWikibaseSnakFormatterBuilders(
- self::getDefaultFormatterBuilders()
+ self::getDefaultValueFormatterBuilders()
);
}
@@ -350,7 +340,7 @@
/**
* Returns a low level factory object for creating formatters for well
known data types.
*
- * @warning This is for use with getDefaultFormatterBuilders() during
bootstrap only!
+ * @warning This is for use with getDefaultValueFormatterBuilders()
during bootstrap only!
* Program logic should use WikibaseClient::getSnakFormatterFactory()
instead!
*
* @param WikibaseValueFormatterBuilders $valueFormatterBuilders
diff --git a/repo/tests/phpunit/includes/WikibaseRepoTest.php
b/repo/tests/phpunit/includes/WikibaseRepoTest.php
index 75ce7f3..2740d2d 100644
--- a/repo/tests/phpunit/includes/WikibaseRepoTest.php
+++ b/repo/tests/phpunit/includes/WikibaseRepoTest.php
@@ -22,7 +22,7 @@
*/
class WikibaseRepoTest extends MediaWikiTestCase {
- public function testGetDefaultValidatorBuilders_noReset() {
+ public function testGetDefaultValidatorBuilders() {
$first =
$this->getWikibaseRepo()->getDefaultValidatorBuilders();
$this->assertInstanceOf( 'Wikibase\Repo\ValidatorBuilders',
$first );
@@ -30,24 +30,12 @@
$this->assertSame( $first, $second );
}
- public function testGetDefaultValidatorBuilders_withReset() {
- $first =
$this->getWikibaseRepo()->getDefaultValidatorBuilders();
- $second =
$this->getWikibaseRepo()->getDefaultValidatorBuilders( 'reset' );
- $this->assertNotSame( $first, $second );
- }
-
- public function testGetDefaultFormatterBuilders_noReset() {
- $first =
$this->getWikibaseRepo()->getDefaultFormatterBuilders();
+ public function testGetDefaultFormatterBuilders() {
+ $first =
$this->getWikibaseRepo()->getDefaultValueFormatterBuilders();
$this->assertInstanceOf(
'Wikibase\Lib\WikibaseValueFormatterBuilders', $first );
- $second =
$this->getWikibaseRepo()->getDefaultFormatterBuilders();
+ $second =
$this->getWikibaseRepo()->getDefaultValueFormatterBuilders();
$this->assertSame( $first, $second );
- }
-
- public function testGetDefaultFormatterBuilders_withReset() {
- $first =
$this->getWikibaseRepo()->getDefaultFormatterBuilders();
- $second =
$this->getWikibaseRepo()->getDefaultFormatterBuilders( 'reset' );
- $this->assertNotSame( $first, $second );
}
public function testGetDataTypeFactoryReturnType() {
--
To view, visit https://gerrit.wikimedia.org/r/259526
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ic169248cc8b5027f89f46073a4c412a323f0fb07
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Wikibase
Gerrit-Branch: master
Gerrit-Owner: Thiemo Mättig (WMDE) <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
