feat: read stacked config (#24)

* feat: read stacked config

- Added `xdg_directories` package
- Updated packages
- Added StackedConfig model
- Added ConfigFileNotFoundException
- Added helper classes
- Updated BaseGenerator to return FutureOr String
- Updated generators
- Updated bottomsheet and dialog generators to take StackedAppFileName into account
- Added ConfigHelper unit tests

Author: ferrarafer

lib/src/generators/base_generator.dart

@@ -1,6 +1,8 @@
+import 'dart:async';
+
 /// Provides functionality common to all Generators
 abstract class BaseGenerator {
-  String generate();
+  FutureOr<String> generate();
 }
 
 mixin StringBufferUtils {

lib/src/generators/bottomsheets/generate/bottomsheet_class_generator.dart

@@ -1,6 +1,7 @@
 import 'package:stacked_generator/src/generators/base_generator.dart';
 import 'package:stacked_generator/src/generators/bottomsheets/bottomsheet_config.dart';
 import 'package:stacked_generator/src/generators/bottomsheets/generate/bottomsheet_class_generator_helper.dart';
+import 'package:stacked_generator/utils.dart';
 
 import 'bottomsheet_class_content.dart';
 
@@ -12,8 +13,10 @@ class BottomsheetClassGenerator extends BottomsheetClassGeneratorHelper
   BottomsheetClassGenerator(this.bottomsheetConfigs, {this.locatorName});
 
   @override
-  String generate() {
-    writeStackedservicesAndGeneratedLocaterImports();
+  Future<String> generate() async {
+    writeStackedservicesAndGeneratedLocaterImports(
+      await getStackedAppFileName(),
+    );
 
     writeBottomsheetsImports(bottomsheetConfigs);
 

lib/src/generators/bottomsheets/generate/bottomsheet_class_generator_helper.dart

@@ -16,11 +16,11 @@ class BottomsheetClassGeneratorHelper with StringBufferUtils {
     write(setupBottomsheetHeader(locatorName));
   }
 
-  void writeStackedservicesAndGeneratedLocaterImports() {
+  void writeStackedservicesAndGeneratedLocaterImports(String name) {
     writeLine();
     writeLine("import 'package:stacked_services/stacked_services.dart';");
     writeLine();
-    writeLine("import 'app.locator.dart';");
+    writeLine("import '$name.locator.dart';");
   }
 
   void writeBottomsheetsImports(List<BottomsheetConfig> bottomsheetConfigs) {

lib/src/generators/dialogs/generate/dialog_class_generator.dart

@@ -1,6 +1,7 @@
 import 'package:stacked_generator/src/generators/base_generator.dart';
 import 'package:stacked_generator/src/generators/dialogs/dialog_config.dart';
 import 'package:stacked_generator/src/generators/dialogs/generate/dialog_class_generator_helper.dart';
+import 'package:stacked_generator/utils.dart';
 
 import 'dialog_class_content.dart';
 
@@ -12,8 +13,10 @@ class DialogClassGenerator extends DialogClassGeneratorHelper
   DialogClassGenerator(this.dialogConfigs, {this.locatorName});
 
   @override
-  String generate() {
-    writeStackedservicesAndGeneratedLocaterImports();
+  Future<String> generate() async {
+    writeStackedservicesAndGeneratedLocaterImports(
+      await getStackedAppFileName(),
+    );
 
     writeDialogsImports(dialogConfigs);
 

lib/src/generators/dialogs/generate/dialog_class_generator_helper.dart

@@ -16,11 +16,11 @@ class DialogClassGeneratorHelper with StringBufferUtils {
     write(setupDialogHeader(locatorName));
   }
 
-  void writeStackedservicesAndGeneratedLocaterImports() {
+  void writeStackedservicesAndGeneratedLocaterImports(String name) {
     writeLine();
     writeLine("import 'package:stacked_services/stacked_services.dart';");
     writeLine();
-    writeLine("import 'app.locator.dart';");
+    writeLine("import '$name.locator.dart';");
   }
 
   void writeDialogsImports(List<DialogConfig> dialogConfigs) {

lib/src/generators/exceptions/config_file_not_found_exception.dart

@@ -0,0 +1,10 @@
+class ConfigFileNotFoundException implements Exception {
+  final String message;
+  final bool shouldHaltCommand;
+  ConfigFileNotFoundException(this.message, {this.shouldHaltCommand = false});
+
+  @override
+  String toString() {
+    return message;
+  }
+}

lib/src/generators/router/generator/navigate_extension_class/navigate_extension_class_builder_helper.dart

@@ -5,7 +5,7 @@ import 'package:stacked_generator/src/generators/router_common/models/route_conf
 import 'package:stacked_generator/src/generators/router_common/models/route_parameter_config.dart';
 import 'package:stacked_generator/utils.dart';
 
-class NavigateExtensionClassBuilderHelper {
+mixin NavigateExtensionClassBuilderHelper {
   Iterable<Method> buildNavigateToExtensionMethods(
     List<RouteConfig> routes,
     DartEmitter emitter,

lib/src/generators/router/generator/router_class/router_class_builder_helper.dart

@@ -3,7 +3,7 @@ import 'package:stacked_generator/src/generators/router_common/models/route_conf
 import 'package:stacked_generator/src/generators/router_common/models/route_parameter_config.dart';
 import 'package:stacked_generator/utils.dart';
 
-class RouterClassBuilderHelper {
+mixin RouterClassBuilderHelper {
   /// Example
   ///
   /// final _routes = <_i1.RouteDef>[

lib/src/generators/router_2/router_extension_builder/router_extension_builder_helper.dart

@@ -4,7 +4,7 @@ import 'package:stacked_generator/src/generators/router_2/code_builder/route_inf
 import 'package:stacked_generator/src/generators/router_common/models/route_config.dart';
 import 'package:stacked_generator/src/generators/router_common/models/route_parameter_config.dart';
 
-class RouterExtensionBuilderHelper {
+mixin RouterExtensionBuilderHelper {
   Iterable<Method> buildNavigateToExtensionMethods(
     List<RouteConfig> routes,
     DartEmitter emitter,

lib/src/helpers/config_helper.dart

@@ -0,0 +1,269 @@
+import 'dart:convert';
+import 'dart:io';
+
+import 'package:freezed_annotation/freezed_annotation.dart';
+import 'package:stacked_generator/src/generators/exceptions/config_file_not_found_exception.dart';
+import 'package:stacked_generator/src/helpers/file_helper.dart';
+import 'package:stacked_generator/src/models/stacked_config.dart';
+
+const kConfigFileMalformed =
+    'Your configuration file is malformed. Double check to make sure you have properly formatted json.';
+const kConfigFileName = 'stacked.json';
+const kConfigFileNotFound =
+    'No configuration file found. Default Stacked values will be used.';
+const kConfigFileNotFoundRetry =
+    'No configuration file found. Please, verify the config path passed as argument.';
+const kDeprecatedPaths =
+    'Paths on Stacked config do not need to start with directory "lib" or "test" because  are mandatory directories, defined by the Flutter framework. Stacked cli will not accept paths starting with "lib" or "test" after the next minor release.';
+
+/// Handles stacked app configuration
+class ConfigHelper {
+  final FileHelper fileHelper;
+  ConfigHelper({required this.fileHelper});
+
+  /// Default config map used to compare and replace with custom values.
+  final Map<String, dynamic> _defaultConfig = StackedConfig().toJson();
+
+  /// Custom config used to store custom values read from file.
+  StackedConfig _customConfig = StackedConfig();
+
+  bool _hasCustomConfig = false;
+
+  bool get hasCustomConfig => _hasCustomConfig;
+
+  /// Relative services path for import statements.
+  String get serviceImportPath => _customConfig.servicesPath;
+
+  /// Relative path where services will be genereated.
+  String get servicePath => _customConfig.servicesPath;
+
+  /// Returns the name of the locator to use when registering service mocks.
+  String get locatorName => _customConfig.locatorName;
+
+  String get registerMocksFunction => _customConfig.registerMocksFunction;
+
+  /// Relative import path related to services of test helpers and mock services.
+  String get serviceTestHelpersImport => getFilePathToHelpersAndMocks(
+        _customConfig.testServicesPath,
+      );
+
+  /// Relative bottom sheet path for import statements.
+  String get bottomSheetsPath => _customConfig.bottomSheetsPath;
+
+  /// File path where bottom sheet builders are located.
+  String get bottomSheetBuilderFilePath =>
+      _customConfig.bottomSheetBuilderFilePath;
+
+  /// File path where bottom sheet type enum values are located.
+  String get bottomSheetTypeFilePath => _customConfig.bottomSheetTypeFilePath;
+
+  /// Relative path where dialogs will be genereated.
+  String get dialogsPath => _customConfig.dialogsPath;
+
+  /// File path where dialog builders are located.
+  String get dialogBuilderFilePath => _customConfig.dialogBuilderFilePath;
+
+  /// File path where dialog type enum values are located.
+  String get dialogTypeFilePath => _customConfig.dialogTypeFilePath;
+
+  /// File path where StackedApp is setup.
+  String get stackedAppFilePath => _customConfig.stackedAppFilePath;
+
+  /// File path where register functions for unit test setup and mock
+  /// declarations are located.
+  String get testHelpersFilePath => _customConfig.testHelpersFilePath;
+
+  /// Relative path where services unit tests will be genereated.
+  String get testServicesPath => _customConfig.testServicesPath;
+
+  /// Relative path where viewmodels unit tests will be genereated.
+  String get testViewsPath => _customConfig.testViewsPath;
+
+  /// Relative views path for import statements.
+  String get viewImportPath => _customConfig.viewsPath;
+
+  /// Relative path where views and viewmodels will be genereated.
+  String get viewPath => _customConfig.viewsPath;
+
+  /// Relative import path related to viewmodels of test helpers and mock services.
+  String get viewTestHelpersImport => getFilePathToHelpersAndMocks(
+        _customConfig.testViewsPath,
+      );
+
+  /// Relative path where widgets will be genereated.
+  String get widgetPath => _customConfig.widgetsPath;
+
+  /// Relative import path related to widget models of test helpers and mock services.
+  String get widgetTestHelpersImport => getFilePathToHelpersAndMocks(
+        _customConfig.testWidgetsPath,
+      );
+
+  /// Returns boolean value to determine view builder style.
+  ///
+  /// False: StackedView
+  /// True: ViewModelBuilder
+  bool get v1 => _customConfig.v1;
+
+  /// Returns int value for line length when format code.
+  int get lineLength => _customConfig.lineLength;
+
+  /// Returns boolean to indicate if the project prefers web templates
+  bool get preferWeb => _customConfig.preferWeb;
+
+  /// Composes configuration file and loads it into memory.
+  ///
+  /// Generally used to load the configuration file at root of the project.
+  Future<void> composeAndLoadConfigFile({
+    String? configFilePath,
+    String? projectPath,
+  }) async {
+    try {
+      final configPath = await composeConfigFile(
+        configFilePath: configFilePath,
+        projectPath: projectPath,
+      );
+
+      await loadConfig(configPath);
+    } on ConfigFileNotFoundException catch (e) {
+      if (e.shouldHaltCommand) rethrow;
+
+      stdout.writeln(e.message);
+    } catch (e) {
+      stdout.writeln(e.toString());
+    }
+  }
+
+  /// Returns configuration file path.
+  ///
+  /// When configFilePath is NOT null should returns configFilePath unless the
+  /// file does NOT exists where should throw a ConfigFileNotFoundException.
+  ///
+  /// When configFilePath is null should returns [kConfigFileName] or with the
+  /// []projectPath] included if it was passed through arguments.
+  @visibleForTesting
+  Future<String> composeConfigFile({
+    String? configFilePath,
+    String? projectPath,
+  }) async {
+    if (configFilePath != null) {
+      if (await fileHelper.fileExists(filePath: configFilePath)) {
+        return configFilePath;
+      }
+
+      throw ConfigFileNotFoundException(
+        kConfigFileNotFoundRetry,
+        shouldHaltCommand: true,
+      );
+    }
+
+    if (projectPath != null) {
+      return '$projectPath/$kConfigFileName';
+    }
+
+    return kConfigFileName;
+  }
+
+  /// Reads configuration file and sets data to [_customConfig] map.
+  @visibleForTesting
+  Future<void> loadConfig(String configFilePath) async {
+    try {
+      final data = await fileHelper.readFileAsString(
+        filePath: configFilePath,
+      );
+      _customConfig = StackedConfig.fromJson(jsonDecode(data));
+      _hasCustomConfig = true;
+      _sanitizeCustomConfig();
+    } on ConfigFileNotFoundException catch (e) {
+      if (e.shouldHaltCommand) rethrow;
+
+      stdout.writeln(e.message);
+    } on FormatException catch (_) {
+      stdout.writeln(kConfigFileMalformed);
+    } catch (e) {
+      stdout.writeln(e.toString());
+    }
+  }
+
+  /// Replaces the default configuration in [path] by custom configuration
+  /// available at [customConfig].
+  ///
+  /// If [hasCustomConfig] is false, returns [path] without modifications.
+  String replaceCustomPaths(String path) {
+    if (!hasCustomConfig) return path;
+
+    final customConfig = _customConfig.toJson();
+    String customPath = path;
+
+    for (var k in _defaultConfig.keys) {
+      // Avoid trying to replace non path values like v1 or lineLength
+      if (!k.contains('path')) continue;
+
+      if (customPath.contains(_defaultConfig[k])) {
+        customPath = customPath.replaceFirst(
+          _defaultConfig[k],
+          customConfig[k],
+        );
+        break;
+      }
+    }
+
+    return customPath;
+  }
+
+  /// Sanitizes the [path] removing [find].
+  ///
+  /// Generally used to remove unnecessary parts of the path as {lib} or {test}.
+  @visibleForTesting
+  String sanitizePath(String path, [String find = 'lib/']) {
+    if (!path.startsWith(find)) return path;
+
+    return path.replaceFirst(find, '');
+  }
+
+  /// Sanitizes [_customConfig] to remove unnecessary {lib} or {test} from paths.
+  ///
+  /// Warns the user if the custom config has deprecated path parts.
+  void _sanitizeCustomConfig() {
+    final sanitizedConfig = _customConfig.copyWith(
+      stackedAppFilePath: sanitizePath(_customConfig.stackedAppFilePath),
+      servicesPath: sanitizePath(_customConfig.servicesPath),
+      viewsPath: sanitizePath(_customConfig.viewsPath),
+      testHelpersFilePath:
+          sanitizePath(_customConfig.testHelpersFilePath, 'test/'),
+      testServicesPath: sanitizePath(_customConfig.testServicesPath, 'test/'),
+      testViewsPath: sanitizePath(_customConfig.testViewsPath, 'test/'),
+    );
+
+    if (_customConfig == sanitizedConfig) return;
+
+    stdout.writeln(kDeprecatedPaths);
+
+    _customConfig = sanitizedConfig;
+  }
+
+  /// Returns file path of test helpers and mock services relative to [path].
+  @visibleForTesting
+  String getFilePathToHelpersAndMocks(String path) {
+    String fileToImport = testHelpersFilePath;
+    final pathSegments =
+        path.split('/').where((element) => !element.contains('.'));
+
+    for (var i = 0; i < pathSegments.length; i++) {
+      fileToImport = '../$fileToImport';
+    }
+
+    return fileToImport;
+  }
+
+  /// Exports custom config as a formatted Json String.
+  String exportConfig() {
+    return const JsonEncoder.withIndent("    ").convert(_customConfig.toJson());
+  }
+
+  /// Overrides [widgets_path] value on configuration.
+  void setWidgetsPath(String? path) {
+    _customConfig = _customConfig.copyWith(
+      widgetsPath: path ?? _customConfig.widgetsPath,
+    );
+  }
+}