fix bot responding to pings on non FGTC pages

NovemLinguae · Dec 30, 2021 · f49218e · f49218e
1 parent 149726c
commit f49218e
Show file tree

Hide file tree

Showing 3 changed files with 77 additions and 2 deletions.
diff --git a/src/Helper.php b/src/Helper.php
@@ -1,9 +1,10 @@
 <?php
 
 class Helper {
-	/** Grabs template Wikicode of first instance encountered of that template. Case insensitive. Returns NULL if no template found. */
+	/** Grabs template Wikicode of first instance encountered of that template. Case insensitive. Returns null if no template found. */
 	function sliceFirstTemplateFound(string $wikicode, string $templateName) {
 		$starting_position = strpos(strtolower($wikicode), "{{" . strtolower($templateName));
+		if ( $starting_position === false ) return null;
 		$counter = 0;
 		$length = strlen($wikicode);
 		for ( $i = $starting_position + 2; $i < $length; $i++ ) {
@@ -20,7 +21,7 @@ function sliceFirstTemplateFound(string $wikicode, string $templateName) {
 				}
 			}
 		}
-		return NULL;
+		return null;
 	}
 
 	/** Used by echoAndFlush() */

diff --git a/tests/HelperTest.php b/tests/HelperTest.php
@@ -7,6 +7,8 @@ function setUp(): void {
 		$this->h = new Helper();
 	}
 
+	// TODO: add @group for grouping. this is equivlent to Jest's "describe"
+
 	function test_insertCodeAtEndOfFirstTemplate_TemplateWithParameters() {
 		$templateNameRegEx = 'Article ?history';
 		$codeToInsert = '[inserted code]';
@@ -184,4 +186,74 @@ function test_deleteArrayValuesBeginningWith_normal() {
 		];
 		$this->assertSame($expected, $result);
 	}
+
+	function test_sliceFirstTemplateFound_normal() {
+		$wikicode = 
+"Test
+{{Good topic box
+| algo                = old(120d)
+| archive             = Wikipedia talk:Featured and good topic candidates/%(year)d
+| archiveheader       = {{Automatic archive navigator}}
+| minthreadstoarchive = 1
+| minthreadsleft      = 4
+}}
+{{tmbox
+|text= '''Questions about a topic you are working on or about the process in general should be asked at [[Wikipedia talk:Featured and good topic questions|Featured and good topic questions]].'''  This page is primarily for discussion on proposals regarding the FTC process.
+}}";
+		$templateName = 'good topic box';
+		$result = $this->h->sliceFirstTemplateFound($wikicode, $templateName);
+		$expected =
+"{{Good topic box
+| algo                = old(120d)
+| archive             = Wikipedia talk:Featured and good topic candidates/%(year)d
+| archiveheader       = {{Automatic archive navigator}}
+| minthreadstoarchive = 1
+| minthreadsleft      = 4
+}}";
+		$this->assertSame($expected, $result);
+	}
+
+	function test_sliceFirstTemplateFound_secondTemplate() {
+		$wikicode = 
+"Test
+{{tmbox
+|text= '''Questions about a topic you are working on or about the process in general should be asked at [[Wikipedia talk:Featured and good topic questions|Featured and good topic questions]].'''  This page is primarily for discussion on proposals regarding the FTC process.
+}}
+{{Good topic box
+| algo                = old(120d)
+| archive             = Wikipedia talk:Featured and good topic candidates/%(year)d
+| archiveheader       = {{Automatic archive navigator}}
+| minthreadstoarchive = 1
+| minthreadsleft      = 4
+}}";
+		$templateName = 'good topic box';
+		$result = $this->h->sliceFirstTemplateFound($wikicode, $templateName);
+		$expected =
+"{{Good topic box
+| algo                = old(120d)
+| archive             = Wikipedia talk:Featured and good topic candidates/%(year)d
+| archiveheader       = {{Automatic archive navigator}}
+| minthreadstoarchive = 1
+| minthreadsleft      = 4
+}}";
+		$this->assertSame($expected, $result);
+	}
+
+	function test_sliceFirstTemplateFound_templateNotFound() {
+		$wikicode = 
+"{{User:MiszaBot/config
+| algo                = old(120d)
+| archive             = Wikipedia talk:Featured and good topic candidates/%(year)d
+| archiveheader       = {{Automatic archive navigator}}
+| minthreadstoarchive = 1
+| minthreadsleft      = 4
+}}
+{{tmbox
+|text= '''Questions about a topic you are working on or about the process in general should be asked at [[Wikipedia talk:Featured and good topic questions|Featured and good topic questions]].'''  This page is primarily for discussion on proposals regarding the FTC process.
+}}";
+		$templateName = 'good topic box';
+		$result = $this->h->sliceFirstTemplateFound($wikicode, $templateName);
+		$expected = null;
+		$this->assertSame($expected, $result);
+	}
 }
diff --git a/tests/PromoteTest.php b/tests/PromoteTest.php
@@ -11,6 +11,8 @@ function setUp(): void {
 		$this->p = new Promote($eh, $h);
 	}
 
+	// TODO: add @group for grouping. this is equivlent to Jest's "describe"
+
 	function test_getTopicWikipediaPageTitle_dontWriteToWikipediaGoodTopics() {
 		$mainArticleTitle = 'TestPage';
 		$goodOrFeatured = 'good';