aboutsummaryrefslogtreecommitdiffstats
path: root/tests/qunit/data/generateJqueryMsgData.php
blob: 2f935c686414c0a25865ea54d43a98be7da3e35d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
<?php
/**
 * This PHP script defines the spec that the mediawiki.jqueryMsg module should conform to.
 *
 * It does this by looking up the results of various kinds of string parsing, with various
 * languages, in the current installation of MediaWiki. It then outputs a static specification,
 * mapping expected inputs to outputs, which is used then run by QUnit.
 */

use MediaWiki\Json\FormatJson;
use MediaWiki\Languages\LanguageFactory;
use MediaWiki\Maintenance\Maintenance;

require __DIR__ . '/../../../maintenance/Maintenance.php';

class GenerateJqueryMsgData extends Maintenance {

	private const KEY_TO_TEST_ARGS = [
		'undelete_short' => [
			[ 0 ],
			[ 1 ],
			[ 2 ],
			[ 5 ],
			[ 21 ],
			[ 101 ]
		],
		'category-subcat-count' => [
			[ 0, 10 ],
			[ 1, 1 ],
			[ 1, 2 ],
			[ 3, 30 ]
		]
	];

	private const TEST_LANGS = [ 'en', 'fr', 'ar', 'jp', 'zh', 'nl', 'ml', 'hi' ];

	/** @var LanguageFactory */
	private $languageFactory;

	public function __construct() {
		parent::__construct();
		$this->addDescription( 'Create a specification for message parsing ini JSON format' );
		// add any other options here
	}

	public function execute() {
		$this->languageFactory = $this->getServiceContainer()->getLanguageFactory();
		$data = $this->getData();
		$this->writeJsonFile( $data, __DIR__ . '/mediawiki.jqueryMsg.data.json' );
	}

	private function getData() {
		$messages = [];
		$tests = [];
		$jsData = [];
		foreach ( self::TEST_LANGS as $languageCode ) {
			$language = $this->languageFactory->getLanguage( $languageCode );
			$jsData[$languageCode] = $language->getJsData();
			foreach ( self::KEY_TO_TEST_ARGS as $key => $testArgs ) {
				foreach ( $testArgs as $args ) {
					// Get the raw message, without any transformations.
					$template = wfMessage( $key )->useDatabase( false )
						->inLanguage( $languageCode )->plain();

					// Get the magic-parsed version with args.
					$result = wfMessage( $key, ...$args )->useDatabase( false )
						->inLanguage( $languageCode )->text();

					// Record the template, args, language, and expected result
					// fake multiple languages by flattening them together.
					$langKey = $languageCode . '_' . $key;
					$messages[$langKey] = $template;
					$tests[] = [
						'name' => $languageCode . ' ' . $key . ' ' . implode( ',', $args ),
						'key' => $langKey,
						'args' => $args,
						'result' => $result,
						'lang' => $languageCode
					];
				}
			}
		}
		return [
			'messages' => $messages,
			'tests' => $tests,
			'jsData' => $jsData,
		];
	}

	private function writeJsonFile( array $data, $dataSpecFile ) {
		$phpParserData = [
			'@' => 'Last generated with ' . basename( __FILE__ ) . ' at ' . gmdate( 'r' ),
		] + $data;

		$output = FormatJson::encode( $phpParserData, true ) . "\n";
		$fp = file_put_contents( $dataSpecFile, $output );
		if ( $fp === false ) {
			die( "Couldn't write to $dataSpecFile." );
		}
	}
}

$maintClass = GenerateJqueryMsgData::class;
require_once RUN_MAINTENANCE_IF_MAIN;