Add support for multiline indenting to ObjectOperatorIndentSniff

Author: marcospassos

src/Standards/PEAR/Sniffs/WhiteSpace/ObjectOperatorIndentSniff.php

@@ -22,6 +22,13 @@ class ObjectOperatorIndentSniff implements Sniff
      */
     public $indent = 4;
 
+    /**
+     * Indicates whether multilevel indenting is allowed.
+     *
+     * @var boolean
+     */
+    public $multilevel = false;
+
 
     /**
      * Returns an array of tokens this test wants to listen for.
@@ -71,12 +78,12 @@ public function process(File $phpcsFile, $stackPtr)
             }
         }
 
-        $requiredIndent = 0;
-        if ($i >= 0 && $tokens[$i]['code'] === T_WHITESPACE) {
-            $requiredIndent = strlen($tokens[$i]['content']);
+        $baseIndent = 0;
+        if ($i >= 0 && $tokens[$i]['code'] === \T_WHITESPACE) {
+            $baseIndent = \strlen($tokens[$i]['content']);
         }
 
-        $requiredIndent += $this->indent;
+        $baseIndent += $this->indent;
 
         // Determine the scope of the original object operator.
         $origBrackets = null;
@@ -96,6 +103,8 @@ public function process(File $phpcsFile, $stackPtr)
             $next = $stackPtr;
         }
 
+        $previousIndent = $baseIndent;
+
         while ($next !== false) {
             // Make sure it is in the same scope, otherwise don't check indent.
             $brackets = null;
@@ -121,22 +130,34 @@ public function process(File $phpcsFile, $stackPtr)
                         $foundIndent = 0;
                     }
 
-                    if ($foundIndent !== $requiredIndent) {
+                    $minIndent      = $previousIndent;
+                    $maxIndent      = $previousIndent;
+                    $expectedIndent = $previousIndent;
+
+                    if ($this->multilevel === true) {
+                        $minIndent      = \max(($previousIndent - $this->indent), $baseIndent);
+                        $maxIndent      = ($previousIndent + $this->indent);
+                        $expectedIndent = \min(\max($foundIndent, $minIndent), $maxIndent);
+                    }
+
+                    if ($foundIndent < $minIndent || $foundIndent > $maxIndent) {
                         $error = 'Object operator not indented correctly; expected %s spaces but found %s';
                         $data  = [
-                            $requiredIndent,
+                            $expectedIndent,
                             $foundIndent,
                         ];
 
                         $fix = $phpcsFile->addFixableError($error, $next, 'Incorrect', $data);
                         if ($fix === true) {
-                            $spaces = str_repeat(' ', $requiredIndent);
+                            $spaces = str_repeat(' ', $expectedIndent);
                             if ($foundIndent === 0) {
                                 $phpcsFile->fixer->addContentBefore($next, $spaces);
                             } else {
                                 $phpcsFile->fixer->replaceToken(($next - 1), $spaces);
                             }
                         }
+                    } else {
+                        $previousIndent = $foundIndent;
                     }
                 }//end if
 

src/Standards/PEAR/Tests/WhiteSpace/ObjectOperatorIndentUnitTest.inc

@@ -71,3 +71,12 @@ someclass::one()
 (new someclass())->one()
     ->two()
         ->three();
+
+// phpcs:set PEAR.WhiteSpace.ObjectOperatorIndent multilevel true
+
+$someObject
+    ->startSomething()
+                    ->someOtherFunc(23, 42)
+->endSomething()
+->doSomething(23, 42)
+->endEverything();

src/Standards/PEAR/Tests/WhiteSpace/ObjectOperatorIndentUnitTest.inc.fixed

@@ -71,3 +71,12 @@ someclass::one()
 (new someclass())->one()
     ->two()
     ->three();
+
+// phpcs:set PEAR.WhiteSpace.ObjectOperatorIndent multilevel true
+
+$someObject
+    ->startSomething()
+        ->someOtherFunc(23, 42)
+    ->endSomething()
+    ->doSomething(23, 42)
+    ->endEverything();

src/Standards/PEAR/Tests/WhiteSpace/ObjectOperatorIndentUnitTest.php

@@ -38,6 +38,10 @@ public function getErrorList()
             65 => 1,
             69 => 1,
             73 => 1,
+            79 => 1,
+            80 => 1,
+            81 => 1,
+            82 => 1,
         ];
 
     }//end getErrorList()