Squiz.WhiteSpace.MemberVarSpacing now has settings for spacing between member vars and spacing before the first member var (refs #1355 and #725)

Author: gsherwood

package.xml

@@ -52,7 +52,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
   - Function call sniffs now check variable function names and self/static object creation
     -- Specific sniffs are Generic.Functions.FunctionCallArgumentSpacing, PEAR.Functions.FunctionCallSignature, and PSR2.Methods.FunctionCallSignature
     -- Thanks to Michał Bundyra for the patch
-  - Generic.Files.LineLength can now be configure to ignore all comment lines, no matter their length
+  - Generic.Files.LineLength can now be configured to ignore all comment lines, no matter their length
     -- Set the ignoreComments property to TRUE (default is FALSE) in your ruleset.xml file to enable this
     -- Thanks to Juliette Reinders Folmer for the patch
   - PEAR.Functions.FunctionDeclaration now removes a blank line if it creates one by moving the curly brace during fixing
@@ -63,6 +63,10 @@ http://pear.php.net/dtd/package-2.0.xsd">
   - Squiz.WhiteSpace.ControlStructureSpacing now ignores comments when checking blank lines at the top of control structures
   - Squiz.WhiteSpace.ObjectOperatorSpacing now detects and fixes spaces around double colons
     -- Thanks to Julius Šmatavičius for the patch
+  - Squiz.WhiteSpace.MemberVarSpacing can now be configured to check any number of blank lines between member vars
+    -- Set the spacing property (default is 1) in your ruleset.xml file to set the spacing
+  - Squiz.WhiteSpace.MemberVarSpacing can now be configured to check a different number of blank lines before the first member var
+    -- Set the spacingBeforeFirst property (default is 1) in your ruleset.xml file to set the spacing
   - Added a new PHP_CodeSniffer\Util\Tokens::$ooScopeTokens static member var for quickly checking object scope
     -- Includes T_CLASS, T_ANON_CLASS, T_INTERFACE, and T_TRAIT
     -- Thanks to Juliette Reinders Folmer for the patch

src/Standards/Squiz/Sniffs/WhiteSpace/MemberVarSpacingSniff.php

@@ -16,6 +16,20 @@
 class MemberVarSpacingSniff extends AbstractVariableSniff
 {
 
+    /**
+     * The number of blank lines between member vars.
+     *
+     * @var integer
+     */
+    public $spacing = 1;
+
+    /**
+     * The number of blank lines before the fist member var.
+     *
+     * @var integer
+     */
+    public $spacingBeforeFirst = 1;
+
 
     /**
      * Processes the function tokens within the class.
@@ -70,7 +84,7 @@ protected function processMemberVar(File $phpcsFile, $stackPtr)
             }//end if
         }//end if
 
-        // There needs to be 1 blank line before the var, not counting comments.
+        // There needs to be n blank lines before the var, not counting comments.
         if ($start === $stackPtr) {
             // No comment found.
             $first = $phpcsFile->findFirstOnLine(Tokens::$emptyTokens, $start, true);
@@ -84,15 +98,31 @@ protected function processMemberVar(File $phpcsFile, $stackPtr)
             $first = $phpcsFile->findNext(Tokens::$commentTokens, ($first + 1));
         }
 
-        $prev       = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($first - 1), null, true);
+        // Determine if this is the first member var.
+        $prev = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($first - 1), null, true);
+        if ($tokens[$prev]['code'] === T_OPEN_CURLY_BRACKET
+            && isset(Tokens::$ooScopeTokens[$tokens[$tokens[$prev]['scope_condition']]['code']]) === true
+        ) {
+            $errorMsg  = 'Expected %s blank line(s) before first member var; %s found';
+            $errorCode = 'FirstIncorrect';
+            $spacing   = (int) $this->spacingBeforeFirst;
+        } else {
+            $errorMsg  = 'Expected %s blank line(s) before member var; %s found';
+            $errorCode = 'Incorrect';
+            $spacing   = (int) $this->spacing;
+        }
+
         $foundLines = ($tokens[$first]['line'] - $tokens[$prev]['line'] - 1);
-        if ($foundLines === 1) {
+        if ($foundLines === $spacing) {
             return;
         }
 
-        $error = 'Expected 1 blank line before member var; %s found';
-        $data  = array($foundLines);
-        $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'Incorrect', $data);
+        $data = array(
+                 $spacing,
+                 $foundLines,
+                );
+
+        $fix = $phpcsFile->addFixableError($errorMsg, $stackPtr, $errorCode, $data);
         if ($fix === true) {
             $phpcsFile->fixer->beginChangeset();
             for ($i = ($prev + 1); $i < $first; $i++) {
@@ -101,7 +131,10 @@ protected function processMemberVar(File $phpcsFile, $stackPtr)
                 }
 
                 if ($tokens[$i]['line'] === $tokens[$first]['line']) {
-                    $phpcsFile->fixer->addNewline(($i - 1));
+                    for ($x = 1; $x <= $spacing; $x++) {
+                        $phpcsFile->fixer->addNewlineBefore($i);
+                    }
+
                     break;
                 }
 

src/Standards/Squiz/Tests/WhiteSpace/MemberVarSpacingUnitTest.inc

@@ -152,3 +152,63 @@ class Foo
     private $caseStudy = null;
 
 }
+
+// @codingStandardsChangeSetting Squiz.WhiteSpace.MemberVarSpacing spacing 2
+
+class MyClass
+{
+    public $var1 = 'value';
+
+
+    public $var2 = 'value';
+
+    public $var3 = 'value';
+
+}//end class
+
+// @codingStandardsChangeSetting Squiz.WhiteSpace.MemberVarSpacing spacing 1
+// @codingStandardsChangeSetting Squiz.WhiteSpace.MemberVarSpacing spacingBeforeFirst 0
+
+class MyClass
+{
+    public $var1 = 'value';
+
+
+    public $var2 = 'value';
+
+    public $var3 = 'value';
+
+}//end class
+
+class MyClass
+{
+
+    public $var1 = 'value';
+
+    public $var2 = 'value';
+
+    public $var3 = 'value';
+
+}//end class
+
+// @codingStandardsChangeSetting Squiz.WhiteSpace.MemberVarSpacing spacing 0
+
+class MyClass
+{
+    public $var1 = 'value';
+
+    public $var2 = 'value';
+    public $var3 = 'value';
+
+}//end class
+
+interface MyInterface
+{
+
+    /* testing */
+    public $var1 = 'value';
+
+    public $var2 = 'value';
+    public $var3 = 'value';
+
+}//end class

src/Standards/Squiz/Tests/WhiteSpace/MemberVarSpacingUnitTest.inc.fixed

@@ -150,3 +150,60 @@ class Foo
     private $caseStudy = null;
 
 }
