Merge pull request #8721 from while-loop/8426-fix-dart-enum

[Dart] Fix Dart enums (#8426)

Author: HugoMario

modules/swagger-codegen/src/main/resources/dart-jaguar/enum.mustache

@@ -1,6 +1,5 @@
 part '{{classFilename}}.jser.dart';
 
-@Entity()
 class {{classname}} {
   /// The underlying value of this enum member.
   final {{dataType}} value;
@@ -12,24 +11,22 @@ class {{classname}} {
       {{#description}}
   /// {{description}}
       {{/description}}
-  static const {{classname}} {{name}} = const {{classname}}._internal({{value}});
+  static const {{classname}} {{name}} = const {{classname}}._internal({{{value}}});
     {{/enumVars}}
   {{/allowableValues}}
 }
 
-class {{classname}}TypeTransformer extends TypeTransformer<{{classname}}> {
+class {{classname}}TypeTransformer {
 
-  @override
   dynamic encode({{classname}} data) {
     return data.value;
   }
 
-  @override
   {{classname}} decode(dynamic data) {
     switch (data) {
       {{#allowableValues}}
         {{#enumVars}}
-      case {{value}}: return {{classname}}.{{name}};
+      case {{{value}}}: return {{classname}}.{{name}};
         {{/enumVars}}
       {{/allowableValues}}
       default: throw('Unknown enum value to decode: $data');

modules/swagger-codegen/src/main/resources/dart/api_client.mustache

@@ -44,11 +44,7 @@ class ApiClient {
           {{#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];
+           return new {{classname}}.fromJson(value);
             {{/isEnum}}
             {{^isEnum}}
           return new {{classname}}.fromJson(value);
@@ -76,13 +72,13 @@ class ApiClient {
     throw new ApiException(500, 'Could not find a suitable class for deserialization');
   }
 
-  dynamic deserialize(String json, String targetType) {
+  dynamic deserialize(String jsonVal, String targetType) {
     // Remove all spaces.  Necessary for reg expressions as well.
     targetType = targetType.replaceAll(' ', '');
 
-    if (targetType == 'String') return json;
+    if (targetType == 'String') return jsonVal;
 
-    var decodedJson = JSON.decode(json);
+    var decodedJson = json.decode(jsonVal);
     return _deserialize(decodedJson, targetType);
   }
 
@@ -91,7 +87,7 @@ class ApiClient {
     if (obj == null) {
       serialized = '';
     } else {
-      serialized = JSON.encode(obj);
+      serialized = json.encode(obj);
     }
     return serialized;
   }

modules/swagger-codegen/src/main/resources/dart/api_helper.mustache

@@ -42,7 +42,7 @@ String parameterToString(dynamic value) {
     {{#model}}
       {{#isEnum}}
   } else if (value is {{classname}}) {
-    return new {{classname}}TypeTransformer().encode(value).toString();
+    return {{classname}}.encode(value).toString();
       {{/isEnum}}
     {{/model}}
   {{/models}}

modules/swagger-codegen/src/main/resources/dart/auth/http_basic_auth.mustache

@@ -8,7 +8,7 @@ class HttpBasicAuth implements Authentication {
   @override
   void applyToParams(List<QueryParam> queryParams, Map<String, String> headerParams) {
     String str = (username == null ? "" : username) + ":" + (password == null ? "" : password);
-    headerParams["Authorization"] = "Basic " + BASE64.encode(UTF8.encode(str));
+    headerParams["Authorization"] = "Basic " + base64.encode(utf8.encode(str));
   }
 
 }

modules/swagger-codegen/src/main/resources/dart/enum.mustache

@@ -1,36 +1,30 @@
-@Entity()
 class {{classname}} {
   /// The underlying value of this enum member.
-  final {{dataType}} value;
+  {{dataType}} value;
 
-  const {{classname}}._internal(this.value);
+  {{classname}}._internal(this.value);
 
   {{#allowableValues}}
     {{#enumVars}}
       {{#description}}
   /// {{description}}
       {{/description}}
-  static const {{classname}} {{name}} = const {{classname}}._internal({{value}});
+  static {{classname}} {{name}} = {{classname}}._internal({{{value}}});
     {{/enumVars}}
   {{/allowableValues}}
-}
-
-class {{classname}}TypeTransformer extends TypeTransformer<{{classname}}> {
-
-  @override
-  dynamic encode({{classname}} data) {
-    return data.value;
-  }
 
-  @override
-  {{classname}} decode(dynamic data) {
+  {{classname}}.fromJson(dynamic data) {
     switch (data) {
-      {{#allowableValues}}
-        {{#enumVars}}
-      case {{value}}: return {{classname}}.{{name}};
-        {{/enumVars}}
-      {{/allowableValues}}
-      default: throw('Unknown enum value to decode: $data');
+    {{#allowableValues}}
+      {{#enumVars}}
+          case {{{value}}}: value = data; break;
+      {{/enumVars}}
+    {{/allowableValues}}
+    default: throw('Unknown enum value to decode: $data');
     }
   }
+
+  static dynamic encode({{classname}} data) {
+    return data.value;
+  }
 }

modules/swagger-codegen/src/test/java/io/swagger/codegen/dart/DartModelEnumTest.java

@@ -0,0 +1,100 @@
+package io.swagger.codegen.dart;
+
+import io.swagger.codegen.CodegenModel;
+import io.swagger.codegen.CodegenProperty;
+import io.swagger.codegen.DefaultCodegen;
+import io.swagger.codegen.languages.DartClientCodegen;
+import io.swagger.models.ComposedModel;
+import io.swagger.models.Model;
+import io.swagger.models.ModelImpl;
+import io.swagger.models.RefModel;
+import io.swagger.models.properties.Property;
+import io.swagger.models.properties.StringProperty;
+import org.testng.Assert;
+import org.testng.annotations.Test;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.Map;
+
+@SuppressWarnings("static-method")
+public class DartModelEnumTest {
+
+    @Test(description = "convert a dart model with an enum")
+    public void converterTest() {
+        final StringProperty enumProperty = new StringProperty();
+        enumProperty.setEnum(Arrays.asList("VALUE1", "VALUE2", "VALUE3"));
+        final ModelImpl model = new ModelImpl().property("name", enumProperty);
+
+        final DefaultCodegen codegen = new DartClientCodegen();
+        final CodegenModel cm = codegen.fromModel("sample", model);
+
+        Assert.assertEquals(cm.vars.size(), 1);
+
+        final CodegenProperty enumVar = cm.vars.get(0);
+        Assert.assertEquals(enumVar.baseName, "name");
+        Assert.assertEquals(enumVar.datatype, "String");
+        Assert.assertEquals(enumVar.datatypeWithEnum, "NameEnum");
+        Assert.assertEquals(enumVar.name, "name");
+        Assert.assertEquals(enumVar.defaultValue, "null");
+        Assert.assertEquals(enumVar.baseType, "String");
+        Assert.assertTrue(enumVar.isEnum);
+    }
+
+    @Test(description = "not override identical parent enums")
+    public void overrideEnumTest() {
+        final StringProperty identicalEnumProperty = new StringProperty();
+        identicalEnumProperty.setEnum(Arrays.asList("VALUE1", "VALUE2", "VALUE3"));
+
+        final StringProperty subEnumProperty = new StringProperty();
+        subEnumProperty.setEnum(Arrays.asList("SUB1", "SUB2", "SUB3"));
+
+        // Add one enum property to the parent
+        final Map<String, Property> parentProperties = new HashMap<String, Property>();
+        parentProperties.put("sharedThing", identicalEnumProperty);
+
+        // Add TWO enums to the subType model; one of which is identical to the one in parent class
+        final Map<String, Property> subProperties = new HashMap<String, Property>();
+        subProperties.put("sharedThing", identicalEnumProperty);
+        subProperties.put("unsharedThing", identicalEnumProperty);
+
+        final ModelImpl parentModel = new ModelImpl();
+        parentModel.setProperties(parentProperties);
+        parentModel.name("parentModel");
+
+        final ModelImpl subModel = new ModelImpl();
+        subModel.setProperties(subProperties);
+        subModel.name("subModel");
+
+        final ComposedModel model = new ComposedModel()
+                .parent(new RefModel(parentModel.getName()))
+                .child(subModel)
+                .interfaces(new ArrayList<RefModel>());
+
+        final DefaultCodegen codegen = new DartClientCodegen();
+        final Map<String, Model> allModels = new HashMap<String, Model>();
+        allModels.put(parentModel.getName(), parentModel);
+        allModels.put(subModel.getName(), subModel);
+
+        final CodegenModel cm = codegen.fromModel("sample", model, allModels);
+
+        Assert.assertEquals(cm.name, "sample");
+        Assert.assertEquals(cm.classname, "Sample");
+        Assert.assertEquals(cm.parent, "ParentModel");
+        Assert.assertTrue(cm.imports.contains("ParentModel"));
+
+        Assert.assertEquals(cm.vars.size(), 2);
+        System.out.println(cm.vars);
+        CodegenProperty enumVar = cm.vars.get(0);
+        Assert.assertEquals(enumVar.baseName, "sharedThing");
+        Assert.assertEquals(enumVar.datatype, "String");
+        Assert.assertEquals(enumVar.datatypeWithEnum, "SharedThingEnum");
+        Assert.assertTrue(enumVar.isEnum);
+        enumVar = cm.vars.get(1);
+        Assert.assertEquals(enumVar.baseName, "unsharedThing");
+        Assert.assertEquals(enumVar.datatype, "String");
+        Assert.assertEquals(enumVar.datatypeWithEnum, "UnsharedThingEnum");
+        Assert.assertTrue(enumVar.isEnum);
+    }
+}

samples/client/petstore/dart/flutter_petstore/swagger/README.md

@@ -87,8 +87,10 @@ Class | Method | HTTP request | Description
 
 ## Documentation For Models
 
+ - [Amount](docs//Amount.md)
  - [ApiResponse](docs//ApiResponse.md)
  - [Category](docs//Category.md)
+ - [Currency](docs//Currency.md)
  - [Order](docs//Order.md)
  - [Pet](docs//Pet.md)
  - [Tag](docs//Tag.md)

samples/client/petstore/dart/flutter_petstore/swagger/docs/Amount.md

@@ -0,0 +1,16 @@
+# swagger.model.Amount
+
+## Load the model package
+```dart
+import 'package:swagger/api.dart';
+```
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **double** | some description  | [default to null]
+**currency** | [**Currency**](Currency.md) |  | [default to null]
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

samples/client/petstore/dart/flutter_petstore/swagger/docs/Currency.md

@@ -0,0 +1,14 @@
+# swagger.model.Currency
+
+## Load the model package
+```dart
+import 'package:swagger/api.dart';
+```
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

samples/client/petstore/dart/flutter_petstore/swagger/lib/api.dart

@@ -1,7 +1,7 @@
 library swagger.api;
 
-import 'dart:convert';
 import 'dart:async';
+import 'dart:convert';
 import 'package:http/http.dart';
 
 part 'api_client.dart';
@@ -16,8 +16,10 @@ part 'api/pet_api.dart';
 part 'api/store_api.dart';
 part 'api/user_api.dart';
 
+part 'model/amount.dart';
 part 'model/api_response.dart';
 part 'model/category.dart';
+part 'model/currency.dart';
 part 'model/order.dart';
 part 'model/pet.dart';
 part 'model/tag.dart';

samples/client/petstore/dart/flutter_petstore/swagger/lib/api_client.dart

@@ -39,10 +39,14 @@ class ApiClient {
           return value is bool ? value : '$value'.toLowerCase() == 'true';
         case 'double':
           return value is double ? value : double.parse('$value');
+        case 'Amount':
+          return new Amount.fromJson(value);
         case 'ApiResponse':
           return new ApiResponse.fromJson(value);
         case 'Category':
           return new Category.fromJson(value);
+        case 'Currency':
+          return new Currency.fromJson(value);
         case 'Order':
           return new Order.fromJson(value);
         case 'Pet':
@@ -72,13 +76,13 @@ class ApiClient {
     throw new ApiException(500, 'Could not find a suitable class for deserialization');
   }
 
-  dynamic deserialize(String jsonStr, String targetType) {
+  dynamic deserialize(String jsonVal, String targetType) {
     // Remove all spaces.  Necessary for reg expressions as well.
     targetType = targetType.replaceAll(' ', '');
 
-    if (targetType == 'String') return jsonStr;
+    if (targetType == 'String') return jsonVal;
 
-    var decodedJson = json.decode(jsonStr);
+    var decodedJson = json.decode(jsonVal);
     return _deserialize(decodedJson, targetType);
   }
 

samples/client/petstore/dart/flutter_petstore/swagger/lib/model/amount.dart

@@ -0,0 +1,48 @@
+part of swagger.api;
+
+class Amount {
+  /* some description  */
+  double value = null;
+   // range from 0.01 to 1000000000000000//
+
+  Currency currency = null;
+  
+  Amount();
+
+  @override
+  String toString() {
+    return 'Amount[value=$value, currency=$currency, ]';
+  }
+
+  Amount.fromJson(Map<String, dynamic> json) {
+    if (json == null) return;
+    value =
+        json['value']
+    ;
+    currency =
+      
+      
+      new Currency.fromJson(json['currency'])
+;
+  }
+
+  Map<String, dynamic> toJson() {
+    return {
+      'value': value,
+      'currency': currency
+     };
+  }
+
+  static List<Amount> listFromJson(List<dynamic> json) {
+    return json == null ? new List<Amount>() : json.map((value) => new Amount.fromJson(value)).toList();
+  }
+
+  static Map<String, Amount> mapFromJson(Map<String, Map<String, dynamic>> json) {
+    var map = new Map<String, Amount>();
+    if (json != null && json.length > 0) {
+      json.forEach((String key, Map<String, dynamic> value) => map[key] = new Amount.fromJson(value));
+    }
+    return map;
+  }
+}
+