(WIP) FMT, fix up remaining tests for Generator Arguments. TODO: Tweak the classes from annotations to have the toMap call, Look into why inline schema name mappings failing to produce first entry

Author: Nexushunter

.github/workflows/code_quality.yml

@@ -11,6 +11,29 @@ on:
   workflow_dispatch:
 
 jobs:
+  ci:
+    name: Dart CI Checks
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        work_dir: [openapi-generator, openapi-generator-annotations]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Dart
+        uses: dart-lang/[email protected]
+        with:
+          sdk: stable
+      - name: Install Dependencies
+        run: dart pub get
+      - name: Validate formatting
+        run: dart format --set-exit-if-changed
+      - name: Run analyzer
+        run: dart analyze
+      - name: Run tests
+        run: dart test
+
   build:
     name: Build example project 🛠️
     runs-on: ubuntu-latest

openapi-generator-annotations/example/example.dart

@@ -7,6 +7,5 @@ import 'package:openapi_generator_annotations/openapi_generator_annotations.dart
     generatorName: Generator.dio,
     outputDirectory: 'api/petstore_api',
     // useNextGen: true,
-    cachePath: 'something'
-)
+    cachePath: 'something')
 class Example extends OpenapiGeneratorConfig {}

openapi-generator-annotations/lib/src/openapi_generator_annotations_base.dart

