[TASK] Take .editorconfig into account

.gitattributes

@@ -41,3 +41,4 @@ phpstan-for-rector.neon export-ignore
 
 # testing Windows spaces - https://help.github.com/en/github/using-git/configuring-git-to-handle-line-endings
 packages/better-php-doc-parser/tests/PhpDocInfo/PhpDocInfoPrinter/FixtureBasic/with_spac.txt text eol=crlf
+packages-tests/FileFormatter/ValueObject/Fixture/composer_carriage_return_line_feed.json json eol=crlf

composer.json

@@ -32,6 +32,8 @@
         "composer/xdebug-handler": "^2.0",
         "danielstjules/stringy": "^3.1",
         "doctrine/inflector": "^2.0",
+        "ergebnis/json-printer": "^3.1",
+        "idiosyncratic/editorconfig": "^0.1.0",
         "jean85/pretty-package-versions": "^1.6",
         "nette/caching": "^3.1",
         "nette/robot-loader": "^3.4",
@@ -48,6 +50,7 @@
         "rector/rector-phpunit": "^0.10.8",
         "rector/rector-symfony": "^0.10.5",
         "sebastian/diff": "^4.0.4",
+        "shanethehat/pretty-xml": "^1.0",
         "symfony/console": "^4.4.8|^5.1",
         "symfony/dependency-injection": "^5.1",
         "symfony/finder": "^4.4.8|^5.1",
@@ -156,7 +159,5 @@
     "config": {
         "sort-packages": true,
         "platform-check": false
-    },
-    "minimum-stability": "dev",
-    "prefer-stable": true
+    }
 }

config/services.php

@@ -5,6 +5,9 @@
 use Composer\Semver\VersionParser;
 use Doctrine\Inflector\Inflector;
 use Doctrine\Inflector\Rules\English\InflectorFactory;
+use Ergebnis\Json\Printer\Printer;
+use Ergebnis\Json\Printer\PrinterInterface;
+use Idiosyncratic\EditorConfig\EditorConfig;
 use Nette\Caching\Cache;
 use PhpParser\BuilderFactory;
 use PhpParser\Lexer;
@@ -21,13 +24,16 @@
 use PHPStan\PhpDocParser\Parser\PhpDocParser;
 use PHPStan\PhpDocParser\Parser\TypeParser;
 use PHPStan\Reflection\ReflectionProvider;
+use PrettyXml\Formatter;
 use Rector\BetterPhpDocParser\PhpDocParser\BetterPhpDocParser;
 use Rector\BetterPhpDocParser\PhpDocParser\BetterTypeParser;
 use Rector\Caching\Cache\NetteCacheFactory;
 use Rector\Core\Console\ConsoleApplication;
 use Rector\Core\NonPhpFile\Rector\RenameClassNonPhpRector;
 use Rector\Core\PhpParser\Parser\NikicPhpParserFactory;
 use Rector\Core\PhpParser\Parser\PhpParserLexerFactory;
+use Rector\FileFormatter\Contract\EditorConfig\EditorConfigParserInterface;
+use Rector\FileFormatter\EditorConfig\EditorConfigIdiosyncraticParser;
 use Rector\NodeTypeResolver\DependencyInjection\PHPStanServicesFactory;
 use Rector\NodeTypeResolver\Reflection\BetterReflection\SourceLocator\IntermediateSourceLocator;
 use Rector\NodeTypeResolver\Reflection\BetterReflection\SourceLocatorProvider\DynamicSourceLocatorProvider;
@@ -146,4 +152,13 @@
         ->factory([service(PHPStanServicesFactory::class), 'createTypeNodeResolver']);
     $services->set(DynamicSourceLocatorProvider::class)
         ->factory([service(PHPStanServicesFactory::class), 'createDynamicSourceLocatorProvider']);
+
+    $services->set(Printer::class);
+    $services->alias(PrinterInterface::class, Printer::class);
+
+    $services->set(Formatter::class);
+
+    $services->set(EditorConfig::class);
+
+    $services->alias(EditorConfigParserInterface::class, EditorConfigIdiosyncraticParser::class);
 };

packages-tests/FileFormatter/EditorConfig/EditorConfigIdiosyncraticParser/.editorconfig

@@ -0,0 +1,3 @@
+[composer.json]
+indent_size = 1
+indent_style = tab

