wiki.techinc.nl/includes/resourceloader/ResourceLoaderSkinModule.php
Timo Tijhof b6a2e22acd resourceloader: Improve coverage of SkinModule
* Ignore getLogoData() which is a one-line proxy to ::getLogo,
  that can't really be tested because static methods can't be stubbed.
  It exists so that this method can be stubbed instead. The actual
  method is already covered.

* Simplify @covers for getStyles() to allow indirect coverage within
  the class because it's intended as a higher-level integration tests.
  The other tests in the suite still cover a specific method only.

Change-Id: I1445a016c1f12a6d8ceaaf745023a28cf20e5371
2018-05-04 17:31:04 +01:00

170 lines
4.8 KiB
PHP

<?php
/**
* ResourceLoader module for skin stylesheets.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @author Timo Tijhof
*/
class ResourceLoaderSkinModule extends ResourceLoaderFileModule {
/**
* All skins are assumed to be compatible with mobile
*/
public $targets = [ 'desktop', 'mobile' ];
/**
* @param ResourceLoaderContext $context
* @return array
*/
public function getStyles( ResourceLoaderContext $context ) {
$logo = $this->getLogoData( $this->getConfig() );
$styles = parent::getStyles( $context );
$this->normalizeStyles( $styles );
$default = !is_array( $logo ) ? $logo : $logo['1x'];
$styles['all'][] = '.mw-wiki-logo { background-image: ' .
CSSMin::buildUrlValue( $default ) .
'; }';
if ( is_array( $logo ) ) {
if ( isset( $logo['svg'] ) ) {
$styles['all'][] = '.mw-wiki-logo { ' .
'background-image: -webkit-linear-gradient(transparent, transparent), ' .
CSSMin::buildUrlValue( $logo['svg'] ) . '; ' .
'background-image: linear-gradient(transparent, transparent), ' .
CSSMin::buildUrlValue( $logo['svg'] ) . ';' .
'background-size: 135px auto; }';
} else {
if ( isset( $logo['1.5x'] ) ) {
$styles[
'(-webkit-min-device-pixel-ratio: 1.5), ' .
'(min--moz-device-pixel-ratio: 1.5), ' .
'(min-resolution: 1.5dppx), ' .
'(min-resolution: 144dpi)'
][] = '.mw-wiki-logo { background-image: ' .
CSSMin::buildUrlValue( $logo['1.5x'] ) . ';' .
'background-size: 135px auto; }';
}
if ( isset( $logo['2x'] ) ) {
$styles[
'(-webkit-min-device-pixel-ratio: 2), ' .
'(min--moz-device-pixel-ratio: 2), ' .
'(min-resolution: 2dppx), ' .
'(min-resolution: 192dpi)'
][] = '.mw-wiki-logo { background-image: ' .
CSSMin::buildUrlValue( $logo['2x'] ) . ';' .
'background-size: 135px auto; }';
}
}
}
return $styles;
}
/**
* Ensure all media keys use array values.
*
* Normalises arrays returned by the ResourceLoaderFileModule::getStyles() method.
*
* @param array &$styles Associative array, keys are strings (media queries),
* values are strings or arrays
*/
private function normalizeStyles( &$styles ) {
foreach ( $styles as $key => $val ) {
if ( !is_array( $val ) ) {
$styles[$key] = [ $val ];
}
}
}
/**
* Non-static proxy to ::getLogo (for overloading in sub classes or tests).
*
* @codeCoverageIgnore
* @since 1.31
* @param Config $conf
* @return string|array
*/
protected function getLogoData( Config $conf ) {
return static::getLogo( $conf );
}
/**
* @param Config $conf
* @return string|array Single url if no variants are defined,
* or an array of logo urls keyed by dppx in form "<float>x".
* Key "1x" is always defined. Key "svg" may also be defined,
* in which case variants other than "1x" are omitted.
*/
public static function getLogo( Config $conf ) {
$logo = $conf->get( 'Logo' );
$logoHD = $conf->get( 'LogoHD' );
$logo1Url = OutputPage::transformResourcePath( $conf, $logo );
if ( !$logoHD ) {
return $logo1Url;
}
$logoUrls = [
'1x' => $logo1Url,
];
if ( isset( $logoHD['svg'] ) ) {
$logoUrls['svg'] = OutputPage::transformResourcePath(
$conf,
$logoHD['svg']
);
} else {
// Only 1.5x and 2x are supported
if ( isset( $logoHD['1.5x'] ) ) {
$logoUrls['1.5x'] = OutputPage::transformResourcePath(
$conf,
$logoHD['1.5x']
);
}
if ( isset( $logoHD['2x'] ) ) {
$logoUrls['2x'] = OutputPage::transformResourcePath(
$conf,
$logoHD['2x']
);
}
}
return $logoUrls;
}
/**
* @param ResourceLoaderContext $context
* @return bool
*/
public function isKnownEmpty( ResourceLoaderContext $context ) {
// Regardless of whether the files are specified, we always
// provide mw-wiki-logo styles.
return false;
}
public function getDefinitionSummary( ResourceLoaderContext $context ) {
$summary = parent::getDefinitionSummary( $context );
$summary[] = [
'logo' => $this->getConfig()->get( 'Logo' ),
'logoHD' => $this->getConfig()->get( 'LogoHD' ),
];
return $summary;
}
}