Jhernandez has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/337821 )
Change subject: Hygiene: Remove useless IIFE in settingsDialog.js
......................................................................
Hygiene: Remove useless IIFE in settingsDialog.js
Change-Id: I2885e02d0e61f9e98e086ce4399bc9a18517e531
---
M src/settingsDialog.js
1 file changed, 177 insertions(+), 179 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/Popups
refs/changes/21/337821/1
diff --git a/src/settingsDialog.js b/src/settingsDialog.js
index b518695..5132939 100644
--- a/src/settingsDialog.js
+++ b/src/settingsDialog.js
@@ -1,203 +1,201 @@
-( function ( mw, $ ) {
+var mw = window.mediaWiki;
+
+/**
+ * Creates a render function that will create the settings dialog and return
+ * a set of methods to operate on it
+ * @returns {Function} render function
+ */
+module.exports = function () {
/**
- * Creates a render function that will create the settings dialog and
return
- * a set of methods to operate on it
- * @returns {Function} render function
+ * Cached settings dialog
+ *
+ * @type {jQuery}
*/
- module.exports = function () {
-
+ var $dialog,
/**
- * Cached settings dialog
+ * Cached settings overlay
*
* @type {jQuery}
*/
- var $dialog,
+ $overlay;
+
+ /**
+ * Renders the relevant form and labels in the settings dialog
+ * @param {Object} boundActions
+ * @returns {Object} object with methods to affect the rendered UI
+ */
+ return function ( boundActions ) {
+
+ if ( !$dialog ) {
+ $dialog = createSettingsDialog();
+ $overlay = $( '<div>' ).addClass( 'mwe-popups-overlay'
);
+
+ // Setup event bindings
+
+ $dialog.find( '.save' ).click( function () {
+ // Find the selected value (simple|advanced|off)
+ var selected = getSelectedSetting( $dialog ),
+ // Only simple means enabled, advanced
is disabled in favor of
+ // NavPops and off means disabled.
+ enabled = selected === 'simple';
+
+ boundActions.saveSettings( enabled );
+ } );
+ $dialog.find( '.close, .okay' ).click(
boundActions.hideSettings );
+ }
+
+ return {
/**
- * Cached settings overlay
- *
- * @type {jQuery}
+ * Append the dialog and overlay to a DOM element
+ * @param {HTMLElement} el
*/
- $overlay;
+ appendTo: function ( el ) {
+ $overlay.appendTo( el );
+ $dialog.appendTo( el );
+ },
- /**
- * Renders the relevant form and labels in the settings dialog
- * @param {Object} boundActions
- * @returns {Object} object with methods to affect the rendered
UI
- */
- return function ( boundActions ) {
+ /**
+ * Show the settings element and position it correctly
+ */
+ show: function () {
+ var h = $( window ).height(),
+ w = $( window ).width();
- if ( !$dialog ) {
- $dialog = createSettingsDialog();
- $overlay = $( '<div>' ).addClass(
'mwe-popups-overlay' );
+ $overlay.show();
- // Setup event bindings
+ // FIXME: Should recalc on browser resize
+ $dialog
+ .show()
+ .css( 'left', ( w - $dialog.outerWidth(
true ) ) / 2 )
+ .css( 'top', ( h - $dialog.outerHeight(
true ) ) / 2 );
+ },
- $dialog.find( '.save' ).click( function () {
- // Find the selected value
(simple|advanced|off)
- var selected = getSelectedSetting(
$dialog ),
- // Only simple means enabled,
advanced is disabled in favor of
- // NavPops and off means
disabled.
- enabled = selected === 'simple';
+ /**
+ * Hide the settings dialog.
+ */
+ hide: function () {
+ $overlay.hide();
+ $dialog.hide();
+ },
- boundActions.saveSettings( enabled );
- } );
- $dialog.find( '.close, .okay' ).click(
boundActions.hideSettings );
- }
+ /**
+ * Toggle the help dialog on or off
+ * @param {Boolean} visible if you want to show or hide
the help dialog
+ */
+ toggleHelp: function ( visible ) {
+ toggleHelp( $dialog, visible );
+ },
- return {
- /**
- * Append the dialog and overlay to a DOM
element
- * @param {HTMLElement} el
- */
- appendTo: function ( el ) {
- $overlay.appendTo( el );
- $dialog.appendTo( el );
- },
-
- /**
- * Show the settings element and position it
correctly
- */
- show: function () {
- var h = $( window ).height(),
- w = $( window ).width();
-
- $overlay.show();
-
- // FIXME: Should recalc on browser
resize
- $dialog
- .show()
- .css( 'left', ( w -
$dialog.outerWidth( true ) ) / 2 )
- .css( 'top', ( h -
$dialog.outerHeight( true ) ) / 2 );
- },
-
- /**
- * Hide the settings dialog.
- */
- hide: function () {
- $overlay.hide();
- $dialog.hide();
- },
-
- /**
- * Toggle the help dialog on or off
- * @param {Boolean} visible if you want to show
or hide the help dialog
- */
- toggleHelp: function ( visible ) {
- toggleHelp( $dialog, visible );
- },
-
- /**
- * Update the form depending on the enabled flag
- *
- * If false and no navpops, then checks 'off'
- * If true, then checks 'on'
- * If false, and there are navpops, then checks
'advanced'
- *
- * @param {Boolean} enabled if page previews
are enabled
- */
- setEnabled: function ( enabled ) {
- var name = 'off';
- if ( enabled ) {
- name = 'simple';
- } else if ( isNavPopupsEnabled() ) {
- name = 'advanced';
- }
-
- // Check the appropiate radio button
- $dialog.find( '#mwe-popups-settings-' +
name )
- .prop( 'checked', true );
+ /**
+ * Update the form depending on the enabled flag
+ *
+ * If false and no navpops, then checks 'off'
+ * If true, then checks 'on'
+ * If false, and there are navpops, then checks
'advanced'
+ *
+ * @param {Boolean} enabled if page previews are enabled
+ */
+ setEnabled: function ( enabled ) {
+ var name = 'off';
+ if ( enabled ) {
+ name = 'simple';
+ } else if ( isNavPopupsEnabled() ) {
+ name = 'advanced';
}
- };
+
+ // Check the appropiate radio button
+ $dialog.find( '#mwe-popups-settings-' + name )
+ .prop( 'checked', true );
+ }
};
};
+};
- /**
- * Create the settings dialog
- *
- * @return {jQuery} settings dialog
- */
- function createSettingsDialog() {
- var $el,
- path = mw.config.get( 'wgExtensionAssetsPath' ) +
'/Popups/resources/ext.popups/images/',
- choices = [
- {
- id: 'simple',
- name: mw.msg(
'popups-settings-option-simple' ),
- description: mw.msg(
'popups-settings-option-simple-description' ),
- image: path + 'hovercard.svg',
- isChecked: true
- },
- {
- id: 'advanced',
- name: mw.msg(
'popups-settings-option-advanced' ),
- description: mw.msg(
'popups-settings-option-advanced-description' ),
- image: path + 'navpop.svg'
- },
- {
- id: 'off',
- name: mw.msg(
'popups-settings-option-off' )
- }
- ];
+/**
+ * Create the settings dialog
+ *
+ * @return {jQuery} settings dialog
+ */
+function createSettingsDialog() {
+ var $el,
+ path = mw.config.get( 'wgExtensionAssetsPath' ) +
'/Popups/resources/ext.popups/images/',
+ choices = [
+ {
+ id: 'simple',
+ name: mw.msg( 'popups-settings-option-simple' ),
+ description: mw.msg(
'popups-settings-option-simple-description' ),
+ image: path + 'hovercard.svg',
+ isChecked: true
+ },
+ {
+ id: 'advanced',
+ name: mw.msg( 'popups-settings-option-advanced'
),
+ description: mw.msg(
'popups-settings-option-advanced-description' ),
+ image: path + 'navpop.svg'
+ },
+ {
+ id: 'off',
+ name: mw.msg( 'popups-settings-option-off' )
+ }
+ ];
- if ( !isNavPopupsEnabled() ) {
- // remove the advanced option
- choices.splice( 1, 1 );
- }
-
- // render the template
- $el = mw.template.get( 'ext.popups', 'settings.mustache'
).render( {
- heading: mw.msg( 'popups-settings-title' ),
- closeLabel: mw.msg( 'popups-settings-cancel' ),
- saveLabel: mw.msg( 'popups-settings-save' ),
- helpText: mw.msg( 'popups-settings-help' ),
- okLabel: mw.msg( 'popups-settings-help-ok' ),
- descriptionText: mw.msg( 'popups-settings-description'
),
- choices: choices
- } );
-
- return $el;
+ if ( !isNavPopupsEnabled() ) {
+ // remove the advanced option
+ choices.splice( 1, 1 );
}
- /**
- * Get the selected value on the radio button
- *
- * @param {jQuery.Object} $el the element to extract the setting from
- * @return {String} Which should be (simple|advanced|off)
- */
- function getSelectedSetting( $el ) {
- return $el.find(
- 'input[name=mwe-popups-setting]:checked,
#mwe-popups-settings'
- ).val();
+ // render the template
+ $el = mw.template.get( 'ext.popups', 'settings.mustache' ).render( {
+ heading: mw.msg( 'popups-settings-title' ),
+ closeLabel: mw.msg( 'popups-settings-cancel' ),
+ saveLabel: mw.msg( 'popups-settings-save' ),
+ helpText: mw.msg( 'popups-settings-help' ),
+ okLabel: mw.msg( 'popups-settings-help-ok' ),
+ descriptionText: mw.msg( 'popups-settings-description' ),
+ choices: choices
+ } );
+
+ return $el;
+}
+
+/**
+ * Get the selected value on the radio button
+ *
+ * @param {jQuery.Object} $el the element to extract the setting from
+ * @return {String} Which should be (simple|advanced|off)
+ */
+function getSelectedSetting( $el ) {
+ return $el.find(
+ 'input[name=mwe-popups-setting]:checked, #mwe-popups-settings'
+ ).val();
+}
+
+/**
+ * Toggles the visibility between a form and the help
+ * @param {jQuery.Object} $el element that contains form and help
+ * @param {Boolean} visible if the help should be visible, or the form
+ */
+function toggleHelp( $el, visible ) {
+ var $dialog = $( '#mwe-popups-settings' ),
+ formSelectors = 'main, .save, .close',
+ helpSelectors = '.mwe-popups-settings-help, .okay';
+
+ if ( visible ) {
+ $dialog.find( formSelectors ).hide();
+ $dialog.find( helpSelectors ).show();
+ } else {
+ $dialog.find( formSelectors ).show();
+ $dialog.find( helpSelectors ).hide();
}
+}
- /**
- * Toggles the visibility between a form and the help
- * @param {jQuery.Object} $el element that contains form and help
- * @param {Boolean} visible if the help should be visible, or the form
- */
- function toggleHelp( $el, visible ) {
- var $dialog = $( '#mwe-popups-settings' ),
- formSelectors = 'main, .save, .close',
- helpSelectors = '.mwe-popups-settings-help, .okay';
-
- if ( visible ) {
- $dialog.find( formSelectors ).hide();
- $dialog.find( helpSelectors ).show();
- } else {
- $dialog.find( formSelectors ).show();
- $dialog.find( helpSelectors ).hide();
- }
- }
-
- /**
- * Checks if the NavigationPopups gadget is enabled by looking at the
global
- * variables
- * @returns {Boolean} if navpops was found to be enabled
- */
- function isNavPopupsEnabled() {
- /* global pg: false*/
- return typeof pg !== 'undefined' && pg.fn.disablePopups !==
undefined;
- }
-
-}( mediaWiki, jQuery ) );
+/**
+ * Checks if the NavigationPopups gadget is enabled by looking at the global
+ * variables
+ * @returns {Boolean} if navpops was found to be enabled
+ */
+function isNavPopupsEnabled() {
+ /* global pg: false*/
+ return typeof pg !== 'undefined' && pg.fn.disablePopups !== undefined;
+}
--
To view, visit https://gerrit.wikimedia.org/r/337821
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I2885e02d0e61f9e98e086ce4399bc9a18517e531
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Popups
Gerrit-Branch: master
Gerrit-Owner: Jhernandez <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
