Use WikiProject banner shell on draft talk pages (#365)

* allow es6 in test files (since they use node) * make existing test strings multi-line, for readability * add banner shell if needed * Use WikiProject banner shell on draft talk pages - Fix #319 Implement WP:PIQA (put the article's class rating in the banner shell instead of in the wikiproject templates) - Fix #73 Multiple WikiProject banners should be collapsed in {{WikiProject banner shell}} - In unit tests, switch from single quotes to backticks, for increased multi-line readability. * fix linter errors * fix regex bug * add a banner shell, even if there's only 1 wikiproject * handle existing banner shell * remove extra line breaks between banners * add test case * add template redirect I saw in the wild today * add test. mark it as skipped since it's failing * tweak comments * completely rewrite AFCH.addTalkPageBanners() * get rid of "X banners added" edit summary code. simplifies things * remove 3 unused parameters from AFCH.addTalkPageBanners * fix linter errors * simplify AFCH.addTalkPageBanners return values
wikimedia-gadgets · Aug 23, 2024 · 655a71a · 655a71a
1 parent d4d8ef6
commit 655a71a
Show file tree

Hide file tree

Showing 4 changed files with 343 additions and 182 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -12,6 +12,16 @@
 		"mw": "writable",
 		"OO": "readonly"
 	},
+	"overrides": [
+		{
+			"files": [
+				"tests/*"
+			],
+			"parserOptions": {
+				"ecmaVersion": 6
+			}
+		}
+	],
 	"rules": {
 		"camelcase": "off",
 		"eqeqeq": "warn",

diff --git a/src/modules/core.js b/src/modules/core.js
@@ -1641,78 +1641,110 @@
 		},
 
 		/**
-		 * @param {string} talkText Wikitext of the draft talk page
+		 * @param {string} wikicode Wikitext of the draft talk page
 		 * @param {string} newAssessment Value of "Article assessment" dropdown list, or "" if blank
 		 * @param {number} revId Revision ID of the draft that is being accepted
 		 * @param {boolean} isBiography Value of the "Is the article a biography?" check box
 		 * @param {Array} newWikiProjects Value of the "Add WikiPrjects" part of the form. The <input> is a chips interface called jquery.chosen. Note that if there are existing WikiProject banners on the page, the form will auto-add those to the "Add WikiProjects" part of the form when it first loads.
 		 * @param {string} lifeStatus Value of "Is the subject alive?" dropdown list ("unknown", "living", "dead")
 		 * @param {string} subjectName Value of the "Subject name (last, first)" text input, or "" if blank
-		 * @param {Array<Object>} existingWikiProjects An array of associative arrays. The associative arrays contain the keys {string} displayName (example: Somalia), {string} templateName (example: WikiProject Somalia), and {boolean} alreadyOnPage
-		 * @param {boolean} alreadyHasWPBio
-		 * @param {null} existingWPBioTemplateName
-		 * @return {Object} { {string} talkText, {number} countOfWikiProjectsAdded, {number} countOfWikiProjectsRemoved }
+		 * @return {Object} wikicode
 		 */
