Fixer::generateDiff(): add tests

jrfnl · jrfnl · commit 10e650251d01 · 2024-02-21T10:34:45.000+01:00
These tests test the functionality and document the behaviour of the `Fixer::generateDiff()` method, with a particular focus on (trailing) whitespace handling in the diff as this was noted in the method itself as a potential point of failure.

Related to 146
diff --git a/.gitattributes b/.gitattributes
@@ -21,3 +21,4 @@ phpunit.xml.dist  export-ignore
 *WinTest.inc text eol=crlf
 *WinTest.php text eol=crlf
 src/Standards/Generic/Tests/Files/LineEndingsUnitTest*.inc text eol=crlf
+tests/Core/Fixer/Fixtures/GenerateDiffTest-WindowsLineEndings.inc text eol=crlf
diff --git a/tests/Core/Fixer/Fixtures/GenerateDiffTest-BlankLinesAtEnd.diff b/tests/Core/Fixer/Fixtures/GenerateDiffTest-BlankLinesAtEnd.diff
@@ -0,0 +1,10 @@
+--- tests/Core/Fixer/Fixtures/GenerateDiffTest-BlankLinesAtEnd.inc
++++ PHP_CodeSniffer
+@@ -5,7 +5,3 @@
+ if ($var) {
+ 	echo 'This line is tab indented';
+ }
+-
+-
+-
+-
diff --git a/tests/Core/Fixer/Fixtures/GenerateDiffTest-BlankLinesAtEnd.inc b/tests/Core/Fixer/Fixtures/GenerateDiffTest-BlankLinesAtEnd.inc
@@ -0,0 +1,11 @@
+<?php
+// Comment with 2 spaces trailing whitespace.  
+$var = FALSE;
+
+if ($var) {
+	echo 'This line is tab indented';
+}
+
+
+
+
diff --git a/tests/Core/Fixer/Fixtures/GenerateDiffTest-BlankLinesAtStart.diff b/tests/Core/Fixer/Fixtures/GenerateDiffTest-BlankLinesAtStart.diff
@@ -0,0 +1,9 @@
+--- tests/Core/Fixer/Fixtures/GenerateDiffTest-BlankLinesAtStart.inc
++++ PHP_CodeSniffer
+@@ -1,6 +1,3 @@
+-
+-
+-
+ <?php
+ // Comment with 2 spaces trailing whitespace.  
+ $var = FALSE;
diff --git a/tests/Core/Fixer/Fixtures/GenerateDiffTest-BlankLinesAtStart.inc b/tests/Core/Fixer/Fixtures/GenerateDiffTest-BlankLinesAtStart.inc
@@ -0,0 +1,10 @@
+
+
+
+<?php
+// Comment with 2 spaces trailing whitespace.  
+$var = FALSE;
+
+if ($var) {
+	echo 'This line is tab indented';
+}
diff --git a/tests/Core/Fixer/Fixtures/GenerateDiffTest-LineAdded.diff b/tests/Core/Fixer/Fixtures/GenerateDiffTest-LineAdded.diff
@@ -0,0 +1,8 @@
+--- tests/Core/Fixer/Fixtures/GenerateDiffTest-LineAdded.inc
++++ PHP_CodeSniffer
+@@ -1,4 +1,5 @@
+ <?php
++// Comment with 2 spaces trailing whitespace.  
+ $var = FALSE;
+ 
+ if ($var) {
diff --git a/tests/Core/Fixer/Fixtures/GenerateDiffTest-LineAdded.inc b/tests/Core/Fixer/Fixtures/GenerateDiffTest-LineAdded.inc
@@ -0,0 +1,6 @@
+<?php
+$var = FALSE;
+
+if ($var) {
+	echo 'This line is tab indented';
+}
diff --git a/tests/Core/Fixer/Fixtures/GenerateDiffTest-LineRemoved.diff b/tests/Core/Fixer/Fixtures/GenerateDiffTest-LineRemoved.diff
@@ -0,0 +1,8 @@
+--- tests/Core/Fixer/Fixtures/GenerateDiffTest-LineRemoved.inc
++++ PHP_CodeSniffer
+@@ -4,5 +4,4 @@
+ 
+ if ($var) {
+ 	echo 'This line is tab indented';
+-    echo 'And this line is not';
+ }
diff --git a/tests/Core/Fixer/Fixtures/GenerateDiffTest-LineRemoved.inc b/tests/Core/Fixer/Fixtures/GenerateDiffTest-LineRemoved.inc
@@ -0,0 +1,8 @@
+<?php
+// Comment with 2 spaces trailing whitespace.  
+$var = FALSE;
+
+if ($var) {
+	echo 'This line is tab indented';
+    echo 'And this line is not';
+}
diff --git a/tests/Core/Fixer/Fixtures/GenerateDiffTest-NoDiff.diff b/tests/Core/Fixer/Fixtures/GenerateDiffTest-NoDiff.diff
diff --git a/tests/Core/Fixer/Fixtures/GenerateDiffTest-NoDiff.inc b/tests/Core/Fixer/Fixtures/GenerateDiffTest-NoDiff.inc
@@ -0,0 +1,7 @@
+<?php
+// Comment with 2 spaces trailing whitespace.  
+$var = FALSE;
+
+if ($var) {
+	echo 'This line is tab indented';
+}
diff --git a/tests/Core/Fixer/Fixtures/GenerateDiffTest-NoTrailingWhitespace.diff b/tests/Core/Fixer/Fixtures/GenerateDiffTest-NoTrailingWhitespace.diff
@@ -0,0 +1,9 @@
+--- tests/Core/Fixer/Fixtures/GenerateDiffTest-NoTrailingWhitespace.inc
++++ PHP_CodeSniffer
+@@ -1,5 +1,5 @@
+ <?php
+-// Comment with 2 spaces trailing whitespace.
++// Comment with 2 spaces trailing whitespace.  
+ $var = FALSE;
+ 
+ if ($var) {
diff --git a/tests/Core/Fixer/Fixtures/GenerateDiffTest-NoTrailingWhitespace.inc b/tests/Core/Fixer/Fixtures/GenerateDiffTest-NoTrailingWhitespace.inc
@@ -0,0 +1,7 @@
+<?php
+// Comment with 2 spaces trailing whitespace.
+$var = FALSE;
+
+if ($var) {
+	echo 'This line is tab indented';
+}
diff --git a/tests/Core/Fixer/Fixtures/GenerateDiffTest-TabsToSpaces.diff b/tests/Core/Fixer/Fixtures/GenerateDiffTest-TabsToSpaces.diff
@@ -0,0 +1,9 @@
+--- tests/Core/Fixer/Fixtures/GenerateDiffTest-TabsToSpaces.inc
++++ PHP_CodeSniffer
+@@ -3,5 +3,5 @@
+ $var = FALSE;
+ 
+ if ($var) {
+-    echo 'This line is tab indented';
++	echo 'This line is tab indented';
+ }
diff --git a/tests/Core/Fixer/Fixtures/GenerateDiffTest-TabsToSpaces.inc b/tests/Core/Fixer/Fixtures/GenerateDiffTest-TabsToSpaces.inc
@@ -0,0 +1,7 @@
+<?php
+// Comment with 2 spaces trailing whitespace.  
+$var = FALSE;
+
+if ($var) {
+    echo 'This line is tab indented';
+}
diff --git a/tests/Core/Fixer/Fixtures/GenerateDiffTest-VarNameChanged.diff b/tests/Core/Fixer/Fixtures/GenerateDiffTest-VarNameChanged.diff
@@ -0,0 +1,12 @@
+--- tests/Core/Fixer/Fixtures/GenerateDiffTest-VarNameChanged.inc
++++ PHP_CodeSniffer
+@@ -1,7 +1,7 @@
+ <?php
+ // Comment with 2 spaces trailing whitespace.  
+-$rav = FALSE;
++$var = FALSE;
+ 
+-if ($rav) {
++if ($var) {
+ 	echo 'This line is tab indented';
+ }
diff --git a/tests/Core/Fixer/Fixtures/GenerateDiffTest-VarNameChanged.inc b/tests/Core/Fixer/Fixtures/GenerateDiffTest-VarNameChanged.inc
@@ -0,0 +1,7 @@
+<?php
+// Comment with 2 spaces trailing whitespace.  
+$rav = FALSE;
+
+if ($rav) {
+	echo 'This line is tab indented';
+}
diff --git a/tests/Core/Fixer/Fixtures/GenerateDiffTest-WhiteSpaceAtEnd.diff b/tests/Core/Fixer/Fixtures/GenerateDiffTest-WhiteSpaceAtEnd.diff
@@ -0,0 +1,8 @@
+--- tests/Core/Fixer/Fixtures/GenerateDiffTest-WhiteSpaceAtEnd.inc
++++ PHP_CodeSniffer
+@@ -4,4 +4,4 @@
+ 
+ if ($var) {
+ 	echo 'This line is tab indented';
+-}     
++}
diff --git a/tests/Core/Fixer/Fixtures/GenerateDiffTest-WhiteSpaceAtEnd.inc b/tests/Core/Fixer/Fixtures/GenerateDiffTest-WhiteSpaceAtEnd.inc
@@ -0,0 +1,7 @@
+<?php
+// Comment with 2 spaces trailing whitespace.  
+$var = FALSE;
+
+if ($var) {
+	echo 'This line is tab indented';
+}     
diff --git a/tests/Core/Fixer/Fixtures/GenerateDiffTest-WhiteSpaceAtStart.diff b/tests/Core/Fixer/Fixtures/GenerateDiffTest-WhiteSpaceAtStart.diff
@@ -0,0 +1,8 @@
+--- tests/Core/Fixer/Fixtures/GenerateDiffTest-WhiteSpaceAtStart.inc
++++ PHP_CodeSniffer
+@@ -1,4 +1,4 @@
+- <?php
++<?php
+ // Comment with 2 spaces trailing whitespace.  
+ $var = FALSE;
+ 
diff --git a/tests/Core/Fixer/Fixtures/GenerateDiffTest-WhiteSpaceAtStart.inc b/tests/Core/Fixer/Fixtures/GenerateDiffTest-WhiteSpaceAtStart.inc
@@ -0,0 +1,7 @@
+ <?php
+// Comment with 2 spaces trailing whitespace.  
+$var = FALSE;
+
+if ($var) {
+	echo 'This line is tab indented';
+}
diff --git a/tests/Core/Fixer/Fixtures/GenerateDiffTest-WindowsLineEndings.inc b/tests/Core/Fixer/Fixtures/GenerateDiffTest-WindowsLineEndings.inc
@@ -0,0 +1,7 @@
+<?php
+// Comment with 2 spaces trailing whitespace.  
+$var = FALSE;
+
+if ($var) {
+	echo 'This line is tab indented';
+}
diff --git a/tests/Core/Fixer/Fixtures/GenerateDiffTest.inc b/tests/Core/Fixer/Fixtures/GenerateDiffTest.inc
@@ -0,0 +1,7 @@
+<?php
+// Comment with 2 spaces trailing whitespace.  
+$var = FALSE;
+
+if ($var) {
+	echo 'This line is tab indented';
+}
diff --git a/tests/Core/Fixer/GenerateDiffTest.php b/tests/Core/Fixer/GenerateDiffTest.php
