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.

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 feature removeEnumValuePrefix from openapi codegen, fix #363 #371

Merged
merged 1 commit into from
Feb 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
34 changes: 34 additions & 0 deletions gen/main/java/issue/_363/_false/EnumWithPrefix.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
package issue._363._false;

@jakarta.annotation.Generated("org.openapitools.codegen.languages.MicronautCodegen")
public enum EnumWithPrefix {

AAA_FOO("aaa_foo"),
AAA_BAR("aaa_bar");

public static final java.lang.String AAA_FOO_VALUE = "aaa_foo";
public static final java.lang.String AAA_BAR_VALUE = "aaa_bar";

private final java.lang.String value;

private EnumWithPrefix(java.lang.String value) {
this.value = value;
}

@com.fasterxml.jackson.annotation.JsonCreator
public static EnumWithPrefix toEnum(java.lang.String value) {
return toOptional(value).orElseThrow(() -> new IllegalArgumentException("Unknown value '" + value + "'."));
}

public static java.util.Optional<EnumWithPrefix> toOptional(java.lang.String value) {
return java.util.Arrays
.stream(values())
.filter(e -> e.value.equals(value))
.findAny();
}

@com.fasterxml.jackson.annotation.JsonValue
public java.lang.String getValue() {
return value;
}
}
34 changes: 34 additions & 0 deletions gen/main/java/issue/_363/_false/EnumWithoutPrefix.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
package issue._363._false;

@jakarta.annotation.Generated("org.openapitools.codegen.languages.MicronautCodegen")
public enum EnumWithoutPrefix {

FOO("foo"),
BAR("bar");

public static final java.lang.String FOO_VALUE = "foo";
public static final java.lang.String BAR_VALUE = "bar";

private final java.lang.String value;

private EnumWithoutPrefix(java.lang.String value) {
this.value = value;
}

@com.fasterxml.jackson.annotation.JsonCreator
public static EnumWithoutPrefix toEnum(java.lang.String value) {
return toOptional(value).orElseThrow(() -> new IllegalArgumentException("Unknown value '" + value + "'."));
}

public static java.util.Optional<EnumWithoutPrefix> toOptional(java.lang.String value) {
return java.util.Arrays
.stream(values())
.filter(e -> e.value.equals(value))
.findAny();
}

@com.fasterxml.jackson.annotation.JsonValue
public java.lang.String getValue() {
return value;
}
}
34 changes: 34 additions & 0 deletions gen/main/java/issue/_363/_true/EnumWithPrefix.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
package issue._363._true;

@jakarta.annotation.Generated("org.openapitools.codegen.languages.MicronautCodegen")
public enum EnumWithPrefix {

FOO("aaa_foo"),
BAR("aaa_bar");

public static final java.lang.String FOO_VALUE = "aaa_foo";
public static final java.lang.String BAR_VALUE = "aaa_bar";

private final java.lang.String value;

private EnumWithPrefix(java.lang.String value) {
this.value = value;
}

@com.fasterxml.jackson.annotation.JsonCreator
public static EnumWithPrefix toEnum(java.lang.String value) {
return toOptional(value).orElseThrow(() -> new IllegalArgumentException("Unknown value '" + value + "'."));
}

public static java.util.Optional<EnumWithPrefix> toOptional(java.lang.String value) {
return java.util.Arrays
.stream(values())
.filter(e -> e.value.equals(value))
.findAny();
}

@com.fasterxml.jackson.annotation.JsonValue
public java.lang.String getValue() {
return value;
}
}
34 changes: 34 additions & 0 deletions gen/main/java/issue/_363/_true/EnumWithoutPrefix.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
package issue._363._true;

