Bartosz Dziewoński has uploaded a new change for review.
https://gerrit.wikimedia.org/r/200188
Change subject: ResourceLoaderImageModule: Remove 'type' stuff
......................................................................
ResourceLoaderImageModule: Remove 'type' stuff
Provides no value and makes the definitions uglier. Also, the
implementation sucks.
This is a breaking change, but ResourceLoaderImageModule was not in
any public release yet. Submitted patches to fix two usages in extensions:
* Gather: I371209afe7b48e7c215ea9912826d4eb2cacf4e5
* MobileFrontend: I1963f5fe759c3a031220157d3a6f0f3b42bc5426
Bug: T94073
Change-Id: I36cfdb09bb203b8d9958e6016447e446dd6ff78b
---
M includes/resourceloader/ResourceLoaderImageModule.php
M tests/phpunit/includes/resourceloader/ResourceLoaderImageModuleTest.php
2 files changed, 63 insertions(+), 118 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/core
refs/changes/88/200188/1
diff --git a/includes/resourceloader/ResourceLoaderImageModule.php
b/includes/resourceloader/ResourceLoaderImageModule.php
index 4d076dc..3fb4882 100644
--- a/includes/resourceloader/ResourceLoaderImageModule.php
+++ b/includes/resourceloader/ResourceLoaderImageModule.php
@@ -39,8 +39,8 @@
protected $images = array();
protected $variants = array();
protected $prefix = null;
- protected $selectorWithoutVariant = '.{prefix}-{type}-{name}';
- protected $selectorWithVariant = '.{prefix}-{type}-{name}-{variant}';
+ protected $selectorWithoutVariant = '.{prefix}-{name}';
+ protected $selectorWithVariant = '.{prefix}-{name}-{variant}';
protected $targets = array( 'desktop', 'mobile' );
/**
@@ -60,32 +60,28 @@
* // CSS class prefix to use in all style rules
* 'prefix' => [CSS class prefix],
* // Alternatively: Format of CSS selector to use in all style
rules
- * 'selector' => [CSS selector template, variables: {prefix}
{type} {name} {variant}],
+ * 'selector' => [CSS selector template, variables: {prefix}
{name} {variant}],
* // Alternatively: When using variants
- * 'selectorWithoutVariant' => [CSS selector template,
variables: {prefix} {type} {name}],
- * 'selectorWithVariant' => [CSS selector template, variables:
{prefix} {type} {name} {variant}],
+ * 'selectorWithoutVariant' => [CSS selector template,
variables: {prefix} {name}],
+ * 'selectorWithVariant' => [CSS selector template, variables:
{prefix} {name} {variant}],
* // List of variants that may be used for the image files
* 'variants' => array(
- * // ([image type] is a string, used in generated CSS class
- * // names and to match variants to images)
- * [image type] => array(
- * [variant name] => array(
- * 'color' => [color string, e.g. '#ffff00'],
- * 'global' => [boolean, if true, this variant is
available
- * for all images of this type],
- * ),
- * )
+ * [variant name] => array(
+ * 'color' => [color string, e.g. '#ffff00'],
+ * 'global' => [boolean, if true, this variant is
available
+ * for all images of this type],
+ * ),
+ * ...
* ),
* // List of image files and their options
* 'images' => array(
- * [image type] => array(
- * [file path string],
- * [file path string] => array(
- * 'name' => [image name string, defaults to file
name],
- * 'variants' => [array of variant name strings,
variants
- * available for this image],
- * ),
- * )
+ * [file path string],
+ * [file path string] => array(
+ * 'name' => [image name string, defaults to file name],
+ * 'variants' => [array of variant name strings,
variants
+ * available for this image],
+ * ),
+ * ...
* ),
* )
* @endcode
@@ -107,25 +103,10 @@
foreach ( $options as $member => $option ) {
switch ( $member ) {
case 'images':
- if ( !is_array( $option ) ) {
- throw new MWException(
- "Invalid collated file
path list error. '$option' given, array expected."
- );
- }
- foreach ( $option as $key => $value ) {
- if ( !is_string( $key ) ) {
- throw new MWException(
- "Invalid
collated file path list key error. '$key' given, string expected."
- );
- }
- $this->{$member}[$key] =
(array)$value;
- }
- break;
-
case 'variants':
if ( !is_array( $option ) ) {
throw new MWException(
- "Invalid variant list
error. '$option' given, array expected."
+ "Invalid list error.
'$option' given, array expected."
);
}
$this->{$member} = $option;
@@ -180,32 +161,30 @@
if ( !isset( $this->imageObjects ) ) {
$this->imageObjects = array();
- foreach ( $this->images as $type => $list ) {
- foreach ( $list as $name => $options ) {
- $imageDesc = is_string( $options ) ?
$options : $options['image'];
+ foreach ( $this->images as $name => $options ) {
+ $imageDesc = is_string( $options ) ? $options :
$options['image'];
- $allowedVariants = array_merge(
- isset( $options['variants'] ) ?
$options['variants'] : array(),
- $this->getGlobalVariants( $type
)
+ $allowedVariants = array_merge(
+ isset( $options['variants'] ) ?
$options['variants'] : array(),
+ $this->getGlobalVariants()
+ );
+ if ( isset( $this->variants ) ) {
+ $variantConfig = array_intersect_key(
+ $this->variants,
+ array_fill_keys(
$allowedVariants, true )
);
- if ( isset( $this->variants[$type] ) ) {
- $variantConfig =
array_intersect_key(
- $this->variants[$type],
- array_fill_keys(
$allowedVariants, true )
- );
- } else {
- $variantConfig = array();
- }
-
- $image = new ResourceLoaderImage(
- $name,
- $this->getName(),
- $imageDesc,
- $this->localBasePath,
- $variantConfig
- );
- $this->imageObjects[ $image->getName()
] = $image;
+ } else {
+ $variantConfig = array();
}
+
+ $image = new ResourceLoaderImage(
+ $name,
+ $this->getName(),
+ $imageDesc,
+ $this->localBasePath,
+ $variantConfig
+ );
+ $this->imageObjects[ $image->getName() ] =
$image;
}
}
@@ -213,43 +192,24 @@
}
/**
- * Get list of variants in this module that are 'global' for given type
of images, i.e., available
- * for every image of given type regardless of image options.
- * @param string $type Image type
+ * Get list of variants in this module that are 'global', i.e.,
available
+ * for every image regardless of image options.
* @return string[]
*/
- public function getGlobalVariants( $type ) {
- if ( !isset( $this->globalVariants[$type] ) ) {
- $this->globalVariants[$type] = array();
+ public function getGlobalVariants() {
+ if ( !isset( $this->globalVariants ) ) {
+ $this->globalVariants = array();
- if ( isset( $this->variants[$type] ) ) {
- foreach ( $this->variants[$type] as $name =>
$config ) {
+ if ( isset( $this->variants ) ) {
+ foreach ( $this->variants as $name => $config )
{
if ( isset( $config['global'] ) &&
$config['global'] ) {
- $this->globalVariants[$type][]
= $name;
+ $this->globalVariants[] = $name;
}
}
}
}
- return $this->globalVariants[$type];
- }
-
- /**
- * Get the type of given image.
- * @param string $imageName Image name
- * @return string
- */
- public function getImageType( $imageName ) {
- foreach ( $this->images as $type => $list ) {
- foreach ( $list as $key => $value ) {
- $file = is_int( $key ) ? $value : $key;
- $options = is_array( $value ) ? $value :
array();
- $name = isset( $options['name'] ) ?
$options['name'] : pathinfo( $file, PATHINFO_FILENAME );
- if ( $name === $imageName ) {
- return $type;
- }
- }
- }
+ return $this->globalVariants;
}
/**
@@ -262,12 +222,7 @@
$script = $context->getResourceLoader()->getLoadScript(
$this->getSource() );
$selectors = $this->getSelectors();
- $needsTypeWithoutVariant = strpos(
$selectors['selectorWithoutVariant'], '{type}' ) !== false;
- $needsTypeWithVariant = strpos(
$selectors['selectorWithVariant'], '{type}' ) !== false;
-
foreach ( $this->getImages() as $name => $image ) {
- $type = $this->getImageType( $name );
-
$declarations = $this->getCssDeclarations(
$image->getDataUri( $context, null, 'original'
),
$image->getUrl( $context, $script, null,
'rasterized' )
@@ -279,8 +234,6 @@
'{prefix}' => $this->getPrefix(),
'{name}' => $name,
'{variant}' => '',
- // Somewhat expensive, don't compute if
not needed
- '{type}' => $needsTypeWithoutVariant ?
$this->getImageType( $name ) : null,
)
);
$rules[] = "$selector {\n\t$declarations\n}";
@@ -298,8 +251,6 @@
'{prefix}' =>
$this->getPrefix(),
'{name}' => $name,
'{variant}' => $variant,
- // Somewhat expensive, don't
compute if not needed
- '{type}' =>
$needsTypeWithVariant ? $this->getImageType( $name ) : null,
)
);
$rules[] = "$selector {\n\t$declarations\n}";
diff --git
a/tests/phpunit/includes/resourceloader/ResourceLoaderImageModuleTest.php
b/tests/phpunit/includes/resourceloader/ResourceLoaderImageModuleTest.php
index 9d14d8f..5c03eb5 100644
--- a/tests/phpunit/includes/resourceloader/ResourceLoaderImageModuleTest.php
+++ b/tests/phpunit/includes/resourceloader/ResourceLoaderImageModuleTest.php
@@ -9,20 +9,18 @@
public static function providerGetModules() {
$commonVariants = array(
- 'icon' => array(
- 'invert' => array(
- 'color' => '#FFFFFF',
- 'global' => true,
- ),
- 'primary' => array(
- 'color' => '#598AD1',
- ),
- 'constructive' => array(
- 'color' => '#00C697',
- ),
- 'destructive' => array(
- 'color' => '#E81915',
- ),
+ 'invert' => array(
+ 'color' => '#FFFFFF',
+ 'global' => true,
+ ),
+ 'primary' => array(
+ 'color' => '#598AD1',
+ ),
+ 'constructive' => array(
+ 'color' => '#00C697',
+ ),
+ 'destructive' => array(
+ 'color' => '#E81915',
),
);
@@ -64,9 +62,7 @@
'class' => 'ResourceLoaderImageModule',
'prefix' => 'oo-ui',
'variants' => $commonVariants,
- 'images' => array(
- 'icon' => $commonImageData,
- ),
+ 'images' => $commonImageData,
),
'.oo-ui-icon-advanced {
...
@@ -108,9 +104,7 @@
'selectorWithoutVariant' =>
'.mw-ui-icon-{name}:after, .mw-ui-icon-{name}:before',
'selectorWithVariant' =>
'.mw-ui-icon-{name}-{variant}:after, .mw-ui-icon-{name}-{variant}:before',
'variants' => $commonVariants,
- 'images' => array(
- 'icon' => $commonImageData,
- ),
+ 'images' => $commonImageData,
),
'.mw-ui-icon-advanced:after,
.mw-ui-icon-advanced:before {
...
--
To view, visit https://gerrit.wikimedia.org/r/200188
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I36cfdb09bb203b8d9958e6016447e446dd6ff78b
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Bartosz Dziewoński <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
