Merge pull request #242 from rodrigoprimo/test-coverage-doc-comment

Generic/DocComment: improve code coverage

Author: jrfnl

src/Standards/Generic/Tests/Commenting/DocCommentUnitTest.inc renamed to src/Standards/Generic/Tests/Commenting/DocCommentUnitTest.1.inc

@@ -259,4 +259,12 @@
  * @return void
  */
 
-/** No docblock close tag. Must be last test without new line.
+// Tests to check handling empty doc comments.
+/**
+ */
+
+/**
+		*
+ *
+   *
+ */

src/Standards/Generic/Tests/Commenting/DocCommentUnitTest.inc.fixed renamed to src/Standards/Generic/Tests/Commenting/DocCommentUnitTest.1.inc.fixed

@@ -264,4 +264,12 @@
  * @return void
  */
 
-/** No docblock close tag. Must be last test without new line.
+// Tests to check handling empty doc comments.
+/**
+ */
+
+/**
+		*
+ *
+   *
+ */

src/Standards/Generic/Tests/Commenting/DocCommentUnitTest.js renamed to src/Standards/Generic/Tests/Commenting/DocCommentUnitTest.1.js

@@ -248,3 +248,23 @@
  * @license	  	https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
  * @link		http://pear.php.net/package/PHP_CodeSniffer
  */
+
+/**
+ * Do something.
+ *
+ * @codeCoverageIgnore
+ *
+ * @phpcs:disable Stnd.Cat.SniffName
+ *
+ * @return void
+ */
+
+// Tests to check handling empty doc comments.
+/**
+ */
+
+/**
+		*
+ *
+   *
+ */

src/Standards/Generic/Tests/Commenting/DocCommentUnitTest.js.fixed renamed to src/Standards/Generic/Tests/Commenting/DocCommentUnitTest.1.js.fixed

@@ -253,3 +253,23 @@
  * @license   https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
  * @link      http://pear.php.net/package/PHP_CodeSniffer
  */
+
+/**
+ * Do something.
+ *
+ * @codeCoverageIgnore
+ *
+ * @phpcs:disable Stnd.Cat.SniffName
+ *
+ * @return void
+ */
+
+// Tests to check handling empty doc comments.
+/**
+ */
+
+/**
+		*
+ *
+   *
+ */

src/Standards/Generic/Tests/Commenting/DocCommentUnitTest.2.inc

@@ -0,0 +1,6 @@
+<?php
+
+// Intentional parse error. Testing that the sniff is *not* triggered
+// in this case
+
+/** No docblock close tag. Must be last test without new line.

src/Standards/Generic/Tests/Commenting/DocCommentUnitTest.2.js

@@ -0,0 +1,4 @@
+// Intentional parse error. Testing that the sniff is *not* triggered
+// in this case
+
+/** No docblock close tag. Must be last test without new line.

src/Standards/Generic/Tests/Commenting/DocCommentUnitTest.php

@@ -41,59 +41,70 @@ public function setCliValues($testFile, $config)
      * The key of the array should represent the line number and the value
      * should represent the number of errors that should occur on that line.
      *
+     * @param string $testFile The name of the file being tested.
+     *
      * @return array(int => int)
      */
-    public function getErrorList()
+    public function getErrorList($testFile='')
     {
-        return [
-            14  => 1,
-            16  => 1,
-            18  => 1,
-            23  => 1,
-            26  => 1,
-            30  => 1,
-            32  => 1,
-            38  => 2,
-            40  => 1,
-            41  => 1,
-            51  => 1,
-            54  => 1,
-            58  => 1,
-            60  => 2,
-            67  => 1,
-            69  => 2,
-            80  => 1,
-            81  => 2,
-            88  => 1,
-            91  => 1,
-            95  => 1,
-            156 => 1,
-            158 => 1,
-            170 => 3,
-            171 => 3,
-            179 => 1,
-            183 => 1,
-            184 => 2,
-            185 => 1,
-            186 => 1,
-            187 => 2,
-            193 => 1,
-            196 => 1,
-            199 => 1,
-            203 => 1,
-            206 => 1,
-            211 => 1,
-            214 => 4,
-            218 => 1,
-            220 => 2,
-            222 => 1,
-            224 => 3,
-            243 => 1,
-            244 => 1,
-            246 => 1,
-            248 => 1,
-            249 => 1,
-        ];
+        switch ($testFile) {
+        case 'DocCommentUnitTest.1.inc':
+        case 'DocCommentUnitTest.1.js':
+            return [
+                14  => 1,
+                16  => 1,
+                18  => 1,
+                23  => 1,
+                26  => 1,
+                30  => 1,
+                32  => 1,
+                38  => 2,
+                40  => 1,
+                41  => 1,
+                51  => 1,
+                54  => 1,
+                58  => 1,
+                60  => 2,
+                67  => 1,
+                69  => 2,
+                80  => 1,
+                81  => 2,
+                88  => 1,
+                91  => 1,
+                95  => 1,
+                156 => 1,
+                158 => 1,
+                170 => 3,
+                171 => 3,
+                179 => 1,
+                183 => 1,
+                184 => 2,
+                185 => 1,
+                186 => 1,
+                187 => 2,
+                193 => 1,
+                196 => 1,
+                199 => 1,
+                203 => 1,
+                206 => 1,
+                211 => 1,
+                214 => 4,
+                218 => 1,
+                220 => 2,
+                222 => 1,
+                224 => 3,
+                243 => 1,
+                244 => 1,
+                246 => 1,
+                248 => 1,
+                249 => 1,
+                263 => 1,
+                266 => 1,
+            ];
+
+        default:
+            return [];
+        }//end switch
 
     }//end getErrorList()