[Printer] Apply configurable multiline on Fluent Method Call on print…

… after method call created/re-printed (#5779) * [Printer] Apply multiline on Fluent Method Call on print * [ci-review] Rector Rectify * update fixture on RectorConfigBuilderRector * re-print args * make new line on fluent call optional to avoid BC break * ensure flag feature not replaced by other config * [ci-review] Rector Rectify * make optional when enabeld only * Fix test * [ci-review] Rector Rectify * comment * allow enable disable * Fix phpstan * clean up call --------- Co-authored-by: GitHub Action <actions@github.com>
rectorphp · Mar 28, 2024 · 08d73a1 · 08d73a1
1 parent 3122ef4
commit 08d73a1
Show file tree

Hide file tree

Showing 20 changed files with 94 additions and 31 deletions.
diff --git a/config/config.php b/config/config.php
@@ -38,4 +38,7 @@
     foreach ($extensionConfigResolver->provide() as $extensionConfigFile) {
         $rectorConfig->import($extensionConfigFile);
     }
+
+    // use original php-parser printer to avoid BC break on fluent call
+    $rectorConfig->newLineOnFluentCall(false);
 };
diff --git a/...tNamespace/RectorConfigBuilderRector/Fixture/disable_parallel_to_without_parallel.php.inc b/...tNamespace/RectorConfigBuilderRector/Fixture/disable_parallel_to_without_parallel.php.inc
@@ -16,6 +16,7 @@ declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
 
-return \Rector\Config\RectorConfig::configure()->withoutParallel();
+return \Rector\Config\RectorConfig::configure()
+    ->withoutParallel();
 
 ?>
diff --git a/...mespace/RectorConfigBuilderRector/Fixture/file_extensions_to_with_file_extensions.php.inc b/...mespace/RectorConfigBuilderRector/Fixture/file_extensions_to_with_file_extensions.php.inc
@@ -16,6 +16,7 @@ declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
 
-return \Rector\Config\RectorConfig::configure()->withFileExtensions(['php', 'phtml']);
+return \Rector\Config\RectorConfig::configure()
+    ->withFileExtensions(['php', 'phtml']);
 
 ?>
diff --git a/...RectorConfigBuilderRector/Fixture/rule_with_configuration_to_with_configured_rule.php.inc b/...RectorConfigBuilderRector/Fixture/rule_with_configuration_to_with_configured_rule.php.inc
@@ -21,8 +21,7 @@ declare(strict_types=1);
 use Rector\Config\RectorConfig;
 use Rector\Renaming\Rector\FuncCall\RenameFunctionRector;
 
-return \Rector\Config\RectorConfig::configure()->withConfiguredRule(RenameFunctionRector::class, [
-    'is_real' => 'is_float',
-]);
+return \Rector\Config\RectorConfig::configure()
+    ->withConfiguredRule(RenameFunctionRector::class, ['is_real' => 'is_float']);
 
 ?>
diff --git a/...Rector/FileWithoutNamespace/RectorConfigBuilderRector/Fixture/rules_to_with_rules.php.inc b/...Rector/FileWithoutNamespace/RectorConfigBuilderRector/Fixture/rules_to_with_rules.php.inc
@@ -26,6 +26,7 @@ use Rector\Transform\Rector\FileWithoutNamespace\RectorConfigBuilderRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\ReturnUnionTypeRector;
 use Rector\TypeDeclaration\Rector\Property\TypedPropertyFromAssignsRector;
 
-return \Rector\Config\RectorConfig::configure()->withRules([ReturnUnionTypeRector::class, RectorConfigBuilderRector::class, TypedPropertyFromAssignsRector::class]);
+return \Rector\Config\RectorConfig::configure()
+    ->withRules([ReturnUnionTypeRector::class, RectorConfigBuilderRector::class, TypedPropertyFromAssignsRector::class]);
 
 ?>
diff --git a/...m/Rector/FileWithoutNamespace/RectorConfigBuilderRector/Fixture/sets_to_with_sets.php.inc b/...m/Rector/FileWithoutNamespace/RectorConfigBuilderRector/Fixture/sets_to_with_sets.php.inc
@@ -18,6 +18,7 @@ declare(strict_types=1);
 use Rector\Config\RectorConfig;
 use Rector\Set\ValueObject\SetList;
 
-return \Rector\Config\RectorConfig::configure()->withSets([SetList::DEAD_CODE]);
+return \Rector\Config\RectorConfig::configure()
+    ->withSets([SetList::DEAD_CODE]);
 
 ?>
