Fixes #176. Match blank boilerplate lines correctly.

moodlehq · Jul 4, 2024 · e6d2726 · e6d2726
1 parent f7668d9
commit e6d2726
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 0 deletions.
diff --git a/moodle/Sniffs/Files/BoilerplateCommentSniff.php b/moodle/Sniffs/Files/BoilerplateCommentSniff.php
@@ -288,6 +288,11 @@ private function completeBoilerplate(File $file, $stackptr, int $lineindex): voi
      */
     private function regexForLine(string $line): string
     {
+        // We need to match the blank lines in their entirety.
+        if ($line === '//') {
+            return '/^\/\/$/';
+        }
+
         return str_replace(
             ['Moodle', 'https\\:'],
             ['.*', 'https?\\:'],

diff --git a/moodle/Tests/FilesBoilerPlateCommentTest.php b/moodle/Tests/FilesBoilerPlateCommentTest.php
@@ -240,4 +240,26 @@ public function testMoodleFilesBoilerplateCommentWithPhpcsTag() {
 
         $this->verifyCsResults();
     }
+
+    public function testMoodleFilesBoilerplateCommentMissingLines() {
+        $this->setStandard('moodle');
+        $this->setSniff('moodle.Files.BoilerplateComment');
+        $this->setFixture(__DIR__ . '/fixtures/files/boilerplatecomment/missing_lines.php');
+
+        $this->setErrors([
+            3 => 'moodle.Files.BoilerplateComment.WrongLine',
+            4 => 'moodle.Files.BoilerplateComment.WrongLine',
+            5 => 'moodle.Files.BoilerplateComment.WrongLine',
+            6 => 'moodle.Files.BoilerplateComment.WrongLine',
+            7 => 'moodle.Files.BoilerplateComment.WrongLine',
+            8 => 'moodle.Files.BoilerplateComment.WrongLine',
+            9 => 'moodle.Files.BoilerplateComment.WrongLine',
+            10 => 'moodle.Files.BoilerplateComment.WrongLine',
+            11 => 'moodle.Files.BoilerplateComment.WrongLine',
+            12 => ['moodle.Files.BoilerplateComment.WrongLine', 'moodle.Files.BoilerplateComment.CommentEndedTooSoon'],
+        ]);
+        $this->setWarnings([]);
+
+        $this->verifyCsResults();
+    }
 }
diff --git a/moodle/Tests/fixtures/files/boilerplatecomment/missing_lines.php b/moodle/Tests/fixtures/files/boilerplatecomment/missing_lines.php
@@ -0,0 +1,12 @@
+<?php
+// This file is part of Moodle - https://moodle.org/
+// Moodle 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 3 of the License, or
+// (at your option) any later version.
+// Moodle 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 Moodle.  If not, see <https://www.gnu.org/licenses/>.
diff --git a/moodle/Tests/fixtures/files/boilerplatecomment/missing_lines.php.fixed b/moodle/Tests/fixtures/files/boilerplatecomment/missing_lines.php.fixed
@@ -0,0 +1,15 @@
+<?php
+// This file is part of Moodle - https://moodle.org/
+//
+// Moodle 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 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle 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 Moodle.  If not, see <https://www.gnu.org/licenses/>.