Merge pull request #37 from TatsuUkraine/release-3.0.0-nullsafe.0

Release 3.0.0-nullsafety.0 -> master

Author: TatsuUkraine

CHANGELOG.md

@@ -1,3 +1,7 @@
+## [3.0.0] - 26.04.2021
+
+- migrate to null-safe
+
 ## [2.3.0] - 19.04.2021
 
 - update deps versions

example/pubspec.yaml

@@ -2,7 +2,7 @@ name: environment_config_example
 version: 0.0.1
 
 environment:
-  sdk: ">=2.7.0 <3.0.0"
+  sdk: ">=2.12.0 <3.0.0"
 
 dependencies:
   environment_config:

lib/argument_parser.dart

@@ -14,7 +14,7 @@ class ArgumentParser {
 
   /// Defines if `config` key was specified
   /// during command run
-  String parseConfigPath() {
+  String? parseConfigPath() {
     ArgParser parser = ArgParser()..addOption(ConfigFieldType.CONFIG);
 
     final ArgResults argResults = parser.parse(
@@ -63,12 +63,10 @@ class ArgumentParser {
       );
     });
 
-    final parsedArguments = parser.parse(arguments);
+    final ArgResults parsedArguments = parser.parse(arguments);
 
-    return Map.fromIterable(
-      parsedArguments.options,
-      key: (dynamic key) => key,
-      value: (dynamic key) => parsedArguments[key],
-    );
+    return {
+      for (String key in parsedArguments.options) key: parsedArguments[key],
+    };
   }
 }

lib/config.dart

