Cache - add indent and line ending to cache signature

PHP-CS-Fixer · Mar 18, 2019 · 739adcf · 739adcf
1 parent efa97df
commit 739adcf
Show file tree

Hide file tree

Showing 7 changed files with 127 additions and 61 deletions.
diff --git a/src/Cache/Cache.php b/src/Cache/Cache.php
@@ -75,6 +75,8 @@ public function toJson()
         $json = json_encode([
             'php' => $this->getSignature()->getPhpVersion(),
             'version' => $this->getSignature()->getFixerVersion(),
+            'indent' => $this->getSignature()->getIndent(),
+            'lineEnding' => $this->getSignature()->getLineEnding(),
             'rules' => $this->getSignature()->getRules(),
             'hashes' => $this->hashes,
         ]);
@@ -111,6 +113,8 @@ public static function fromJson($json)
         $requiredKeys = [
             'php',
             'version',
+            'indent',
+            'lineEnding',
             'rules',
             'hashes',
         ];
@@ -127,6 +131,8 @@ public static function fromJson($json)
         $signature = new Signature(
             $data['php'],
             $data['version'],
+            $data['indent'],
+            $data['lineEnding'],
             $data['rules']
         );
 

diff --git a/src/Cache/Signature.php b/src/Cache/Signature.php
@@ -29,6 +29,16 @@ final class Signature implements SignatureInterface
      */
     private $fixerVersion;
 
+    /**
+     * @var string
+     */
+    private $indent;
+
+    /**
+     * @var string
+     */
+    private $lineEnding;
+
     /**
      * @var array
      */
@@ -37,12 +47,16 @@ final class Signature implements SignatureInterface
     /**
      * @param string $phpVersion
      * @param string $fixerVersion
+     * @param string $indent
+     * @param string $lineEnding
      * @param array  $rules
      */
-    public function __construct($phpVersion, $fixerVersion, array $rules)
+    public function __construct($phpVersion, $fixerVersion, $indent, $lineEnding, array $rules)
     {
         $this->phpVersion = $phpVersion;
         $this->fixerVersion = $fixerVersion;
+        $this->indent = $indent;
+        $this->lineEnding = $lineEnding;
         $this->rules = self::utf8Encode($rules);
     }
 
@@ -56,6 +70,16 @@ public function getFixerVersion()
         return $this->fixerVersion;
     }
 
