Merge pull request #36 from FlutterGen/error-handling

wasabeef · web-flow · commit 2eae2766177f · 2020-09-12T03:04:28.000+09:00
Handling invalid settings and tests
diff --git a/bin/flutter_gen_command.dart b/bin/flutter_gen_command.dart
@@ -1,7 +1,7 @@
 import 'dart:io';
 
 import 'package:args/args.dart';
-import 'package:flutter_gen/flutter_generator.dart';
+import 'package:flutter_gen/src/flutter_generator.dart';
 import 'package:flutter_gen/src/utils/cast.dart';
 
 void main(List<String> args) {
diff --git a/build.yaml b/build.yaml
@@ -6,7 +6,7 @@ targets:
 
 builders:
   flutter_gen:
-    import: "package:flutter_gen/flutter_generator.dart"
+    import: "package:flutter_gen/build.dart"
     builder_factories: [ "build" ]
     build_extensions: { "$lib$": [ ".gen.dart" ] }
     auto_apply: dependents
diff --git a/lib/build.dart b/lib/build.dart
@@ -0,0 +1,20 @@
+import 'dart:io';
+
+import 'package:build/build.dart';
+
+import 'src/flutter_generator.dart';
+
+Builder build(BuilderOptions options) {
+  Future(() async {
+    await FlutterGenerator(File('pubspec.yaml')).build();
+  });
+  return EmptyBuilder();
+}
+
+class EmptyBuilder extends Builder {
+  @override
+  Future<void> build(BuildStep buildStep) async {}
+
+  @override
+  Map<String, List<String>> get buildExtensions => {};
+}
diff --git a/lib/src/flutter_generator.dart b/lib/src/flutter_generator.dart
@@ -1,29 +1,14 @@
 import 'dart:io';
 
-import 'package:build/build.dart';
 import 'package:dart_style/dart_style.dart';
 import 'package:path/path.dart';
 
-import 'src/generators/assets_generator.dart';
-import 'src/generators/colors_generator.dart';
-import 'src/generators/fonts_generator.dart';
-import 'src/settings/config.dart';
-import 'src/utils/file.dart';
-
-Builder build(BuilderOptions options) {
-  Future(() async {
-    await FlutterGenerator(File('pubspec.yaml')).build();
-  });
-  return EmptyBuilder();
-}
-
-class EmptyBuilder extends Builder {
-  @override
-  Future<void> build(BuildStep buildStep) async {}
-
-  @override
-  Map<String, List<String>> get buildExtensions => {};
-}
+import 'generators/assets_generator.dart';
+import 'generators/colors_generator.dart';
+import 'generators/fonts_generator.dart';
+import 'settings/config.dart';
+import 'utils/error.dart';
+import 'utils/file.dart';
 
 class FlutterGenerator {
   const FlutterGenerator(this.pubspecFile);
@@ -34,12 +19,12 @@ class FlutterGenerator {
     final config = Config(pubspecFile);
     try {
       await config.load();
-    } on FormatException catch (e) {
+    } on InvalidSettingsException catch (e) {
       stderr.writeln(e.message);
-      exit(-1);
+      return;
     } on FileSystemException catch (e) {
       stderr.writeln(e.message);
-      exit(-1);
+      return;
     }
 
     var output = Config.defaultOutput;
diff --git a/lib/src/generators/assets_generator.dart b/lib/src/generators/assets_generator.dart
@@ -2,12 +2,13 @@ import 'dart:collection';
 import 'dart:io';
 
 import 'package:dart_style/dart_style.dart';
-import 'package:path/path.dart';
 import 'package:dartx/dartx.dart';
+import 'package:path/path.dart';
 
 import '../settings/asset_type.dart';
 import '../settings/flutter.dart';
 import '../settings/flutter_gen.dart';
+import '../utils/error.dart';
 import '../utils/string.dart';
 import 'generator_helper.dart';
 import 'integrations/integration.dart';
@@ -19,8 +20,10 @@ String generateAssets(
   FlutterGen flutterGen,
   FlutterAssets assets,
 ) {
-  assert(assets != null && assets.hasAssets,
-      throw 'The value of "flutter/assets:" is incorrect.');
+  if (assets == null || !assets.hasAssets) {
+    throw InvalidSettingsException(
+        'The value of "flutter/assets:" is incorrect.');
+  }
 
   final importsBuffer = StringBuffer();
   final classesBuffer = StringBuffer();
diff --git a/lib/src/generators/colors_generator.dart b/lib/src/generators/colors_generator.dart
@@ -8,15 +8,16 @@ import 'package:xml/xml.dart';
 import '../settings/color_path.dart';
 import '../settings/flutter_gen.dart';
 import '../utils/color.dart';
+import '../utils/error.dart';
 import '../utils/string.dart';
 import 'generator_helper.dart';
 
 String generateColors(
     File pubspecFile, DartFormatter formatter, FlutterGenColors colors) {
-  assert(
-      colors != null, throw 'The value of "flutter_gen/colors:" is incorrect.');
-  assert(colors.hasInputs,
-      throw 'The value of "flutter_gen/colors/inputs:" is incorrect.');
+  if (colors == null || !colors.hasInputs) {
+    throw InvalidSettingsException(
+        'The value of "flutter_gen/colors:" is incorrect.');
+  }
 
   final buffer = StringBuffer();
   buffer.writeln(header);
diff --git a/lib/src/generators/fonts_generator.dart b/lib/src/generators/fonts_generator.dart
@@ -4,12 +4,15 @@ import 'package:yaml/yaml.dart';
 
 import '../settings/flutter.dart';
 import '../utils/cast.dart';
+import '../utils/error.dart';
 import '../utils/string.dart';
 import 'generator_helper.dart';
 
 String generateFonts(DartFormatter formatter, FlutterFonts fonts) {
-  assert(fonts != null && fonts.hasFonts,
-      throw 'The value of "flutter/fonts:" is incorrect.');
+  if (fonts == null || !fonts.hasFonts) {
+    throw InvalidSettingsException(
+        'The value of "flutter/fonts:" is incorrect.');
+  }
 
   final buffer = StringBuffer();
   buffer.writeln(header);
diff --git a/lib/src/settings/config.dart b/lib/src/settings/config.dart
@@ -4,6 +4,7 @@ import 'package:path/path.dart';
 import 'package:yaml/yaml.dart';
 
 import '../utils/cast.dart';
+import '../utils/error.dart';
 import 'flutter.dart';
 import 'flutter_gen.dart';
 
@@ -29,7 +30,7 @@ class Config {
           'Cannot open pubspec.yaml: ${pubspecFile.absolute}');
     });
     if (pubspec.isEmpty) {
-      throw const FormatException('pubspec.yaml is empty');
+      throw const InvalidSettingsException('pubspec.yaml is empty');
     }
 
     final properties = safeCast<YamlMap>(loadYaml(pubspec));
@@ -42,7 +43,7 @@ class Config {
     }
 
     if (!hasFlutter && !hasFlutterGen) {
-      throw const FormatException('FlutterGen settings not founded.');
+      throw const InvalidSettingsException('FlutterGen settings not founded.');
     }
 
     return this;
diff --git a/lib/src/settings/flutter_gen.dart b/lib/src/settings/flutter_gen.dart
@@ -44,7 +44,7 @@ class FlutterGen {
 
   FlutterGenColors colors;
 
-  bool get hasColors => colors != null;
+  bool get hasColors => colors != null && colors.hasInputs;
 }
 
 class FlutterGenColors {
diff --git a/lib/src/utils/error.dart b/lib/src/utils/error.dart
@@ -0,0 +1,5 @@
+class InvalidSettingsException implements Exception {
+  const InvalidSettingsException(this.message);
+
+  final String message;
+}
diff --git a/test/assets_gen_test.dart b/test/assets_gen_test.dart
@@ -0,0 +1,105 @@
+@TestOn('vm')
+import 'dart:io';
+
+import 'package:dart_style/dart_style.dart';
+import 'package:flutter_gen/src/flutter_generator.dart';
+import 'package:flutter_gen/src/generators/assets_generator.dart';
+import 'package:flutter_gen/src/settings/config.dart';
+import 'package:flutter_gen/src/utils/error.dart';
+import 'package:test/test.dart';
+
+void main() {
+  setUp(() {
+    final dir = Directory('test_resources/lib/gen/assets.gen.dart');
+
+    if (dir.existsSync()) {
+      dir.deleteSync(recursive: true);
+    }
+  });
+
+  group('Test Assets generator', () {
+    test('Assets on pubspec.yaml', () async {
+      final pubspec = File('test_resources/pubspec_assets.yaml');
+      final config = await Config(pubspec).load();
+      final formatter = DartFormatter(
+          pageWidth: config.flutterGen.lineLength, lineEnding: '\n');
+
+      final actual = generateAssets(
+          pubspec, formatter, config.flutterGen, config.flutter.assets);
+      final expected = File('test_resources/actual_data/assets.gen.dart')
+          .readAsStringSync()
+          .replaceAll('\r\n', '\n');
+
+      expect(actual, expected);
+    });
+
+    test('Assets snake-case style on pubspec.yaml', () async {
+      final pubspec = File('test_resources/pubspec_assets_snake_case.yaml');
+      final config = await Config(pubspec).load();
+      final formatter = DartFormatter(
+          pageWidth: config.flutterGen.lineLength, lineEnding: '\n');
+
+      final actual = generateAssets(
+          pubspec, formatter, config.flutterGen, config.flutter.assets);
+      final expected =
+          File('test_resources/actual_data/assets_snake_case.gen.dart')
+              .readAsStringSync()
+              .replaceAll('\r\n', '\n');
+
+      expect(actual, expected);
+    });
+
+    test('Assets camel-case style on pubspec.yaml', () async {
+      final pubspec = File('test_resources/pubspec_assets_camel_case.yaml');
+      final config = await Config(pubspec).load();
+      final formatter = DartFormatter(
+          pageWidth: config.flutterGen.lineLength, lineEnding: '\n');
+
+      final actual = generateAssets(
+          pubspec, formatter, config.flutterGen, config.flutter.assets);
+      final expected =
+          File('test_resources/actual_data/assets_camel_case.gen.dart')
+              .readAsStringSync()
+              .replaceAll('\r\n', '\n');
+
+      expect(actual, expected);
+    });
+
+    test('Assets with No integrations on pubspec.yaml', () async {
+      await FlutterGenerator(
+              File('test_resources/pubspec_assets_no_integrations.yaml'))
+          .build();
+      expect(
+        File('test_resources/lib/gen/assets.gen.dart').readAsStringSync(),
+        isNotEmpty,
+      );
+
+      final pubspec =
+          File('test_resources/pubspec_assets_no_integrations.yaml');
+      final config = await Config(pubspec).load();
+      final formatter = DartFormatter(
+          pageWidth: config.flutterGen.lineLength, lineEnding: '\n');
+
+      final actual = generateAssets(
+          pubspec, formatter, config.flutterGen, config.flutter.assets);
+      final expected =
+          File('test_resources/actual_data/assets_no_integrations.gen.dart')
+              .readAsStringSync()
+              .replaceAll('\r\n', '\n');
+
+      expect(actual, expected);
+    });
+
+    test('Assets with No lists on pubspec.yaml', () async {
+      final pubspec = File('test_resources/pubspec_assets_no_list.yaml');
+      final config = await Config(pubspec).load();
+      final formatter = DartFormatter(
+          pageWidth: config.flutterGen.lineLength, lineEnding: '\n');
+
+      expect(() async {
+        return generateAssets(
+            pubspec, formatter, config.flutterGen, config.flutter.assets);
+      }, throwsA(isA<InvalidSettingsException>()));
+    });
+  });
+}
diff --git a/test/colors_gen_test.dart b/test/colors_gen_test.dart
@@ -0,0 +1,57 @@
+@TestOn('vm')
+import 'dart:io';
+
+import 'package:dart_style/dart_style.dart';
+import 'package:flutter_gen/src/generators/colors_generator.dart';
+import 'package:flutter_gen/src/settings/config.dart';
+import 'package:flutter_gen/src/utils/error.dart';
+import 'package:test/test.dart';
+
+void main() {
+  setUp(() {
+    final dir = Directory('test_resources/lib/gen/colors.gen.dart');
+
+    if (dir.existsSync()) {
+      dir.deleteSync(recursive: true);
+    }
+  });
+
+  group('Test Color generator', () {
+    test('Colors on pubspec.yaml', () async {
+      final pubspec = File('test_resources/pubspec_colors.yaml');
+      final config = await Config(pubspec).load();
+      final formatter = DartFormatter(
+          pageWidth: config.flutterGen.lineLength, lineEnding: '\n');
+
+      final actual =
+          generateColors(pubspec, formatter, config.flutterGen.colors);
+      final expected = File('test_resources/actual_data/colors.gen.dart')
+          .readAsStringSync()
+          .replaceAll('\r\n', '\n');
+
+      expect(actual, expected);
+    });
+
+    test('Wrong colors settings on pubspec.yaml', () async {
+      final pubspec = File('test_resources/pubspec_colors_no_inputs.yaml');
+      final config = await Config(pubspec).load();
+      final formatter = DartFormatter(
+          pageWidth: config.flutterGen.lineLength, lineEnding: '\n');
+
+      expect(() async {
+        return generateColors(pubspec, formatter, config.flutterGen.colors);
+      }, throwsA(isA<InvalidSettingsException>()));
+    });
+
+    test('Wrong colors settings on pubspec.yaml', () async {
+      final pubspec = File('test_resources/pubspec_colors_no_inputs_list.yaml');
+      final config = await Config(pubspec).load();
+      final formatter = DartFormatter(
+          pageWidth: config.flutterGen.lineLength, lineEnding: '\n');
+
+      expect(() async {
+        return generateColors(pubspec, formatter, config.flutterGen.colors);
+      }, throwsA(isA<InvalidSettingsException>()));
+    });
+  });
+}
diff --git a/test/flutter_gen_test.dart b/test/flutter_gen_test.dart
diff --git a/test/fonts_gen_test.dart b/test/fonts_gen_test.dart
diff --git a/test_resources/pubspec_assets_no_list.yaml b/test_resources/pubspec_assets_no_list.yaml
diff --git a/test_resources/pubspec_colors_no_inputs.yaml b/test_resources/pubspec_colors_no_inputs.yaml
diff --git a/test_resources/pubspec_colors_no_inputs_list.yaml b/test_resources/pubspec_colors_no_inputs_list.yaml
diff --git a/test_resources/pubspec_fonts_no_family.yaml b/test_resources/pubspec_fonts_no_family.yaml

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@ import 'package:path/path.dart';`
`4`	`4`	`import 'package:yaml/yaml.dart';`
`5`	`5`
`6`	`6`	`import '../utils/cast.dart';`
	`7`	`+import '../utils/error.dart';`
`7`	`8`	`import 'flutter.dart';`
`8`	`9`	`import 'flutter_gen.dart';`
`9`	`10`
`@@ -29,7 +30,7 @@ class Config {`
`29`	`30`	`'Cannot open pubspec.yaml: ${pubspecFile.absolute}');`
`30`	`31`	`});`
`31`	`32`	`if (pubspec.isEmpty) {`
`32`		`- throw const FormatException('pubspec.yaml is empty');`
	`33`	`+ throw const InvalidSettingsException('pubspec.yaml is empty');`
`33`	`34`	`}`
`34`	`35`
`35`	`36`	`final properties = safeCast<YamlMap>(loadYaml(pubspec));`
`@@ -42,7 +43,7 @@ class Config {`
`42`	`43`	`}`
`43`	`44`
`44`	`45`	`if (!hasFlutter && !hasFlutterGen) {`
`45`		`- throw const FormatException('FlutterGen settings not founded.');`
	`46`	`+ throw const InvalidSettingsException('FlutterGen settings not founded.');`
`46`	`47`	`}`
`47`	`48`
`48`	`49`	`return this;`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ class FlutterGen {`
`44`	`44`
`45`	`45`	`FlutterGenColors colors;`
`46`	`46`
`47`		`- bool get hasColors => colors != null;`
	`47`	`+ bool get hasColors => colors != null && colors.hasInputs;`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`class FlutterGenColors {`