packages-tests/FileFormatter/EditorConfig/EditorConfigIdiosyncraticParser/EditorConfigIdiosyncraticParserTest.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Rector\Tests\FileFormatter\EditorConfig\EditorConfigIdiosyncraticParser;
+
+use Rector\Core\ValueObject\Application\File;
+use Rector\FileFormatter\Contract\EditorConfig\EditorConfigParserInterface;
+use Rector\FileFormatter\ValueObject\Indent;
+use Rector\FileFormatter\ValueObjectFactory\EditorConfigConfigurationBuilder;
+use Rector\Testing\PHPUnit\AbstractTestCase;
+use Symplify\SmartFileSystem\SmartFileInfo;
+
+final class EditorConfigIdiosyncraticParserTest extends AbstractTestCase
+{
+    /**
+     * @var EditorConfigParserInterface
+     */
+    private $editorConfigParser;
+
+    protected function setUp(): void
+    {
+        $this->boot();
+        $this->editorConfigParser = $this->getService(EditorConfigParserInterface::class);
+    }
+
+    public function testComposerJsonFile(): void
+    {
+        $editorConfigConfigurationBuilder = EditorConfigConfigurationBuilder::anEditorConfigConfiguration();
+        $editorConfigConfigurationBuilder->withIndent(Indent::createSpaceWithSize(20));
+
+        $composerJsonFile = new SmartFileInfo(__DIR__ . '/Fixture/composer.json');
+
+        $file = new File($composerJsonFile, $composerJsonFile->getContents());
+
+        $editorConfigConfiguration = $this->editorConfigParser->extractConfigurationForFile(
+            $file,
+            $editorConfigConfigurationBuilder
+        );
+
+        $this->assertSame('tab', $editorConfigConfiguration->getIndentStyle());
+        $this->assertSame(1, $editorConfigConfiguration->getIndentSize());
+    }
+}

packages-tests/FileFormatter/EditorConfig/EditorConfigIdiosyncraticParser/Fixture/composer.json

@@ -0,0 +1,5 @@
+{
+    "name": "foo/bar",
+    "description": "A foo bar baz extension",
+    "license": "GPL-2.0-or-later"
+}

packages-tests/FileFormatter/Formatter/JsonFileFormatter/Fixture/composer_change_indent_style_to_tab.json

@@ -0,0 +1,11 @@
+{
+    "name": "foo/bar",
+    "description": "A foo bar baz extension",
+    "license": "GPL-2.0-or-later"
+}
+-----
+{
+	"name": "foo/bar",
+	"description": "A foo bar baz extension",
+	"license": "GPL-2.0-or-later"
+}

packages-tests/FileFormatter/Formatter/JsonFileFormatter/JsonFileFormatterTest.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\FileFormatter\Formatter\JsonFileFormatter;
+
+use Iterator;
+use Rector\Core\ValueObject\Application\File;
+use Rector\FileFormatter\Formatter\JsonFileFormatter;
+use Rector\FileFormatter\ValueObject\Indent;
+use Rector\FileFormatter\ValueObjectFactory\EditorConfigConfigurationBuilder;
+use Rector\Testing\PHPUnit\AbstractTestCase;
+use Symplify\EasyTesting\DataProvider\StaticFixtureFinder;
+use Symplify\EasyTesting\StaticFixtureSplitter;
+use Symplify\SmartFileSystem\SmartFileInfo;
+
+final class JsonFileFormatterTest extends AbstractTestCase
+{
+    /**
+     * @var JsonFileFormatter
+     */
+    private $jsonFileFormatter;
+
+    protected function setUp(): void
+    {
+        $this->boot();
+        $this->jsonFileFormatter = $this->getService(JsonFileFormatter::class);
+    }
+
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(SmartFileInfo $fileInfo): void
+    {
+        $this->doTestFileInfo($fileInfo);
+    }
+
+    /**
+     * @return Iterator<array<int, SmartFileInfo>>
+     */
+    public function provideData(): Iterator
+    {
+        return StaticFixtureFinder::yieldDirectory(__DIR__ . '/Fixture', '*.json');
+    }
+
+    private function doTestFileInfo(SmartFileInfo $smartFileInfo): void
+    {
+        $inputFileInfoAndExpected = StaticFixtureSplitter::splitFileInfoToLocalInputAndExpected($smartFileInfo);
+
+        $inputFileInfo = $inputFileInfoAndExpected->getInputFileInfo();
+        $file = new File($inputFileInfo, $inputFileInfo->getContents());
+
+        $editorConfigConfigurationBuilder = EditorConfigConfigurationBuilder::anEditorConfigConfiguration();
+        $editorConfigConfigurationBuilder->withIndent(Indent::createTabWithSize(1));
+
+        $this->jsonFileFormatter->format($file, $editorConfigConfigurationBuilder->build());
+
+        $this->assertSame($inputFileInfoAndExpected->getExpected(), $file->getFileContent());
+    }
+}

packages-tests/FileFormatter/Formatter/XmlFileFormatter/Fixture/change_from_spaces_to_tabs.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0"?>
+<catalog>
+    <book id="bk101">
+<author>Gambardella, Matthew</author>
+        <title>XML Developer's Guide</title>
+        <genre>Computer</genre>
+        <price>44.95</price>
+        <publish_date>2000-10-01</publish_date>
+        <description>An in-depth look at creating applications
+            with XML.</description>
+    </book>
+</catalog>
+-----
+<?xml version="1.0"?>
+<catalog>
+	<book id="bk101">
+		<author>Gambardella, Matthew</author>
+		<title>XML Developer's Guide</title>
+		<genre>Computer</genre>
+		<price>44.95</price>
+		<publish_date>2000-10-01</publish_date>
+		<description>An in-depth look at creating applications
+		with XML.</description>
+	</book>
+</catalog>

