[CS] Fix dynamic and broken indent detection, allow to configure spac…

…ing via RectorConfig::indent() method (#2442)
rectorphp · Jun 6, 2022 · 38a9718 · 38a9718
1 parent 1c64bb1
commit 38a9718
Show file tree

Hide file tree

Showing 15 changed files with 175 additions and 161 deletions.
diff --git a/config/config.php b/config/config.php
@@ -64,6 +64,7 @@
 
     $rectorConfig->disableImportNames();
     $rectorConfig->importShortClasses();
+    $rectorConfig->indent(' ', 4);
 
     $rectorConfig->fileExtensions(['php']);
     $rectorConfig->nestedChainMethodCallLimit(60);

diff --git a/packages/BetterPhpDocParser/PhpDocParser/ClassAnnotationMatcher.php b/packages/BetterPhpDocParser/PhpDocParser/ClassAnnotationMatcher.php
@@ -72,8 +72,12 @@ private function _resolveTagFullyQualifiedName(
     /**
      * @param Use_[]|GroupUse[] $uses
      */
-    private function resolveFullyQualifiedClass(array $uses, Node $node, string $tag, bool $returnNullOnUnknownClass): ?string
-    {
+    private function resolveFullyQualifiedClass(
+        array $uses,
+        Node $node,
+        string $tag,
+        bool $returnNullOnUnknownClass
+    ): ?string {
         $scope = $node->getAttribute(AttributeKey::SCOPE);
 
         if ($scope instanceof Scope) {
@@ -88,7 +92,7 @@ private function resolveFullyQualifiedClass(array $uses, Node $node, string $tag
                     return $this->resolveAsAliased($uses, $tag, $returnNullOnUnknownClass);
                 }
 
-                if (str_starts_with($tag, '\\') && $this->reflectionProvider->hasClass($tag)) {
+                if ($this->isPreslashedExistingClass($tag)) {
                     // Global or absolute Class
                     return $tag;
                 }
@@ -127,10 +131,20 @@ private function resolveAsAliased(array $uses, string $tag, bool $returnNullOnUn
 
     private function resolveClass(?string $class, bool $returnNullOnUnknownClass): ?string
     {
-        if (null === $class) {
+        if ($class === null) {
             return null;
         }
+
         $resolvedClass = $this->reflectionProvider->hasClass($class) ? $class : null;
         return $returnNullOnUnknownClass ? $resolvedClass : $class;
     }
+
+    private function isPreslashedExistingClass(string $tag): bool
+    {
+        if (! str_starts_with($tag, '\\')) {
+            return false;
+        }
+
+        return $this->reflectionProvider->hasClass($tag);
+    }
 }
diff --git a/packages/Config/RectorConfig.php b/packages/Config/RectorConfig.php
@@ -230,4 +230,14 @@ public function cacheClass(string $cacheClass): void
         $parameters = $this->parameters();
         $parameters->set(Option::CACHE_CLASS, $cacheClass);
     }
+
+    /**
+     * @see https://github.com/nikic/PHP-Parser/issues/723#issuecomment-712401963
+     */
+    public function indent(string $character, int $count): void
+    {
+        $parameters = $this->parameters();
+        $parameters->set(Option::INDENT_CHAR, $character);
+        $parameters->set(Option::INDENT_SIZE, $count);
+    }
 }
diff --git a/...MethodCall/RemoveEmptyMethodCallRector/Fixture/fixture_remove_method_call_on_this.php.inc b/...MethodCall/RemoveEmptyMethodCallRector/Fixture/fixture_remove_method_call_on_this.php.inc
@@ -4,14 +4,14 @@ namespace Rector\Tests\DeadCode\Rector\MethodCall\RemoveEmptyMethodCallRector\Fi
 
 final class FixtureRemoveMethodCallOnThis
 {
-	public function __construct()
-	{
-		$this->validateLineLengths();
-	}
-
-	protected function validateLineLengths(): void
-	{
-	}
+    public function __construct()
+    {
+        $this->validateLineLengths();
+    }
+
+    protected function validateLineLengths(): void
+    {
+    }
 }
 
 ?>
@@ -22,13 +22,13 @@ namespace Rector\Tests\DeadCode\Rector\MethodCall\RemoveEmptyMethodCallRector\Fi
 
 final class FixtureRemoveMethodCallOnThis
 {
-	public function __construct()
-	{
-	}
+    public function __construct()
+    {
+    }
 
-	protected function validateLineLengths(): void
-	{
-	}
+    protected function validateLineLengths(): void
+    {
+    }
 }
 
 ?>
diff --git a/...moveEmptyMethodCallRector/Fixture/fixture_remove_method_call_on_this_use_abstract.php.inc b/...moveEmptyMethodCallRector/Fixture/fixture_remove_method_call_on_this_use_abstract.php.inc
@@ -4,17 +4,17 @@ namespace Rector\Tests\DeadCode\Rector\MethodCall\RemoveEmptyMethodCallRector\Fi
 
 abstract class Validator
 {
-	protected function validateLineLengths(): void
-	{
-	}
+    protected function validateLineLengths(): void
+    {
+    }
 }
 
 final class GeneratorStubUseAbstract extends Validator
 {
-	public function __construct()
-	{
-		$this->validateLineLengths();
-	}
+    public function __construct()
+    {
+        $this->validateLineLengths();
+    }
 }
 
 ?>
@@ -25,16 +25,16 @@ namespace Rector\Tests\DeadCode\Rector\MethodCall\RemoveEmptyMethodCallRector\Fi
 
 abstract class Validator
 {
-	protected function validateLineLengths(): void
-	{
-	}
+    protected function validateLineLengths(): void
+    {
+    }
 }
 
 final class GeneratorStubUseAbstract extends Validator
 {
-	public function __construct()
-	{
-	}
+    public function __construct()
+    {
+    }
 }
 
 ?>
diff --git a/...80/Rector/Class_/ClassPropertyAssignToConstructorPromotionRector/Fixture/copy_doc.php.inc b/...80/Rector/Class_/ClassPropertyAssignToConstructorPromotionRector/Fixture/copy_doc.php.inc
@@ -9,23 +9,23 @@ class Z {}
 
 final class CopyDoc
 {
-	public Y $y;
-
-	/**
-	 * @var Z[]
-	 * @Assert\Valid()
-	 * @Assert\NotBlank()
-	 */
-	public array $z = [];
-
-	/**
-	 * @param Z[] $z
-	 */
-	public function __construct(Y $y, array $z = [])
-	{
-		$this->y = $y;
-		$this->z = $z;
-	}
+    public Y $y;
+
+    /**
+     * @var Z[]
+     * @Assert\Valid()
+     * @Assert\NotBlank()
+     */
+    public array $z = [];
+
+    /**
+     * @param Z[] $z
+     */
+    public function __construct(Y $y, array $z = [])
+    {
+        $this->y = $y;
+        $this->z = $z;
+    }
 }
 ?>
 -----
@@ -40,18 +40,18 @@ class Z {}
 
 final class CopyDoc
 {
-	/**
-	 * @param Z[] $z
-	 */
-	public function __construct(
-		public Y $y,
-		/**
-		 * @Assert\Valid()
-		 * @Assert\NotBlank()
-		 */
-		public array $z = []
-	)
-	{
-	}
+    /**
+     * @param Z[] $z
+     */
+    public function __construct(
+        public Y $y,
+        /**
+         * @Assert\Valid()
+         * @Assert\NotBlank()
+         */
+        public array $z = []
+    )
+    {
+    }
 }
 ?>
diff --git a/...p80/Rector/Class_/ClassPropertyAssignToConstructorPromotionRector/Fixture/generic.php.inc b/...p80/Rector/Class_/ClassPropertyAssignToConstructorPromotionRector/Fixture/generic.php.inc
@@ -7,18 +7,18 @@ namespace Rector\Tests\Php80\Rector\Class_\ClassPropertyAssignToConstructorPromo
  */
 final class Generic
 {
-	/**
-	 * @var T
-	 */
-	public mixed $value;
+    /**
+     * @var T
+     */
+    public mixed $value;
 
-	/**
-	 * @param T $value
-	 */
-	public function __construct(mixed $value)
-	{
-		$this->value = $value;
-	}
+    /**
+     * @param T $value
+     */
+    public function __construct(mixed $value)
+    {
+        $this->value = $value;
+    }
 }
 ?>
 -----
@@ -31,11 +31,11 @@ namespace Rector\Tests\Php80\Rector\Class_\ClassPropertyAssignToConstructorPromo
  */
 final class Generic
 {
-	/**
-	 * @param T $value
-	 */
-	public function __construct(public mixed $value)
-	{
-	}
+    /**
+     * @param T $value
+     */
+    public function __construct(public mixed $value)
+    {
+    }
 }
 ?>
diff --git a/...tor/Class_/ClassPropertyAssignToConstructorPromotionRector/Fixture/iterable_typed.php.inc b/...tor/Class_/ClassPropertyAssignToConstructorPromotionRector/Fixture/iterable_typed.php.inc
@@ -4,18 +4,18 @@ namespace Rector\Tests\Php80\Rector\Class_\ClassPropertyAssignToConstructorPromo
 
 class IterableTyped
 {
-	/**
-	 * @var iterable<string>
-	 */
-	private iterable $property;
+    /**
+     * @var iterable<string>
+     */
+    private iterable $property;
 
-	/**
-	 * @param iterable<string> $property
-	 */
-	public function __construct(iterable $property)
-	{
-		$this->property = $property;
-	}
+    /**
+     * @param iterable<string> $property
+     */
+    public function __construct(iterable $property)
+    {
+        $this->property = $property;
+    }
 }
 ?>
 -----
@@ -25,11 +25,11 @@ namespace Rector\Tests\Php80\Rector\Class_\ClassPropertyAssignToConstructorPromo
 
 class IterableTyped
 {
-	/**
-	 * @param iterable<string> $property
-	 */
-	public function __construct(private iterable $property)
-	{
-	}
+    /**
+     * @param iterable<string> $property
+     */
+    public function __construct(private iterable $property)
+    {
+    }
 }
 ?>
diff --git a/...ss_/ClassPropertyAssignToConstructorPromotionRector/Fixture/union_fully_qualified.php.inc b/...ss_/ClassPropertyAssignToConstructorPromotionRector/Fixture/union_fully_qualified.php.inc
@@ -10,20 +10,20 @@ class Z {}
 
 final class UnionFullyQualified
 {
-	public Y $y;
+    public Y $y;
 
-	public Z $z;
+    public Z $z;
 
-	public function __construct(Y $y, Z $z)
-	{
-		$this->y = $y;
-		$this->z = $z;
-	}
+    public function __construct(Y $y, Z $z)
+    {
+        $this->y = $y;
+        $this->z = $z;
+    }
 
-	public function getX(): X
-	{
-		return $this->y;
-	}
+    public function getX(): X
+    {
+        return $this->y;
+    }
 }
 ?>
 -----
@@ -39,13 +39,13 @@ class Z {}
 
 final class UnionFullyQualified
 {
-	public function __construct(public Y $y, public Z $z)
-	{
-	}
-
-	public function getX(): X
-	{
-		return $this->y;
-	}
+    public function __construct(public Y $y, public Z $z)
+    {
+    }
+
+    public function getX(): X
+    {
+        return $this->y;
+    }
 }
 ?>