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 Nim client code generator #3879

Merged
merged 49 commits into from
Sep 13, 2019
Merged
Show file tree
Hide file tree
Changes from 45 commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
f266380
First version of Nim Client
hokamoto Sep 1, 2019
18d367a
Add some codes
hokamoto Sep 5, 2019
9639569
Add some codes
hokamoto Sep 5, 2019
a999b5e
Add some codes
hokamoto Sep 8, 2019
5d73b11
Add some codes
hokamoto Sep 8, 2019
3880039
Add some codes
hokamoto Sep 12, 2019
c48f0a0
First version of Nim Client
hokamoto Sep 1, 2019
c5e4713
Add some codes
hokamoto Sep 5, 2019
feb96b1
Add some codes
hokamoto Sep 5, 2019
5fdc0ab
Add some codes
hokamoto Sep 8, 2019
ae33303
Add some codes
hokamoto Sep 8, 2019
ba35508
Add some codes
hokamoto Sep 12, 2019
fc74ece
[Dart] Fix README template and update testing doco (#3809)
nickmeinhold Sep 3, 2019
7b4a201
Support custom git repository (#3757)
qmuntal Sep 3, 2019
2451702
Add links to article and video (#3820)
wing328 Sep 3, 2019
9ef73eb
Better Go code format (#3819)
wing328 Sep 4, 2019
c90c6c8
Add gRPC Protobuf schema generator (#3818)
wing328 Sep 4, 2019
bdfed92
1792 fix remote spec handling and hash calculation (#3440)
johngray Sep 4, 2019
7c5cfb7
fixed bug where nullApi.java would be generated. Instead, generated …
bensimpson-ch Sep 4, 2019
99eb680
Revert "1792 fix remote spec handling and hash calculation (#3440)"
wing328 Sep 4, 2019
ac1f19d
Add nickmeinhold to Dart technical committee (#3830)
wing328 Sep 4, 2019
9cbcebc
Bug #2845 typescript angular inheritance (#3812)
mnahkies Sep 5, 2019
9ba0dd0
fix warnings in csharp-netcore client (#3831)
wing328 Sep 5, 2019
5d21a8f
Add missing files to the form request (#3834)
etherealjoy Sep 5, 2019
8c637fb
[client][go] avoid duplicated reflect imports (#3847)
qmuntal Sep 6, 2019
f26f726
Following up for #3440 (1792 fix remote spec handling and hash calcul…
fujigon Sep 6, 2019
4a1eb91
Add a link (#3850)
ackintosh Sep 7, 2019
3228ca2
Add Element AI to the list (#3856)
wing328 Sep 7, 2019
2fb08fb
maven-plugin-plugin 3.6.0 (#3854)
sullis Sep 7, 2019
221443a
[Java][okhttp-gson] fix failure to deserialize floats (#3846)
bensimpson-ch Sep 7, 2019
adf1297
Adds Http Info To Dart Api (#3851)
austbot Sep 7, 2019
86adb0a
[C++][Pistache] Add missing setter for arrays (#3837)
muttleyxd Sep 7, 2019
82f00f2
typescript-inversify: improve check for required parameters, support …
bodograumann Sep 9, 2019
0f10987
[typescript-angular] allow empty string basePath (#3489)
martinnovak Sep 9, 2019
bf441c2
Fix/r/serialization fix and minor 3xx resp fix (#3817)
Ramanth Sep 10, 2019
e51ffbe
typescript-axios: Fix baseoptions (#3866)
7474 Sep 10, 2019
0396bb4
Rename gRPC generator to "protobuf-schema" (#3864)
wing328 Sep 10, 2019
3dd0ebd
Prepare v4.1.2 release (#3873)
wing328 Sep 11, 2019
58ec946
fix version in readme
macjohnny Sep 11, 2019
580ca11
BugFix #2053 Spring Boot fails to parse LocalDate query parameter (#3…
peyerroger Sep 11, 2019
fbb3b27
update doc, samples (#3875)
wing328 Sep 11, 2019
549fc8f
update stable release
wing328 Sep 11, 2019
bface47
Update the batch for Windows
hokamoto Sep 12, 2019
5a28be0
Merge branch 'nim-client' of github.com:hokamoto/openapi-generator in…
hokamoto Sep 12, 2019
19cc13b
Merge remote-tracking branch 'upstream/master' into nim-client
hokamoto Sep 12, 2019
2db44c7
Add a test snippet
hokamoto Sep 12, 2019
bcec49b
Update ensure-up-to-date
hokamoto Sep 12, 2019
7276034
Add Nim to README.md
hokamoto Sep 12, 2019
090875b
Ran ensure-up-to-date to pass CircleCI tests
hokamoto Sep 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
31 changes: 31 additions & 0 deletions bin/nim-client-petstore.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
#!/bin/sh
macjohnny marked this conversation as resolved.
Show resolved Hide resolved

SCRIPT="$0"

while [ -h "$SCRIPT" ] ; do
ls=$(ls -ld "$SCRIPT")
link=$(expr "$ls" : '.*-> \(.*\)$')
if expr "$link" : '/.*' > /dev/null; then
SCRIPT="$link"
else
SCRIPT=$(dirname "$SCRIPT")/"$link"
fi
done

if [ ! -d "${APP_DIR}" ]; then
APP_DIR=$(dirname "$SCRIPT")/..
APP_DIR=$(cd "${APP_DIR}"; pwd)
fi

executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"

if [ ! -f "$executable" ]
then
mvn clean package
fi

# if you've executed sbt assembly previously it will use that instead.
export JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"
ags="$@ generate -t modules/openapi-generator/src/main/resources/nim-client -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml --additional-properties packageName=petstore -g nim -o samples/client/petstore/nim"

java ${JAVA_OPTS} -jar ${executable} ${ags}
10 changes: 10 additions & 0 deletions bin/windows/nim-client-petstore.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
set executable=.\modules\openapi-generator-cli\target\openapi-generator-cli.jar

If Not Exist %executable% (
mvn clean package
)

REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M -DloggerPath=conf/log4j.properties
set ags=generate --artifact-id "nim-petstore-client" -i modules\openapi-generator\src\test\resources\2_0\petstore.yaml --additional-properties packageName=petstore -g nim -o samples\client\petstore\nim

java %JAVA_OPTS% -jar %executable% %ags%
Original file line number Diff line number Diff line change
@@ -0,0 +1,309 @@
package org.openapitools.codegen.languages;
Copy link
Member

Choose a reason for hiding this comment

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

I'll add the copyright header in another PR.


import io.swagger.v3.oas.models.media.ArraySchema;
import io.swagger.v3.oas.models.media.Schema;
import io.swagger.v3.oas.models.media.StringSchema;
import org.openapitools.codegen.*;
import org.openapitools.codegen.utils.ModelUtils;
import org.openapitools.codegen.utils.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.File;
import java.util.*;

import static org.openapitools.codegen.utils.StringUtils.camelize;
import static org.openapitools.codegen.utils.StringUtils.underscore;

public class NimClientCodegen extends DefaultCodegen implements CodegenConfig {
static Logger LOGGER = LoggerFactory.getLogger(NimClientCodegen.class);

public static final String PROJECT_NAME = "projectName";

protected String packageName = "openapiclient";
protected String packageVersion = "1.0.0";

public CodegenType getTag() {
return CodegenType.CLIENT;
}

public String getName() {
return "nim";
}

public String getHelp() {
return "Generates a nim client.";
Copy link
Member

Choose a reason for hiding this comment

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

I'll add the word "beta" as follows:

Generates a nim client (beta).

}

public NimClientCodegen() {
super();

outputFolder = "generated-code" + File.separator + "nim";
modelTemplateFiles.put("model.mustache", ".nim");
apiTemplateFiles.put("api.mustache", ".nim");
embeddedTemplateDir = templateDir = "nim-client";
apiPackage = File.separator + packageName + File.separator + "apis";
modelPackage = File.separator + packageName + File.separator + "models";
supportingFiles.add(new SupportingFile("README.mustache", "", "README.md"));
supportingFiles.add(new SupportingFile("sample_client.mustache", "", "sample_client.nim"));
supportingFiles.add(new SupportingFile("config.mustache", "", "config.nim"));

setReservedWordsLowerCase(
Arrays.asList(
"addr", "and", "as", "asm",
"bind", "block", "break",
"case", "cast", "concept", "const", "continue", "converter",
"defer", "discard", "distinct", "div", "do",
"elif", "else", "end", "enum", "except", "export",
"finally", "for", "from", "func",
"if", "import", "in", "include", "interface", "is", "isnot", "iterator",
"let",
"macro", "method", "mixin", "mod",
"nil", "not", "notin",
"object", "of", "or", "out",
"proc", "ptr",
"raise", "ref", "return",
"shl", "shr", "static",
"template", "try", "tuple", "type",
"using",
"var",
"when", "while",
"xor",
"yield"
)
);

defaultIncludes = new HashSet<String>(
Arrays.asList(
"array"
)
);

languageSpecificPrimitives = new HashSet<String>(
Arrays.asList(
"int",
"int8",
"int16",
"int32",
"int64",
"uint",
"uint8",
"uint16",
"uint32",
"uint64",
"float",
"float32",
"float64",
"bool",
"char",
"string",
"cstring",
"pointer")
);

typeMapping.clear();
typeMapping.put("integer", "int");
typeMapping.put("long", "int64");
typeMapping.put("number", "float");
typeMapping.put("float", "float");
typeMapping.put("double", "float64");
typeMapping.put("boolean", "bool");
typeMapping.put("UUID", "string");
typeMapping.put("URI", "string");
typeMapping.put("date", "string");
typeMapping.put("DateTime", "string");
typeMapping.put("password", "string");
typeMapping.put("file", "string");
}

public void setPackageName(String packageName) {
this.packageName = packageName;
}

public void setPackageVersion(String packageVersion) {
this.packageVersion = packageVersion;
}

@Override
public Map<String, Object> postProcessModels(Map<String, Object> objs) {
return postProcessModelsEnum(objs);
}

@Override
public void processOpts() {
super.processOpts();

if (additionalProperties.containsKey(CodegenConstants.PACKAGE_NAME)) {
setPackageName((String) additionalProperties.get(CodegenConstants.PACKAGE_NAME));
}

if (additionalProperties.containsKey(CodegenConstants.PACKAGE_VERSION)) {
setPackageVersion((String) additionalProperties.get(CodegenConstants.PACKAGE_VERSION));
}

additionalProperties.put(CodegenConstants.PACKAGE_NAME, packageName);
additionalProperties.put(CodegenConstants.PACKAGE_VERSION, packageVersion);

apiPackage = File.separator + packageName + File.separator + "apis";
modelPackage = File.separator + packageName + File.separator + "models";
supportingFiles.add(new SupportingFile("lib.mustache", "", packageName + ".nim"));
}

@Override
public String escapeReservedWord(String name) {
LOGGER.warn("A reserved word \"" + name + "\" is used. Consider renaming the field name");
if (this.reservedWordsMappings().containsKey(name)) {
return this.reservedWordsMappings().get(name);
}
return "`" + name + "`";
}

@Override
public String escapeQuotationMark(String input) {
return input.replace("\"", "");
}

@Override
public String escapeUnsafeCharacters(String input) {
return input.replace("*/", "*_/").replace("/*", "/_*");
}

@Override
public String toModelImport(String name) {
name = name.replaceAll("-", "_");
if (importMapping.containsKey(name)) {
return "model_" + StringUtils.underscore(importMapping.get(name));
} else {
return "model_" + StringUtils.underscore(name);
}
}

@Override
public String toApiImport(String name) {
name = name.replaceAll("-", "_");
if (importMapping.containsKey(name)) {
return "api_" + StringUtils.underscore(importMapping.get(name));
} else {
return "api_" + StringUtils.underscore(name);
}
}

@Override
public String toModelFilename(String name) {
name = name.replaceAll("-", "_");
return "model_" + StringUtils.underscore(name);
}

@Override
public String toApiFilename(String name) {
name = name.replaceAll("-", "_");
return "api_" + StringUtils.underscore(name);
}

@Override
public String toOperationId(String operationId) {
String sanitizedOperationId = sanitizeName(operationId);

if (isReservedWord(sanitizedOperationId)) {
sanitizedOperationId = "call" + StringUtils.camelize(sanitizedOperationId, false);
}

return StringUtils.camelize(sanitizedOperationId, true);
}

@Override
public Map<String, Object> postProcessOperationsWithModels(Map<String, Object> objs, List<Object> allModels) {
@SuppressWarnings("unchecked")
Map<String, Object> objectMap = (Map<String, Object>) objs.get("operations");
@SuppressWarnings("unchecked")
List<CodegenOperation> operations = (List<CodegenOperation>) objectMap.get("operation");
for (CodegenOperation operation : operations) {
operation.httpMethod = operation.httpMethod.toLowerCase(Locale.ROOT);
}

return objs;
}

@Override
public String getTypeDeclaration(Schema p) {
if (ModelUtils.isArraySchema(p)) {
ArraySchema ap = (ArraySchema) p;
Schema inner = ap.getItems();
if (inner == null) {
return null;
}
return "seq[" + getTypeDeclaration(inner) + "]";
} else if (ModelUtils.isMapSchema(p)) {
Schema inner = ModelUtils.getAdditionalProperties(p);
if (inner == null) {
inner = new StringSchema();
}
return "Table[string, " + getTypeDeclaration(inner) + "]";
}

String schemaType = getSchemaType(p);
if (typeMapping.containsKey(schemaType)) {
return typeMapping.get(schemaType);
}

if (schemaType.matches("\\d.*")) { // starts with number
return "`" + schemaType + "`";
} else {
return schemaType;
}
}

@Override
public String toVarName(String name) {
if (isReservedWord(name)) {
name = escapeReservedWord(name);
}

if (name.matches("^\\d.*")) {
name = "`" + name + "`";
}

return name;
}

@Override
public String toParamName(String name) {
return toVarName(name);
}

@Override
protected boolean needToImport(String type) {
if (defaultIncludes.contains(type)) {
return false;
} else if (languageSpecificPrimitives.contains(type)) {
return false;
} else if (typeMapping.containsKey(type) && languageSpecificPrimitives.contains(typeMapping.get(type))) {
return false;
}

return true;
}

@Override
public String toEnumName(CodegenProperty property) {
String name = StringUtils.camelize(property.name, false);

if (name.matches("\\d.*")) { // starts with number
return "`" + name + "`";
} else {
return name;
}
}

@Override
public String toEnumVarName(String name, String datatype) {
name = name.replace(" ", "_");
name = StringUtils.camelize(name, false);

if (name.matches("\\d.*")) { // starts with number
return "`" + name + "`";
} else {
return name;
}
}
}
Copy link
Member

Choose a reason for hiding this comment

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

We're using 4 space indention so I'll reformat the code in a separate PR.

Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ org.openapitools.codegen.languages.JavascriptClosureAngularClientCodegen
org.openapitools.codegen.languages.JMeterClientCodegen
org.openapitools.codegen.languages.LuaClientCodegen
org.openapitools.codegen.languages.MysqlSchemaCodegen
org.openapitools.codegen.languages.NimClientCodegen
org.openapitools.codegen.languages.NodeJSServerCodegen
org.openapitools.codegen.languages.NodeJSExpressServerCodegen
org.openapitools.codegen.languages.ObjcClientCodegen
Expand Down
Loading