From 103c444120233c3649cb0e08cfe345396d206679 Mon Sep 17 00:00:00 2001
From: Simon Gilli <25326036+gilbertsoft@users.noreply.github.com>
Date: Thu, 18 Nov 2021 00:32:21 +0100
Subject: [PATCH] [BUGFIX] Use recommended naming for config

The PHP CS-Fixer docs recommends using .php-cs-fixer.dist.php to commit
to the repository and using .php-cs-fixer.php for a local override see
https://github.com/FriendsOfPHP/PHP-CS-Fixer/blob/07430f5aca4874476bf175317cfb6284cd80421a/doc/config.rst
---
 src/Setup.php            | 17 +++++++----
 tests/Unit/SetupTest.php | 64 ++++++++++++++++++++++++++++++++--------
 2 files changed, 63 insertions(+), 18 deletions(-)

diff --git a/src/Setup.php b/src/Setup.php
index be14c38..a3f58ed 100644
--- a/src/Setup.php
+++ b/src/Setup.php
@@ -54,19 +54,24 @@ private function copyPhpCsFixerConfig(bool $force, string $typePrefix): bool
     {
         $errors = false;
 
-        if (!$force && file_exists($this->rootPath . '/.php_cs') && !file_exists($this->rootPath . '/.php-cs-fixer.php')) {
-            rename($this->rootPath . '/.php_cs', $this->rootPath . '/.php-cs-fixer.php');
-            echo "Found deprecated .php_cs file and renamed it to .php-cs-fixer.php.\n";
+        if (!$force && file_exists($this->rootPath . '/.php_cs') && !file_exists($this->rootPath . '/.php-cs-fixer.dist.php')) {
+            rename($this->rootPath . '/.php_cs', $this->rootPath . '/.php-cs-fixer.dist.php');
+            echo "Found deprecated .php_cs file and renamed it to .php-cs-fixer.dist.php.\n";
+        }
+
+        if (!$force && file_exists($this->rootPath . '/.php-cs-fixer.php') && !file_exists($this->rootPath . '/.php-cs-fixer.dist.php')) {
+            rename($this->rootPath . '/.php-cs-fixer.php', $this->rootPath . '/.php-cs-fixer.dist.php');
+            echo "Found .php-cs-fixer.php file and renamed it to .php-cs-fixer.dist.php.\n";
         }
 
         if (
             !$force
-            && (file_exists($this->rootPath . '/.php_cs') || file_exists($this->rootPath . '/.php-cs-fixer.php'))
+            && (file_exists($this->rootPath . '/.php_cs') || file_exists($this->rootPath . '/.php-cs-fixer.dist.php'))
         ) {
-            echo "A .php-cs-fixer.php file already exists in your main folder, but the -f option was not set. Nothing copied.\n";
+            echo "A .php-cs-fixer.dist.php file already exists in your main folder, but the -f option was not set. Nothing copied.\n";
             $errors = true;
         } else {
-            copy($this->templatesPath . '/' . $typePrefix . '_php-cs-fixer.dist.php', $this->rootPath . '/.php-cs-fixer.php');
+            copy($this->templatesPath . '/' . $typePrefix . '_php-cs-fixer.dist.php', $this->rootPath . '/.php-cs-fixer.dist.php');
 
             if (file_exists($this->rootPath . '/.php_cs')) {
                 unlink($this->rootPath . '/.php_cs');
diff --git a/tests/Unit/SetupTest.php b/tests/Unit/SetupTest.php
index bca45b8..d40f616 100644
--- a/tests/Unit/SetupTest.php
+++ b/tests/Unit/SetupTest.php
@@ -109,8 +109,9 @@ public function testForExtensionScenarios(
     public function scenariosProvider(): \Generator
     {
         $editorconfigWarning = "A .editorconfig file already exists in your main folder, but the -f option was not set. Nothing copied.\n";
-        $phpcsInformation = "Found deprecated .php_cs file and renamed it to .php-cs-fixer.php.\n";
-        $phpcsWarning = "A .php-cs-fixer.php file already exists in your main folder, but the -f option was not set. Nothing copied.\n";
+        $phpcsFoundDeprecatedInformation = "Found deprecated .php_cs file and renamed it to .php-cs-fixer.dist.php.\n";
+        $phpcsFoundInformation = "Found .php-cs-fixer.php file and renamed it to .php-cs-fixer.dist.php.\n";
+        $phpcsWarning = "A .php-cs-fixer.dist.php file already exists in your main folder, but the -f option was not set. Nothing copied.\n";
 
         yield 'all files are created' => [
             'existingFiles' => [],
@@ -119,13 +120,15 @@ public function scenariosProvider(): \Generator
             'expectedOutput' => '',
             'expectedFiles' => [
                 '.editorconfig' => 'TPL:editorconfig.dist',
-                '.php-cs-fixer.php' => 'TPL:{$typePrefix}_php-cs-fixer.dist.php',
+                '.php-cs-fixer.dist.php' => 'TPL:{$typePrefix}_php-cs-fixer.dist.php',
+                '.php-cs-fixer.php' => false,
                 '.php_cs' => false,
             ],
         ];
         yield 'files are not overwritten' => [
             'existingFiles' => [
                 '.editorconfig' => 'FIX:editorconfig.dist',
+                '.php-cs-fixer.dist.php' => 'FIX:php-cs-fixer.dist.php',
                 '.php-cs-fixer.php' => 'FIX:php-cs-fixer.dist.php',
                 '.php_cs' => 'FIX:php-cs-fixer.dist.php',
             ],
@@ -134,6 +137,7 @@ public function scenariosProvider(): \Generator
             'expectedOutput' => $editorconfigWarning . $phpcsWarning,
             'expectedFiles' => [
                 '.editorconfig' => 'FIX:editorconfig.dist',
+                '.php-cs-fixer.dist.php' => 'FIX:php-cs-fixer.dist.php',
                 '.php-cs-fixer.php' => 'FIX:php-cs-fixer.dist.php',
                 '.php_cs' => 'FIX:php-cs-fixer.dist.php',
             ],
@@ -147,20 +151,36 @@ public function scenariosProvider(): \Generator
             'expectedOutput' => $editorconfigWarning,
             'expectedFiles' => [
                 '.editorconfig' => 'FIX:editorconfig.dist',
-                '.php-cs-fixer.php' => 'TPL:{$typePrefix}_php-cs-fixer.dist.php',
+                '.php-cs-fixer.dist.php' => 'TPL:{$typePrefix}_php-cs-fixer.dist.php',
+                '.php-cs-fixer.php' => false,
                 '.php_cs' => false,
             ],
         ];
-        yield 'php-cs-fixer.php is not overwritten' => [
+        yield 'php-cs-fixer.dist.php is not overwritten' => [
             'existingFiles' => [
-                '.php-cs-fixer.php' => 'FIX:php-cs-fixer.dist.php',
+                '.php-cs-fixer.dist.php' => 'FIX:php-cs-fixer.dist.php',
             ],
             'force' => false,
             'expectedResult' => 1,
             'expectedOutput' => $phpcsWarning,
             'expectedFiles' => [
                 '.editorconfig' => 'TPL:editorconfig.dist',
+                '.php-cs-fixer.dist.php' => 'FIX:php-cs-fixer.dist.php',
+                '.php-cs-fixer.php' => false,
+                '.php_cs' => false,
+            ],
+        ];
+        yield 'php-cs-fixer.php is not overwritten' => [
+            'existingFiles' => [
                 '.php-cs-fixer.php' => 'FIX:php-cs-fixer.dist.php',
+            ],
+            'force' => false,
+            'expectedResult' => 1,
+            'expectedOutput' => $phpcsFoundInformation . $phpcsWarning,
+            'expectedFiles' => [
+                '.editorconfig' => 'TPL:editorconfig.dist',
+                '.php-cs-fixer.dist.php' => 'FIX:php-cs-fixer.dist.php',
+                '.php-cs-fixer.php' => false,
                 '.php_cs' => false,
             ],
         ];
@@ -170,16 +190,18 @@ public function scenariosProvider(): \Generator
             ],
             'force' => false,
             'expectedResult' => 1,
-            'expectedOutput' => $phpcsInformation . $phpcsWarning,
+            'expectedOutput' => $phpcsFoundDeprecatedInformation . $phpcsWarning,
             'expectedFiles' => [
                 '.editorconfig' => 'TPL:editorconfig.dist',
-                '.php-cs-fixer.php' => 'FIX:php-cs-fixer.dist.php',
+                '.php-cs-fixer.dist.php' => 'FIX:php-cs-fixer.dist.php',
+                '.php-cs-fixer.php' => false,
                 '.php_cs' => false,
             ],
         ];
         yield 'all files are overwritten' => [
             'existingFiles' => [
                 '.editorconfig' => 'FIX:editorconfig.dist',
+                '.php-cs-fixer.dist.php' => 'FIX:php-cs-fixer.dist.php',
                 '.php-cs-fixer.php' => 'FIX:php-cs-fixer.dist.php',
                 '.php_cs' => 'FIX:php-cs-fixer.dist.php',
             ],
@@ -188,7 +210,8 @@ public function scenariosProvider(): \Generator
             'expectedOutput' => '',
             'expectedFiles' => [
                 '.editorconfig' => 'TPL:editorconfig.dist',
-                '.php-cs-fixer.php' => 'TPL:{$typePrefix}_php-cs-fixer.dist.php',
+                '.php-cs-fixer.dist.php' => 'TPL:{$typePrefix}_php-cs-fixer.dist.php',
+                '.php-cs-fixer.php' => 'FIX:php-cs-fixer.dist.php',
                 '.php_cs' => false,
             ],
         ];
@@ -201,11 +224,26 @@ public function scenariosProvider(): \Generator
             'expectedOutput' => '',
             'expectedFiles' => [
                 '.editorconfig' => 'TPL:editorconfig.dist',
-                '.php-cs-fixer.php' => 'TPL:{$typePrefix}_php-cs-fixer.dist.php',
+                '.php-cs-fixer.dist.php' => 'TPL:{$typePrefix}_php-cs-fixer.dist.php',
+                '.php-cs-fixer.php' => false,
                 '.php_cs' => false,
             ],
         ];
         yield 'php-cs-fixer.dist.php is overwritten' => [
+            'existingFiles' => [
+                '.php-cs-fixer.dist.php' => 'FIX:php-cs-fixer.dist.php',
+            ],
+            'force' => true,
+            'expectedResult' => 0,
+            'expectedOutput' => '',
+            'expectedFiles' => [
+                '.editorconfig' => 'TPL:editorconfig.dist',
+                '.php-cs-fixer.dist.php' => 'TPL:{$typePrefix}_php-cs-fixer.dist.php',
+                '.php-cs-fixer.php' => false,
+                '.php_cs' => false,
+            ],
+        ];
+        yield 'php-cs-fixer.php is preserved' => [
             'existingFiles' => [
                 '.php-cs-fixer.php' => 'FIX:php-cs-fixer.dist.php',
             ],
@@ -214,7 +252,8 @@ public function scenariosProvider(): \Generator
             'expectedOutput' => '',
             'expectedFiles' => [
                 '.editorconfig' => 'TPL:editorconfig.dist',
-                '.php-cs-fixer.php' => 'TPL:{$typePrefix}_php-cs-fixer.dist.php',
+                '.php-cs-fixer.dist.php' => 'TPL:{$typePrefix}_php-cs-fixer.dist.php',
+                '.php-cs-fixer.php' => 'FIX:php-cs-fixer.dist.php',
                 '.php_cs' => false,
             ],
         ];
@@ -227,7 +266,8 @@ public function scenariosProvider(): \Generator
             'expectedOutput' => '',
             'expectedFiles' => [
                 '.editorconfig' => 'TPL:editorconfig.dist',
-                '.php-cs-fixer.php' => 'TPL:{$typePrefix}_php-cs-fixer.dist.php',
+                '.php-cs-fixer.dist.php' => 'TPL:{$typePrefix}_php-cs-fixer.dist.php',
+                '.php-cs-fixer.php' => false,
                 '.php_cs' => false,
             ],
         ];