@@ -17,18 +17,19 @@ class Config {
 
   final Iterable<FieldConfig> _fields;
 
-  Config(this.config, this.arguments, Iterable<FieldConfig> fields, this.extConfig): _fields = fields;
-
-  factory Config.fromMap(
-    PlatformValueProvider valueProvider,
-    Map<dynamic, dynamic> config,
-    Map<dynamic, dynamic> args
-  ) {
-    final String devExtension = config[ConfigFieldType.DEV_EXTENSION];
+  Config(
+      this.config, this.arguments, Iterable<FieldConfig> fields, this.extConfig)
+      : _fields = fields;
+
+  factory Config.fromMap(PlatformValueProvider valueProvider,
+      Map<dynamic, dynamic> config, Map<String, dynamic> args) {
+    final String? devExtension = config[ConfigFieldType.DEV_EXTENSION];
     final Map<dynamic, dynamic> configFields = config[ConfigFieldType.FIELDS];
-    final Map<dynamic, dynamic> extensions = config[ConfigFieldType.EXTENSIONS] ?? {};
+    final Map<dynamic, dynamic> extensions =
+        config[ConfigFieldType.EXTENSIONS] ?? {};
+
     Map<dynamic, dynamic> extension = {};
-    String extensionName;
+    String? extensionName;
 
     if (devExtension != null && args[devExtension]) {
       extensionName = devExtension;
@@ -44,40 +45,38 @@ class Config {
       extension = extensions[extensionName] ?? {};
     }
 
-    Map<dynamic, dynamic> extensionFields = extension[ConfigFieldType.FIELDS] ?? {};
+    Map<dynamic, dynamic> extensionFields =
+        extension[ConfigFieldType.FIELDS] ?? {};
 
-    final Iterable<FieldConfig> fields = configFields.keys
-      .map((key) => FieldConfig(
-        valueProvider,
-        key,
-        config[ConfigFieldType.FIELDS][key] ?? {},
-        extensionFields[key] ?? {},
-        args[key]
-      ));
+    final Iterable<FieldConfig> fields = configFields.keys.map((key) =>
+        FieldConfig(
+            valueProvider,
+            key,
+            config[ConfigFieldType.FIELDS][key] ?? {},
+            extensionFields[key] ?? {},
+            args[key]));
 
     return Config(config, args, fields, extension);
   }
 
   /// Target file for generated config class
-  String get filePath {
-    return 'lib/${_getConfigValue(ConfigFieldType.PATH, 'environment_config.dart')}';
-  }
+  String get filePath =>
+      'lib/${_getConfigValue(ConfigFieldType.PATH, 'environment_config.dart')}';
 
   /// Target file for `.env` params
-  String get dotEnvFilePath {
-    return _getConfigValue(ConfigFieldType.DOTENV_PATH, '.env');
-  }
+  String get dotEnvFilePath =>
+      _getConfigValue(ConfigFieldType.DOTENV_PATH, '.env')!;
 
   /// Provides config class name
   String get className {
-    String className = _getConfigValue(ConfigFieldType.CLASS);
+    String? className = _getConfigValue(ConfigFieldType.CLASS);
 
     if (className != null) {
       return className;
     }
 
     final String fileName =
-        RegExp(r'\/([\w_-]+)\.dart$').firstMatch(filePath).group(1);
+        RegExp(r'\/([\w_-]+)\.dart$').firstMatch(filePath)!.group(1)!;
 
     return fileName
         .split('_')
@@ -86,20 +85,18 @@ class Config {
   }
 
   /// Fields, that should be exported to `.env` file
-  Iterable<FieldConfig> get dotEnvFields {
-    return _fields.where((field) => field.isDotEnv);
-  }
+  Iterable<FieldConfig> get dotEnvFields =>
+      _fields.where((field) => field.isDotEnv);
 
   /// Fields, that should be exported to Dart config file
-  Iterable<FieldConfig> get classConfigFields {
-    return _fields.where((field) => field.isConfigField);
-  }
+  Iterable<FieldConfig> get classConfigFields =>
+      _fields.where((field) => field.isConfigField);
 
   /// Collection if imports, that should be added to config class
   Iterable<String> get imports => [
-    ...(config[ConfigFieldType.IMPORTS]?.toList() ?? []),
-    ...(extConfig[ConfigFieldType.IMPORTS]?.toList() ?? []),
-  ];
+        ...(config[ConfigFieldType.IMPORTS]?.toList() ?? []),
+        ...(extConfig[ConfigFieldType.IMPORTS]?.toList() ?? []),
+      ];
 
   /// If class should contain `const` constructor
   bool get isClassConst => config[ConfigFieldType.CONST] ?? false;
@@ -110,7 +107,7 @@ class Config {
   /// Defines if generator should try to create Dart config file
   bool get createConfigClass => classConfigFields.isNotEmpty;
 
-  String _getConfigValue(key, [String defaultValue]) {
+  String? _getConfigValue(key, [String? defaultValue]) {
     if (arguments.containsKey(key) && !arguments[key].isEmpty) {
       return arguments[key];
     }

lib/config_generator.dart

@@ -20,16 +20,14 @@ class ConfigGenerator {
     if (config.createConfigClass) {
       futures.add(_generateClass());
     }
-    
+
     if (config.createDotEnv) {
       futures.add(_generateDotEnv());
     }
 
     if (futures.isEmpty) {
-      throw ValidationError(
-        ConfigFieldType.FIELDS,
-        'At least one field should be defined for `.env` or Dart config class'
-      );
+      throw ValidationError(ConfigFieldType.FIELDS,
+          'At least one field should be defined for `.env` or Dart config class');
     }
 
     return Future.wait(futures);
@@ -50,14 +48,15 @@ class ConfigGenerator {
               Class((ClassBuilder builder) => builder
                 ..constructors.addAll(constructors)
                 ..name = config.className
-                ..fields.addAll(config.classConfigFields.map((FieldConfig field) => Field(
-                      (FieldBuilder builder) => builder
-                        ..name = field.name
-                        ..static = field.isStatic
-                        ..modifier = field.modifier
-                        ..type = Reference(field.type)
-                        ..assignment = Code(field.value),
-                    )))),
+                ..fields.addAll(
+                    config.classConfigFields.map((FieldConfig field) => Field(
+                          (FieldBuilder builder) => builder
+                            ..name = field.name
+                            ..static = field.isStatic
+                            ..modifier = field.modifier
+                            ..type = Reference(field.type)
+                            ..assignment = Code(field.value),
+                        )))),
             ]));
 
     final classDefinition =

lib/config_loader.dart

@@ -22,7 +22,7 @@ const String _CONFIG_KEY = 'environment_config';
 /// - pubspec.yaml
 ///
 /// If no config file found will throw exception
-Future<YamlMap> loadConfig(String path) async {
+Future<YamlMap> loadConfig(String? path) async {
   List<String> files = [..._CONFIG_FILES];
 
   if (path != null) {
@@ -41,7 +41,7 @@ Future<YamlMap> loadConfig(String path) async {
       continue;
     }
 
-    final YamlMap config = loadYaml(yamlString);
+    final YamlMap? config = loadYaml(yamlString);
 
     if (config == null) {
       continue;

lib/errors/validation_error.dart

@@ -2,7 +2,7 @@ import 'config_error.dart';
 
 class ValidationError extends ConfigError {
   final String field;
-  final String message;
+  final String? message;
 
   ValidationError(this.field, [this.message]);
 

lib/field_config.dart

@@ -17,17 +17,15 @@ class FieldConfig {
   final Map<dynamic, dynamic> extField;
 
   /// Value provided from command params
-  final String _value;
+  final String? _value;
 
   final PlatformValueProvider _valueProvider;
 
   FieldConfig(
-      PlatformValueProvider valueProvider,
-      this.name,
-      this.field,
-      this.extField,
-      [String value]
-      ) : _value = value, _valueProvider = valueProvider {
+      PlatformValueProvider valueProvider, this.name, this.field, this.extField,
+      [String? value])
+      : _value = value,
+        _valueProvider = valueProvider {
     if (_fieldValue == null) {
       throw ValidationError(name, '"$name" is required');
     }
@@ -57,7 +55,9 @@ class FieldConfig {
       return false;
     }
 
-    return extField[ConfigFieldType.CONST] ?? field[ConfigFieldType.CONST] ?? true;
+    return extField[ConfigFieldType.CONST] ??
+        field[ConfigFieldType.CONST] ??
+        true;
   }
 
   /// Is Field should be defined as STATIC
@@ -73,37 +73,42 @@ class FieldConfig {
   ///
   /// If `pattern` is specified, value will injected into it
   String get value {
-    String pattern = _pattern;
+    String? pattern = _pattern;
 
-    if (_pattern == null && type == 'String') {
+    if (pattern == null && _isStringType) {
       pattern = '\'__VALUE__\'';
     }
 
     if (pattern == null) {
-      return _fieldValue;
+      return _fieldValue!;
     }
 
-    return pattern.replaceAll(_PATTERN_REGEXP, _fieldValue);
+    return pattern.replaceAll(_PATTERN_REGEXP, _fieldValue!);
   }
 
   /// Value for key in `.env` file
-  String get dotEnvValue {
-    return _pattern?.replaceAll(_PATTERN_REGEXP, _fieldValue) ?? _fieldValue;
-  }
+  String get dotEnvValue =>
+      _pattern?.replaceAll(_PATTERN_REGEXP, _fieldValue!) ?? _fieldValue!;
 
-  String get _pattern => extField[ConfigFieldType.PATTERN] ?? field[ConfigFieldType.PATTERN];
+  String? get _pattern =>
+      extField[ConfigFieldType.PATTERN] ?? field[ConfigFieldType.PATTERN];
 
-  String get _globalValue {
-    final String globalKey = extField[ConfigFieldType.ENV_VAR] ?? field[ConfigFieldType.ENV_VAR];
+  String? get _globalValue {
+    final String? globalKey =
+        extField[ConfigFieldType.ENV_VAR] ?? field[ConfigFieldType.ENV_VAR];
 
     if ((globalKey ?? '').isNotEmpty) {
-      return _valueProvider.getValue(globalKey);
+      return _valueProvider.getValue(globalKey!);
     }
 
     return null;
   }
 
-  String get _fieldValue {
-    return (_value ?? _globalValue ?? extField[ConfigFieldType.DEFAULT] ?? field[ConfigFieldType.DEFAULT])?.toString();
-  }
-}
+  String? get _fieldValue => (_value ??
+          _globalValue ??
+          extField[ConfigFieldType.DEFAULT] ??
+          field[ConfigFieldType.DEFAULT])
+      ?.toString();
+
+  bool get _isStringType => const ['String', 'String?'].contains(type);
+}

lib/platform_value_provider.dart

@@ -5,11 +5,11 @@ class PlatformValueProvider {
   final Map<String, String> data = Platform.environment;
 
   /// Returns value from platform env variable
-  String getValue(String key) {
+  String? getValue(String key) {
     if (data.containsKey(key)) {
       return data[key];
     }
 
     return null;
   }
-}
+}

pubspec.yaml

@@ -1,15 +1,15 @@
 name: environment_config
 description: Environment specific config generator. Allows to specify env configuration during CI/CD build. Primarily created to simplify Flutter build configuration
-version: 2.3.0
+version: 3.0.0
 homepage: https://github.com/TatsuUkraine/dart_environment_config
 repository: https://github.com/TatsuUkraine/dart_environment_config
 issue_tracker: https://github.com/TatsuUkraine/dart_environment_config/issues
 
 environment:
-  sdk: ">=2.2.2 <3.0.0"
+  sdk: '>=2.12.0 <3.0.0'
 
 dependencies:
-  dart_style: ">=2.0.0 <3.0.0"
-  code_builder: ">=3.0.0 <4.0.0"
-  args: ">=2.0.0 <3.0.0"
-  yaml: ">=3.0.0 <4.0.0"
+  dart_style: '>=2.0.0 <3.0.0'
+  code_builder: '>=4.0.0 <5.0.0'
+  args: '>=2.0.0 <3.0.0'
+  yaml: '>=3.0.0 <4.0.0'