Skip to content

[Java] Fix numeric field names #3436

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
merged 3 commits into from
Jul 25, 2019
Merged

[Java] Fix numeric field names #3436

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1280221
Fix for OpenAPITools/openapi-generator#3293. Number fields in java ge…
Fjolnir-Dvorak Jul 24, 2019
8847046
Added a few tests for number to varName to persist and ensure this be…
Fjolnir-Dvorak Jul 24, 2019
01f52f1
I also added a few test for convertModelName to prevent similar break…
Fjolnir-Dvorak Jul 24, 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
5 changes: 5 additions & 0 deletions ...enapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -585,6 +585,11 @@ public String toVarName(String name) {
name = "_u";
}

// numbers are not allowed at the beginning
if (name.matches("^\\d.*")) {
Copy link
Member

Choose a reason for hiding this comment

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

I guess this is needed here, in addition to

openapi-generator/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java

Line 615 in 1280221

if (isReservedWord(name) || name.matches("^\\d.*")) {

if the name is all uppercase and thus matches this early return:

openapi-generator/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractJavaCodegen.java

Lines 594 to 596 in 1280221

if (name.matches("^[A-Z0-9_]*$")) {
return name;
}

name = "_" + name;
}

// if it's all uppper case, do nothing
if (name.matches("^[A-Z0-9_]*$")) {
return name;
Expand Down
29 changes: 23 additions & 6 deletions ...penapi-generator/src/test/java/org/openapitools/codegen/java/AbstractJavaCodegenTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,15 +89,31 @@ public void convertVarName() throws Exception {
Assert.assertEquals(fakeJavaCodegen.toVarName("USERname"), "usERname");
Assert.assertEquals(fakeJavaCodegen.toVarName("USERNAME"), "USERNAME");
Assert.assertEquals(fakeJavaCodegen.toVarName("USER123NAME"), "USER123NAME");
}
Assert.assertEquals(fakeJavaCodegen.toVarName("1"), "_1");
Assert.assertEquals(fakeJavaCodegen.toVarName("1a"), "_1a");
Assert.assertEquals(fakeJavaCodegen.toVarName("1A"), "_1A");
Assert.assertEquals(fakeJavaCodegen.toVarName("1AAAA"), "_1AAAA");
Assert.assertEquals(fakeJavaCodegen.toVarName("1AAaa"), "_1aAaa");
}

@Test
public void convertModelName() throws Exception {
@Test
public void convertModelName() throws Exception {
Assert.assertEquals(fakeJavaCodegen.toModelName("name"), "Name");
Assert.assertEquals(fakeJavaCodegen.toModelName("$name"), "Name");
Assert.assertEquals(fakeJavaCodegen.toModelName("nam#e"), "Name");
Assert.assertEquals(fakeJavaCodegen.toModelName("$another-fake?"), "AnotherFake");
}
Assert.assertEquals(fakeJavaCodegen.toModelName("1a"), "Model1a");
Assert.assertEquals(fakeJavaCodegen.toModelName("1A"), "Model1A");
Assert.assertEquals(fakeJavaCodegen.toModelName("AAAb"), "AAAb");
Assert.assertEquals(fakeJavaCodegen.toModelName("aBB"), "ABB");
Assert.assertEquals(fakeJavaCodegen.toModelName("AaBBa"), "AaBBa");
Assert.assertEquals(fakeJavaCodegen.toModelName("A_B"), "AB");
Assert.assertEquals(fakeJavaCodegen.toModelName("A-B"), "AB");
Assert.assertEquals(fakeJavaCodegen.toModelName("Aa_Bb"), "AaBb");
Assert.assertEquals(fakeJavaCodegen.toModelName("Aa-Bb"), "AaBb");
Assert.assertEquals(fakeJavaCodegen.toModelName("Aa_bb"), "AaBb");
Assert.assertEquals(fakeJavaCodegen.toModelName("Aa-bb"), "AaBb");
}

@Test
public void testInitialConfigValues() throws Exception {
Expand Down Expand Up @@ -163,7 +179,7 @@ public void testAdditionalPropertiesPutForConfigValues() throws Exception {
}

@Test
public void toEnumValue(){
public void toEnumValue() {
final AbstractJavaCodegen codegen = new P_AbstractJavaCodegen();
Assert.assertEquals(codegen.toEnumValue("1", "Integer"), "1");
Assert.assertEquals(codegen.toEnumValue("42", "Double"), "42");
Expand Down Expand Up @@ -213,7 +229,7 @@ public void apiDocFileFolder() {
codegen.setOutputDir("/User/open.api.tools");
Assert.assertEquals(codegen.apiDocFileFolder(), "/User/open.api.tools/docs/".replace('/', File.separatorChar));
}

@Test(description = "tests if API version specification is used if no version is provided in additional properties")
public void openApiversionTest() {
final P_AbstractJavaCodegen codegen = new P_AbstractJavaCodegen();
Expand Down Expand Up @@ -310,6 +326,7 @@ public String getHelp() {
/**
* Gets artifact version.
* Only for testing purposes.
*
* @return version
*/
public String getArtifactVersion() {
Expand Down