Fixed bug that was preventing copying of dark background. Fixes #163.…

… Updated pubspec.yaml to show which platforms are supported.
jonbhanson · Apr 20, 2021 · e310c3f · e310c3f
1 parent b35fdf5
commit e310c3f
Show file tree

Hide file tree

Showing 13 changed files with 203 additions and 245 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+## [1.1.8] - (2021-Apr-20)
+
+* Fixed bug that was preventing copying of dark background.  Fixes [#163](https://github.com/jonbhanson/flutter_native_splash/issues/163).
+* Updated pubspec.yaml to show which platforms are supported.
+
 ## [1.1.7+1] - (2021-Apr-02)
 
 * flutter_native_splash:remove adheres to android/ios/web setting.  Fixes [#159](https://github.com/jonbhanson/flutter_native_splash/issues/159).

diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ First, add `flutter_native_splash` as a dev dependency in your pubspec.yaml file
 
 ```yaml
 dev_dependencies:
-  flutter_native_splash: ^1.1.7+1
+  flutter_native_splash: ^1.1.8
 ```
 
 Don't forget to `flutter pub get`.

diff --git a/ios.mp4 b/ios.mp4
diff --git a/lib/android.dart b/lib/android.dart
@@ -1,4 +1,4 @@
-part of flutter_native_splash_supported_platform;
+part of flutter_native_splash;
 
 /// Image template
 class _AndroidDrawableTemplate {

diff --git a/lib/constants.dart b/lib/constants.dart
@@ -1,4 +1,4 @@
-part of flutter_native_splash_supported_platform;
+part of flutter_native_splash;
 
 // Android-related constants
 const String _androidResFolder = 'android/app/src/main/res/';

diff --git a/lib/flutter_native_splash.dart b/lib/flutter_native_splash.dart
@@ -3,26 +3,190 @@
 /// This is the main entry point for the Flutter Native Splash package.
 library flutter_native_splash;
 
-/*
- pub.dev will give lower pub points for not supporting multiple platforms.
- Since create_splash makes use of dart:io which does not support JS,
- only import create_splash on platforms that support io.  For other platforms,
- throw an unsupported exception.
- */
-import 'unsupported_platform.dart' // Stub implementation
-    if (dart.library.io) 'supported_platform.dart'; // dart:io implementation
+import 'dart:io';
+
+import 'package:image/image.dart';
+import 'package:meta/meta.dart';
+import 'package:xml/xml.dart';
+import 'package:yaml/yaml.dart';
+
+part 'android.dart';
+part 'constants.dart';
+part 'ios.dart';
+part 'templates.dart';
+part 'web.dart';
 
 /// Create splash screens for Android and iOS
 void createSplash() {
-  tryCreateSplash();
+  var config = getConfig();
+  checkConfig(config);
+  createSplashByConfig(config);
 }
 
 /// Create splash screens for Android and iOS based on a config argument
 void createSplashByConfig(Map<String, dynamic> config) {
-  tryCreateSplashByConfig(config);
+  var image = checkImageExists(config: config, parameter: 'image');
+  var darkImage = checkImageExists(config: config, parameter: 'image_dark');
+  var color = parseColor(config['color']);
+  var darkColor = parseColor(config['color_dark']);
+  var backgroundImage =
+      checkImageExists(config: config, parameter: 'background_image');
+  var darkBackgroundImage =
+      checkImageExists(config: config, parameter: 'background_image_dark');
+  var plistFiles = config['info_plist_files'];
+  var gravity = (config['fill'] ?? false) ? 'fill' : 'center';
+  if (config['android_gravity'] != null) gravity = config['android_gravity'];
+  bool fullscreen = config['fullscreen'] ?? false;
+  String iosContentMode = config['ios_content_mode'] ?? 'center';
+  final webImageMode = (config['web_image_mode'] ?? 'center');
+
+  if (!config.containsKey('android') || config['android']) {
+    _createAndroidSplash(
+      imagePath: image,
+      darkImagePath: darkImage,
+      backgroundImage: backgroundImage,
+      darkBackgroundImage: darkBackgroundImage,
+      color: color,
+      darkColor: darkColor,
+      gravity: gravity,
+      fullscreen: fullscreen,
+    );
+  }
+
+  if (!config.containsKey('ios') || config['ios']) {
+    _createiOSSplash(
+      imagePath: image,
+      darkImagePath: darkImage,
+      backgroundImage: backgroundImage,
+      darkBackgroundImage: darkBackgroundImage,
+      color: color,
+      darkColor: darkColor,
+      plistFiles: plistFiles,
+      iosContentMode: iosContentMode,
+      fullscreen: fullscreen,
+    );
+  }
+
+  if (!config.containsKey('web') || config['web']) {
+    _createWebSplash(
+        imagePath: image,
+        darkImagePath: darkImage,
+        backgroundImage: backgroundImage,
+        darkBackgroundImage: darkBackgroundImage,
+        color: color,
+        darkColor: darkColor,
+        imageMode: webImageMode);
+  }
+
+  print('');
+  print('Native splash complete. 👍');
+  print('Now go finish building something awesome! 💪 You rock! 🤘🤩');
 }
 
 /// Remove any splash screen by setting the default white splash
 void removeSplash() {
-  tryRemoveSplash();
+  print('Restoring Flutter\'s default white native splash screen...');
+  var config = getConfig();
+
+  var removeConfig = <String, dynamic>{'color': '#ffffff'};
+  if (config.containsKey('android')) {
+    removeConfig['android'] = config['android'];
+  }
+  if (config.containsKey('ios')) {
+    removeConfig['ios'] = config['ios'];
+  }
+  if (config.containsKey('web')) {
+    removeConfig['web'] = config['web'];
+  }
+  createSplashByConfig(removeConfig);
+}
+
+String checkImageExists(
+    {required Map<String, dynamic> config, required String parameter}) {
+  String image = config[parameter] ?? '';
+  if (image.isNotEmpty && !File(image).existsSync()) {
+    print('The file "$image" set as the parameter "$parameter" was not found.');
+    exit(1);
+  }
+  return image;
+}
+
+/// Get config from `pubspec.yaml` or `flutter_native_splash.yaml`
+Map<String, dynamic> getConfig({String? configFile}) {
+  // if `flutter_native_splash.yaml` exists use it as config file, otherwise use `pubspec.yaml`
+  String filePath;
+  if (configFile != null && File(configFile).existsSync()) {
+    filePath = configFile;
+  } else if (File('flutter_native_splash.yaml').existsSync()) {
+    filePath = 'flutter_native_splash.yaml';
+  } else {
+    filePath = 'pubspec.yaml';
+  }
+
+  final Map yamlMap = loadYaml(File(filePath).readAsStringSync());
+
+  if (!(yamlMap['flutter_native_splash'] is Map)) {
+    throw Exception('Your `$filePath` file does not contain a '
+        '`flutter_native_splash` section.');
+  }
+
+  // yamlMap has the type YamlMap, which has several unwanted side effects
+  final config = <String, dynamic>{};
+  for (MapEntry<dynamic, dynamic> entry
+      in yamlMap['flutter_native_splash'].entries) {
+    if (entry.value is YamlList) {
+      var list = <String>[];
+      (entry.value as YamlList).forEach((dynamic value) {
+        if (value is String) {
+          list.add(value);
+        }
+      });
+      config[entry.key] = list;
+    } else {
+      config[entry.key] = entry.value;
+    }
+  }
+  return config;
+}
+
+void checkConfig(Map<String, dynamic> config) {
+  if (config.containsKey('color') && config.containsKey('background_image')) {
+    print('Your `flutter_native_splash` section cannot not contain both a '
+        '`color` and `background_image`.');
+    exit(1);
+  }
+
+  if (!config.containsKey('color') && !config.containsKey('background_image')) {
+    print('Your `flutter_native_splash` section does not contain a `color` or '
+        '`background_image`.');
+    exit(1);
+  }
+
+  if (config.containsKey('color_dark') &&
+      config.containsKey('background_image_dark')) {
+    print('Your `flutter_native_splash` section cannot not contain both a '
+        '`color_dark` and `background_image_dark`.');
+    exit(1);
+  }
+
+  if (config.containsKey('image_dark') &&
+      !config.containsKey('color_dark') &&
+      !config.containsKey('background_image_dark')) {
+    print('Your `flutter_native_splash` section contains `image_dark` but '
+        'does not contain a `color_dark` or a `background_image_dark`.');
+    exit(1);
+  }
+}
+
+@visibleForTesting
+String parseColor(var color) {
+  if (color is int) color = color.toString().padLeft(6, '0');
+
+  if (color is String) {
+    color = color.replaceAll('#', '').replaceAll(' ', '');
+    if (color.length == 6) return color;
+  }
+  if (color == null) return '';
+
+  throw Exception('Invalid color value');
 }
diff --git a/lib/ios.dart b/lib/ios.dart
@@ -1,4 +1,4 @@
-part of flutter_native_splash_supported_platform;
+part of flutter_native_splash;
 
 // Image template
 class _IosLaunchImageTemplate {
@@ -269,7 +269,7 @@ void _createBackground({
   } else if (darkBackgroundImageSource.isNotEmpty) {
     // Copy will not work if the directory does not exist, so createSync
     // will ensure that the directory exists.
-    File(darkBackgroundImageSource).createSync(recursive: true);
+    File(darkBackgroundImageDestination).createSync(recursive: true);
     File(darkBackgroundImageSource).copySync(darkBackgroundImageDestination);
   } else {
     final file = File(darkBackgroundImageDestination);