Added support for enums in Dart.

swagger-api · Sep 19, 2017 · b245242 · b245242
1 parent 8067612
commit b245242
Show file tree

Hide file tree

Showing 16 changed files with 126 additions and 41 deletions.
diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/DartClientCodegen.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/DartClientCodegen.java
@@ -3,17 +3,22 @@
 import io.swagger.codegen.CliOption;
 import io.swagger.codegen.CodegenConfig;
 import io.swagger.codegen.CodegenConstants;
+import io.swagger.codegen.CodegenModel;
 import io.swagger.codegen.CodegenType;
 import io.swagger.codegen.DefaultCodegen;
 import io.swagger.codegen.SupportingFile;
+import io.swagger.models.Model;
 import io.swagger.models.properties.ArrayProperty;
 import io.swagger.models.properties.MapProperty;
 import io.swagger.models.properties.Property;
 
 import java.io.File;
+import java.util.ArrayList;
 import java.util.Arrays;
-import java.util.HashSet;
 import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
 
 public class DartClientCodegen extends DefaultCodegen implements CodegenConfig {
     public static final String BROWSER_CLIENT = "browserClient";
@@ -182,7 +187,7 @@ public void processOpts() {
 
 
     @Override
-    public String escapeReservedWord(String name) {           
+    public String escapeReservedWord(String name) {
         if(this.reservedWordsMappings().containsKey(name)) {
             return this.reservedWordsMappings().get(name);
         }
@@ -300,6 +305,60 @@ public String getSwaggerType(Property p) {
         return toModelName(type);
     }
 
+    @Override
+    public Map<String, Object> postProcessModels(Map<String, Object> objs) {
+        Map<String, Object> result = postProcessModelsEnum(objs);
+
+        // Build a list of all the enum models.
+        List<Object> models = (List<Object>) objs.get("models");
+        // Check if there already exists a list.
+        Object storedTransformers = additionalProperties.get("transformers");
+        List<Map<String, String>> enumTransformers = storedTransformers != null ?
+                (List<Map<String, String>>) storedTransformers :
+                new ArrayList<Map<String, String>>();
+        for (Object modelObject : models) {
+            Map<String, Object> modelMap = (Map<String, Object>) modelObject;
+            CodegenModel model = (CodegenModel) modelMap.get("model");
+            if (model.isEnum && model.allowableValues != null) {
+                Map<String, String> enumObject = new HashMap<String, String>();
+                String className = model.classname;
+                enumObject.put("className", className);
+                enumObject.put("transformer", className + "TypeTransformer");
+                enumTransformers.add(enumObject);
+            }
+        }
+        // Store the list as an additional property.
+        additionalProperties.put("transformers", enumTransformers);
+        return result;
+    }
+
+    @Override
+    public String toEnumVarName(String value, String datatype) {
+        if (value.length() == 0) {
+            return "EMPTY";
+        }
+
+        // The lone difference with the super version is the replacement of non
+        // word characters with '__' instead of '_'. This is to handle negative
+        // numbers, so that e.g. -1 is transformed into '__1' and not '_1' like
+        // 1 is.
+        String var = value.replaceAll("\\W+", "__").toUpperCase();
+        if (var.matches("\\d.*")) {
+            return "_" + var;
+        } else {
+            return var;
+        }
+    }
+
+    @Override
+    public String toEnumValue(String value, String datatype) {
+      if ("number".equalsIgnoreCase(datatype) || "int".equalsIgnoreCase(datatype)) {
+          return value;
+      } else {
+          return "\"" + escapeText(value) + "\"";
+      }
+    }
+
     @Override
     public String toOperationId(String operationId) {
         // method name cannot use reserved keyword, e.g. return

diff --git a/modules/swagger-codegen/src/main/resources/dart/api_client.mustache b/modules/swagger-codegen/src/main/resources/dart/api_client.mustache
@@ -16,7 +16,8 @@ class ApiClient {
   Map<String, Authentication> _authentications = {};
 
   final dson = new Dartson.JSON()
-                   ..addTransformer(new DateTimeParser(), DateTime);
+      {{#transformers}}..addTransformer(new {{transformer}}(), {{className}})
+      {{/transformers}}..addTransformer(new DateTimeParser(), DateTime);
 
   final _RegList = new RegExp(r'^List<(.*)>$');
   final _RegMap = new RegExp(r'^Map<String,(.*)>$');
@@ -46,7 +47,16 @@ class ApiClient {
         {{#models}}
           {{#model}}
         case '{{classname}}':
+            {{#isEnum}}
+          // Enclose the value in a list so that Dartson can use a transformer
+          // to decode it.
+          final listValue = [value];
+          final List<dynamic> listResult = dson.map(listValue, []);
+          return listResult[0];
+            {{/isEnum}}
+            {{^isEnum}}
           return dson.map(value, new {{classname}}());
+            {{/isEnum}}
           {{/model}}
         {{/models}}
         default:
@@ -116,7 +126,7 @@ class ApiClient {
     headerParams['Content-Type'] = contentType;
 
     if(body is MultipartRequest) {
-      var request = new MultipartRequest(method, Uri.parse(url));      
+      var request = new MultipartRequest(method, Uri.parse(url));
       request.fields.addAll(body.fields);
       request.files.addAll(body.files);
       request.headers.addAll(body.headers);
@@ -141,7 +151,7 @@ class ApiClient {
   }
 
   /// Update query and header parameters based on authentication settings.
-  /// @param authNames The authentications to apply  
+  /// @param authNames The authentications to apply
   void _updateParamsForAuth(List<String> authNames, List<QueryParam> queryParams, Map<String, String> headerParams) {
     authNames.forEach((authName) {
       Authentication auth = _authentications[authName];

diff --git a/modules/swagger-codegen/src/main/resources/dart/apilib.mustache b/modules/swagger-codegen/src/main/resources/dart/apilib.mustache
@@ -6,6 +6,7 @@ import 'package:http/browser_client.dart';{{/browserClient}}
 import 'package:http/http.dart';
 import 'package:dartson/dartson.dart';
 import 'package:dartson/transformers/date_time.dart';
+import 'package:dartson/type_transformer.dart';
 
 part 'api_client.dart';
 part 'api_helper.dart';
@@ -21,4 +22,3 @@ part 'auth/http_basic_auth.dart';
 {{/model}}{{/models}}
 
 ApiClient defaultApiClient = new ApiClient();
-
diff --git a/modules/swagger-codegen/src/main/resources/dart/class.mustache b/modules/swagger-codegen/src/main/resources/dart/class.mustache
@@ -0,0 +1,14 @@
+@Entity()
+class {{classname}} {
+  {{#vars}}{{#description}}/* {{{description}}} */{{/description}}
+  @Property(name: '{{baseName}}')
+  {{{datatype}}} {{name}} = {{{defaultValue}}};
+  {{#allowableValues}}{{#min}} // range from {{min}} to {{max}}{{/min}}//{{^min}}enum {{name}}Enum { {{#values}} {{.}}, {{/values}} };{{/min}}{{/allowableValues}}
+  {{/vars}}
+  {{classname}}();
+
+  @override
+  String toString()  {
+    return '{{classname}}[{{#vars}}{{name}}=${{name}}, {{/vars}}]';
+  }
+}
diff --git a/modules/swagger-codegen/src/main/resources/dart/enum.mustache b/modules/swagger-codegen/src/main/resources/dart/enum.mustache
@@ -0,0 +1,26 @@
+@Entity()
+enum {{classname}} {
+  {{#allowableValues}}{{#enumVars}}{{name}}{{^-last}},{{/-last}}
+  {{/enumVars}}{{/allowableValues}}
+}
+
+class {{classname}}TypeTransformer extends TypeTransformer<{{classname}}> {
+
+  @override
+  dynamic encode({{classname}} data) {
+    switch(data) {
+      {{#allowableValues}}{{#enumVars}}case {{classname}}.{{name}}: return {{value}};
+      {{/enumVars}}{{/allowableValues}}
+      default: throw('Unknown enum value to encode: $data');
+    }
+  }
+
+  @override
+  {{classname}} decode(dynamic data) {
+    switch (data) {
+      {{#allowableValues}}{{#enumVars}}case {{value}}: return {{classname}}.{{name}};
+      {{/enumVars}}{{/allowableValues}}
+      default: throw('Unknown enum value to decode: $data');
+    }
+  }
+}
diff --git a/modules/swagger-codegen/src/main/resources/dart/model.mustache b/modules/swagger-codegen/src/main/resources/dart/model.mustache
@@ -1,19 +1,7 @@
 part of {{pubName}}.api;
 
-{{#models}}{{#model}}
-@Entity()
-class {{classname}} {
-  {{#vars}}{{#description}}/* {{{description}}} */{{/description}}
-  @Property(name: '{{baseName}}')
-  {{{datatype}}} {{name}} = {{{defaultValue}}};
-  {{#allowableValues}}{{#min}} // range from {{min}} to {{max}}{{/min}}//{{^min}}enum {{name}}Enum { {{#values}} {{.}}, {{/values}} };{{/min}}{{/allowableValues}}
-  {{/vars}}
-  {{classname}}();
-
-  @override
-  String toString()  {
-    return '{{classname}}[{{#vars}}{{name}}=${{name}}, {{/vars}}]';
-  }
-
-}
-{{/model}}{{/models}}
+{{#models}}
+{{#model}}
+{{#isEnum}}{{>enum}}{{/isEnum}}{{^isEnum}}{{>class}}{{/isEnum}}
+{{/model}}
+{{/models}}
diff --git a/samples/client/petstore/dart/swagger/.swagger-codegen/VERSION b/samples/client/petstore/dart/swagger/.swagger-codegen/VERSION
@@ -1 +1 @@
-2.2.3-SNAPSHOT
+2.3.0-SNAPSHOT
diff --git a/samples/client/petstore/dart/swagger/docs/StoreApi.md b/samples/client/petstore/dart/swagger/docs/StoreApi.md
@@ -87,7 +87,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-[**Map<String, int>**](Map.md)
+**Map<String, int>**
 
 ### Authorization
 

diff --git a/samples/client/petstore/dart/swagger/lib/api.dart b/samples/client/petstore/dart/swagger/lib/api.dart
@@ -6,6 +6,7 @@ import 'package:http/browser_client.dart';
 import 'package:http/http.dart';
 import 'package:dartson/dartson.dart';
 import 'package:dartson/transformers/date_time.dart';
+import 'package:dartson/type_transformer.dart';
 
 part 'api_client.dart';
 part 'api_helper.dart';
@@ -28,4 +29,3 @@ part 'model/user.dart';
 
 
 ApiClient defaultApiClient = new ApiClient();
-
diff --git a/samples/client/petstore/dart/swagger/lib/api_client.dart b/samples/client/petstore/dart/swagger/lib/api_client.dart
@@ -16,7 +16,7 @@ class ApiClient {
   Map<String, Authentication> _authentications = {};
 
   final dson = new Dartson.JSON()
-                   ..addTransformer(new DateTimeParser(), DateTime);
+      ..addTransformer(new DateTimeParser(), DateTime);
 
   final _RegList = new RegExp(r'^List<(.*)>$');
   final _RegMap = new RegExp(r'^Map<String,(.*)>$');
@@ -121,7 +121,7 @@ class ApiClient {
     headerParams['Content-Type'] = contentType;
 
     if(body is MultipartRequest) {
-      var request = new MultipartRequest(method, Uri.parse(url));      
+      var request = new MultipartRequest(method, Uri.parse(url));
       request.fields.addAll(body.fields);
       request.files.addAll(body.files);
       request.headers.addAll(body.headers);
@@ -146,7 +146,7 @@ class ApiClient {
   }
 
   /// Update query and header parameters based on authentication settings.
-  /// @param authNames The authentications to apply  
+  /// @param authNames The authentications to apply
   void _updateParamsForAuth(List<String> authNames, List<QueryParam> queryParams, Map<String, String> headerParams) {
     authNames.forEach((authName) {
       Authentication auth = _authentications[authName];

diff --git a/samples/client/petstore/dart/swagger/lib/model/api_response.dart b/samples/client/petstore/dart/swagger/lib/model/api_response.dart
@@ -1,6 +1,5 @@
 part of swagger.api;
 
-
 @Entity()
 class ApiResponse {
 
@@ -21,6 +20,5 @@ class ApiResponse {
   String toString()  {
     return 'ApiResponse[code=$code, type=$type, message=$message, ]';
   }
-
 }
 
diff --git a/samples/client/petstore/dart/swagger/lib/model/category.dart b/samples/client/petstore/dart/swagger/lib/model/category.dart
@@ -1,6 +1,5 @@
 part of swagger.api;
 
-
 @Entity()
 class Category {
 
@@ -17,6 +16,5 @@ class Category {
   String toString()  {
     return 'Category[id=$id, name=$name, ]';
   }
-
 }
 
diff --git a/samples/client/petstore/dart/swagger/lib/model/order.dart b/samples/client/petstore/dart/swagger/lib/model/order.dart
@@ -1,6 +1,5 @@
 part of swagger.api;
 
-
 @Entity()
 class Order {
 
@@ -33,6 +32,5 @@ class Order {
   String toString()  {
     return 'Order[id=$id, petId=$petId, quantity=$quantity, shipDate=$shipDate, status=$status, complete=$complete, ]';
   }
-
 }
 
diff --git a/samples/client/petstore/dart/swagger/lib/model/pet.dart b/samples/client/petstore/dart/swagger/lib/model/pet.dart
@@ -1,6 +1,5 @@
 part of swagger.api;
 
-
 @Entity()
 class Pet {
 
@@ -33,6 +32,5 @@ class Pet {
   String toString()  {
     return 'Pet[id=$id, category=$category, name=$name, photoUrls=$photoUrls, tags=$tags, status=$status, ]';
   }
-
 }
 
diff --git a/samples/client/petstore/dart/swagger/lib/model/tag.dart b/samples/client/petstore/dart/swagger/lib/model/tag.dart
@@ -1,6 +1,5 @@
 part of swagger.api;
 
-
 @Entity()
 class Tag {
 
@@ -17,6 +16,5 @@ class Tag {
   String toString()  {
     return 'Tag[id=$id, name=$name, ]';
   }
-
 }
 
diff --git a/samples/client/petstore/dart/swagger/lib/model/user.dart b/samples/client/petstore/dart/swagger/lib/model/user.dart
@@ -1,6 +1,5 @@
 part of swagger.api;
 
-
 @Entity()
 class User {
 
@@ -41,6 +40,5 @@ class User {
   String toString()  {
     return 'User[id=$id, username=$username, firstName=$firstName, lastName=$lastName, email=$email, password=$password, phone=$phone, userStatus=$userStatus, ]';
   }
-
 }