https://www.mediawiki.org/wiki/Special:Code/MediaWiki/114009

Revision: 114009
Author:   happydog
Date:     2012-03-16 11:40:44 +0000 (Fri, 16 Mar 2012)
Log Message:
-----------
Tidied up grouping/ordering of CodeReview.php so it is a bit more clearly 
delineated.  Hunting for configuration settings was becoming somewhat painful!

No functional changes, just some comments to delineate sections, and a couple 
of items moved so related stuff is grouped together.

Modified Paths:
--------------
    trunk/extensions/CodeReview/CodeReview.php

Modified: trunk/extensions/CodeReview/CodeReview.php
===================================================================
--- trunk/extensions/CodeReview/CodeReview.php  2012-03-16 11:14:50 UTC (rev 
114008)
+++ trunk/extensions/CodeReview/CodeReview.php  2012-03-16 11:40:44 UTC (rev 
114009)
@@ -27,6 +27,8 @@
 
 */
 
+/******** EXTENSION CREDITS ********/
+
 $wgExtensionCredits['specialpage'][] = array(
        'path' => __FILE__,
        'name' => 'CodeReview',
@@ -35,6 +37,8 @@
        'descriptionmsg' => 'codereview-desc',
 );
 
+/******** CLASS DEFINITIONS ********/
+
 $dir = dirname( __FILE__ ) . '/';
 
 $wgAutoloadClasses['ApiCodeUpdate'] = $dir . 'api/ApiCodeUpdate.php';
@@ -88,11 +92,15 @@
 $wgAutoloadClasses['SvnRevTagTablePager'] = $dir . 
'ui/CodeRevisionTagView.php';
 $wgAutoloadClasses['CodeStatusChangeTablePager'] = $dir . 
'ui/CodeRevisionStatusView.php';
 
+/******** SPECIAL PAGE SETUP ********/
+
 $wgSpecialPages['Code'] = 'SpecialCode';
 $wgSpecialPageGroups['Code'] = 'developer';
 $wgSpecialPages['RepoAdmin'] = 'SpecialRepoAdmin';
 $wgSpecialPageGroups['RepoAdmin'] = 'developer';
 
+/******** API SETUP ********/
+
 $wgAPIModules['codeupdate'] = 'ApiCodeUpdate';
 $wgAPIModules['codediff'] = 'ApiCodeDiff';
 $wgAPIModules['coderevisionupdate'] ='ApiRevisionUpdate';
@@ -101,9 +109,13 @@
 $wgAPIListModules['coderevisions'] = 'ApiQueryCodeRevisions';
 $wgAPIListModules['codetags'] = 'ApiQueryCodeTags';
 
+/******** I18N MESSAGES ********/
+
 $wgExtensionMessagesFiles['CodeReview'] = $dir . 'CodeReview.i18n.php';
 $wgExtensionMessagesFiles['CodeReviewAliases'] = $dir . 'CodeReview.alias.php';
 
+/******** NEW USER RIGHTS ********/
+
 $wgAvailableRights[] = 'repoadmin';
 $wgAvailableRights[] = 'codereview-use';
 $wgAvailableRights[] = 'codereview-add-tag';
@@ -127,6 +139,8 @@
 
 $wgGroupPermissions['svnadmins']['repoadmin'] = true;
 
+/******** CONFIGURATION SETTINGS ********/
+
 // Constants returned from CodeRepository::getDiff() when no diff can be 
calculated.
 
 // If you can't directly access the remote SVN repo, you can set this
@@ -147,40 +161,6 @@
 // Shuffle the tag cloud
 $wgCodeReviewShuffleTagCloud = false;
 
-$commonModuleInfo = array(
-       'localBasePath' => dirname( __FILE__ ) . '/modules',
-       'remoteExtPath' => 'CodeReview/modules',
-);
-
-// Styles and any code common to all Special:Code subviews:
-$wgResourceModules['ext.codereview'] = array(
-       'scripts' => 'ext.codereview.js',
-       'dependencies' => 'jquery.suggestions',
-) + $commonModuleInfo;
-
-$wgResourceModules['ext.codereview.styles'] = array(
-       'styles' => 'ext.codereview.styles.css',
-) + $commonModuleInfo;
-
-// On-demand diff loader for CodeRevisionView:
-$wgResourceModules['ext.codereview.loaddiff'] = array(
-       'scripts' => 'ext.codereview.loaddiff.js'
-) + $commonModuleInfo;
-
-// Revision tooltips CodeRevisionView:
-$wgResourceModules['ext.codereview.tooltips'] = array(
-       'scripts' => 'ext.codereview.tooltips.js',
-       'dependencies' => 'jquery.tipsy',
-) + $commonModuleInfo;
-
-// Revision 'scapmap':
-$wgResourceModules['ext.codereview.overview'] = array(
-       'scripts' => 'ext.codereview.overview.js',
-       'styles' => 'ext.codereview.overview.css',
-       'dependencies' => 'jquery.tipsy',
-       'messages' => array( 'codereview-overview-title', 
'codereview-overview-desc' ),
-) + $commonModuleInfo;
-
 // If you are running a closed svn, fill the following two lines with the 