+    public function getIndent()
+    {
+        return $this->indent;
+    }
+
+    public function getLineEnding()
+    {
+        return $this->lineEnding;
+    }
+
     public function getRules()
     {
         return $this->rules;
@@ -65,6 +89,8 @@ public function equals(SignatureInterface $signature)
     {
         return $this->phpVersion === $signature->getPhpVersion()
             && $this->fixerVersion === $signature->getFixerVersion()
+            && $this->indent === $signature->getIndent()
+            && $this->lineEnding === $signature->getLineEnding()
             && $this->rules === $signature->getRules();
     }
 

diff --git a/src/Cache/SignatureInterface.php b/src/Cache/SignatureInterface.php
@@ -29,6 +29,16 @@ public function getPhpVersion();
      */
     public function getFixerVersion();
 
+    /**
+     * @return string
+     */
+    public function getIndent();
+
+    /**
+     * @return string
+     */
+    public function getLineEnding();
+
     /**
      * @return array
      */

diff --git a/src/Console/ConfigurationResolver.php b/src/Console/ConfigurationResolver.php
@@ -202,6 +202,8 @@ public function getCacheManager()
                     new Signature(
                         PHP_VERSION,
                         $this->toolInfo->getVersion(),
+                        $this->getConfig()->getIndent(),
+                        $this->getConfig()->getLineEnding(),
                         $this->getRules()
                     ),
                     $this->isDryRun(),

diff --git a/tests/Cache/CacheTest.php b/tests/Cache/CacheTest.php
@@ -15,6 +15,7 @@
 use PhpCsFixer\Cache\Cache;
 use PhpCsFixer\Cache\Signature;
 use PhpCsFixer\Cache\SignatureInterface;
+use PhpCsFixer\Config;
 use PhpCsFixer\Tests\TestCase;
 use PhpCsFixer\ToolInfo;
 
@@ -173,11 +174,14 @@ public function testCanConvertToAndFromJson(SignatureInterface $signature)
     public function provideCanConvertToAndFromJsonCases()
     {
         $toolInfo = new ToolInfo();
+        $config = new Config();
 
         return [
             [new Signature(
                 PHP_VERSION,
                 '2.0',
+                '  ',
+                "\r\n",
                 [
                     'foo' => true,
                     'bar' => true,
@@ -186,6 +190,8 @@ public function provideCanConvertToAndFromJsonCases()
             [new Signature(
                 PHP_VERSION,
                 $toolInfo->getVersion(),
+                $config->getIndent(),
+                $config->getLineEnding(),
                 [
                     // value encoded in ANSI, not UTF
                     'header_comment' => ['header' => 'Dariusz '.base64_decode('UnVtafFza2k=', true)],
@@ -201,6 +207,8 @@ public function testToJsonThrowsExceptionOnInvalid()
         $signature = $this->prophesize(\PhpCsFixer\Cache\SignatureInterface::class);
         $signature->getPhpVersion()->willReturn('7.1.0');
         $signature->getFixerVersion()->willReturn('2.2.0');
+        $signature->getIndent()->willReturn('    ');
+        $signature->getLineEnding()->willReturn(PHP_EOL);
         $signature->getRules()->willReturn([
             $invalidUtf8Sequence => true,
         ]);

diff --git a/tests/Cache/FileHandlerTest.php b/tests/Cache/FileHandlerTest.php
@@ -15,6 +15,7 @@
 use PhpCsFixer\Cache\Cache;
 use PhpCsFixer\Cache\FileHandler;
 use PhpCsFixer\Cache\Signature;
+use PhpCsFixer\Cache\SignatureInterface;
 use PhpCsFixer\Tests\TestCase;
 
 /**
@@ -79,14 +80,7 @@ public function testReadReturnsCache()
     {
         $file = $this->getFile();
 
-        $signature = new Signature(
-            PHP_VERSION,
-            '2.0',
-            [
-                'foo',
-                'bar',
-            ]
-        );
+        $signature = $this->createSignature();
 
         $cache = new Cache($signature);
 
@@ -110,14 +104,7 @@ public function testWriteThrowsIOExceptionIfFileCanNotBeWritten()
             preg_quote($file, '#')
         ));
 
-        $cache = new Cache(new Signature(
-            PHP_VERSION,
-            '2.0',
-            [
-                'foo',
-                'bar',
-            ]
-        ));
+        $cache = new Cache($this->createSignature());
 
         $handler = new FileHandler($file);
 
@@ -128,14 +115,7 @@ public function testWriteWritesCache()
     {
         $file = $this->getFile();
 
-        $cache = new Cache(new Signature(
-            PHP_VERSION,
-            '2.0',
-            [
-                'foo',
-                'bar',
-            ]
-        ));
+        $cache = new Cache($this->createSignature());
 
         $handler = new FileHandler($file);
 
@@ -160,14 +140,7 @@ public function testWriteCacheToDirectory()
             preg_quote('Cannot write cache file "'.realpath($dir).'" as the location exists as directory.', '#')
         ));
 
-        $handler->write(new Cache(new Signature(
-            PHP_VERSION,
-            '2.0',
-            [
-                'foo',
-                'bar',
-            ]
-        )));
+        $handler->write(new Cache($this->createSignature()));
     }
 
     public function testWriteCacheToNonWriteableFile()
@@ -187,14 +160,7 @@ public function testWriteCacheToNonWriteableFile()
             preg_quote('Cannot write to file "'.realpath($file).'" as it is not writable.', '#')
         ));
 
-        $handler->write(new Cache(new Signature(
-            PHP_VERSION,
-            '2.0',
-            [
-                'foo',
-                'bar',
-            ]
-        )));
+        $handler->write(new Cache($this->createSignature()));
     }
 
     public function testWriteCacheFilePermissions()
@@ -205,14 +171,7 @@ public function testWriteCacheFilePermissions()
         $this->assertFileNotExists($file);
 
         $handler = new FileHandler($file);
-        $handler->write(new Cache(new Signature(
-            PHP_VERSION,
-            '2.0',
-            [
-                'foo',
-                'bar',
-            ]
-        )));
+        $handler->write(new Cache($this->createSignature()));
 
         $this->assertFileExists($file);
         $this->assertTrue(@is_file($file), sprintf('Failed cache "%s" `is_file`.', $file));
@@ -229,4 +188,21 @@ private function getFile()
     {
         return __DIR__.'/.php_cs.cache';
     }
+
+    /**
+     * @return SignatureInterface
+     */
+    private function createSignature()
+    {
+        return new Signature(
+            PHP_VERSION,
+            '2.0',
+            '    ',
+            PHP_EOL,
+            [
+                'foo',
+                'bar',
+            ]
+        );
+    }
 }
diff --git a/tests/Cache/SignatureTest.php b/tests/Cache/SignatureTest.php
@@ -42,6 +42,8 @@ public function testConstructorSetsValues()
     {
         $php = PHP_VERSION;
         $version = '2.0';
+        $indent = '    ';
+        $lineEnding = PHP_EOL;
         $rules = [
             'foo',
             'bar',
@@ -50,42 +52,74 @@ public function testConstructorSetsValues()
         $signature = new Signature(
             $php,
             $version,
+            $indent,
+            $lineEnding,
             $rules
         );
 
         $this->assertSame($php, $signature->getPhpVersion());
         $this->assertSame($version, $signature->getFixerVersion());
+        $this->assertSame($indent, $signature->getIndent());
+        $this->assertSame($lineEnding, $signature->getLineEnding());
         $this->assertSame($rules, $signature->getRules());
     }
 
-    public function testEqualsReturnsFalseIfValuesAreNotIdentical()
+    /**
+     * @dataProvider provideEqualsReturnsFalseIfValuesAreNotIdenticalCases
+     *
+     * @param Signature $signature
+     * @param Signature $anotherSignature
+     */
+    public function testEqualsReturnsFalseIfValuesAreNotIdentical($signature, $anotherSignature)
+    {
+        $this->assertFalse($signature->equals($anotherSignature));
+    }
+
+    public function provideEqualsReturnsFalseIfValuesAreNotIdenticalCases()
     {
         $php = PHP_VERSION;
         $version = '2.0';
+        $indent = '    ';
+        $lineEnding = "\n";
         $rules = [
             'foo',
             'bar',
         ];
 
-        $signature = new Signature(
-            $php,
-            $version,
-            $rules
-        );
+        $base = new Signature($php, $version, $indent, $lineEnding, $rules);
 
-        $anotherSignature = new Signature(
-            $php,
-            $version.'.1',
-            $rules
-        );
+        yield 'php' => [
+            $base,
+            new Signature('50400', $version, $indent, $lineEnding, $rules),
+        ];
 
-        $this->assertFalse($signature->equals($anotherSignature));
+        yield 'version' => [
+            $base,
+            new Signature($php, '2.12', $indent, $lineEnding, $rules),
+        ];
+
+        yield 'indent' => [
+            $base,
+            new Signature($php, $version, "\t", $lineEnding, $rules),
+        ];
+
+        yield 'lineEnding' => [
+            $base,
+            new Signature($php, $version, $indent, "\r\n", $rules),
+        ];
+
+        yield 'rules' => [
+            $base,
+            new Signature($php, $version, $indent, $lineEnding, ['foo']),
+        ];
     }
 
     public function testEqualsReturnsTrueIfValuesAreIdentical()
     {
         $php = PHP_VERSION;
         $version = '2.0';
+        $indent = '    ';
+        $lineEnding = PHP_EOL;
         $rules = [
             'foo',
             'bar',
@@ -94,12 +128,16 @@ public function testEqualsReturnsTrueIfValuesAreIdentical()
         $signature = new Signature(
             $php,
             $version,
+            $indent,
+            $lineEnding,
             $rules
         );
 
         $anotherSignature = new Signature(
             $php,
             $version,
+            $indent,
+            $lineEnding,
             $rules
         );