From db78ca92b213ff27a2f63d042136f2992c4ceb32 Mon Sep 17 00:00:00 2001
From: Junichi Yamamoto <junichi11@apache.org>
Date: Sat, 8 Jun 2024 07:34:22 +0900
Subject: [PATCH] Fix the formatter for no curly "if" statement with a line
 comment [GH-7185]

- https://github.com/apache/netbeans/issues/7185
- Don't add the `WHITESPACE_BETWEEN_LINE_COMMENTS` token
- Add unit tests

Example:
```php
if (true)
    $example = 1; // comment1

// comment2
```

Before:
```php
if (true)
    $example = 1; // comment1

new line is added here
// comment2
```

After:
```php
if (true)
    $example = 1; // comment1

// comment2
```
---
 .../php/editor/indent/FormatVisitor.java      | 11 ++++++-
 .../testfiles/formatting/issueGH7185_01.php   | 24 ++++++++++++++
 .../formatting/issueGH7185_01.php.formatted   | 25 +++++++++++++++
 .../testfiles/formatting/issueGH7185_02.php   | 27 ++++++++++++++++
 .../formatting/issueGH7185_02.php.formatted   | 27 ++++++++++++++++
 .../testfiles/formatting/issueGH7185_03.php   | 29 +++++++++++++++++
 .../formatting/issueGH7185_03.php.formatted   | 30 +++++++++++++++++
 .../testfiles/formatting/issueGH7185_04.php   | 31 ++++++++++++++++++
 .../formatting/issueGH7185_04.php.formatted   | 31 ++++++++++++++++++
 .../testfiles/formatting/issueGH7185_05.php   | 32 +++++++++++++++++++
 .../formatting/issueGH7185_05.php.formatted   | 31 ++++++++++++++++++
 .../php/editor/indent/PHPFormatterTest.java   | 25 +++++++++++++++
 12 files changed, 322 insertions(+), 1 deletion(-)
 create mode 100644 php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_01.php
 create mode 100644 php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_01.php.formatted
 create mode 100644 php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_02.php
 create mode 100644 php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_02.php.formatted
 create mode 100644 php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_03.php
 create mode 100644 php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_03.php.formatted
 create mode 100644 php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_04.php
 create mode 100644 php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_04.php.formatted
 create mode 100644 php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_05.php
 create mode 100644 php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_05.php.formatted

diff --git a/php/php.editor/src/org/netbeans/modules/php/editor/indent/FormatVisitor.java b/php/php.editor/src/org/netbeans/modules/php/editor/indent/FormatVisitor.java
index 509b8030d356..2e5c0c83ada0 100644
--- a/php/php.editor/src/org/netbeans/modules/php/editor/indent/FormatVisitor.java
+++ b/php/php.editor/src/org/netbeans/modules/php/editor/indent/FormatVisitor.java
@@ -2659,7 +2659,16 @@ private void addFormatToken(List<FormatToken> tokens) {
                             }
                             tokens.add(new FormatToken(FormatToken.Kind.WHITESPACE_INDENT, newOffset, "\n" + ts.token().text().toString()));
                             if (ts.moveNext() && ts.token().id() == PHPTokenId.PHP_LINE_COMMENT) {
-                                tokens.add(new FormatToken(FormatToken.Kind.WHITESPACE_BETWEEN_LINE_COMMENTS, ts.offset()));
+                                ASTNode parent = path.get(0);
+                                if (!(parent instanceof IfStatement) || isCurly) {
+                                    // GH-7185 don't add this to an "if" statement without curly braces
+                                    // e.g.
+                                    // if (true)
+                                    //     $example = 1; // comment1
+                                    //
+                                    // // comment2
+                                    tokens.add(new FormatToken(FormatToken.Kind.WHITESPACE_BETWEEN_LINE_COMMENTS, ts.offset()));
+                                }
                             }
                             // #268710 for adding/checking the PHP_LINE_COMMENT token later
                             ts.movePrevious();