-		addTalkPageBanners: function ( talkText, newAssessment, revId, isBiography, newWikiProjects, lifeStatus, subjectName, existingWikiProjects, alreadyHasWPBio, existingWPBioTemplateName ) {
-			var talkTextPrefix = '';
+		addTalkPageBanners: function ( wikicode, newAssessment, revId, isBiography, newWikiProjects, lifeStatus, subjectName ) {
+			// build an array of all banners already on page
+			var bannerTemplates = 'wikiproject (?!banner)|football|oka';
+			var bannerTemplateRegEx = new RegExp( '{{(?:' + bannerTemplates + ')[^}]+}}', 'gi' );
+			var banners = wikicode.match( bannerTemplateRegEx ) || [];
+
+			// delete all banners already on page
+			banners.forEach( function ( v ) {
+				wikicode = wikicode.replace( v, '' );
+			} );
 
-			// Add the AFC banner
-			talkTextPrefix += '{{subst:WPAFC/article|class=' + newAssessment +
-				( revId ? '|oldid=' + revId : '' ) + '}}';
+			// delete shell already on page
+			var bannerShellTemplates = 'WikiProject banner shell|WikiProjectBanners|WikiProject Banners|WPB|WPBS|WikiProject cooperation shell|Wikiprojectbannershell|WikiProject Banner Shell|Wpb|WPBannerShell|Wpbs|Wikiprojectbanners|WP Banner Shell|WP banner shell|Bannershell|Wikiproject banner shell|WIkiProjectBanner Shell|WikiProjectBannerShell|WikiProject BannerShell|Coopshell|WikiprojectBannerShell|WikiProject Shell|Scope shell|Project shell|WikiProject shell|WikiProject banner|Wpbannershell|Multiple wikiprojects|Wikiproject banner holder|Project banner holder|WikiProject banner shell\\/test1|Article assessment|WikiProject bannershell';
+			var bannerShellRegEx = new RegExp( '{{(?:' + bannerShellTemplates + ')[^}]*}}', 'is' );
+			wikicode = wikicode.replace( bannerShellRegEx, '' );
 
-			// Add biography banner if specified
-			if ( isBiography ) {
-				// Ensure we don't have duplicate biography tags
-				AFCH.removeFromArray( newWikiProjects, 'WikiProject Biography' );
+			// trim. makes unit tests more stable
+			wikicode = wikicode.trim();
+
+			// add AFC banner to array
+			banners.push(
+				'{{subst:WPAFC/article' +
+				( revId ? '|oldid=' + revId : '' ) +
+				'}}'
+			);
 
-				talkTextPrefix += ( '\n{{WikiProject Biography|living=' +
+			// delete existing biography banner. when accepting, reviewer is forced to choose if it's a biography or not, so we'll add (or not add) our own biography banner later
+			banners = banners.filter( function ( value ) {
+				return !value.match( /^{{WikiProject Biography/i );
+			} );
+
+			// add biography banner to array
+			if ( isBiography ) {
+				banners.push(
+					'{{WikiProject Biography|living=' +
 					( lifeStatus !== 'unknown' ? ( lifeStatus === 'living' ? 'yes' : 'no' ) : '' ) +
-					'|class=' + newAssessment + '|listas=' + subjectName + '}}' );
+					'|listas=' + subjectName +
+					'}}'
+				);
 			}
 
-			// Add disambiguation banner if needed
-			if ( newAssessment === 'disambig' &&
-				$.inArray( 'WikiProject Disambiguation', newWikiProjects ) === -1 ) {
-				newWikiProjects.push( 'WikiProject Disambiguation' );
+			// add disambiguation banner to array
+			if ( newAssessment === 'disambig' ) {
+				banners.push( '{{WikiProject Disambiguation}}' );
 			}
 
-			// Add and remove WikiProjects
-			/** @member {Array} */
-			var wikiProjectsToAdd = newWikiProjects.filter( function ( newTemplateName ) {
-				return !existingWikiProjects.some( function ( existingTplObj ) {
-					return existingTplObj.templateName === newTemplateName;
-				} );
-			} );
-			/** @member {Array} */
-			var wikiProjectsToRemove = existingWikiProjects.filter( function ( existingTplObj ) {
-				return !newWikiProjects.some( function ( newTemplateName ) {
-					return existingTplObj.templateName === newTemplateName;
-				} );
-			} ).map( function ( templateObj ) {
-				return templateObj.realTemplateName || templateObj.templateName;
-			} );
-			if ( alreadyHasWPBio && !isBiography ) {
-				wikiProjectsToRemove.push( existingWPBioTemplateName || 'wikiproject biography' );
+			// add banners selected in UI to array
+			for ( var key in newWikiProjects ) {
+				banners.push( '{{' + newWikiProjects[ key ] + '}}' );
 			}
 
-			$.each( wikiProjectsToAdd, function ( _index, templateName ) {
-				talkTextPrefix += '\n{{' + templateName + '|class=' + newAssessment + '}}';
-			} );
-			$.each( wikiProjectsToRemove, function ( _index, templateName ) {
-				// Regex from https://stackoverflow.com/a/5306111/1757964
-				var sanitizedTemplateName = templateName.replace( /[-[\]{}()*+?.,\\^$|#\s]/g, '\\$&' );
-				talkText = talkText.replace( new RegExp( '\\n?\\{\\{\\s*' + sanitizedTemplateName + '\\s*.+?\\}\\}', 'is' ), '' );
+			// remove duplicate banners, case insensitive
+			banners = AFCH.removeDuplicateBanners( banners );
+
+			// delete |class= from banners in array
+			banners = banners.map( function ( value ) {
+				return value.replace( /\s*\|\s*class\s*=\s*[^|}]*([\n|}])/, '$1' );
 			} );
 
-			// We prepend the text so that talk page content is not removed
-			// (e.g. pages in `Draft:` namespace with discussion)
-			talkText = talkTextPrefix + '\n\n' + talkText;
+			// Convert array back to wikitext and append to top of talk page.
+			// Always add a shell even if it's just wrapping one banner, for code simplification reasons.
+			// Add |class= to shell.
+			wikicode = '{{WikiProject banner shell' +
+				( newAssessment ? '|class=' + newAssessment : '' ) +
+				'|\n' +
+				banners.join( '\n' ) +
+				'\n}}\n' +
+				wikicode;
 
-			return {
-				talkText: talkText,
-				countOfWikiProjectsAdded: wikiProjectsToAdd.length,
-				countOfWikiProjectsRemoved: wikiProjectsToRemove.length
-			};
+			// add an extra line break between the last template and the first heading
+			wikicode = wikicode.replace( /}}\n==/, '}}\n\n==' );
+
+			// trim. makes unit tests more stable
+			wikicode = wikicode.trim();
+
+			return wikicode;
+		},
+
+		/**
+		 * In an array of templates, remove duplicate templates, case insensitive.
+		 *
+		 * @param {Array} banners [ '{{WikiProject Australia}}', {{wikiproject australia}}', '{{WikiProject Australia|class=B}}' ]
+		 * @return {Array} banners [ '{{WikiProject Australia}}' ]
+		 */
+		removeDuplicateBanners: function ( banners ) {
+			var uniqueBanners = [];
+			var bannerMap = {};
+			banners.forEach( function ( banner ) {
+				var bannerKey = banner.toLowerCase().match( /{{[^|}]+/ )[ 0 ];
+				if ( !bannerMap[ bannerKey ] ) {
+					uniqueBanners.push( banner );
+					bannerMap[ bannerKey ] = true;
+				}
+			} );
+			return uniqueBanners;
 		},
 
 		/**

diff --git a/src/modules/submissions.js b/src/modules/submissions.js
@@ -2388,29 +2388,17 @@
 				// ---------
 
 				talkPage.getText().done( function ( talkText ) {
-					var results = AFCH.addTalkPageBanners(
+					talkText = AFCH.addTalkPageBanners(
 						talkText,
 						data.newAssessment,
 						afchPage.additionalData.revId,
 						data.isBiography,
 						data.newWikiProjects,
 						data.lifeStatus,
-						data.subjectName,
-						data.existingWikiProjects,
-						data.alreadyHasWPBio,
-						data.existingWPBioTemplateName
+						data.subjectName
 					);
-					talkText = results.talkText;
 
-					var summary = 'Placing [[Wikipedia:Articles for creation|Articles for creation]] banner';
-					if ( results.countOfWikiProjectsAdded > 0 ) {
-						summary += ', adding ' + results.countOfWikiProjectsAdded +
-							' WikiProject banner' + ( ( results.countOfWikiProjectsAdded === 1 ) ? '' : 's' );
-					}
-					if ( results.countOfWikiProjectsRemoved > 0 ) {
-						summary += ', removing ' + results.countOfWikiProjectsRemoved +
-							' WikiProject banner' + ( ( results.countOfWikiProjectsRemoved === 1 ) ? '' : 's' );
-					}
+					var summary = 'Placing [[Wikipedia:Articles for creation|Articles for creation]] banner, and possibly other banners';
 
 					if ( comments && comments.length > 0 ) {
 						talkText = talkText.trim() + '\n\n== Comments left by AfC reviewers ==\n' + comments.join( '\n\n' );