Merge branch 'allow-multiple-assignment-alignment-at-start-of-assign-token' of https://github.com/johnpbloch/PHP_CodeSniffer

Author: gsherwood

src/Standards/Generic/Sniffs/Formatting/MultipleStatementAlignmentSniff.php

@@ -47,6 +47,23 @@ class MultipleStatementAlignmentSniff implements Sniff
      */
     public $maxPadding = 1000;
 
+    /**
+     * Controls which side of the assignment token is used for alignment
+     *
+     * The default is to use the end of the assignemnt token:
+     *
+     * $test  = 'Hello';
+     * $test .= ' World';
+     *
+     * Setting to false reverses the alignment:
+     *
+     * $test = 'Hello';
+     * $test .= 'World';
+     *
+     * @var boolean
+     */
+    public $alignAtEndOfAssignToken = true;
+
 
     /**
      * Returns an array of tokens this test wants to listen for.
@@ -253,6 +270,10 @@ public function checkAlignment($phpcsFile, $stackPtr, $end=null)
             // padding length if they aligned with us.
             $varEnd    = $tokens[($var + 1)]['column'];
             $assignLen = $tokens[$assign]['length'];
+            if ($this->alignAtEndOfAssignToken !== true) {
+                $assignLen = 1;
+            }
+
             if ($assign !== $stackPtr) {
                 if ($prevAssign === null) {
                     // Processing an inner block but no assignments found.

src/Standards/Generic/Tests/Formatting/MultipleStatementAlignmentUnitTest.inc

@@ -406,3 +406,57 @@ $foofoo   = new Foo([
 
 $i = 0;
 echo "TEST: ".($i += 1)."\n";
+
+// Valid
+$foo      = 'Hello';
+$variable = 12;
+$foo     .= ' World';
+$test     = 1;
+$test   <<= 6;
+
+// Invalid
+$foo      = 'Hello';
+$variable = 12;
+$foo      .= ' World';
+$test     = 1;
+$test     <<= 6;
+
+// phpcs:set Generic.Formatting.MultipleStatementAlignment alignAtEndOfAssignToken false
+
+// Valid
+$foo      = 'Hello';
+$variable = 12;
+$foo      .= ' World';
+$test     = 1;
+$test     <<= 6;
+
+// Invalid
+$foo      = 'Hello';
+$variable = 12;
+$foo     .= ' World';
+$test     = 1;
+$test   <<= 6;
+
+// phpcs:set Generic.Formatting.MultipleStatementAlignment maxPadding 8
+
+$one                = 'one';
+$varonetwo          = 'two';
+$varonetwothree     = 'three';
+$varonetwothreefour = 'four';
+
+$one       = 'one';
+$varonetwo .= 'two';
+$varonetwo = 'two';
+$varonetwo .= 'two';
+$varonetwothree     = 'three';
+$varonetwothreefour = 'four';
+
+$one         <<= 8;
+$onetwothree = 3;
+
+// phpcs:set Generic.Formatting.MultipleStatementAlignment alignAtEndOfAssignToken true
+
+$one       <<= 8;
+$onetwothree = 3;
+
+// phpcs:set Generic.Formatting.MultipleStatementAlignment maxPadding 1000

src/Standards/Generic/Tests/Formatting/MultipleStatementAlignmentUnitTest.inc.fixed

@@ -406,3 +406,57 @@ $foofoo = new Foo([
 
 $i = 0;
 echo "TEST: ".($i += 1)."\n";
+
+// Valid
+$foo      = 'Hello';
+$variable = 12;
+$foo     .= ' World';
+$test     = 1;
+$test   <<= 6;
+
+// Invalid
+$foo      = 'Hello';
+$variable = 12;
+$foo     .= ' World';
+$test     = 1;
+$test   <<= 6;
+
+// phpcs:set Generic.Formatting.MultipleStatementAlignment alignAtEndOfAssignToken false
+
+// Valid
+$foo      = 'Hello';
+$variable = 12;
+$foo      .= ' World';
+$test     = 1;
+$test     <<= 6;
+
+// Invalid
+$foo      = 'Hello';
+$variable = 12;
+$foo      .= ' World';
+$test     = 1;
+$test     <<= 6;
+
+// phpcs:set Generic.Formatting.MultipleStatementAlignment maxPadding 8
+
+$one       = 'one';
+$varonetwo = 'two';
+$varonetwothree     = 'three';
+$varonetwothreefour = 'four';
+
+$one       = 'one';
+$varonetwo .= 'two';
+$varonetwo = 'two';
+$varonetwo .= 'two';
+$varonetwothree     = 'three';
+$varonetwothreefour = 'four';
+
+$one <<= 8;
+$onetwothree = 3;
+
+// phpcs:set Generic.Formatting.MultipleStatementAlignment alignAtEndOfAssignToken true
+
+$one       <<= 8;
+$onetwothree = 3;
+
+// phpcs:set Generic.Formatting.MultipleStatementAlignment maxPadding 1000

src/Standards/Generic/Tests/Formatting/MultipleStatementAlignmentUnitTest.php

@@ -111,6 +111,13 @@ public function getWarningList($testFile='MultipleStatementAlignmentUnitTest.inc
                 398 => 1,
                 399 => 1,
                 401 => 1,
+                420 => 1,
+                422 => 1,
+                436 => 1,
+                438 => 1,
+                442 => 1,
+                443 => 1,
+                454 => 1,
             ];
         break;
         case 'MultipleStatementAlignmentUnitTest.js':