diff --git a/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_01.php b/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_01.php
new file mode 100644
index 000000000000..280a5c023cbb
--- /dev/null
+++ b/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_01.php
@@ -0,0 +1,24 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+if (1)
+    $test = 0;  // test
+
+// test
diff --git a/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_01.php.formatted b/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_01.php.formatted
new file mode 100644
index 000000000000..ed3a85dc7bc5
--- /dev/null
+++ b/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_01.php.formatted
@@ -0,0 +1,25 @@
+<?php
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+if (1)
+    $test = 0;  // test
+
+// test
diff --git a/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_02.php b/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_02.php
new file mode 100644
index 000000000000..8a4b6a126d05
--- /dev/null
+++ b/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_02.php
@@ -0,0 +1,27 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+if (1)
+    $test = 0;  // test
+
+// test
+
+// test
+$test;
diff --git a/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_02.php.formatted b/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_02.php.formatted
new file mode 100644
index 000000000000..05fdf9adb45e
--- /dev/null
+++ b/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_02.php.formatted
@@ -0,0 +1,27 @@
+<?php
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+if (1)
+    $test = 0;  // test
+
+// test
+// test
+$test;
diff --git a/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_03.php b/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_03.php
new file mode 100644
index 000000000000..e644b05a7989
--- /dev/null
+++ b/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_03.php
@@ -0,0 +1,29 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+if (1)
+    $test = 0;  // test
+
+// test
+
+
+function test(): void {
+    return;
+}
diff --git a/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_03.php.formatted b/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_03.php.formatted
new file mode 100644
index 000000000000..c15d5b49f048
--- /dev/null
+++ b/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_03.php.formatted
@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+if (1)
+    $test = 0;  // test
+
+// test
+
+
+function test(): void {
+    return;
+}
diff --git a/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_04.php b/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_04.php
new file mode 100644
index 000000000000..31218d4edbf9
--- /dev/null
+++ b/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_04.php
@@ -0,0 +1,31 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+if (1)
+    $test = 0;  // test
+else
+    $else = 0; // test
+
+// test
+
+// test
+function test(): void {
+    return;
+}
diff --git a/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_04.php.formatted b/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_04.php.formatted
new file mode 100644
index 000000000000..49ba5c3c2494
--- /dev/null
+++ b/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_04.php.formatted
@@ -0,0 +1,31 @@
+<?php
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+if (1)
+    $test = 0;  // test
+else
+    $else = 0; // test
+
+// test
+// test
+function test(): void {
+    return;
+}
diff --git a/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_05.php b/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_05.php
new file mode 100644
index 000000000000..d6a2c9cca3d2
--- /dev/null
+++ b/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_05.php
@@ -0,0 +1,32 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+if (1) {
+    $test = 0;  // test
+    // test
+    // test
+} else {
+    $test = 0;  // test
+
+    // test
+    // test
+
+    // test
+}
diff --git a/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_05.php.formatted b/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_05.php.formatted
new file mode 100644
index 000000000000..4012174edf6c
--- /dev/null
+++ b/php/php.editor/test/unit/data/testfiles/formatting/issueGH7185_05.php.formatted
@@ -0,0 +1,31 @@
+<?php
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+if (1) {
+    $test = 0;  // test
+    // test
+    // test
+} else {
+    $test = 0;  // test
+    // test
+    // test
+    // test
+}
diff --git a/php/php.editor/test/unit/src/org/netbeans/modules/php/editor/indent/PHPFormatterTest.java b/php/php.editor/test/unit/src/org/netbeans/modules/php/editor/indent/PHPFormatterTest.java
index ddfbd74b2e1a..08b507c12d94 100644
--- a/php/php.editor/test/unit/src/org/netbeans/modules/php/editor/indent/PHPFormatterTest.java
+++ b/php/php.editor/test/unit/src/org/netbeans/modules/php/editor/indent/PHPFormatterTest.java
@@ -1139,4 +1139,29 @@ public void testTypedClassConstants_02() throws Exception {
         reformatFileContents("testfiles/formatting/php83/typedClassConstants_02.php", options, false, true);
     }
 
+    public void testGH7185_01() throws Exception {
+        HashMap<String, Object> options = new HashMap<>(FmtOptions.getDefaults());
+        reformatFileContents("testfiles/formatting/issueGH7185_01.php", options, false, false);
+    }
+
+    public void testGH7185_02() throws Exception {
+        HashMap<String, Object> options = new HashMap<>(FmtOptions.getDefaults());
+        reformatFileContents("testfiles/formatting/issueGH7185_02.php", options, false, false);
+    }
+
+    public void testGH7185_03() throws Exception {
+        HashMap<String, Object> options = new HashMap<>(FmtOptions.getDefaults());
+        reformatFileContents("testfiles/formatting/issueGH7185_03.php", options, false, false);
+    }
+
+    public void testGH7185_04() throws Exception {
+        HashMap<String, Object> options = new HashMap<>(FmtOptions.getDefaults());
+        reformatFileContents("testfiles/formatting/issueGH7185_04.php", options, false, false);
+    }
+
+    public void testGH7185_05() throws Exception {
+        HashMap<String, Object> options = new HashMap<>(FmtOptions.getDefaults());
+        reformatFileContents("testfiles/formatting/issueGH7185_05.php", options, false, false);
+    }
+
 }