+
+// @codingStandardsChangeSetting Squiz.WhiteSpace.MemberVarSpacing spacing 2
+
+class MyClass
+{
+
+    public $var1 = 'value';
+
+
+    public $var2 = 'value';
+
+
+    public $var3 = 'value';
+
+}//end class
+
+// @codingStandardsChangeSetting Squiz.WhiteSpace.MemberVarSpacing spacing 1
+// @codingStandardsChangeSetting Squiz.WhiteSpace.MemberVarSpacing spacingBeforeFirst 0
+
+class MyClass
+{
+    public $var1 = 'value';
+
+    public $var2 = 'value';
+
+    public $var3 = 'value';
+
+}//end class
+
+class MyClass
+{
+    public $var1 = 'value';
+
+    public $var2 = 'value';
+
+    public $var3 = 'value';
+
+}//end class
+
+// @codingStandardsChangeSetting Squiz.WhiteSpace.MemberVarSpacing spacing 0
+
+class MyClass
+{
+    public $var1 = 'value';
+    public $var2 = 'value';
+    public $var3 = 'value';
+
+}//end class
+
+interface MyInterface
+{
+    /* testing */
+    public $var1 = 'value';
+    public $var2 = 'value';
+    public $var3 = 'value';
+
+}//end class

src/Standards/Squiz/Tests/WhiteSpace/MemberVarSpacingUnitTest.php

@@ -38,6 +38,13 @@ public function getErrorList()
                 106 => 1,
                 115 => 1,
                 150 => 1,
+                160 => 1,
+                165 => 1,
+                177 => 1,
+                186 => 1,
+                200 => 1,
+                209 => 1,
+                211 => 1,
                );
 
     }//end getErrorList()