username and password
 // of a user allowed to access it. Otherwise, leave it false.
 // This is only necessary if using the shell method to access Subversion
@@ -291,6 +271,74 @@
        'tested',
 );
 
+/******** RESOURCE CONFIGURATION ********/
+
+$commonModuleInfo = array(
+       'localBasePath' => dirname( __FILE__ ) . '/modules',
+       'remoteExtPath' => 'CodeReview/modules',
+);
+
+// Styles and any code common to all Special:Code subviews:
+$wgResourceModules['ext.codereview'] = array(
+       'scripts' => 'ext.codereview.js',
+       'dependencies' => 'jquery.suggestions',
+) + $commonModuleInfo;
+
+$wgResourceModules['ext.codereview.styles'] = array(
+       'styles' => 'ext.codereview.styles.css',
+) + $commonModuleInfo;
+
+// On-demand diff loader for CodeRevisionView:
+$wgResourceModules['ext.codereview.loaddiff'] = array(
+       'scripts' => 'ext.codereview.loaddiff.js'
+) + $commonModuleInfo;
+
+// Revision tooltips CodeRevisionView:
+$wgResourceModules['ext.codereview.tooltips'] = array(
+       'scripts' => 'ext.codereview.tooltips.js',
+       'dependencies' => 'jquery.tipsy',
+) + $commonModuleInfo;
+
+// Revision 'scapmap':
+$wgResourceModules['ext.codereview.overview'] = array(
+       'scripts' => 'ext.codereview.overview.js',
+       'styles' => 'ext.codereview.overview.css',
+       'dependencies' => 'jquery.tipsy',
+       'messages' => array( 'codereview-overview-title', 
'codereview-overview-desc' ),
+) + $commonModuleInfo;
+
+# Add global JS vars
+$wgHooks['MakeGlobalVariablesScript'][] = 'efCodeReviewResourceLoaderGlobals';
+
+/**
+ * @param $values array
+ * @return bool
+ */
+function efCodeReviewResourceLoaderGlobals( &$values ){
+       # Bleugh, this is horrible
+       global $wgTitle;
+       if( $wgTitle->isSpecial( 'Code' ) ){
+               $bits = explode( '/', $wgTitle->getText() );
+               if( isset( $bits[1] ) ){
+                       $values['wgCodeReviewRepository'] = $bits[1];
+               }
+       }
+       return true;
+}
+
+# Add state messages to RL
+$wgExtensionFunctions[] = 'efCodeReviewAddTooltipMessages';
+
+function efCodeReviewAddTooltipMessages() {
+       global $wgResourceModules;
+
+       $wgResourceModules['ext.codereview.tooltips']['messages'] = array_merge(
+               CodeRevision::getPossibleStateMessageKeys(),
+               array( 'code-tooltip-withsummary', 
'code-tooltip-withoutsummary' ) );
+}
+
+/******** DB UPDATING ********/
+
 # Schema changes
 $wgHooks['LoadExtensionSchemaUpdates'][] = 'efCodeReviewSchemaUpdates';
 
@@ -366,7 +414,8 @@
        return true;
 }
 
-# Unit tests
+/******** UNIT TESTS ********/
+
 $wgHooks['UnitTestsList'][] = 'efCodeReviewUnitTests';
 
 /**
@@ -379,33 +428,3 @@
        $files[] = dirname( __FILE__ ) . '/tests/DiffHighlighterTest.php';
        return true;
 }
-
-# Add global JS vars
-$wgHooks['MakeGlobalVariablesScript'][] = 'efCodeReviewResourceLoaderGlobals';
-
-/**
- * @param $values array
- * @return bool
- */
-function efCodeReviewResourceLoaderGlobals( &$values ){
-       # Bleugh, this is horrible
-       global $wgTitle;
-       if( $wgTitle->isSpecial( 'Code' ) ){
-               $bits = explode( '/', $wgTitle->getText() );
-               if( isset( $bits[1] ) ){
-                       $values['wgCodeReviewRepository'] = $bits[1];
-               }
-       }
-       return true;
-}
-
-# Add state messages to RL
-$wgExtensionFunctions[] = 'efCodeReviewAddTooltipMessages';
-
-function efCodeReviewAddTooltipMessages() {
-       global $wgResourceModules;
-
-       $wgResourceModules['ext.codereview.tooltips']['messages'] = array_merge(
-               CodeRevision::getPossibleStateMessageKeys(),
-               array( 'code-tooltip-withsummary', 
'code-tooltip-withoutsummary' ) );
-}


_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs

Reply via email to