refactor: parsing to reuse logic

java-james · java-james · commit eb5e408beda2 · 2026-04-21T12:54:36.000+10:00
diff --git a/example/pubspec.lock b/example/pubspec.lock
@@ -68,7 +68,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "6.0.0"
+    version: "6.0.1"
   flutter_lints:
     dependency: "direct dev"
     description:
diff --git a/lib/src/dotenv.dart b/lib/src/dotenv.dart
@@ -1,6 +1,5 @@
 import 'dart:async';
 
-import 'package:flutter/material.dart';
 import 'package:flutter/services.dart' show rootBundle;
 import 'package:flutter/widgets.dart';
 
@@ -35,7 +34,7 @@ class DotEnv {
   bool _isInitialized = false;
   final Map<String, String> _envMap = {};
 
-  /// A copy of variables loaded at runtime from a file + any entries from mergeWith when loaded.
+  /// Variables loaded at runtime from a file + any entries from mergeWith when loaded.
   Map<String, String> get env {
     if (!_isInitialized) {
       throw NotInitializedError();
@@ -60,62 +59,42 @@ class DotEnv {
     return value;
   }
 
-  /// Load the enviroment variable value as an [int]
-  ///
-  /// If variable with [name] does not exist then [fallback] will be used.
-  /// However if also no [fallback] is supplied an error will occur.
-  ///
-  /// Furthermore an [FormatException] will be thrown if the variable with [name]
-  /// exists but can not be parsed as an [int].
-  int getInt(String name, {int? fallback}) {
-    final value = maybeGet(name);
-    if (value == null && fallback == null) {
-      throw AssertionError(
-          '$name variable not found. A non-null fallback is required for missing entries');
-    }
-    return value != null ? int.parse(value) : fallback!;
-  }
+  /// Throws [AssertionError] if not found and no [fallback] given.
+  /// Throws [FormatException] if found but not parseable.
+  int getInt(String name, {int? fallback}) =>
+      _getTyped(name, fallback, int.parse);
+
+  /// Throws [AssertionError] if not found and no [fallback] given.
+  /// Throws [FormatException] if found but not parseable.
+  double getDouble(String name, {double? fallback}) =>
+      _getTyped(name, fallback, double.parse);
+
+  /// Accepts `true`/`1` and `false`/`0` (case-insensitive).
+  /// Throws [AssertionError] if not found and no [fallback] given.
+  /// Throws [FormatException] if found but not parseable.
+  bool getBool(String name, {bool? fallback}) =>
+      _getTyped(name, fallback, _parseBool);
 
-  /// Load the enviroment variable value as a [double]
-  ///
-  /// If variable with [name] does not exist then [fallback] will be used.
-  /// However if also no [fallback] is supplied an error will occur.
-  ///
-  /// Furthermore an [FormatException] will be thrown if the variable with [name]
-  /// exists but can not be parsed as a [double].
-  double getDouble(String name, {double? fallback}) {
+  T _getTyped<T>(String name, T? fallback, T Function(String) parse) {
     final value = maybeGet(name);
     if (value == null && fallback == null) {
       throw AssertionError(
           '$name variable not found. A non-null fallback is required for missing entries');
     }
-    return value != null ? double.parse(value) : fallback!;
+    return value != null ? parse(value) : fallback!;
   }
 
-  /// Load the enviroment variable value as a [bool]
-  ///
-  /// If variable with [name] does not exist then [fallback] will be used.
-  /// However if also no [fallback] is supplied an error will occur.
-  ///
-  /// Furthermore an [FormatException] will be thrown if the variable with [name]
-  /// exists but can not be parsed as a [bool].
-  bool getBool(String name, {bool? fallback}) {
-    final value = maybeGet(name);
-    if (value == null && fallback == null) {
-      throw AssertionError(
-          '$name variable not found. A non-null fallback is required for missing entries');
-    }
-    if (value != null) {
-      if (['true', '1'].contains(value.toLowerCase())) {
+  static bool _parseBool(String value) {
+    switch (value.toLowerCase()) {
+      case 'true':
+      case '1':
         return true;
-      } else if (['false', '0'].contains(value.toLowerCase())) {
+      case 'false':
+      case '0':
         return false;
-      } else {
+      default:
         throw const FormatException('Could not parse as a bool');
-      }
     }
-
-    return fallback!;
   }
 
   String? maybeGet(String name, {String? fallback}) => env[name] ?? fallback;
@@ -159,15 +138,12 @@ class DotEnv {
       }
     }
 
-    final linesFromMergeWith = mergeWith.entries
-        .map((entry) => "${entry.key}=${entry.value}")
-        .toList();
-    final allLines = linesFromMergeWith
-      ..addAll(linesFromOverrides)
-      ..addAll(linesFromFile);
-    final envEntries = parser.parse(allLines);
-    _envMap.addAll(envEntries);
-    _isInitialized = true;
+    _mergeAndStore(
+      linesFromFile: linesFromFile,
+      linesFromOverrides: linesFromOverrides,
+      mergeWith: mergeWith,
+      parser: parser,
+    );
   }
 
   void loadFromString({
@@ -187,21 +163,28 @@ class DotEnv {
       throw EmptyEnvFileError();
     }
     final linesFromFile = envString.split('\n');
-    final linesFromOverrides = overrideWith
-        .map((String lines) => lines.split('\n'))
-        .expand((x) => x)
-        .toList();
-    final linesFromMergeWith = mergeWith.entries
-        .map((entry) => "${entry.key}=${entry.value}")
-        .toList();
-
-    final allLines = linesFromMergeWith
-      ..addAll(linesFromOverrides)
-      ..addAll(linesFromFile);
-
-    final envEntries = parser.parse(allLines);
+    final linesFromOverrides = overrideWith.expand((s) => s.split('\n')).toList();
+
+    _mergeAndStore(
+      linesFromFile: linesFromFile,
+      linesFromOverrides: linesFromOverrides,
+      mergeWith: mergeWith,
+      parser: parser,
+    );
+  }
 
-    _envMap.addAll(envEntries);
+  void _mergeAndStore({
+    required List<String> linesFromFile,
+    required List<String> linesFromOverrides,
+    required Map<String, String> mergeWith,
+    required Parser parser,
+  }) {
+    final allLines = [
+      ...mergeWith.entries.map((e) => '${e.key}=${e.value}'),
+      ...linesFromOverrides,
+      ...linesFromFile,
+    ];
+    _envMap.addAll(parser.parse(allLines));
     _isInitialized = true;
   }
 
@@ -213,7 +196,7 @@ class DotEnv {
   Future<List<String>> _getEntriesFromFile(String filename) async {
     try {
       WidgetsFlutterBinding.ensureInitialized();
-      var envString = await rootBundle.loadString(filename);
+      final envString = await rootBundle.loadString(filename);
       if (envString.isEmpty) {
         throw EmptyEnvFileError(filename: filename);
       }
diff --git a/lib/src/parser.dart b/lib/src/parser.dart
@@ -14,8 +14,8 @@ class Parser {
   /// Creates a [Map](dart:core).
   /// Duplicate keys are silently discarded.
   Map<String, String> parse(Iterable<String> lines) {
-    var envMap = <String, String>{};
-    for (var line in lines) {
+    final envMap = <String, String>{};
+    for (final line in lines) {
       final parsedKeyValue = parseOne(line, envMap: envMap);
       if (parsedKeyValue.isEmpty) continue;
       envMap.putIfAbsent(
@@ -40,7 +40,7 @@ class Parser {
         .trim();
     final quoteChar = getSurroundingQuoteCharacter(envValue);
     var envValueWithoutQuotes = removeSurroundingQuotes(envValue);
-    // Add any escapted quotes
+    // Add any escaped quotes
     if (quoteChar == _singleQuote) {
       envValueWithoutQuotes = envValueWithoutQuotes.replaceAll("\\'", "'");
       // Return. We don't expect any bash variables in single quoted strings
diff --git a/test/dotenv_test.dart b/test/dotenv_test.dart
@@ -5,7 +5,6 @@ import 'package:flutter_test/flutter_test.dart';
 void main() {
   group('dotenv', () {
     setUp(() {
-      print(Directory.current.toString());
       dotenv.loadFromString(
           envString: File('test/.env')
               .readAsStringSync()); // mergeWith: Platform.environment
@@ -53,7 +52,6 @@ void main() {
 
   group('dotenv with overrides', () {
     setUp(() {
-      print(Directory.current.toString());
       dotenv.loadFromString(
         envString: File('test/.env').readAsStringSync(),
         overrideWith: [File("test/.env-override").readAsStringSync()],
@@ -88,19 +86,19 @@ void main() {
       expect(dotenv.env['OVERRIDE_VALUE'], 'overridden');
     });
     test(
-        'when getting a vairable that is not in .env, we should get the fallback we defined',
+        'when getting a variable that is not in .env, we should get the fallback we defined',
         () {
       expect(dotenv.get('FOO', fallback: 'bar'), 'foo');
       expect(dotenv.get('COMMENTS', fallback: 'sample'), 'sample');
       expect(dotenv.get('EQUAL_SIGNS', fallback: 'sample'), 'equals==');
     });
     test(
-        'when getting a vairable that is not in .env, we should get an error thrown',
+        'when getting a variable that is not in .env, we should get an error thrown',
         () {
       expect(() => dotenv.get('COMMENTS'), throwsAssertionError);
     });
     test(
-        'when getting a vairable using the nullable getter, we should get null if no fallback is defined',
+        'when getting a variable using the nullable getter, we should get null if no fallback is defined',
         () {
       expect(dotenv.maybeGet('COMMENTS'), null);
       expect(dotenv.maybeGet('COMMENTS', fallback: 'sample'), 'sample');
diff --git a/test/parser_test.dart b/test/parser_test.dart
