SpecialJavaScriptTest::exportQUnit() - Code Metrics - Inspection of "Daily Inspection: Merge "Remove skin mode of Speci..." - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (04580f)

unknown

created 2016-04-04 17:07 UTC

SpecialJavaScriptTest::exportQUnit() A

↳ Parent: SpecialJavaScriptTest

Complexity

Conditions	2
Paths	2

Size

Total Lines	62
Code Lines	36

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	62
rs	9.4743
cc	2
eloc	36
nc	2
nop	0

How to fix Long Method

<?php
/**
 * Implements Special:JavaScriptTest
 *
 * 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 SpecialPage
 */

/**
 * @ingroup SpecialPage
 */
class SpecialJavaScriptTest extends SpecialPage {

	public function __construct() {
		parent::__construct( 'JavaScriptTest' );
	}

	public function execute( $par ) {
		$out = $this->getOutput();

		$this->setHeaders();
		$out->disallowUserJs();

		// This special page is disabled by default ($wgEnableJavaScriptTest), and contains
		// no sensitive data. In order to allow TestSwarm to embed it into a test client window,
		// we need to allow iframing of this page.
		$out->allowClickjacking();

		// Sub resource: Internal JavaScript export bundle for QUnit
		if ( $par === 'qunit/export' ) {
			$this->exportQUnit();
			return;
		}

		// Regular view: QUnit test runner
		// (Support "/qunit" and "/qunit/plain" for backwards compatibility)
		if ( $par === null || $par === '' || $par === 'qunit' || $par === 'qunit/plain' ) {
			$this->plainQUnit();
			return;
		}

		// Unknown action
		$out->setStatusCode( 404 );
		$out->setPageTitle( $this->msg( 'javascripttest' ) );
		$out->addHTML(
			'<div class="error">'
			. $this->msg( 'javascripttest-pagetext-unknownaction' )
				->plaintextParams( $par )->parseAsBlock()
			. '</div>'
		);
	}

	/**
	 * Get summary text wrapped in a container
	 *
	 * @return string HTML
	 */
	private function getSummaryHtml() {
		$summary = $this->msg( 'javascripttest-qunit-intro' )
			->params( 'https://www.mediawiki.org/wiki/Manual:JavaScript_unit_testing' )
			->parseAsBlock();
		return "<div id=\"mw-javascripttest-summary\">$summary</div>";
	}

	/**
	 * Generate self-sufficient JavaScript payload to run the tests elsewhere.
	 *
	 * Includes startup module to request modules from ResourceLoader.
	 *
	 * Note: This modifies the registry to replace 'jquery.qunit' with an
	 * empty module to allow external environment to preload QUnit with any
	 * neccecary framework adapters (e.g. Karma). Loading it again would
	 * re-define QUnit and dereference event handlers from Karma.
	 */
	private function exportQUnit() {
		$out = $this->getOutput();
		$out->disable();

		$rl = $out->getResourceLoader();

		$query = [
			'lang' => $this->getLanguage()->getCode(),
			'skin' => $this->getSkin()->getSkinName(),
			'debug' => ResourceLoader::inDebugMode() ? 'true' : 'false',
			'target' => 'test',
		];
		$embedContext = new ResourceLoaderContext( $rl, new FauxRequest( $query ) );
		$query['only'] = 'scripts';
		$startupContext = new ResourceLoaderContext( $rl, new FauxRequest( $query ) );

		$query['raw'] = true;

		$modules = $rl->getTestModuleNames( 'qunit' );

		// Disable autostart because we load modules asynchronously. By default, QUnit would start
		// at domready when there are no tests loaded and also fire 'QUnit.done' which then instructs
		// Karma to end the run before the tests even started.
		$qunitConfig = 'QUnit.config.autostart = false;'
			. 'if (window.__karma__) {'
			// karma-qunit's use of autostart=false and QUnit.start conflicts with ours.
			// Hack around this by replacing 'karma.loaded' with a no-op and call it ourselves later.
			// See <https://github.com/karma-runner/karma-qunit/issues/27>.
			. 'window.__karma__.loaded = function () {};'
			. '}';

		// The below is essentially a pure-javascript version of OutputPage::getHeadScripts.
		$startup = $rl->makeModuleResponse( $startupContext, [
			'startup' => $rl->getModule( 'startup' ),
		] );
		// Embed page-specific mw.config variables.
		// The current Special page shouldn't be relevant to tests, but various modules (which
		// are loaded before the test suites), reference mw.config while initialising.
		$code = ResourceLoader::makeConfigSetScript( $out->getJSVars() );
		// Embed private modules as they're not allowed to be loaded dynamically
		$code .= $rl->makeModuleResponse( $embedContext, [
			'user.options' => $rl->getModule( 'user.options' ),
			'user.tokens' => $rl->getModule( 'user.tokens' ),
		] );
		// Catch exceptions (such as "dependency missing" or "unknown module") so that we
		// always start QUnit. Re-throw so that they are caught and reported as global exceptions
		// by QUnit and Karma.
		$code .= '(function () {'
			. 'var start = window.__karma__ ? window.__karma__.start : QUnit.start;'
			. 'try {'
			. 'mw.loader.using( ' . Xml::encodeJsVar( $modules ) . ' ).always( start );'
			. '} catch ( e ) { start(); throw e; }'
			. '}());';

		header( 'Content-Type: text/javascript; charset=utf-8' );
		header( 'Cache-Control: private, no-cache, must-revalidate' );
		header( 'Pragma: no-cache' );
		echo $qunitConfig;
		echo $startup;
		// The following has to be deferred via RLQ because the startup module is asynchronous.
		echo ResourceLoader::makeLoaderConditionalScript( $code );

	}