diff --git a/...Rector/FileWithoutNamespace/RectorConfigBuilderRector/Fixture/with_autoload_paths.php.inc b/...Rector/FileWithoutNamespace/RectorConfigBuilderRector/Fixture/with_autoload_paths.php.inc
@@ -18,8 +18,7 @@ declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
 
-return \Rector\Config\RectorConfig::configure()->withAutoloadPaths([
-    __DIR__  . '/../autoload.php',
-]);
+return \Rector\Config\RectorConfig::configure()
+    ->withAutoloadPaths([__DIR__  . '/../autoload.php']);
 
 ?>
diff --git a/...ector/FileWithoutNamespace/RectorConfigBuilderRector/Fixture/with_bootstrap_files.php.inc b/...ector/FileWithoutNamespace/RectorConfigBuilderRector/Fixture/with_bootstrap_files.php.inc
@@ -18,8 +18,7 @@ declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
 
-return \Rector\Config\RectorConfig::configure()->withBootstrapFiles([
-    __DIR__  . '/constants.php',
-]);
+return \Rector\Config\RectorConfig::configure()
+    ->withBootstrapFiles([__DIR__  . '/constants.php']);
 
 ?>
diff --git a/...Transform/Rector/FileWithoutNamespace/RectorConfigBuilderRector/Fixture/with_path.php.inc b/...Transform/Rector/FileWithoutNamespace/RectorConfigBuilderRector/Fixture/with_path.php.inc
@@ -21,8 +21,8 @@ declare(strict_types=1);
 use Rector\Config\RectorConfig;
 use Rector\TypeDeclaration\Rector\ClassMethod\ReturnUnionTypeRector;
 
-return \Rector\Config\RectorConfig::configure()->withPaths([
-    __DIR__ . '/src',
-])->withRules([ReturnUnionTypeRector::class]);
+return \Rector\Config\RectorConfig::configure()
+    ->withPaths([__DIR__ . '/src'])
+    ->withRules([ReturnUnionTypeRector::class]);
 
 ?>
diff --git a/...orm/Rector/FileWithoutNamespace/RectorConfigBuilderRector/Fixture/with_phpversion.php.inc b/...orm/Rector/FileWithoutNamespace/RectorConfigBuilderRector/Fixture/with_phpversion.php.inc
@@ -18,6 +18,7 @@ declare(strict_types=1);
 use Rector\Config\RectorConfig;
 use Rector\ValueObject\PhpVersion;
 
-return \Rector\Config\RectorConfig::configure()->withPhpVersion(PhpVersion::PHP_74);
+return \Rector\Config\RectorConfig::configure()
+    ->withPhpVersion(PhpVersion::PHP_74);
 
 ?>
diff --git a/...Transform/Rector/FileWithoutNamespace/RectorConfigBuilderRector/Fixture/with_rule.php.inc b/...Transform/Rector/FileWithoutNamespace/RectorConfigBuilderRector/Fixture/with_rule.php.inc
@@ -18,6 +18,7 @@ declare(strict_types=1);
 use Rector\Config\RectorConfig;
 use Rector\Transform\Rector\FileWithoutNamespace\RectorConfigBuilderRector;
 
-return \Rector\Config\RectorConfig::configure()->withRules([RectorConfigBuilderRector::class]);
+return \Rector\Config\RectorConfig::configure()
+    ->withRules([RectorConfigBuilderRector::class]);
 
 ?>
diff --git a/...ransform/Rector/FileWithoutNamespace/RectorConfigBuilderRector/Fixture/with_rules.php.inc b/...ransform/Rector/FileWithoutNamespace/RectorConfigBuilderRector/Fixture/with_rules.php.inc
@@ -21,6 +21,7 @@ use Rector\Config\RectorConfig;
 use Rector\Transform\Rector\FileWithoutNamespace\RectorConfigBuilderRector;
 use Rector\TypeDeclaration\Rector\Property\TypedPropertyFromAssignsRector;
 
-return \Rector\Config\RectorConfig::configure()->withRules([RectorConfigBuilderRector::class, TypedPropertyFromAssignsRector::class]);
+return \Rector\Config\RectorConfig::configure()
+    ->withRules([RectorConfigBuilderRector::class, TypedPropertyFromAssignsRector::class]);
 
 ?>
diff --git a/...ithoutNamespace/RectorConfigBuilderRector/Fixture/with_rules_class_constant_value.php.inc b/...ithoutNamespace/RectorConfigBuilderRector/Fixture/with_rules_class_constant_value.php.inc
@@ -36,6 +36,7 @@ class SomeClass
     ];
 }
 
