Skip to content

Update StaticHtmlGenerator to allow snake_case property names #2612

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
wing328 merged 7 commits into from
Apr 12, 2019
Merged

Update StaticHtmlGenerator to allow snake_case property names #2612

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7aef0b3
Updated StaticHtmlGenerator to it overrides the toVarName(String name…
Apr 4, 2019
4b5feb0
adding model propery with a snake_case name
Apr 5, 2019
5ee3be6
Reverting change to base petstore.yaml file
Apr 9, 2019
f0f5e42
Trying to trigger another CI build
Apr 9, 2019
953d946
Trying to trigger another CI build
farrez Apr 9, 2019
f807601
Merge branch 'master' of https://github.com/farrez/openapi-generator
Apr 12, 2019
a5f463e
Removing trailing space
Apr 12, 2019
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
15 changes: 15 additions & 0 deletions ...enapi-generator/src/main/java/org/openapitools/codegen/languages/StaticHtmlGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@

import java.util.*;

import static org.openapitools.codegen.utils.StringUtils.escape;

public class StaticHtmlGenerator extends DefaultCodegen implements CodegenConfig {
protected String invokerPackage = "org.openapitools.client";
protected String groupId = "org.openapitools";
Expand Down Expand Up @@ -176,6 +178,19 @@ public String toModelName(final String name) {
return name;
}

// DefaultCodegen converts snake_case property names to snakeUnderscorecase
// but for static HTML, we want to preserve snake_case names
@Override
public String toVarName(String name) {
if (reservedWords.contains(name)) {
return escapeReservedWord(name);
} else if (((CharSequence) name).chars().anyMatch(character -> specialCharReplacements.keySet().contains("" + ((char) character)))) {
return escape(name, specialCharReplacements, Arrays.asList("_"), null);
} else {
return name;
}
}

public void preprocessOpenAPI(OpenAPI openAPI) {
Info info = openAPI.getInfo();
info.setDescription(toHtml(info.getDescription()));
Expand Down
16 changes: 16 additions & 0 deletions ...penapi-generator/src/test/java/org/openapitools/codegen/html/StaticHtmlGeneratorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
import io.swagger.v3.oas.models.media.Schema;
import io.swagger.v3.oas.models.media.StringSchema;
import org.openapitools.codegen.CodegenModel;
import org.openapitools.codegen.CodegenProperty;
import org.openapitools.codegen.DefaultCodegen;
import org.openapitools.codegen.TestUtils;
import org.openapitools.codegen.languages.StaticHtmlGenerator;
import org.testng.Assert;
Expand Down Expand Up @@ -54,4 +56,18 @@ public void testSpecWithoutSchema() throws Exception {
Assert.assertEquals(openAPI.getInfo().getTitle(), "ping test");
}

@Test(description = "ensure that snake_case propery names wont be converted to snakeUnderscorecase")
public void testFromPropertyWithUnderscores() {
final Schema schema = new Schema()
.description("a sample model with property containing an underscore")
.addProperties("favorite_food", new StringSchema());
final OpenAPI openAPI = TestUtils.createOpenAPIWithOneSchema("UnderscoreTest", schema);
final DefaultCodegen codegen = new StaticHtmlGenerator();
codegen.setOpenAPI(openAPI);

CodegenProperty property = codegen.fromProperty("favorite_food", (Schema) openAPI.getComponents().getSchemas().get("UnderscoreTest").getProperties().get("favorite_food"));

Assert.assertEquals(property.baseName, "favorite_food");
Assert.assertEquals(property.name, "favorite_food");
}
Copy link
Member

@wing328 wing328 Apr 11, 2019

Choose a reason for hiding this comment

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

@farrez Thanks for adding the test case. Can the issue be also resolved by using baseName instead of name in the mustache templates as baseName should store the original property name defined in the spec.

Copy link
Contributor Author

@farrez farrez Apr 12, 2019

Choose a reason for hiding this comment

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

Yes that would also have worked.

Copy link
Member

@wing328 wing328 Apr 12, 2019

Choose a reason for hiding this comment

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

👌 I'll make the change with another PR.

}