@@ -54,7 +54,6 @@ class Openapi {
   /// --reserved-words-mappings
   final Map<String, String>? reservedWordsMappings;
 
-
   /// Tells openapi-generator to always run during the build process
   /// if set to false (the default), openapi-generator will skip processing if the [outputDirectory] already exists
   final bool? alwaysRun;
@@ -105,27 +104,29 @@ class Openapi {
   /// For use with [useNextGen].
   final String? cachePath;
 
-  const Openapi(
-      {this.additionalProperties,
-      @deprecated
-      this.overwriteExistingFiles,
-      this.skipSpecValidation = false,
-      required this.inputSpecFile,
-      this.templateDirectory,
-      required this.generatorName,
-      this.outputDirectory,
-      this.typeMappings,
-      this.importMappings,
-      this.reservedWordsMappings,
-      this.inlineSchemaNameMappings,
-      // this.inlineSchemaOptions,
-      this.apiPackage,
-      this.fetchDependencies = true,
-      this.runSourceGenOnOutput = true,
-      @deprecated
-      this.alwaysRun = false,
-      this.cachePath,
-      this.useNextGen = false,}): assert(cachePath != null && !useNextGen, 'useNextGen should be set when providing cachePath');
+  const Openapi({
+    this.additionalProperties,
+    @deprecated this.overwriteExistingFiles,
+    this.skipSpecValidation = false,
+    required this.inputSpecFile,
+    this.templateDirectory,
+    required this.generatorName,
+    this.outputDirectory,
+    this.typeMappings,
+    this.importMappings,
+    this.reservedWordsMappings,
+    this.inlineSchemaNameMappings,
+    // this.inlineSchemaOptions,
+    this.apiPackage,
+    this.fetchDependencies = true,
+    this.runSourceGenOnOutput = true,
+    @deprecated this.alwaysRun = false,
+    this.cachePath,
+    this.useNextGen = false,
+  });
+  // TODO: Enable assertion error
+  // : assert(cachePath != null && !useNextGen,
+  //       'useNextGen should be set when providing cachePath');
 }
 
 class AdditionalProperties {
@@ -186,22 +187,43 @@ class AdditionalProperties {
   /// an error if the discriminator is missing.
   final bool legacyDiscriminatorBehavior;
 
-  const AdditionalProperties(
-      {this.allowUnicodeIdentifiers = false,
-      this.ensureUniqueParams = true,
-      this.useEnumExtension = false,
-      this.prependFormOrBodyParameters = false,
-      this.pubAuthor,
-      this.pubAuthorEmail,
-      this.pubDescription,
-      this.pubHomepage,
-      this.legacyDiscriminatorBehavior = true,
-      this.pubName,
-      this.pubVersion,
-      this.sortModelPropertiesByRequiredFlag = true,
-      this.sortParamsByRequiredFlag = true,
-      this.sourceFolder,
-      this.wrapper = Wrapper.none});
+  const AdditionalProperties({
+    this.allowUnicodeIdentifiers = false,
+    this.ensureUniqueParams = true,
+    this.useEnumExtension = false,
+    this.prependFormOrBodyParameters = false,
+    this.pubAuthor,
+    this.pubAuthorEmail,
+    this.pubDescription,
+    this.pubHomepage,
+    this.legacyDiscriminatorBehavior = true,
+    this.pubName,
+    this.pubVersion,
+    this.sortModelPropertiesByRequiredFlag = true,
+    this.sortParamsByRequiredFlag = true,
+    this.sourceFolder,
+    this.wrapper = Wrapper.none,
+  });
+
+  /// Produces an [AdditionalProperties] object from the [ConstantReader] [map].
+  AdditionalProperties.fromMap(Map<String, dynamic> map)
+      : this(
+          allowUnicodeIdentifiers: map['allowUnicodeIdentifiers'] ?? false,
+          ensureUniqueParams: map['ensureUniqueParams'] ?? true,
+          useEnumExtension: map['useEnumExtension'] ?? true,
+          prependFormOrBodyParameters: map['prependFormOrBodyParameters'] ?? false,
+          pubAuthor: map['pubAuthor'],
+          pubAuthorEmail: map['pubAuthorEmail'],
+          pubDescription: map['pubDescription'],
+          pubHomepage: map['pubHomepage'],
+          pubName: map['pubName'],
+          pubVersion: map['pubVersion'],
+          legacyDiscriminatorBehavior: map['legacyDiscriminatorBehavior'] ?? true,
+          sortModelPropertiesByRequiredFlag: map['sortModelPropertiesByRequiredFlag'] ?? true,
+          sortParamsByRequiredFlag: map['sortParamsByRequiredFlag'] ?? true,
+          sourceFolder: map['sourceFolder'],
+          wrapper:  EnumTransformer.wrapper(map['wrapper']),
+        );
 }
 
 /// Allows you to customize how inline schemas are handled or named
@@ -216,10 +238,10 @@ class InlineSchemaOptions {
   final bool skipSchemaReuse;
 
   ///	will restore the 6.x (or below) behaviour to refactor allOf inline schemas
-  ///into $ref. (v7.0.0 will skip the refactoring of these allOf inline schmeas by default)
+  ///into $ref. (v7.0.0 will skip the refactoring of these allOf inline schemas by default)
   final bool refactorAllofInlineSchemas;
 
-  /// 	Email address of the author in generated pubspec
+  /// Email address of the author in generated pubspec
   final bool resolveInlineEnums;
 
   const InlineSchemaOptions(
@@ -228,6 +250,16 @@ class InlineSchemaOptions {
       this.skipSchemaReuse = true,
       this.refactorAllofInlineSchemas = true,
       this.resolveInlineEnums = true});
+
+  /// Produces an [InlineSchemaOptions] that is easily consumable from the [ConstantReader].
+  InlineSchemaOptions.fromMap(Map<String, dynamic> map)
+      : this(
+          arrayItemSuffix: map['arrayItemSuffix'],
+          mapItemSuffix: map['mapItemSuffix'],
+          skipSchemaReuse: map['skipSchemaReuse'] ?? true,
+          refactorAllofInlineSchemas: map['refactorAllofInlineSchemas'] ?? true,
+          resolveInlineEnums: map['resolveInlineEnums'] ?? true,
+        );
 }
 
 class DioProperties extends AdditionalProperties {
@@ -270,6 +302,12 @@ class DioProperties extends AdditionalProperties {
             sortParamsByRequiredFlag: sortParamsByRequiredFlag,
             sourceFolder: sourceFolder,
             useEnumExtension: useEnumExtension);
+
+  DioProperties.fromMap(Map<String, dynamic> map)
+      : dateLibrary = map['dateLibrary'],
+        nullableFields = map['nullableFields'] as bool?,
+        serializationLibrary = map['serializationLibrary'],
+        super.fromMap(map);
 }
 
 class DioAltProperties extends AdditionalProperties {
@@ -326,6 +364,14 @@ class DioAltProperties extends AdditionalProperties {
             sortParamsByRequiredFlag: sortParamsByRequiredFlag,
             sourceFolder: sourceFolder,
             useEnumExtension: useEnumExtension);
+
+  DioAltProperties.fromMap(Map<String, dynamic> map)
+      : nullSafe = map['nullSafe'] as bool?,
+        nullSafeArrayDefault = map['nullSafeArrayDefault'] as bool?,
+        listAnyOf = map['listAnyOf'] as bool?,
+        pubspecDependencies = map['pubspecDependencies'],
+        pubspecDevDependencies = map['pubspecDevDependencies'],
+        super.fromMap(map);
 }
 
 enum DioDateLibrary {
@@ -341,6 +387,7 @@ enum DioSerializationLibrary { built_value, json_serializable }
 
 enum SerializationFormat { JSON, PROTO }
 
+
 /// The name of the generator to use
 enum Generator {
   /// This generator uses the default http package that comes with dart
@@ -361,4 +408,38 @@ enum Generator {
   dioAlt,
 }
 
+// TODO: Upon release of NextGen as default migrate to sdk 2.17 for enhanced enums
+//  remove this work around.
+/// Transforms the enums used with the [Openapi] annotation.
+class EnumTransformer {
+  /// Converts the given [name] to the matching [Generator] name.
+  ///
+  /// Defaults to [Generator.dart];
+  static Generator generator(String? name) {
+    print(name);
+    switch(name) {
+      case 'dio':
+        return Generator.dio;
+      case 'dioAlt':
+        return Generator.dioAlt;
+      default:
+        return Generator.dart;
+    }
+  }
+
+  /// Converts the given [name] to the matching [Wrapper] name.
+  ///
+  /// Defaults to [Wrapper.none];
+  static Wrapper wrapper(String? name) {
+    switch(name) {
+      case 'fvm':
+        return Wrapper.fvm;
+      case 'flutterw':
+        return Wrapper.flutterw;
+      default:
+        return Wrapper.none;
+    }
+  }
+}
+
 enum Wrapper { fvm, flutterw, none }

openapi-generator-annotations/pubspec.yaml

@@ -8,5 +8,5 @@ environment:
   sdk: '>=2.12.0 <3.0.0'
 
 dev_dependencies:
-  pedantic:
   test:
+  source_gen_test: ^1.0.6

openapi-generator-annotations/test/openapi_generator_annotations_test.dart

@@ -3,16 +3,19 @@ import 'package:test/test.dart';
 
 void main() {
   group('OpenApi', () {
-    group('NextGen', (){
-
-      test('Sets cachePath',(){
-        final api =Openapi(inputSpecFile: '', generatorName: Generator.dart, cachePath: 'somePath');
+    group('NextGen', () {
+      test('Sets cachePath', () {
+        final api = Openapi(
+            inputSpecFile: '',
+            generatorName: Generator.dart,
+            cachePath: 'somePath');
         expect(api.cachePath, 'somePath');
       });
-    test('Sets useNextGenFlag',(){
-        final api =Openapi(inputSpecFile: '', generatorName: Generator.dart, useNextGen: true);
+      test('Sets useNextGenFlag', () {
+        final api = Openapi(
+            inputSpecFile: '', generatorName: Generator.dart, useNextGen: true);
         expect(api.useNextGen, isTrue);
-    });
+      });
     });
   });
 }

openapi-generator/lib/src/extensions/type_methods.dart

@@ -1,8 +1,8 @@
 import 'dart:mirrors';
 
-import 'package:analyzer/dart/ast/ast.dart';
-import 'package:analyzer/dart/constant/value.dart';
 import 'package:analyzer/dart/element/type.dart';
+import 'package:openapi_generator/src/utils.dart';
+import 'package:openapi_generator_annotations/openapi_generator_annotations.dart';
 import 'package:source_gen/source_gen.dart' show ConstantReader, TypeChecker;
 
 /// Extension adding the type methods to `ConstantReader`.
@@ -81,30 +81,47 @@ extension ReadProperty on ConstantReader {
       return defaultValue;
     }
 
-    // TODO: This may be way too naive
-    if (defaultValue is Map<String, DartObject>) {
-      return v.revive().namedArguments as T;
+    if (defaultValue is AdditionalProperties ||
+        defaultValue is InlineSchemaOptions) {
+      final mapping = v
+          .revive()
+          .namedArguments
+          .map((key, value) => MapEntry(key, convertToPropertyValue(value)));
+      if (defaultValue is AdditionalProperties) {
+        if (defaultValue is DioProperties) {
+          return DioProperties.fromMap(mapping) as T;
+        } else if (defaultValue is DioAltProperties) {
+          return DioAltProperties.fromMap(mapping) as T;
+        } else {
+          return AdditionalProperties.fromMap(mapping) as T;
+        }
+      } else {
+        return InlineSchemaOptions.fromMap(mapping) as T;
+      }
     }
 
-    switch (T) {
-      case Map:
-        return v.mapValue as T;
-      case bool:
-        return v.boolValue as T;
-      case int:
-        return v.intValue as T;
-      case List:
-        return v.listValue as T;
-      case double:
-        return v.doubleValue as T;
-      case String:
-        return v.stringValue as T;
-      case Set:
-        return v.setValue as T;
-      case Literal:
-        return v.literalValue as T;
-      default:
-        return defaultValue;
+    if (isA(v, Map)) {
+      return v.mapValue.map((key, value) => MapEntry(
+          convertToPropertyValue(key!), convertToPropertyValue(value!))) as T;
+    } else if (isA(v, bool)) {
+      return v.boolValue as T;
+    } else if (isA(v, double)) {
+      return v.doubleValue as T;
+    } else if (isA(v, int)) {
+      return v.intValue as T;
+    } else if (isA(v, String)) {
+      return v.stringValue as T;
+    } else if (isA(v, Set)) {
+      return v.setValue as T;
+    } else if (isA(v, List)) {
+      return v.listValue as T;
+    } else if (isA(v, Enum)) {
+      return v.enumValue();
+    } else {
+      return defaultValue;
     }
   }
 }
+
+bool isA(ConstantReader? v, Type t) =>
+    v?.instanceOf(TypeChecker.fromRuntime(t)) ?? false;