-return \Rector\Config\RectorConfig::configure()->withRules(SomeClass::RULES);
+return \Rector\Config\RectorConfig::configure()
+    ->withRules(SomeClass::RULES);
 
 ?>
diff --git a/...Transform/Rector/FileWithoutNamespace/RectorConfigBuilderRector/Fixture/with_skip.php.inc b/...Transform/Rector/FileWithoutNamespace/RectorConfigBuilderRector/Fixture/with_skip.php.inc
@@ -21,8 +21,8 @@ declare(strict_types=1);
 use Rector\Config\RectorConfig;
 use Rector\TypeDeclaration\Rector\ClassMethod\ReturnUnionTypeRector;
 
-return \Rector\Config\RectorConfig::configure()->withSkip([
-    __DIR__ . '/src/migrations',
-])->withRules([ReturnUnionTypeRector::class]);
+return \Rector\Config\RectorConfig::configure()
+    ->withSkip([__DIR__ . '/src/migrations'])
+    ->withRules([ReturnUnionTypeRector::class]);
 
 ?>
diff --git a/...ransform/Rector/FileWithoutNamespace/RectorConfigBuilderRector/config/configured_rule.php b/...ransform/Rector/FileWithoutNamespace/RectorConfigBuilderRector/config/configured_rule.php
@@ -6,4 +6,5 @@
 use Rector\Transform\Rector\FileWithoutNamespace\RectorConfigBuilderRector;
 
 return RectorConfig::configure()
+    ->withFluentCallNewLine()
     ->withRules([RectorConfigBuilderRector::class]);
diff --git a/src/Config/RectorConfig.php b/src/Config/RectorConfig.php
@@ -313,6 +313,11 @@ public function symfonyContainerPhp(string $filePath): void
         SimpleParameterProvider::setParameter(Option::SYMFONY_CONTAINER_PHP_PATH_PARAMETER, $filePath);
     }
 
+    public function newLineOnFluentCall(bool $enabled = true): void
+    {
+        SimpleParameterProvider::setParameter(Option::NEW_LINE_ON_FLUENT_CALL, $enabled);
+    }
+
     /**
      * @param string[] $extensions
      */

diff --git a/src/Configuration/Option.php b/src/Configuration/Option.php
@@ -87,6 +87,12 @@ final class Option
      */
     public const SYMFONY_CONTAINER_PHP_PATH_PARAMETER = 'symfony_container_php_path';
 
+    /**
+     * @internal Use @see \Rector\Config\RectorConfig::newLineOnFluentCall()
+     * @var string
+     */
+    public const NEW_LINE_ON_FLUENT_CALL = 'new_line_on_fluent_call';
+
     /**
      * @var string
      */

diff --git a/src/Configuration/RectorConfigBuilder.php b/src/Configuration/RectorConfigBuilder.php
@@ -122,9 +122,11 @@ final class RectorConfigBuilder
      * To make sure type declarations set and level are not duplicated,
      * as both contain same rules
      */
-    private bool $isTypeCoverageLevelUsed = false;
+    private ?bool $isTypeCoverageLevelUsed = null;
 
