wiki.techinc.nl/maintenance/language/generateUcfirstOverrides.php
Dreamy Jazz e7393b3cc7 Exclude boilerplate maintenance code from code coverage reports
Why:
* Maintenance scripts in core have bolierplate code that is
  added before and after the class to allow directly running
  the maintenance script.
* Running the maintenance script directly has been deprecated
  since 1.40, so this boilerplate code is only to support a now
  deprecated method of running maintenance scripts.
* This code cannot also be marked as covered, due to PHPUnit
  not recognising code coverage for files.
* Therefore, it is best to ignore this boilerplate code in code
  coverage reports as it cannot be marked as covered and also
  is for deprecated code.

What:
* Wrap the boilerplate code (requiring Maintenance.php and then
  later defining the maintenance script class and running if the
  maintenance script was called directly) with @codeCoverageIgnore
  comments.
* Some files use a different boilerplate code, however, these
  should also be marked as ignored for coverage for the same
  reason that coverage is not properly reported for files.

Bug: T371167
Change-Id: I32f5c6362dfb354149a48ce9c28da9a7fc494f7c
2024-08-27 13:22:29 +01:00

96 lines
3.1 KiB
PHP

<?php
/**
* Generate a php file containing an array of
* utf8_lowercase => utf8_uppercase
* overrides. Takes as input two json files generated with generateUpperCharTable.php
* as input.
*
* Example run:
* # this will prepare a file to use to make hhvm's Language::ucfirst work like php7's
*
* $ php7.2 maintenance/language/generateUpperCharTable.php --outfile php7.2.json
* $ hhvm --php maintenance/language/generateUpperCharTable.php --outfile hhvm.json
* $ hhvm maintenance/language/generateUcfirstOverrides.php \
* --override hhvm.json --with php7.2.json --outfile test.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
* @ingroup MaintenanceLanguage
*/
use Wikimedia\StaticArrayWriter;
// @codeCoverageIgnoreStart
require_once __DIR__ . '/../Maintenance.php';
// @codeCoverageIgnoreEnd
class GenerateUcfirstOverrides extends Maintenance {
public function __construct() {
parent::__construct();
$this->addDescription(
'Generates a php source file containing a definition for mb_strtoupper overrides' );
$this->addOption( 'outfile', 'Output file', true, true, 'o' );
$this->addOption( 'override', 'Char table we want to override',
true, true, false, true );
$this->addOption( 'with', 'Char table we want to obtain', true, true );
}
public function execute() {
$outfile = $this->getOption( 'outfile' );
$fromTables = [];
foreach ( $this->getOption( 'override' ) as $fileName ) {
$fromTables[] = $this->loadJson( $fileName );
}
$to = $this->loadJson( $this->getOption( 'with' ) );
$overrides = [];
foreach ( $fromTables as $from ) {
foreach ( $from as $lc => $uc ) {
$ref = $to[$lc] ?? null;
if ( $ref !== null && $ref !== $uc ) {
$overrides[$lc] = $ref;
}
}
}
ksort( $overrides );
$writer = new StaticArrayWriter();
file_put_contents(
$outfile,
$writer->create( $overrides, 'File created by generateUcfirstOverrides.php' )
);
}
private function loadJson( $filename ) {
$data = file_get_contents( $filename );
if ( $data === false ) {
$msg = sprintf( "Could not load data from file '%s'\n", $filename );
$this->fatalError( $msg );
}
$json = json_decode( $data, true );
if ( $json === null ) {
$msg = sprintf( "Invalid json in the data file %s\n", $filename );
$this->fatalError( $msg, 2 );
}
return $json;
}
}
// @codeCoverageIgnoreStart
$maintClass = GenerateUcfirstOverrides::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd