Skip to content

Fix markdown table formatting if snapshot comment contains new line chars #3694

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
georgweiss wants to merge 1 commit into
base: master
Choose a base branch
from
+30 −1
Open

Fix markdown table formatting if snapshot comment contains new line chars #3694

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion ...ava/org/phoebus/applications/saveandrestore/logging/SaveSnapshotActionAdapterFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,17 @@ protected void getCommonSnapshotInfo(SaveSnapshotActionInfo saveSnapshotActionIn
// This is needed!
stringBuilder.append("|-|-|\n");
stringBuilder.append("| Snapshot name | ").append(saveSnapshotActionInfo.getSnapshotName()).append(" |\n");
stringBuilder.append("| Comment | ").append(saveSnapshotActionInfo.getComment()).append(" |\n");
stringBuilder.append("| Comment | ").append(replaceNewLineChars(saveSnapshotActionInfo.getComment())).append(" |\n");
stringBuilder.append("| Created | ").append(saveSnapshotActionInfo.getSnapshotCreatedDate()).append(" |\n");
}

/**
* Replace line feed or carriage return + line feed with space char. Used for instance to correctly create a markdown table
* for a snapshot where the comment field contains line feed or carriage return + line feed.
* @param input Input string
* @return The mangled string.
*/
protected String replaceNewLineChars(String input) {
return input.replace("\n", " ").replace("\r", "");
}
}
19 changes: 19 additions & 0 deletions ...phoebus/applications/saveandrestore/logging/SaveSnapshotActionAdapterFactoryTestData.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@

import java.util.List;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;

public class SaveSnapshotActionAdapterFactoryTestData {
Expand Down Expand Up @@ -51,4 +52,22 @@ public void testAdaptSaveAction(){
assertTrue(logEntry.getTitle().contains("snapshot name"));
assertTrue(logEntry.getDescription().contains("snapshot name"));
}

@Test
public void testReplaceNewLineChars(){
String someString = "Foo Bar";
assertEquals("Foo Bar", saveSnapshotActionAdapterFactory.replaceNewLineChars(someString));

someString = "Foo\nBar";
assertEquals("Foo Bar", saveSnapshotActionAdapterFactory.replaceNewLineChars(someString));

someString = "Foo\r\nBar";
assertEquals("Foo Bar", saveSnapshotActionAdapterFactory.replaceNewLineChars(someString));

someString = "Foo\r\nBar\nBaz";
assertEquals("Foo Bar Baz", saveSnapshotActionAdapterFactory.replaceNewLineChars(someString));

someString = "Foo" + System.lineSeparator() + "Bar";
assertEquals("Foo Bar", saveSnapshotActionAdapterFactory.replaceNewLineChars(someString));
}
}