Merge pull request #2328 from wing328/model_reserved_word

wing328 · wing328 · commit bc559b3b69c6 · 2016-03-07T23:04:42.000+08:00
Use "Model" to handle model name with reserved keywords
diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/AbstractCSharpCodegen.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/AbstractCSharpCodegen.java
@@ -497,7 +497,7 @@ public String toModelName(String name) {
         // model name cannot use reserved keyword, e.g. return
         if (isReservedWord(name)) {
             LOGGER.warn(name + " (reserved word) cannot be used as model name. Renamed to " + camelize("model_" + name));
-            name = "model_" + name; // e.g. return => ObjectReturn (after camelize)
+            name = "model_" + name; // e.g. return => ModelReturn (after camelize)
         }
 
         // camelize the model name
diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/AbstractTypeScriptClientCodegen.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/AbstractTypeScriptClientCodegen.java
@@ -134,7 +134,7 @@ public String toModelName(String name) {
 
         // model name cannot use reserved keyword, e.g. return
         if (isReservedWord(name)) {
-            String modelName = camelize("object_" + name);
+            String modelName = camelize("model_" + name);
             LOGGER.warn(name + " (reserved word) cannot be used as model name. Renamed to " + modelName);
             return modelName;
         }
diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/AndroidClientCodegen.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/AndroidClientCodegen.java
@@ -185,13 +185,22 @@ public String toParamName(String name) {
 
     @Override
     public String toModelName(String name) {
+        // add prefix, suffix if needed
+        if (!StringUtils.isEmpty(modelNamePrefix)) {
+            name = modelNamePrefix + "_" + name;
+        }
+
+        if (!StringUtils.isEmpty(modelNameSuffix)) {
+            name = name + "_" + modelNameSuffix;
+        }
+
         // camelize the model name
         // phone_number => PhoneNumber
-        name = camelize(sanitizeName(modelNamePrefix + name + modelNameSuffix));
+        name = camelize(sanitizeName(name));
 
         // model name cannot use reserved keyword, e.g. return
         if (isReservedWord(name)) {
-            String modelName = "Object" + name;
+            String modelName = "Model" + name;
             LOGGER.warn(name + " (reserved word) cannot be used as model name. Renamed to " + modelName);
             return modelName;
         }
diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/FlashClientCodegen.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/FlashClientCodegen.java
@@ -287,9 +287,20 @@ public String toParamName(String name) {
 
     @Override
     public String toModelName(String name) {
+        if (!StringUtils.isEmpty(modelNamePrefix)) {
+            name = modelNamePrefix + "_" + name;
+        }
+
+        if (!StringUtils.isEmpty(modelNameSuffix)) {
+            name = name + "_" + modelNameSuffix;
+        }
+
+        name = sanitizeName(name);
+
         // model name cannot use reserved keyword, e.g. return
         if (isReservedWord(name)) {
-            throw new RuntimeException(name + " (reserved word) cannot be used as a model name");
+            LOGGER.warn(name + " (reserved word) cannot be used as model name. Renamed to " + camelize("model_" + name));
+            name = "model_" + name; // e.g. return => ModelReturn (after camelize)
         }
 
         // camelize the model name
@@ -299,14 +310,8 @@ public String toModelName(String name) {
 
     @Override
     public String toModelFilename(String name) {
-        // model name cannot use reserved keyword, e.g. return
-        if (isReservedWord(name)) {
-            throw new RuntimeException(name + " (reserved word) cannot be used as a model name");
-        }
-
-        // underscore the model file name
-        // PhoneNumber => phone_number
-        return camelize(dropDots(name));
+        // leverage toModelName
+        return dropDots(toModelName(name));
     }
 
     @Override
@@ -344,7 +349,8 @@ public String toOperationId(String operationId) {
 
         // method name cannot use reserved keyword, e.g. return
         if (isReservedWord(operationId)) {
-            throw new RuntimeException(operationId + " (reserved word) cannot be used as method name");
+            LOGGER.warn(operationId + " (reserved word) cannot be used as method name. Renamed to " + underscore(sanitizeName("call_" + operationId)));
+            operationId = "call_" + operationId;
         }
 
         return underscore(operationId);
diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/GoClientCodegen.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/GoClientCodegen.java
@@ -192,9 +192,21 @@ public String toParamName(String name) {
 
     @Override
     public String toModelName(String name) {
+        if (!StringUtils.isEmpty(modelNamePrefix)) {
+            name = modelNamePrefix + "_" + name;
+        }
+
+        if (!StringUtils.isEmpty(modelNameSuffix)) {
+            name = name + "_" + modelNameSuffix;
+        }
+
+        name = sanitizeName(name);
+
         // model name cannot use reserved keyword, e.g. return
-        if(isReservedWord(name))
-            throw new RuntimeException(name + " (reserved word) cannot be used as a model name");
+        if (isReservedWord(name)) {
+            LOGGER.warn(name + " (reserved word) cannot be used as model name. Renamed to " + camelize("model_" + name));
+            name = "model_" + name; // e.g. return => ModelReturn (after camelize)
+        }
 
         // camelize the model name
         // phone_number => PhoneNumber
@@ -257,8 +269,10 @@ public String getSwaggerType(Property p) {
     @Override
     public String toOperationId(String operationId) {
         // method name cannot use reserved keyword, e.g. return
-        if(isReservedWord(operationId))
-            throw new RuntimeException(operationId + " (reserved word) cannot be used as method name");
+        if (isReservedWord(operationId)) {
+            LOGGER.warn(operationId + " (reserved word) cannot be used as method name. Renamed to " + camelize(sanitizeName("call_" + operationId)));
+            operationId = "call_" + operationId;
+        }
 
         return camelize(operationId);
     }
diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/JavaClientCodegen.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/JavaClientCodegen.java
@@ -388,7 +388,7 @@ public String toModelName(final String name) {
 
         // model name cannot use reserved keyword, e.g. return
         if (isReservedWord(camelizedName)) {
-            final String modelName = "Object" + camelizedName;
+            final String modelName = "Model" + camelizedName;
             LOGGER.warn(camelizedName + " (reserved word) cannot be used as model name. Renamed to " + modelName);
             return modelName;
         }
diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/JavascriptClientCodegen.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/JavascriptClientCodegen.java
@@ -308,7 +308,7 @@ public String toModelName(String name) {
 
         // model name cannot use reserved keyword, e.g. return
         if (isReservedWord(name)) {
-            String modelName = "Object" + name;
+            String modelName = "Model" + name;
             LOGGER.warn(name + " (reserved word) cannot be used as model name. Renamed to " + modelName);
             return modelName;
         }
diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/JavascriptClosureAngularClientCodegen.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/JavascriptClosureAngularClientCodegen.java
@@ -8,6 +8,8 @@
 import java.util.*;
 import java.io.File;
 
+import org.apache.commons.lang.StringUtils;
+
 public class JavascriptClosureAngularClientCodegen extends DefaultCodegen implements CodegenConfig {
     public JavascriptClosureAngularClientCodegen() {
         super();
@@ -128,10 +130,19 @@ public String toParamName(String name) {
 
     @Override
     public String toModelName(String name) {
+        if (!StringUtils.isEmpty(modelNamePrefix)) {
+            name = modelNamePrefix + "_" + name;
+        }
+
+        if (!StringUtils.isEmpty(modelNameSuffix)) {
+            name = name + "_" + modelNameSuffix;
+        }
+
         // model name cannot use reserved keyword, e.g. return
-        if (isReservedWord(name))
-            throw new RuntimeException(name
-                    + " (reserved word) cannot be used as a model name");
+        if (isReservedWord(name)) {
+            LOGGER.warn(name + " (reserved word) cannot be used as model name. Renamed to " + camelize("model_" + name));
+            name = "model_" + name; // e.g. return => ModelReturn (after camelize)
+        }
 
         // camelize the model name
         // phone_number => PhoneNumber
diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/ObjcClientCodegen.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/ObjcClientCodegen.java
@@ -316,8 +316,8 @@ else if (languageSpecificPrimitives.contains(swaggerType)) {
     public String toModelName(String type) {
         // model name cannot use reserved keyword
         if (reservedWords.contains(type)) {
-            LOGGER.warn(type+ " (reserved word) cannot be used as model name. Renamed to " + ("object_" + type) + " before further processing");
-            type = "object_" + type; // e.g. return => ObjectReturn (after camelize)
+            LOGGER.warn(type+ " (reserved word) cannot be used as model name. Renamed to " + ("model_" + type) + " before further processing");
+            type = "model_" + type; // e.g. return => ModelReturn (after camelize)
         }
 
         return toModelNameWithoutReservedWordCheck(type);
diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/PerlClientCodegen.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/PerlClientCodegen.java
@@ -222,8 +222,8 @@ public String toModelName(String name) {
 
         // model name cannot use reserved keyword
         if (isReservedWord(name)) {
-            LOGGER.warn(name + " (reserved word) cannot be used as model name. Renamed to " + camelize("object_" + name));
-            name = "object_" + name;
+            LOGGER.warn(name + " (reserved word) cannot be used as model name. Renamed to " + camelize("model_" + name));
+            name = "model_" + name;
         }
 
         // add prefix/suffic to model name
diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/PhpClientCodegen.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/PhpClientCodegen.java
@@ -369,8 +369,8 @@ public String toModelName(String name) {
 
         // model name cannot use reserved keyword
         if (isReservedWord(name)) {
-            LOGGER.warn(name + " (reserved word) cannot be used as model name. Renamed to " + camelize("object_" + name));
-            name = "object_" + name; // e.g. return => ObjectReturn (after camelize)
+            LOGGER.warn(name + " (reserved word) cannot be used as model name. Renamed to " + camelize("model_" + name));
+            name = "model_" + name; // e.g. return => ModelReturn (after camelize)
         }
 
         // add prefix and/or suffic only if name does not start wth \ (e.g. \DateTime)
diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/PythonClientCodegen.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/PythonClientCodegen.java
@@ -218,8 +218,8 @@ public String toModelName(String name) {
 
         // model name cannot use reserved keyword, e.g. return
         if (isReservedWord(name)) {
-            LOGGER.warn(name + " (reserved word) cannot be used as model name. Renamed to " + camelize("object_" + name));
-            name = "object_" + name; // e.g. return => ObjectReturn (after camelize)
+            LOGGER.warn(name + " (reserved word) cannot be used as model name. Renamed to " + camelize("model_" + name));
+            name = "model_" + name; // e.g. return => ModelReturn (after camelize)
         }
 
         if (!StringUtils.isEmpty(modelNamePrefix)) {
@@ -243,8 +243,8 @@ public String toModelFilename(String name) {
 
         // model name cannot use reserved keyword, e.g. return
         if (isReservedWord(name)) {
-            LOGGER.warn(name + " (reserved word) cannot be used as model filename. Renamed to " + underscore(dropDots("object_" + name)));
-            name = "object_" + name; // e.g. return => ObjectReturn (after camelize)
+            LOGGER.warn(name + " (reserved word) cannot be used as model filename. Renamed to " + underscore(dropDots("model_" + name)));
+            name = "model_" + name; // e.g. return => ModelReturn (after camelize)
         }
 
         if (!StringUtils.isEmpty(modelNamePrefix)) {
diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/RubyClientCodegen.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/RubyClientCodegen.java
@@ -381,7 +381,7 @@ public String toModelName(String name) {
 
         // model name cannot use reserved keyword, e.g. return
         if (isReservedWord(name)) {
-            String modelName = camelize("object_" + name);
+            String modelName = camelize("Model" + name);
             LOGGER.warn(name + " (reserved word) cannot be used as model name. Renamed to " + modelName);
             return modelName;
         }
@@ -404,7 +404,7 @@ public String toModelFilename(String name) {
         }
         // model name cannot use reserved keyword, e.g. return
         if (isReservedWord(name)) {
-            String filename = underscore("object_" + name);
+            String filename = underscore("model_" + name);
             LOGGER.warn(name + " (reserved word) cannot be used as model filename. Renamed to " + filename);
             return filename;
         }
diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/SwiftCodegen.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/SwiftCodegen.java
@@ -263,7 +263,7 @@ public String toModelName(String name) {
 
         // model name cannot use reserved keyword, e.g. return
         if (isReservedWord(name)) {
-            String modelName = "Object" + name;
+            String modelName = "Model" + name;
             LOGGER.warn(name + " (reserved word) cannot be used as model name. Renamed to " + modelName);
             return modelName;
         }

Original file line number	Diff line number	Diff line change
`@@ -497,7 +497,7 @@ public String toModelName(String name) {`
`497`	`497`	`// model name cannot use reserved keyword, e.g. return`
`498`	`498`	`if (isReservedWord(name)) {`
`499`	`499`	`LOGGER.warn(name + " (reserved word) cannot be used as model name. Renamed to " + camelize("model_" + name));`
`500`		`- name = "model_" + name; // e.g. return => ObjectReturn (after camelize)`
	`500`	`+ name = "model_" + name; // e.g. return => ModelReturn (after camelize)`
`501`	`501`	`}`
`502`	`502`
`503`	`503`	`// camelize the model name`
Original file line number	Diff line number	Diff line change
`@@ -134,7 +134,7 @@ public String toModelName(String name) {`
`134`	`134`
`135`	`135`	`// model name cannot use reserved keyword, e.g. return`
`136`	`136`	`if (isReservedWord(name)) {`
`137`		`- String modelName = camelize("object_" + name);`
	`137`	`+ String modelName = camelize("model_" + name);`
`138`	`138`	`LOGGER.warn(name + " (reserved word) cannot be used as model name. Renamed to " + modelName);`
`139`	`139`	`return modelName;`
`140`	`140`	`}`
Original file line number	Diff line number	Diff line change
`@@ -388,7 +388,7 @@ public String toModelName(final String name) {`
`388`	`388`
`389`	`389`	`// model name cannot use reserved keyword, e.g. return`
`390`	`390`	`if (isReservedWord(camelizedName)) {`
`391`		`- final String modelName = "Object" + camelizedName;`
	`391`	`+ final String modelName = "Model" + camelizedName;`
`392`	`392`	`LOGGER.warn(camelizedName + " (reserved word) cannot be used as model name. Renamed to " + modelName);`
`393`	`393`	`return modelName;`
`394`	`394`	`}`
Original file line number	Diff line number	Diff line change
`@@ -308,7 +308,7 @@ public String toModelName(String name) {`
`308`	`308`
`309`	`309`	`// model name cannot use reserved keyword, e.g. return`
`310`	`310`	`if (isReservedWord(name)) {`
`311`		`- String modelName = "Object" + name;`
	`311`	`+ String modelName = "Model" + name;`
`312`	`312`	`LOGGER.warn(name + " (reserved word) cannot be used as model name. Renamed to " + modelName);`
`313`	`313`	`return modelName;`
`314`	`314`	`}`
Original file line number	Diff line number	Diff line change
`@@ -222,8 +222,8 @@ public String toModelName(String name) {`
`222`	`222`
`223`	`223`	`// model name cannot use reserved keyword`
`224`	`224`	`if (isReservedWord(name)) {`
`225`		`- LOGGER.warn(name + " (reserved word) cannot be used as model name. Renamed to " + camelize("object_" + name));`
`226`		`- name = "object_" + name;`
	`225`	`+ LOGGER.warn(name + " (reserved word) cannot be used as model name. Renamed to " + camelize("model_" + name));`
	`226`	`+ name = "model_" + name;`
`227`	`227`	`}`
`228`	`228`
`229`	`229`	`// add prefix/suffic to model name`