packages-tests/FileFormatter/Formatter/XmlFileFormatter/XmlFileFormatterTest.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\FileFormatter\Formatter\XmlFileFormatter;
+
+use Iterator;
+use Rector\Core\ValueObject\Application\File;
+use Rector\FileFormatter\Formatter\XmlFileFormatter;
+use Rector\FileFormatter\ValueObject\Indent;
+use Rector\FileFormatter\ValueObjectFactory\EditorConfigConfigurationBuilder;
+use Rector\Testing\PHPUnit\AbstractTestCase;
+use Symplify\EasyTesting\DataProvider\StaticFixtureFinder;
+use Symplify\EasyTesting\StaticFixtureSplitter;
+use Symplify\SmartFileSystem\SmartFileInfo;
+
+final class XmlFileFormatterTest extends AbstractTestCase
+{
+    /**
+     * @var XmlFileFormatter
+     */
+    private $xmlFileFormatter;
+
+    protected function setUp(): void
+    {
+        $this->boot();
+        $this->xmlFileFormatter = $this->getService(XmlFileFormatter::class);
+    }
+
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(SmartFileInfo $fileInfo): void
+    {
+        $this->doTestFileInfo($fileInfo);
+    }
+
+    /**
+     * @return Iterator<array<int, SmartFileInfo>>
+     */
+    public function provideData(): Iterator
+    {
+        return StaticFixtureFinder::yieldDirectory(__DIR__ . '/Fixture', '*.xml');
+    }
+
+    private function doTestFileInfo(SmartFileInfo $smartFileInfo): void
+    {
+        $inputFileInfoAndExpected = StaticFixtureSplitter::splitFileInfoToLocalInputAndExpected($smartFileInfo);
+
+        $inputFileInfo = $inputFileInfoAndExpected->getInputFileInfo();
+        $file = new File($inputFileInfo, $inputFileInfo->getContents());
+
+        $editorConfigConfigurationBuilder = EditorConfigConfigurationBuilder::anEditorConfigConfiguration();
+        $editorConfigConfigurationBuilder->withIndent(Indent::createTabWithSize(1));
+
+        $this->xmlFileFormatter->format($file, $editorConfigConfigurationBuilder->build());
+
+        $this->assertSame($inputFileInfoAndExpected->getExpected(), $file->getFileContent());
+    }
+}

packages-tests/FileFormatter/Formatter/YamlFileFormatter/Fixture/yaml_change_indent_size_from_two_to_four.yaml

@@ -0,0 +1,15 @@
+martin:
+  name: Martin
+  job: Developer
+  skills:
+    - python
+    - perl
+    - pascal
+-----
+martin:
+    name: Martin
+    job: Developer
+    skills:
+        - python
+        - perl
+        - pascal

packages-tests/FileFormatter/Formatter/YamlFileFormatter/YamlFileFormatterTest.php

@@ -0,0 +1,61 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\FileFormatter\Formatter\YamlFileFormatter;
+
+use Iterator;
+use Rector\Core\ValueObject\Application\File;
+use Rector\FileFormatter\Formatter\YamlFileFormatter;
+use Rector\FileFormatter\ValueObject\Indent;
+use Rector\FileFormatter\ValueObjectFactory\EditorConfigConfigurationBuilder;
+use Rector\Testing\PHPUnit\AbstractTestCase;
+use Symplify\EasyTesting\DataProvider\StaticFixtureFinder;
+use Symplify\EasyTesting\StaticFixtureSplitter;
+use Symplify\SmartFileSystem\SmartFileInfo;
+
+final class YamlFileFormatterTest extends AbstractTestCase
+{
+    /**
+     * @var YamlFileFormatter
+     */
+    private $yamlFileFormatter;
+
+    protected function setUp(): void
+    {
+        $this->boot();
+        $this->yamlFileFormatter = $this->getService(YamlFileFormatter::class);
+    }
+
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(SmartFileInfo $fileInfo): void
+    {
+        $this->doTestFileInfo($fileInfo);
+    }
+
+    /**
+     * @return Iterator<array<int, SmartFileInfo>>
+     */
+    public function provideData(): Iterator
+    {
+        return StaticFixtureFinder::yieldDirectory(__DIR__ . '/Fixture', '*.yaml');
+    }
+
+    private function doTestFileInfo(SmartFileInfo $smartFileInfo): void
+    {
+        $inputFileInfoAndExpected = StaticFixtureSplitter::splitFileInfoToLocalInputAndExpected($smartFileInfo);
+
+        $inputFileInfo = $inputFileInfoAndExpected->getInputFileInfo();
+        $file = new File($inputFileInfo, $inputFileInfo->getContents());
+
+        $editorConfigConfigurationBuilder = EditorConfigConfigurationBuilder::anEditorConfigConfiguration();
+        $editorConfigConfigurationBuilder->withIndent(Indent::createSpaceWithSize(4));
+        $editorConfigConfigurationBuilder->withInsertFinalNewline(false);
+
+        $this->yamlFileFormatter->format($file, $editorConfigConfigurationBuilder->build());
+
+        $this->assertSame($inputFileInfoAndExpected->getExpected(), $file->getFileContent());
+    }
+}