💥 (fonts_loader) remove loadAppFonts and package argument from loadFonts

bamlab · Sep 22, 2024 · cb232d0 · cb232d0
1 parent 193a7b1
commit cb232d0
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 128 deletions.
diff --git a/example/multi_packages_app/app/test/flutter_test_config.dart b/example/multi_packages_app/app/test/flutter_test_config.dart
@@ -17,7 +17,7 @@ Future<void> testExecutable(FutureOr<void> Function() testMain) async {
   AdaptiveTestConfiguration.instance
     ..setEnforcedTestPlatform(TargetPlatform.macOS)
     ..setDeviceVariants(defaultDeviceConfigs);
-  await loadAppFonts();
+  await loadFonts();
   const m1IntelDifferenceThreshold = 0.2 / 100; // 0.2%
   setupFileComparatorWithThreshold(m1IntelDifferenceThreshold);
   await testMain();

diff --git a/example/multi_packages_app/theme/test/flutter_test_config.dart b/example/multi_packages_app/theme/test/flutter_test_config.dart
@@ -17,7 +17,7 @@ Future<void> testExecutable(FutureOr<void> Function() testMain) async {
   AdaptiveTestConfiguration.instance
     ..setEnforcedTestPlatform(TargetPlatform.macOS)
     ..setDeviceVariants(defaultDeviceConfigs);
-  await loadAppFonts();
+  await loadFonts();
   const m1IntelDifferenceThreshold = 0.2 / 100; // 0.2%
   setupFileComparatorWithThreshold(m1IntelDifferenceThreshold);
   await testMain();

diff --git a/example/simple_app/test/flutter_test_config.dart b/example/simple_app/test/flutter_test_config.dart
@@ -17,7 +17,7 @@ Future<void> testExecutable(FutureOr<void> Function() testMain) async {
   AdaptiveTestConfiguration.instance
     ..setEnforcedTestPlatform(TargetPlatform.macOS)
     ..setDeviceVariants(defaultDeviceConfigs);
-  await loadAppFonts();
+  await loadFonts();
   const m1IntelDifferenceThreshold = 0.2 / 100; // 0.2%
   setupFileComparatorWithThreshold(m1IntelDifferenceThreshold);
   await testMain();

diff --git a/lib/src/helpers/fonts_loader.dart b/lib/src/helpers/fonts_loader.dart
@@ -1,106 +1,22 @@
 // ignore_for_file: avoid-dynamic, avoid-accessing-collections-by-constant-index
 
 import 'dart:convert';
-import 'dart:io';
 
-import 'package:file/file.dart' as f;
-import 'package:file/local.dart' as l;
 import 'package:flutter/services.dart';
 import 'package:flutter_test/flutter_test.dart';
-import 'package:meta/meta.dart';
-import 'package:path/path.dart' as path;
-import 'package:platform/platform.dart' as p;
 
-/// A class representing a package within a multi-packages app
-class Package {
-  /// Creates a new [Package] instance.
-  /// Either [name] or [relativePath] must be provided.
-  Package({this.name, this.relativePath})
-      : assert(name != null || relativePath != null);
-
-  /// This is the name of the package as defined in the pubspec.yaml file
-  final String? name;
-
-  /// This is the path to the package relative to where the test is run from.
-  final String? relativePath;
-}
-
-/// Load fonts to make sure they show up in golden tests.
+/// Load fonts and icons to make sure they show up in golden tests.
 ///
 /// To use it efficiently:
 /// * Create a flutter_test_config.dart file. See:
 /// https://api.flutter.dev/flutter/flutter_test/flutter_test-library.html
 /// * add `await loadFonts();` in the `testExecutable` function.
 ///
-/// *Note* for this function to work, your package needs to include all fonts
-/// it uses in a font dir at the root of the project.
-@Deprecated("Use [loadAppFonts] instead")
-Future<void> loadFonts([String? package]) {
-  return package != null
-      ? loadFontsFromPackage(
-          package: Package(name: package, relativePath: './$package'),
-        )
-      : loadFontsFromPackage();
-}
-
-/// Load fonts from a given package to make sure they show up in golden tests.
-///
-/// To use it efficiently:
-/// * Create a flutter_test_config.dart file. See:
-/// https://api.flutter.dev/flutter/flutter_test/flutter_test-library.html
-/// * add `await loadFontsFromPackage(Package(name: 'my_theme', relativePath: './theme'));` in the `testExecutable` function.
-///
-/// *Note* for this function to work, your given package needs to include all fonts
-/// it uses in a font dir at the root of the project referenced by the given [package] argument.
-/// If no [package] is provided, it will look for a fonts dir at the root of the project.
-/// If a [package] is provided with a [Package.relativePath] it will look for a fonts dir with the package located at that path
-/// If a [package] is provided with a [Package.name] it will prefix the fonts dir with `packages/[package.name]`
-@Deprecated("Use [loadAppFonts] instead")
-Future<void> loadFontsFromPackage({Package? package}) async {
-  TestWidgetsFlutterBinding.ensureInitialized();
-  await _load(loadFontsFromFontsDir(package));
-  await _loadMaterialIconFont();
-}
-
-/// Assumes a fonts dir in root of project
-@visibleForTesting
-Map<String, List<Future<ByteData>>> loadFontsFromFontsDir([Package? package]) {
-  final fontFamilyToData = <String, List<Future<ByteData>>>{};
-  final currentDir = path.dirname(Platform.script.path);
-  final fontsDirectory = path.join(
-    currentDir,
-    package == null || package.relativePath == null
-        ? 'fonts'
-        : '${package.relativePath}/fonts',
-  );
-  final prefix = package == null || package.name == null
-      ? ''
-      : 'packages/${package.name}/';
-  for (final file in Directory(fontsDirectory).listSync()) {
-    if (file is File) {
-      final fontFamily = prefix +
-          (path.basenameWithoutExtension(file.path).split('-').firstOrNull ??
-              '');
-      (fontFamilyToData[fontFamily] ??= []).add(_fileToByteData(file));
-    }
-  }
-
-  return fontFamilyToData;
-}
-
-Future<ByteData> _fileToByteData(File file) async {
-  final bytes = await file.readAsBytes();
-
-  return ByteData.view(bytes.buffer);
-}
-
-/// Load fonts and icons to make sure they show up in golden tests.
+/// /// Load fonts to make sure they show up in golden tests.
 ///
-/// To use it efficiently:
-/// * Create a flutter_test_config.dart file. See:
-/// https://api.flutter.dev/flutter/flutter_test/flutter_test-library.html
-/// * add `await loadAppFonts();` in the `testExecutable` function.
-Future<void> loadAppFonts() async {
+/// *Note* for this function to work, your package needs to include all fonts
+/// it uses az assets.
+Future<void> loadFonts() async {
   TestWidgetsFlutterBinding.ensureInitialized();
 
   final fontManifest = await rootBundle.loadStructuredData<Iterable<dynamic>>(
@@ -118,39 +34,3 @@ Future<void> loadAppFonts() async {
   }
   await Future.wait(waitList);
 }
-
-Future<void> _load(Map<String, List<Future<ByteData>>> fontFamilyToData) async {
-  final waitList = <Future<void>>[];
-  for (final entry in fontFamilyToData.entries) {
-    final loader = FontLoader(entry.key);
-    for (final data in entry.value) {
-      loader.addFont(data);
-    }
-    waitList.add(loader.load());
-  }
-  await Future.wait(waitList);
-}
-
-// Loads the cached material icon font.
-// Only necessary for golden tests. Relies on the tool updating cached assets
-// before running tests.
-Future<void> _loadMaterialIconFont() async {
-  const f.FileSystem fs = l.LocalFileSystem();
-  const p.Platform platform = p.LocalPlatform();
-  final flutterRoot = fs.directory(platform.environment['FLUTTER_ROOT']);
-
-  final iconFont = flutterRoot.childFile(
-    fs.path.join(
-      'bin',
-      'cache',
-      'artifacts',
-      'material_fonts',
-      'MaterialIcons-Regular.otf',
-    ),
-  );
-
-  final bytes =
-      Future<ByteData>.value(iconFont.readAsBytesSync().buffer.asByteData());
-
-  await (FontLoader('MaterialIcons')..addFont(bytes)).load();
-}