fix: include the parenthesis only when a scope is supplied

Commit example: "style: fix eslint error"

Closes #4

Author: darrachequesne

src/com/leroymerlin/commit/CommitDialog.java

@@ -6,8 +6,6 @@
 
 import javax.swing.*;
 
-import static org.apache.commons.lang.StringUtils.isBlank;
-
 /**
  * @author Damien Arrachequesne
  */
@@ -29,56 +27,8 @@ protected JComponent createCenterPanel() {
         return panel.getMainPanel();
     }
 
-    String getCommitMessage() {
-        return String.format("%s(%s): %s%n%n%s%s%s",
-                panel.getChangeType(),
-                panel.getChangeScope(),
-                panel.getShortDescription(),
-                getLongDescription(),
-                getBreakingChanges(),
-                getClosedIssues());
-    }
-
-    private String getLongDescription() {
-        return breakLines(panel.getLongDescription(), 100);
-    }
-
-    private String getBreakingChanges() {
-        if (isBlank(panel.getBreakingChanges())) {
-            return "";
-        }
-        return String.format("%n%n%s", "BREAKING CHANGE: " + panel.getBreakingChanges());
+    CommitMessage getCommitMessage() {
+        return panel.getCommitMessage();
     }
 
-    private String getClosedIssues() {
-        if (isBlank(panel.getClosedIssues())) {
-            return "";
-        }
-        return String.format("%n%n%s", "Closes " + panel.getClosedIssues());
-    }
-
-    private static String breakLines(String input, int maxLineLength) {
-        String[] tokens = input.split("\\s+");
-        StringBuilder output = new StringBuilder(input.length());
-        int lineLength = 0;
-        for (int i = 0; i < tokens.length; i++) {
-            String word = tokens[i];
-
-            boolean shouldAddNewLine = lineLength + (" " + word).length() > maxLineLength;
-            if (shouldAddNewLine) {
-                if (i > 0) {
-                    output.append(System.lineSeparator());
-                }
-                lineLength = 0;
-            }
-            boolean shouldAddSpace = i < tokens.length - 1 &&
-                    (lineLength + (word + " ").length() + tokens[i + 1].length() <= maxLineLength);
-            if (shouldAddSpace) {
-                word += " ";
-            }
-            output.append(word);
-            lineLength += word.length();
-        }
-        return output.toString();
-    }
 }

src/com/leroymerlin/commit/CommitMessage.java

@@ -0,0 +1,81 @@
+package com.leroymerlin.commit;
+
+import static org.apache.commons.lang.StringUtils.isNotBlank;
+
+/**
+ * @author Damien Arrachequesne <damien.arrachequesne@gmail.com>
+ */
+class CommitMessage {
+    private final String content;
+
+    CommitMessage(ChangeType changeType, String changeScope, String shortDescription, String longDescription, String closedIssues, String breakingChanges) {
+        this.content = buildContent(changeType, changeScope, shortDescription, longDescription, closedIssues, breakingChanges);
+    }
+
+    private String buildContent(ChangeType changeType, String changeScope, String shortDescription, String longDescription, String closedIssues, String breakingChanges) {
+        StringBuilder builder = new StringBuilder();
+        builder.append(changeType.label());
+        if (isNotBlank(changeScope)) {
+            builder
+                    .append('(')
+                    .append(changeScope)
+                    .append(')');
+        }
+        builder
+                .append(": ")
+                .append(shortDescription)
+                .append(System.lineSeparator())
+                .append(System.lineSeparator())
+                .append(breakLines(longDescription, 100));
+
+        if (isNotBlank(breakingChanges)) {
+            builder
+                    .append(System.lineSeparator())
+                    .append(System.lineSeparator())
+                    .append("BREAKING CHANGE: ")
+                    .append(breakingChanges);
+        }
+
+        if (isNotBlank(closedIssues)) {
+            builder.append(System.lineSeparator());
+            for (String closedIssue : closedIssues.split(",")) {
+                builder
+                        .append(System.lineSeparator())
+                        .append("Closes ")
+                        .append(closedIssue);
+            }
+        }
+
+        return builder.toString();
+    }
+
+    private static String breakLines(String input, int maxLineLength) {
+        String[] tokens = input.split("\\s+");
+        StringBuilder output = new StringBuilder(input.length());
+        int lineLength = 0;
+        for (int i = 0; i < tokens.length; i++) {
+            String word = tokens[i];
+
+            boolean shouldAddNewLine = lineLength + (" " + word).length() > maxLineLength;
+            if (shouldAddNewLine) {
+                if (i > 0) {
+                    output.append(System.lineSeparator());
+                }
+                lineLength = 0;
+            }
+            boolean shouldAddSpace = i < tokens.length - 1 &&
+                    (lineLength + (word + " ").length() + tokens[i + 1].length() <= maxLineLength);
+            if (shouldAddSpace) {
+                word += " ";
+            }
+            output.append(word);
+            lineLength += word.length();
+        }
+        return output.toString();
+    }
+
+    @Override
+    public String toString() {
+        return content;
+    }
+}

