Skip to content
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

Add javadoc example and unit test for composing set via CodeWriter.on… #619

Merged
merged 3 commits into from
Oct 31, 2020
Merged

Add javadoc example and unit test for composing set via CodeWriter.on… #619

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b50870d
Add javadoc example and unit test for composing set via CodeWriter.on…
kggilmer Oct 30, 2020
ec68e0c
Fix sample code
kggilmer Oct 30, 2020
949df07
Move test to smithy-utils and add trailing \n
mtdowling Oct 31, 2020
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
14 changes: 14 additions & 0 deletions ...egen-core/src/test/java/software/amazon/smithy/codegen/core/writer/CodegenWriterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,4 +113,18 @@ public void importsUseReferencesFromSymbols() {
assertThat(writer.getImportContainer().imports, hasKey("MyString"));
assertThat(writer.getImportContainer().imports.get("MyString"), equalTo("java.lang.String"));
}

@Test
public void canComposeSetWithSection() {
String testSection = "testSection";
MyWriter writer = new MyWriter("foo");

writer.onSection(testSection, text -> writer.write(text + "1, "));
writer.onSection(testSection, text -> writer.write(text + "2, "));
writer.onSection(testSection, text -> writer.write(text + "3"));

writer.write("[${L@testSection}]", "");

assertThat(writer.toString(), equalTo("[1, 2, 3]"));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, looks like this needs either a trailing newline, or you need to disable newlines in the writer

Copy link
Member

@mtdowling mtdowling Oct 31, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've pushed up a fix. I also moved this test to smithy-utils.

}
}
12 changes: 12 additions & 0 deletions smithy-utils/src/main/java/software/amazon/smithy/utils/CodeWriter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,18 @@
* System.out.println(writer.toString());
* // Outputs: "Leading text...Intercepted: foo...Trailing text...\n"
* }</pre>
*
* Inline sections are useful for composing sets or lists from any code with access to {@code CodeWriter}:
*
* <pre>{@code
* CodeWriter writer = new CodeWriter();
* writer.onSection("example", text -> writer.write(text + "1, "));
* writer.onSection("example", text -> writer.write(text + "2, "));
* writer.onSection("example", text -> writer.write(text + "3"));
* writer.write("[${L@example}]", "");
* System.out.println(writer.toString());
* // Outputs: "[1, 2, 3]\n"
* }</pre>
*/
public class CodeWriter {
private static final Pattern LINES = Pattern.compile("\\r?\\n");
Expand Down