Add consistent multiline method chain fixer with Pest expectation support

Author: stayallive

src/Fixer/MultilineMethodChainingFixer.php

@@ -50,6 +50,7 @@ public function isCandidate(Tokens $tokens): bool
     protected function applyFix(SplFileInfo $file, Tokens $tokens): void
     {
         $lineEnding = $this->whitespacesConfig->getLineEnding();
+        $isTestFile = str_ends_with($file->getFilename(), 'Test.php');
 
         for ($index = 1, $count = count($tokens); $index < $count; $index++) {
             if (!$tokens[$index]->isObjectOperator() || $this->startsOnNewLine($tokens, $index)) {
@@ -58,7 +59,11 @@ protected function applyFix(SplFileInfo $file, Tokens $tokens): void
 
             $previousOperatorIndex = $this->previousChainObjectOperator($tokens, $index);
 
-            if ($previousOperatorIndex === null || !$this->startsOnNewLine($tokens, $previousOperatorIndex)) {
+            if (
+                $previousOperatorIndex === null
+                || !$this->startsOnNewLine($tokens, $previousOperatorIndex)
+                || $isTestFile && $this->isAndExpectationSegment($tokens, $previousOperatorIndex)
+            ) {
                 continue;
             }
 
@@ -76,6 +81,15 @@ protected function applyFix(SplFileInfo $file, Tokens $tokens): void
         }
     }
 
+    private function isAndExpectationSegment(Tokens $tokens, int $operatorIndex): bool
+    {
+        $methodNameIndex = $tokens->getNextMeaningfulToken($operatorIndex);
+
+        return $methodNameIndex !== null
+            && $tokens[$methodNameIndex]->isGivenKind(T_STRING)
+            && strtolower($tokens[$methodNameIndex]->getContent()) === 'and';
+    }
+
     private function previousChainObjectOperator(Tokens $tokens, int $index): ?int
     {
         $segmentEndIndex = $tokens->getPrevMeaningfulToken($index);

tests/Unit/MultilineMethodChainingFixerTest.php

@@ -90,10 +90,46 @@ public function testNestedArgumentChainsDoNotMakeTheOuterChainMultiline(): void
         $this->assertSame($source, $this->fix($source));
     }
 
-    private function fix(string $source): string
+    public function testItKeepsPestAndExpectationSegmentsTogetherInTestFiles(): void
+    {
+        $source = <<<'PHP'
+<?php
+
+expect($first)->toBeTrue()
+    ->and($second)->toBeFalse()
+    ->and($third)->toBeNull();
+
+PHP;
+
+        $this->assertSame($source, $this->fix($source));
+    }
+
+    public function testItStillMovesSegmentsAfterAndMethodsOutsideTestFiles(): void
+    {
+        $source = <<<'PHP'
+<?php
+
+$result = $query->first()
+    ->and($other)->finish();
+
+PHP;
+
+        $expected = <<<'PHP'
+<?php
+
+$result = $query->first()
+    ->and($other)
+    ->finish();
+
+PHP;
+
+        $this->assertSame($expected, $this->fix($source, 'Source.php'));
+    }
+
+    private function fix(string $source, string $filename = __FILE__): string
     {
         $tokens = Tokens::fromCode($source);
-        $file   = new SplFileInfo(__FILE__);
+        $file   = new SplFileInfo($filename);
 
         (new MultilineMethodChainingFixer)->fix($file, $tokens);
         (new MethodChainingIndentationFixer)->fix($file, $tokens);