src/com/leroymerlin/commit/CommitPanel.java

@@ -26,28 +26,15 @@ JPanel getMainPanel() {
         return mainPanel;
     }
 
-    String getChangeType() {
-        ChangeType type = (ChangeType) changeType.getSelectedItem();
-        return type.label();
+    CommitMessage getCommitMessage() {
+        return new CommitMessage(
+                (ChangeType) changeType.getSelectedItem(),
+                changeScope.getText().trim(),
+                shortDescription.getText().trim(),
+                longDescription.getText().trim(),
+                breakingChanges.getText().trim(),
+                closedIssues.getText().trim()
+        );
     }
 
-    String getChangeScope() {
-        return changeScope.getText().trim();
-    }
-
-    String getShortDescription() {
-        return shortDescription.getText().trim();
-    }
-
-    String getLongDescription() {
-        return longDescription.getText().trim();
-    }
-
-    String getBreakingChanges() {
-        return breakingChanges.getText().trim();
-    }
-
-    String getClosedIssues() {
-        return closedIssues.getText().trim();
-    }
 }

src/com/leroymerlin/commit/CreateCommitAction.java

@@ -23,7 +23,7 @@ public void actionPerformed(AnActionEvent actionEvent) {
         CommitDialog dialog = new CommitDialog(actionEvent.getProject());
         dialog.show();
         if (dialog.getExitCode() == DialogWrapper.OK_EXIT_CODE) {
-            commitPanel.setCommitMessage(dialog.getCommitMessage());
+            commitPanel.setCommitMessage(dialog.getCommitMessage().toString());
         }
     }
 

tests/com/leroymerlin/commit/CommitMessageTest.java

@@ -0,0 +1,46 @@
+package com.leroymerlin.commit;
+
+import org.junit.Test;
+
+import static org.junit.Assert.assertEquals;
+
+public class CommitMessageTest {
+
+    @Test
+    public void testFormatCommit() {
+        CommitMessage commitMessage = new CommitMessage(ChangeType.FIX, "ngStyle",
+                "skip setting empty value when new style has the property",
+                "Previously, all the properties in oldStyles are set to empty value once. Using AngularJS with jQuery 3.3.1, this disables the CSS transition as reported in jquery/jquery#4185.",
+                "#16709", "");
+        String expected = "fix(ngStyle): skip setting empty value when new style has the property\n" +
+                "\n" +
+                "Previously, all the properties in oldStyles are set to empty value once. Using AngularJS with \n" +
+                "jQuery 3.3.1, this disables the CSS transition as reported in jquery/jquery#4185.\n" +
+                "\n" +
+                "Closes #16709";
+        assertEquals(commitMessage.toString(), expected);
+    }
+
+    @Test
+    public void testFormatCommit_withoutScope() {
+        CommitMessage commitMessage = new CommitMessage(ChangeType.STYLE, "",
+                "fix eslint error", "", "", "");
+        String expected = "style: fix eslint error\n\n";
+        assertEquals(commitMessage.toString(), expected);
+    }
+
+    @Test
+    public void testFormatCommit_withMultipleClosedIssues() {
+        CommitMessage commitMessage = new CommitMessage(ChangeType.FEAT, "$route",
+                "add support for the `reloadOnUrl` configuration option",
+                "Enables users to specify that a particular route should not be reloaded after a URL change.",
+                "#7925,#15002", "");
+        String expected = "feat($route): add support for the `reloadOnUrl` configuration option\n" +
+                "\n" +
+                "Enables users to specify that a particular route should not be reloaded after a URL change.\n" +
+                "\n" +
+                "Closes #7925\n" +
+                "Closes #15002";
+        assertEquals(commitMessage.toString(), expected);
+    }
+}