refactor(annotations): changed inputspec methods to be more descriptive

BREAKING CHANGE: changed Inputspec.empty to Inputspec.json
  changed Inputspec.emptyYaml to Inputspec.yaml

Author: gibahjoe

example/lib/main.dart

@@ -10,6 +10,7 @@ void main() {
   additionalProperties:
       DioProperties(pubName: 'petstore_api', pubAuthor: 'Johnny dep..'),
   inputSpecFile: 'openapi-spec.yaml',
+  inputSpec: InputSpec(path: 'openapi-spec.yaml'),
   typeMappings: {'Pet': 'ExamplePet'},
   generatorName: Generator.dio,
   runSourceGenOnOutput: true,

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

@@ -152,7 +152,7 @@ class Openapi {
     this.additionalProperties,
     this.overwriteExistingFiles,
     this.skipSpecValidation = false,
-    required this.inputSpecFile,
+    @Deprecated('To be removed in the next major') required this.inputSpecFile,
     this.inputSpec,
     this.templateDirectory,
     required this.generatorName,
@@ -179,30 +179,18 @@ class Openapi {
 /// Includes the option to use the default json or yaml paths.
 class InputSpec {
   final String path;
-  final bool defaultYaml;
-  final bool useYml;
 
-  const InputSpec({String? path, this.defaultYaml = true, this.useYml = false})
-      : path = path ??
-            'openapi.${defaultYaml ? 'y${useYml ? '' : 'a'}ml' : 'json'}';
+  const InputSpec({required this.path});
 
-  const InputSpec.empty() : this();
+  const InputSpec.json() : this(path: 'openapi.json');
 
-  const InputSpec.emptyJson() : this(defaultYaml: false);
-  const InputSpec.emptyYml() : this(useYml: true);
+  const InputSpec.yaml({bool shortExtension = false})
+      : this(path: 'openapi.y${shortExtension ? '' : 'a'}ml');
 
-  Map<String, dynamic> toJsonMap() => {
-        'path': path,
-        'defaultYaml': defaultYaml,
-        'useYml': useYml,
-      };
+  Map<String, dynamic> toJsonMap() => {'path': path};
 
   InputSpec.fromMap(Map<String, dynamic> map)
-      : this(
-          path: map['path'],
-          defaultYaml: map['defaultYaml'] == 'true' ? true : false,
-          useYml: map['useYml'] == 'true' ? true : false,
-        );
+      : this(path: map['path']);
 }
 
 /// Provides the location for the remote specification.

openapi-generator-annotations/test/openapi_generator_annotations_test.dart

@@ -9,15 +9,15 @@ void main() {
   group('OpenApi', () {
     test('defaults', () {
       final props = Openapi(
-        inputSpecFile: InputSpec.empty().path,
-        inputSpec: InputSpec.empty(),
+        inputSpecFile: InputSpec.json().path,
+        inputSpec: InputSpec.json(),
         generatorName: Generator.dart,
       );
       expect(props.additionalProperties, isNull);
       expect(props.overwriteExistingFiles, isNull);
       expect(props.skipSpecValidation, false);
-      expect(props.inputSpecFile, InputSpec.empty().path);
-      expect(props.inputSpec!.path, InputSpec.empty().path);
+      expect(props.inputSpecFile, InputSpec.json().path);
+      expect(props.inputSpec!.path, InputSpec.json().path);
       expect(props.templateDirectory, isNull);
       expect(props.generatorName, Generator.dart);
       expect(props.outputDirectory, isNull);
@@ -37,49 +37,45 @@ void main() {
     group('NextGen', () {
       test('Sets cachePath', () {
         final api = Openapi(
-            inputSpecFile: InputSpec.empty().path,
+            inputSpecFile: InputSpec.json().path,
             generatorName: Generator.dart,
             cachePath: 'somePath');
         expect(api.cachePath, 'somePath');
       });
       test('Sets useNextGenFlag', () {
         final api = Openapi(
-            inputSpecFile: InputSpec.empty().path,
+            inputSpecFile: InputSpec.json().path,
             generatorName: Generator.dart,
             useNextGen: true);
         expect(api.useNextGen, isTrue);
       });
       test('Sets projectPubspecPath', () {
         final api = Openapi(
-            inputSpecFile: InputSpec.empty().path,
+            inputSpecFile: InputSpec.json().path,
             generatorName: Generator.dart,
             projectPubspecPath: 'test');
         expect(api.projectPubspecPath, 'test');
       });
       test('Set debug logging', () {
         final api = Openapi(
-            inputSpecFile: InputSpec.empty().path,
-            inputSpec: InputSpec.empty(),
+            inputSpecFile: InputSpec.json().path,
+            inputSpec: InputSpec.json(),
             generatorName: Generator.dart,
             debugLogging: true);
         expect(api.debugLogging, isTrue);
       });
       group('InputSpec', () {
         group('local spec', () {
           test('provides default yaml path', () {
-            expect(InputSpec.empty().path, 'openapi.yaml');
-            expect(InputSpec.empty().defaultYaml, isTrue);
-            expect(InputSpec.empty().useYml, isFalse);
+            expect(InputSpec.yaml().path, 'openapi.yaml');
+            expect(InputSpec.yaml(shortExtension: true).path, 'openapi.yml');
           });
           test('provides default yml path', () {
-            expect(InputSpec.emptyYml().path, 'openapi.yml');
-            expect(InputSpec.emptyYml().defaultYaml, isTrue);
-            expect(InputSpec.emptyYml().useYml, isTrue);
+            expect(InputSpec.yaml(shortExtension: true).path, 'openapi.yml');
+            expect(InputSpec.yaml(shortExtension: false).path, 'openapi.yaml');
           });
           test('provides default json path', () {
-            expect(InputSpec.emptyJson().path, 'openapi.json');
-            expect(InputSpec.emptyJson().defaultYaml, isFalse);
-            expect(InputSpec.emptyJson().useYml, isFalse);
+            expect(InputSpec.json().path, 'openapi.json');
           });
           test('uses path', () {
             expect(InputSpec(path: 'path').path, 'path');

openapi-generator/lib/src/models/generator_arguments.dart

@@ -117,7 +117,7 @@ class GeneratorArguments {
     required src_gen.ConstantReader annotations,
     bool alwaysRun = false,
     String inputSpecFile = '',
-    InputSpec inputSpec = const InputSpec.empty(),
+    InputSpec inputSpec = const InputSpec.json(),
     String templateDirectory = '',
     Generator generator = Generator.dart,
     Map<String, String> typeMapping = const {},

openapi-generator/pubspec.yaml

@@ -24,3 +24,7 @@ dev_dependencies:
   source_gen_test:
   pedantic:
   coverage: ^1.6.3
+
+dependency_overrides:
+  openapi_generator_annotations:
+    path: ../openapi-generator-annotations