Replace default value of first parameter in getWarningList() with ''

Replacing the default value with an empty string. Per Juliette's comment (PHPCSStandards#163 (comment)) there are three reasons why we want to do that: - The default value has no value in practice. It is an optional argument which is not enforced via the abstract functions, but is passed in all cases, so the default is never used in practice. - Setting the default value as file 1 also has an assumption implied, while IMO assumptions have no place in a test suite. - Maintainability - one less thing to have to keep in sync and to guard against typos
dingo-d · Dec 23, 2023 · efda300 · efda300
1 parent d7049db
commit efda300
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 5 deletions.
diff --git a/src/Standards/Generic/Tests/Formatting/MultipleStatementAlignmentUnitTest.php b/src/Standards/Generic/Tests/Formatting/MultipleStatementAlignmentUnitTest.php
@@ -45,7 +45,7 @@ public function getErrorList()
      *
      * @return array<int, int>
      */
-    public function getWarningList($testFile='MultipleStatementAlignmentUnitTest.inc')
+    public function getWarningList($testFile='')
     {
         switch ($testFile) {
         case 'MultipleStatementAlignmentUnitTest.inc':

diff --git a/src/Standards/PEAR/Tests/Commenting/FileCommentUnitTest.php b/src/Standards/PEAR/Tests/Commenting/FileCommentUnitTest.php
@@ -74,7 +74,7 @@ public function getErrorList($testFile='FileCommentUnitTest.inc')
      *
      * @return array<int, int>
      */
-    public function getWarningList($testFile='FileCommentUnitTest.inc')
+    public function getWarningList($testFile='')
     {
         switch ($testFile) {
         case 'FileCommentUnitTest.1.inc':

diff --git a/src/Standards/Squiz/Tests/ControlStructures/ForLoopDeclarationUnitTest.php b/src/Standards/Squiz/Tests/ControlStructures/ForLoopDeclarationUnitTest.php
@@ -118,7 +118,7 @@ public function getErrorList($testFile='ForLoopDeclarationUnitTest.inc')
      *
      * @return array<int, int>
      */
-    public function getWarningList($testFile='ForLoopDeclarationUnitTest.inc')
+    public function getWarningList($testFile='')
     {
         switch ($testFile) {
         case 'ForLoopDeclarationUnitTest.inc':

diff --git a/src/Standards/Squiz/Tests/ControlStructures/SwitchDeclarationUnitTest.php b/src/Standards/Squiz/Tests/ControlStructures/SwitchDeclarationUnitTest.php
@@ -143,7 +143,7 @@ public function getErrorList($testFile='SwitchDeclarationUnitTest.inc')
      *
      * @return array<int, int>
      */
-    public function getWarningList($testFile='SwitchDeclarationUnitTest.inc')
+    public function getWarningList($testFile='')
     {
         if ($testFile === 'SwitchDeclarationUnitTest.js') {
             return [273 => 1];

diff --git a/src/Standards/Squiz/Tests/PHP/CommentedOutCodeUnitTest.php b/src/Standards/Squiz/Tests/PHP/CommentedOutCodeUnitTest.php
@@ -45,7 +45,7 @@ public function getErrorList()
      *
      * @return array<int, int>
      */
-    public function getWarningList($testFile='CommentedOutCodeUnitTest.inc')
+    public function getWarningList($testFile='')
     {
         switch ($testFile) {
         case 'CommentedOutCodeUnitTest.inc':