	private function plainQUnit() {
		$out = $this->getOutput();
		$out->disable();

		$styles = $out->makeResourceLoaderLink( 'jquery.qunit',
			ResourceLoaderModule::TYPE_STYLES
		);

		// Use 'raw' because QUnit loads before ResourceLoader initialises (omit mw.loader.state call)
		// Use 'test' to ensure OutputPage doesn't use the "async" attribute because QUnit must
		// load before qunit/export.
		$scripts = $out->makeResourceLoaderLink( 'jquery.qunit',
			ResourceLoaderModule::TYPE_SCRIPTS,
			[ 'raw' => true, 'sync' => true ]
		);

		$head = implode( "\n", array_merge( $styles['html'], $scripts['html'] ) );
		$summary = $this->getSummaryHtml();
		$html = <<<HTML
<!DOCTYPE html>
<title>QUnit</title>
$head
$summary
<div id="qunit"></div>
HTML;

		$url = $this->getPageTitle( 'qunit/export' )->getFullURL( [
			'debug' => ResourceLoader::inDebugMode() ? 'true' : 'false',
		] );
		$html .= "\n" . Html::linkedScript( $url );

		header( 'Content-Type: text/html; charset=utf-8' );
		echo $html;
	}

	/**
	 * Return an array of subpages that this special page will accept.
	 *
	 * @return string[] subpages
	 */
	public function getSubpagesForPrefixSearch() {
		return self::$frameworks;
	}

	protected function getGroupName() {
		return 'other';
	}
}