-    private bool $isDeadCodeLevelUsed = false;
+    private ?bool $isDeadCodeLevelUsed = null;
+
+    private ?bool $isFluentNewLine = null;
 
     /**
      * @var RegisteredService[]
@@ -135,14 +137,14 @@ public function __invoke(RectorConfig $rectorConfig): void
     {
         $uniqueSets = array_unique($this->sets);
 
-        if (in_array(SetList::TYPE_DECLARATION, $uniqueSets, true) && $this->isTypeCoverageLevelUsed) {
+        if (in_array(SetList::TYPE_DECLARATION, $uniqueSets, true) && $this->isTypeCoverageLevelUsed === true) {
             throw new InvalidConfigurationException(sprintf(
                 'Your config already enables type declarations set.%sRemove "->withTypeCoverageLevel()" as it only duplicates it, or remove type declaration set.',
                 PHP_EOL
             ));
         }
 
-        if (in_array(SetList::DEAD_CODE, $uniqueSets, true) && $this->isDeadCodeLevelUsed) {
+        if (in_array(SetList::DEAD_CODE, $uniqueSets, true) && $this->isDeadCodeLevelUsed === true) {
             throw new InvalidConfigurationException(sprintf(
                 'Your config already enables dead code set.%sRemove "->withDeadCodeLevel()" as it only duplicates it, or remove dead code set.',
                 PHP_EOL
@@ -256,6 +258,10 @@ public function __invoke(RectorConfig $rectorConfig): void
         if ($this->symfonyContainerPhpFile !== null) {
             $rectorConfig->symfonyContainerPhp($this->symfonyContainerPhpFile);
         }
+
+        if ($this->isFluentNewLine !== null) {
+            $rectorConfig->newLineOnFluentCall($this->isFluentNewLine);
+        }
     }
 
     /**
@@ -688,6 +694,12 @@ public function withTypeCoverageLevel(int $level): self
         return $this;
     }
 
+    public function withFluentCallNewLine(bool $isFluentNewLine = true): self
+    {
+        $this->isFluentNewLine = $isFluentNewLine;
+        return $this;
+    }
+
     public function registerService(string $className, ?string $alias = null, ?string $tag = null): self
     {
         $this->registerServices[] = new RegisteredService($className, $alias, $tag);

diff --git a/src/PhpParser/Printer/BetterStandardPrinter.php b/src/PhpParser/Printer/BetterStandardPrinter.php
@@ -7,11 +7,14 @@
 use Nette\Utils\Strings;
 use PhpParser\Comment;
 use PhpParser\Node;
+use PhpParser\Node\Arg;
 use PhpParser\Node\AttributeGroup;
 use PhpParser\Node\Expr;
 use PhpParser\Node\Expr\Array_;
 use PhpParser\Node\Expr\ArrowFunction;
+use PhpParser\Node\Expr\CallLike;
 use PhpParser\Node\Expr\Closure;
+use PhpParser\Node\Expr\MethodCall;
 use PhpParser\Node\Expr\Ternary;
 use PhpParser\Node\Expr\Yield_;
 use PhpParser\Node\Param;
@@ -166,10 +169,7 @@ protected function pExpr_ArrowFunction(ArrowFunction $arrowFunction): string
             return parent::pExpr_ArrowFunction($arrowFunction);
         }
 
-        $indentSize = SimpleParameterProvider::provideIntParameter(Option::INDENT_SIZE);
-
-        $indent = str_repeat($this->getIndentCharacter(), $this->indentLevel) .
-            str_repeat($this->getIndentCharacter(), $indentSize);
+        $indent = $this->resolveIndentSpaces();
 
         $text = "\n" . $indent;
         foreach ($comments as $key => $comment) {
@@ -459,6 +459,36 @@ protected function pScalar_LNumber(LNumber $lNumber): string|int
         return parent::pScalar_LNumber($lNumber);
     }
 
+    private function resolveIndentSpaces(): string
+    {
+        $indentSize = SimpleParameterProvider::provideIntParameter(Option::INDENT_SIZE);
+
+        return str_repeat($this->getIndentCharacter(), $this->indentLevel) .
+            str_repeat($this->getIndentCharacter(), $indentSize);
+    }
+
+    protected function pExpr_MethodCall(MethodCall $methodCall): string
+    {
+        if (SimpleParameterProvider::provideBoolParameter(Option::NEW_LINE_ON_FLUENT_CALL) === false) {
+            return parent::pExpr_MethodCall($methodCall);
+        }
+
+        if ($methodCall->var instanceof CallLike) {
+            foreach ($methodCall->args as $arg) {
+                if (! $arg instanceof Arg) {
+                    continue;
+                }
+
+                $arg->value->setAttribute(AttributeKey::ORIGINAL_NODE, null);
+            }
+
+            return $this->pDereferenceLhs($methodCall->var) . "\n" . $this->resolveIndentSpaces() . "->" . $this->pObjectProperty($methodCall->name)
+            . '(' . $this->pMaybeMultiline($methodCall->args) . ')';
+        }
+
+        return parent::pExpr_MethodCall($methodCall);
+    }
+
     /**
      * Keep attributes on newlines
      */

diff --git a/src/Testing/PHPUnit/AbstractRectorTestCase.php b/src/Testing/PHPUnit/AbstractRectorTestCase.php
@@ -58,6 +58,7 @@ public static function tearDownAfterClass(): void
         SimpleParameterProvider::setParameter(Option::INDENT_CHAR, ' ');
         SimpleParameterProvider::setParameter(Option::INDENT_SIZE, 4);
         SimpleParameterProvider::setParameter(Option::POLYFILL_PACKAGES, []);
+        SimpleParameterProvider::setParameter(Option::NEW_LINE_ON_FLUENT_CALL, false);
     }
 
     protected function setUp(): void