4449235516
I177dad88 introduced the skin version user preference field and associated configuration values. Per T242381, the field is to presented as a checkbox with the implied storage type of a boolean where a string is needed. A PreferencesFormPreSave hook handler was added to adapt values of either data type to the other. While this was a neat solution to a minor nit, the adapter's implementation is incompatible with the GlobalPreferences extension as the PreferencesFormPreSave hook isn't run whilst saving global preferences. Rather than adding an equivalent hook to the GlobalPreferences extension, create a custom field based on a checkbox with the adapter included. This allows us to: - Separate the business logic concerned with preserving the user's VectorSkinVersion preference if they've simply disabled Vector from the adapter - Simplify the adapter's implementation - Forego adding hooks to the GlobalPreferences codebase Additional changes: - Replace repeated string literals with equivalent constants in tests/phpunit/integration/VectorHooksTest.php Bug: T258493 Change-Id: I628435a4ad676f55534191b8c10147be28be5d73
108 lines
3.2 KiB
PHP
108 lines
3.2 KiB
PHP
<?php
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
|
|
namespace MediaWiki\Skins\Vector\Tests\Integration;
|
|
|
|
use Vector\Constants;
|
|
use Vector\HTMLForm\Fields\HTMLLegacySkinVersionField;
|
|
|
|
/**
|
|
* @group Vector
|
|
* @coversDefaultClass \Vector\HTMLForm\Fields\HTMLLegacySkinVersionField
|
|
*/
|
|
class HTMLLegacySkinVersionFieldTest extends \MediaWikiTestCase {
|
|
|
|
public function provideDefault() {
|
|
yield [ 'true' ];
|
|
yield [ 1 ];
|
|
}
|
|
|
|
/**
|
|
* @dataProvider provideDefault
|
|
* @covers ::__construct
|
|
*/
|
|
public function testConstructValidatesDefault( $default ) {
|
|
$this->expectException( \Wikimedia\Assert\PreconditionException::class );
|
|
|
|
new HTMLLegacySkinVersionField( [
|
|
'default' => $default
|
|
] );
|
|
}
|
|
|
|
public function provideGetInput() {
|
|
yield [ Constants::SKIN_VERSION_LEGACY, true ];
|
|
yield [ Constants::SKIN_VERSION_LATEST, false ];
|
|
}
|
|
|
|
/**
|
|
* @dataProvider provideGetInput
|
|
* @covers ::getInputHTML
|
|
* @covers ::getInputOOUI
|
|
*/
|
|
public function testGetInput( $skinVersionValue, $checkValue ) {
|
|
$params = [
|
|
'fieldname' => 'VectorSkinVersion',
|
|
'class' => HTMLLegacySkinVersionField::class,
|
|
'section' => 'rendering/skin/skin-prefs',
|
|
'label-message' => 'prefs-vector-enable-vector-1-label',
|
|
'help-message' => 'prefs-vector-enable-vector-1-help',
|
|
'default' => true,
|
|
'hide-if' => [ '!==', 'wpskin', Constants::SKIN_NAME ],
|
|
];
|
|
$skinVersionField = new HTMLLegacySkinVersionField( $params );
|
|
$checkField = new \HTMLCheckField( $params );
|
|
|
|
$this->assertSame(
|
|
$skinVersionField->getInputHTML( $skinVersionValue ),
|
|
$checkField->getInputHTML( $checkValue ),
|
|
'::getInputHTML matches HTMLCheckField::getInputHTML with mapped value'
|
|
);
|
|
|
|
$this->assertEquals(
|
|
$skinVersionField->getInputOOUI( $skinVersionValue ),
|
|
$checkField->getInputOOUI( $checkValue ),
|
|
'::getInputOOUI matches HTMLCheckField::getInputOOUI with mapped value'
|
|
);
|
|
}
|
|
|
|
public function provideLoadDataFromRequest() {
|
|
yield [ null, Constants::SKIN_VERSION_LEGACY ];
|
|
yield [ true, Constants::SKIN_VERSION_LEGACY ];
|
|
yield [ false, Constants::SKIN_VERSION_LATEST ];
|
|
}
|
|
|
|
/**
|
|
* @dataProvider provideLoadDataFromRequest
|
|
* @covers ::loadDataFromRequest
|
|
*/
|
|
public function testLoadDataFromRequest( $wpVectorSkinVersion, $expectedResult ) {
|
|
$skinVerionField = new HTMLLegacySkinVersionField( [
|
|
'fieldname' => 'VectorSkinVersion',
|
|
'default' => true,
|
|
] );
|
|
|
|
$request = new \WebRequest();
|
|
$request->setVal( 'wpVectorSkinVersion', $wpVectorSkinVersion );
|
|
|
|
$this->assertSame( $skinVerionField->loadDataFromRequest( $request ), $expectedResult );
|
|
}
|
|
}
|