1			<?php
2			/**
3			* Implements Special:JavaScriptTest
4			*
5			* This program is free software; you can redistribute it and/or modify
6			* it under the terms of the GNU General Public License as published by
7			* the Free Software Foundation; either version 2 of the License, or
8			* (at your option) any later version.
9			*
10			* This program is distributed in the hope that it will be useful,
11			* but WITHOUT ANY WARRANTY; without even the implied warranty of
12			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13			* GNU General Public License for more details.
14			*
15			* You should have received a copy of the GNU General Public License along
16			* with this program; if not, write to the Free Software Foundation, Inc.,
17			* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18			* http://www.gnu.org/copyleft/gpl.html
19			*
20			* @file
21			* @ingroup SpecialPage
22			*/
23
24			/**
25			* @ingroup SpecialPage
26			*/
27			class SpecialJavaScriptTest extends SpecialPage {
28
29			public function __construct() {
30			parent::__construct( 'JavaScriptTest' );
31			}
32
33			public function execute( $par ) {
34			$out = $this->getOutput();
35
36			$this->setHeaders();
37			$out->disallowUserJs();
38
39			// This special page is disabled by default ($wgEnableJavaScriptTest), and contains
40			// no sensitive data. In order to allow TestSwarm to embed it into a test client window,
41			// we need to allow iframing of this page.
42			$out->allowClickjacking();
43
44			// Sub resource: Internal JavaScript export bundle for QUnit
45			if ( $par === 'qunit/export' ) {
46			$this->exportQUnit();
47			return;
48			}
49
50			// Regular view: QUnit test runner
51			// (Support "/qunit" and "/qunit/plain" for backwards compatibility)
52			if ( $par === null \|\| $par === '' \|\| $par === 'qunit' \|\| $par === 'qunit/plain' ) {
53			$this->plainQUnit();
54			return;
55			}
56
57			// Unknown action
58			$out->setStatusCode( 404 );
59			$out->setPageTitle( $this->msg( 'javascripttest' ) );
60			$out->addHTML(
61			'<div class="error">'
62			. $this->msg( 'javascripttest-pagetext-unknownaction' )
63			->plaintextParams( $par )->parseAsBlock()
64			. '</div>'
65			);
66			}
67
68			/**
69			* Get summary text wrapped in a container
70			*
71			* @return string HTML
72			*/
73			private function getSummaryHtml() {
74			$summary = $this->msg( 'javascripttest-qunit-intro' )
75			->params( 'https://www.mediawiki.org/wiki/Manual:JavaScript_unit_testing' )
76			->parseAsBlock();
77			return "<div id=\"mw-javascripttest-summary\">$summary</div>";
78			}
79
80			/**
81			* Generate self-sufficient JavaScript payload to run the tests elsewhere.
82			*
83			* Includes startup module to request modules from ResourceLoader.
84			*
85			* Note: This modifies the registry to replace 'jquery.qunit' with an
86			* empty module to allow external environment to preload QUnit with any
87			* neccecary framework adapters (e.g. Karma). Loading it again would
88			* re-define QUnit and dereference event handlers from Karma.
89			*/
90			private function exportQUnit() {
91			$out = $this->getOutput();
92			$out->disable();
93
94			$rl = $out->getResourceLoader();
95
96			$query = [
97			'lang' => $this->getLanguage()->getCode(),
98			'skin' => $this->getSkin()->getSkinName(),
99			'debug' => ResourceLoader::inDebugMode() ? 'true' : 'false',
100			'target' => 'test',
101			];
102			$embedContext = new ResourceLoaderContext( $rl, new FauxRequest( $query ) );
103			$query['only'] = 'scripts';
104			$startupContext = new ResourceLoaderContext( $rl, new FauxRequest( $query ) );
105
106			$query['raw'] = true;
107
108			$modules = $rl->getTestModuleNames( 'qunit' );
109
110			// Disable autostart because we load modules asynchronously. By default, QUnit would start
111			// at domready when there are no tests loaded and also fire 'QUnit.done' which then instructs
112			// Karma to end the run before the tests even started.
113			$qunitConfig = 'QUnit.config.autostart = false;'
114			. 'if (window.__karma__) {'
115			// karma-qunit's use of autostart=false and QUnit.start conflicts with ours.
116			// Hack around this by replacing 'karma.loaded' with a no-op and call it ourselves later.
117			// See <https://github.com/karma-runner/karma-qunit/issues/27>.
118			. 'window.__karma__.loaded = function () {};'
119			. '}';
120
121			// The below is essentially a pure-javascript version of OutputPage::getHeadScripts.
122			$startup = $rl->makeModuleResponse( $startupContext, [
123			'startup' => $rl->getModule( 'startup' ),
124			] );
125			// Embed page-specific mw.config variables.
126			// The current Special page shouldn't be relevant to tests, but various modules (which
127			// are loaded before the test suites), reference mw.config while initialising.
128			$code = ResourceLoader::makeConfigSetScript( $out->getJSVars() );
129			// Embed private modules as they're not allowed to be loaded dynamically
130			$code .= $rl->makeModuleResponse( $embedContext, [
131			'user.options' => $rl->getModule( 'user.options' ),
132			'user.tokens' => $rl->getModule( 'user.tokens' ),
133			] );
134			// Catch exceptions (such as "dependency missing" or "unknown module") so that we
135			// always start QUnit. Re-throw so that they are caught and reported as global exceptions
136			// by QUnit and Karma.
137			$code .= '(function () {'
138			. 'var start = window.__karma__ ? window.__karma__.start : QUnit.start;'
139			. 'try {'
140			. 'mw.loader.using( ' . Xml::encodeJsVar( $modules ) . ' ).always( start );'
141			. '} catch ( e ) { start(); throw e; }'
142			. '}());';
143
144			header( 'Content-Type: text/javascript; charset=utf-8' );
145			header( 'Cache-Control: private, no-cache, must-revalidate' );
146			header( 'Pragma: no-cache' );
147			echo $qunitConfig;
148			echo $startup;
149			// The following has to be deferred via RLQ because the startup module is asynchronous.
150			echo ResourceLoader::makeLoaderConditionalScript( $code );
			0 ignored issues – show Deprecated Code introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The method `ResourceLoader::makeLoaderConditionalScript()` has been deprecated with message: since 1.25; use makeInlineScript instead This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
151			}
152
153			private function plainQUnit() {
154			$out = $this->getOutput();
155			$out->disable();
156
157			$styles = $out->makeResourceLoaderLink( 'jquery.qunit',
158			ResourceLoaderModule::TYPE_STYLES
159			);
160
161			// Use 'raw' because QUnit loads before ResourceLoader initialises (omit mw.loader.state call)
162			// Use 'test' to ensure OutputPage doesn't use the "async" attribute because QUnit must
163			// load before qunit/export.
164			$scripts = $out->makeResourceLoaderLink( 'jquery.qunit',
165			ResourceLoaderModule::TYPE_SCRIPTS,
166			[ 'raw' => true, 'sync' => true ]
167			);
168
169			$head = implode( "\n", array_merge( $styles['html'], $scripts['html'] ) );
170			$summary = $this->getSummaryHtml();
171			$html = <<<HTML
172			<!DOCTYPE html>
173			<title>QUnit</title>
174			$head
175			$summary
176			<div id="qunit"></div>
177			HTML;
178
179			$url = $this->getPageTitle( 'qunit/export' )->getFullURL( [
180			'debug' => ResourceLoader::inDebugMode() ? 'true' : 'false',
181			] );
182			$html .= "\n" . Html::linkedScript( $url );
183
184			header( 'Content-Type: text/html; charset=utf-8' );
185			echo $html;
186			}
187
188			/**
189			* Return an array of subpages that this special page will accept.
190			*
191			* @return string[] subpages
192			*/
193			public function getSubpagesForPrefixSearch() {
194			return self::$frameworks;
195			}
196
197			protected function getGroupName() {
198			return 'other';
199			}
200			}
201

wikimedia / mediawiki

Branch — master (04580f)

SpecialJavaScriptTest::exportQUnit() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like