Skip to content

ROASTER-54: Formatter isn't apply on Javadoc #43

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

Merged
gastaldi merged 1 commit into from
Sep 16, 2015
Merged

ROASTER-54: Formatter isn't apply on Javadoc #43

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
2 changes: 1 addition & 1 deletion impl/src/main/java/org/jboss/forge/roaster/model/util/Formatter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ public static String format(Properties prefs, String source)
IDocument doc = new Document(source);
try
{
TextEdit edit = codeFormatter.format(CodeFormatter.K_COMPILATION_UNIT,
TextEdit edit = codeFormatter.format(CodeFormatter.K_COMPILATION_UNIT | CodeFormatter.F_INCLUDE_COMMENTS,
source, 0, source.length(), 0, null);
if (edit != null)
{
Expand Down
2 changes: 2 additions & 0 deletions impl/src/test/java/org/jboss/forge/test/roaster/model/JavaDocTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ public void testJavaDocCreation() throws Exception
{
String expected = "/**" + LINE_SEPARATOR
+ " * Do Something" + LINE_SEPARATOR
+ " * " + LINE_SEPARATOR
+ " * @author George Gastaldi" + LINE_SEPARATOR + " */" + LINE_SEPARATOR
+ "public class MyClass {" + LINE_SEPARATOR + "}";
JavaClassSource javaClass = Roaster.create(JavaClassSource.class).setPublic().setName("MyClass");
Expand All @@ -89,6 +90,7 @@ public void testJavaDocSetFullText() throws Exception
{
String expected = "/**" + LINE_SEPARATOR
+ " * Do Something" + LINE_SEPARATOR
+ " * " + LINE_SEPARATOR
+ " * @author George Gastaldi" + LINE_SEPARATOR + " */" + LINE_SEPARATOR
+ "public class MyClass {" + LINE_SEPARATOR + "}";
JavaClassSource javaClass = Roaster.create(JavaClassSource.class).setPublic().setName("MyClass");
Expand Down
44 changes: 44 additions & 0 deletions impl/src/test/java/org/jboss/forge/test/roaster/model/util/FormatterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,14 @@

package org.jboss.forge.test.roaster.model.util;

import static org.junit.Assert.assertEquals;

import java.io.InputStream;
import java.util.Properties;

import org.jboss.forge.roaster.Roaster;
import org.jboss.forge.roaster.model.source.JavaClassSource;
import org.jboss.forge.roaster.model.source.JavaDocSource;
import org.jboss.forge.roaster.model.util.Formatter;
import org.jboss.forge.roaster.spi.Streams;
import org.jboss.forge.test.roaster.model.FieldAnnotationTest;
Expand All @@ -23,6 +27,8 @@
*/
public class FormatterTest
{
public static final String LINE_SEPARATOR = System.getProperty("line.separator");

private static JavaClassSource javaClass;

private static String content;
Expand Down Expand Up @@ -57,4 +63,42 @@ public void testToUnformattedStringAsOriginalContent()
{
Assert.assertEquals(content, javaClass.toUnformattedString());
}

@Test
public void testFormatWithJavaDocOptions() throws Exception
{
// ROASTER-54
JavaClassSource source = Roaster.parse(JavaClassSource.class, "public class SomeClass {}");
JavaDocSource<JavaClassSource> javaDoc = source.getJavaDoc();
javaDoc.setText("Class documentation text");
javaDoc.addTagValue("@author", "George Gastaldi");

String result1 = Formatter.format(source);

StringBuilder sb1 = new StringBuilder();
sb1.append("/**" + LINE_SEPARATOR);
sb1.append(" * Class documentation text" + LINE_SEPARATOR);
sb1.append(" * " + LINE_SEPARATOR);
sb1.append(" * @author George Gastaldi" + LINE_SEPARATOR);
sb1.append(" */" + LINE_SEPARATOR);
sb1.append("public class SomeClass {" + LINE_SEPARATOR);
sb1.append("}");
assertEquals(sb1.toString(), result1);

Properties prefs = new Properties();
prefs.put("org.eclipse.jdt.core.formatter.comment.line_length", "25");
prefs.put("org.eclipse.jdt.core.formatter.comment.new_lines_at_javadoc_boundaries", "false");

String result2 = Formatter.format(prefs, source);

StringBuilder sb2 = new StringBuilder();
sb2.append("/** Class documentation" + LINE_SEPARATOR);
sb2.append(" * text" + LINE_SEPARATOR);
sb2.append(" * " + LINE_SEPARATOR);
sb2.append(" * @author George" + LINE_SEPARATOR);
sb2.append(" * Gastaldi */" + LINE_SEPARATOR);
sb2.append("public class SomeClass {" + LINE_SEPARATOR);
sb2.append("}");
assertEquals(sb2.toString(), result2);
}
}