@jakarta.annotation.Generated("org.openapitools.codegen.languages.MicronautCodegen")
public enum EnumWithoutPrefix {

FOO("foo"),
BAR("bar");

public static final java.lang.String FOO_VALUE = "foo";
public static final java.lang.String BAR_VALUE = "bar";

private final java.lang.String value;

private EnumWithoutPrefix(java.lang.String value) {
this.value = value;
}

@com.fasterxml.jackson.annotation.JsonCreator
public static EnumWithoutPrefix toEnum(java.lang.String value) {
return toOptional(value).orElseThrow(() -> new IllegalArgumentException("Unknown value '" + value + "'."));
}

public static java.util.Optional<EnumWithoutPrefix> toOptional(java.lang.String value) {
return java.util.Arrays
.stream(values())
.filter(e -> e.value.equals(value))
.findAny();
}

@com.fasterxml.jackson.annotation.JsonValue
public java.lang.String getValue() {
return value;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

import static org.openapitools.codegen.CodegenConstants.GENERATE_API_TESTS;
import static org.openapitools.codegen.CodegenConstants.MODEL_NAME_SUFFIX;
import static org.openapitools.codegen.CodegenConstants.REMOVE_ENUM_VALUE_PREFIX;
import static org.openapitools.codegen.CodegenConstants.REMOVE_ENUM_VALUE_PREFIX_DESC;
import static org.openapitools.codegen.CodegenConstants.SOURCE_FOLDER;
import static org.openapitools.codegen.CodegenConstants.SOURCE_FOLDER_DESC;

Expand Down Expand Up @@ -103,6 +105,8 @@ public MicronautCodegen() {
cliOptions.add(CliOption.newString(CLIENT_ID, "ClientId to use."));
cliOptions.add(CliOption.newString(SOURCE_FOLDER, SOURCE_FOLDER_DESC));
cliOptions.add(CliOption.newString("testFolder", "test folder for generated code"));
cliOptions.add(
CliOption.newBoolean(REMOVE_ENUM_VALUE_PREFIX, REMOVE_ENUM_VALUE_PREFIX_DESC, removeEnumValuePrefix));

// there is no documentation template yet

Expand All @@ -127,6 +131,7 @@ public MicronautCodegen() {
additionalProperties.put(GENERATE_CONSTANTS, generateConstants);
additionalProperties.put(SEALED, sealed);
additionalProperties.put(RECORD, record);
additionalProperties.put(REMOVE_ENUM_VALUE_PREFIX, removeEnumValuePrefix);
additionalProperties.put("curly", "{");

// add custom type mappings
Expand Down Expand Up @@ -248,6 +253,9 @@ record = convertPropertyToBooleanAndWriteBack(RECORD);
if (additionalProperties.containsKey(GENERATE_CONSTANTS)) {
generateConstants = convertPropertyToBooleanAndWriteBack(GENERATE_CONSTANTS);
}
if (additionalProperties.containsKey(REMOVE_ENUM_VALUE_PREFIX)) {
removeEnumValuePrefix = convertPropertyToBooleanAndWriteBack(REMOVE_ENUM_VALUE_PREFIX);
}

// we do not generate projects, only api, set source and test folder

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,20 @@ void modelWithArrayItemsWithValidation() {
generate(configurator.addAdditionalProperty("clientId", "test"));
}

@DisplayName("enum with removeEnumValuePrefix=true")
@Test
void enumWithRemoveEnumValuePrefixTrue() {
generate(configurator("src/test/resources/openapi/issue-363.yaml", "issue._363._true")
.addAdditionalProperty(CodegenConstants.REMOVE_ENUM_VALUE_PREFIX, "true"));
}

@DisplayName("enum with removeEnumValuePrefix=false")
@Test
void enumWithRemoveEnumValuePrefixFalse() {
generate(configurator("src/test/resources/openapi/issue-363.yaml", "issue._363._false")
.addAdditionalProperty(CodegenConstants.REMOVE_ENUM_VALUE_PREFIX, "false"));
}

static void generate(CodegenConfigurator configurator) {
var gen = new DefaultGenerator();
gen.setGenerateMetadata(false);
Expand Down
17 changes: 17 additions & 0 deletions src/test/resources/openapi/issue-363.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
openapi: 3.0.3
info:
title: Spec for <https://github.com/kokuwaio/micronaut-openapi-codegen/issues/363>
version: "1"
paths: {}
components:
schemas:
EnumWithoutPrefix:
type: string
enum:
- foo
- bar
EnumWithPrefix:
type: string
enum:
- aaa_foo
- aaa_bar