Refactor a bit and skip useless changes

Author: ThomasEcalle

lib/src/changes/files_to_modify_content.dart

@@ -9,26 +9,31 @@ List<RequiredChange> getFilesToModifyContent(
       regexp: RegExp(config.oldDartPackageName),
       replacement: config.newDartPackageName,
       paths: ["pubspec.yaml"],
+      needChanges: config.oldDartPackageName != config.newDartPackageName,
     ),
     RequiredChange(
       regexp: RegExp('android:label="${config.oldAppName}"'),
       replacement: 'android:label="${config.newAppName}"',
       paths: ["android/app/src/main/AndroidManifest.xml"],
+      needChanges: config.oldAppName != config.newAppName,
     ),
     RequiredChange(
       regexp: RegExp('applicationId "${config.oldApplicationId}"'),
       replacement: 'applicationId "${config.newApplicationId}"',
       paths: ["android/app/build.gradle"],
+      needChanges: config.oldApplicationId != config.newApplicationId,
     ),
     RequiredChange(
       regexp: RegExp(config.oldBundleId),
       replacement: config.newBundleId,
       paths: ["ios/Runner.xcodeproj/project.pbxproj"],
+      needChanges: config.oldBundleId != config.newBundleId,
     ),
     RequiredChange(
       regexp: RegExp(config.oldAppName),
       replacement: config.newAppName,
       paths: ["ios/Runner/Info.plist"],
+      needChanges: config.oldAppName != config.newAppName,
     ),
     RequiredChange(
       regexp: RegExp(config.oldAndroidPackageName),
@@ -37,6 +42,7 @@ List<RequiredChange> getFilesToModifyContent(
         "android/app/src",
       ],
       isDirectory: true,
+      needChanges: config.oldAndroidPackageName != config.newAndroidPackageName,
     ),
   ];
 }

lib/src/changes/files_to_modify_name.dart

@@ -9,6 +9,7 @@ List<RequiredChange> getFilesToModifyName(
       regexp: RegExp(config.oldDartPackageName),
       replacement: config.newDartPackageName,
       paths: ["android/${config.oldDartPackageName}_android.iml"],
+      needChanges: config.oldDartPackageName != config.newDartPackageName,
     ),
   ];
 }

lib/src/flutter_rename_app.dart

@@ -16,6 +16,7 @@ import 'utils/get_config.dart';
 renameApp() async {
   try {
     final Config config = await getConfig();
+
     Logger.info("Current app name: ${config.oldAppName}");
     Logger.info("New name will be: ${config.newAppName}");
 
@@ -62,6 +63,8 @@ renameApp() async {
   }
 }
 
+/// Change all imports in given path (recursively)
+/// Needed in order to change dart package name in lib or test
 _changeAllImportsIn(String directoryPath, Config config) {
   final Directory directory = Directory(directoryPath);
   if (directory.existsSync()) {
@@ -80,29 +83,36 @@ _changeAllImportsIn(String directoryPath, Config config) {
   }
 }
 
+/// Apply the list of required files name changes
 _applyNameChanges(List<RequiredChange> requiredChanges) {
   requiredChanges.forEach((RequiredChange change) {
-    for (final path in change.paths) {
-      _changeFileName(path, change.regexp, change.replacement);
+    if (change.needChanges) {
+      for (final path in change.paths) {
+        _changeFileName(path, change.regexp, change.replacement);
+      }
     }
   });
 }
 
+/// Apply the list of required files content changes
 _applyContentChanges(List<RequiredChange> requiredChanges) {
   requiredChanges.forEach((RequiredChange change) {
-    for (final path in change.paths) {
-      if (change.isDirectory) {
-        final Directory directory = Directory(path);
-        directory.listSync(recursive: true).forEach((FileSystemEntity entity) {
-          _changeContentInFile(entity.path, change.regexp, change.replacement);
-        });
-      } else {
-        _changeContentInFile(path, change.regexp, change.replacement);
+    if (change.needChanges) {
+      for (final path in change.paths) {
+        if (change.isDirectory) {
+          final Directory directory = Directory(path);
+          directory.listSync(recursive: true).forEach((FileSystemEntity entity) {
+            _changeContentInFile(entity.path, change.regexp, change.replacement);
+          });
+        } else {
+          _changeContentInFile(path, change.regexp, change.replacement);
+        }
       }
     }
   });
 }
 
+/// Change the name of the File at the given path by the given replacement name
 _changeFileName(String filePath, RegExp regexp, String replacement) {
   if (filePath.contains(regexp)) {
     try {
@@ -112,14 +122,15 @@ _changeFileName(String filePath, RegExp regexp, String replacement) {
   }
 }
 
+/// Change content of the given File by the given content
 _changeContentInFile(String filePath, RegExp regexp, String replacement) {
   try {
     final File file = File(filePath);
     final String content = file.readAsStringSync();
     if (content.contains(regexp)) {
       final String newContent = content.replaceAll(regexp, replacement);
       file.writeAsStringSync(newContent);
-      Logger.info("Changed file $filePath");
+      Logger.info("$filePath has been modified");
     }
   } catch (error) {}
 }

lib/src/models/required_change.dart

@@ -3,11 +3,13 @@ class RequiredChange {
   final String replacement;
   final List<String> paths;
   final bool isDirectory;
+  final bool needChanges;
 
   RequiredChange({
     this.regexp,
     this.replacement,
     this.paths,
     this.isDirectory = false,
+    this.needChanges = true,
   });
 }

lib/src/utils/change_android_package_name.dart

@@ -35,8 +35,6 @@ changeAndroidPackageName(Config config) async {
   });
 
   /// Deleting all inside old Android package
-  print("Working directory = ${workingDirectory.path}");
-
   final Directory directoryToDelete = _getFirstDifferentDirectory(
     workingDirectory.path,
     oldPackageNameParts,
@@ -66,13 +64,18 @@ Directory _getFirstDifferentDirectory(
   List<String> newPackageParts,
 ) {
   String path = "";
+  bool foundADifference = false;
   for (int i = 0; i < oldPackageParts.length; i++) {
     path += "${oldPackageParts[i]}/";
     if (!newPackageParts.contains(oldPackageParts[i])) {
+      foundADifference = true;
       break;
     }
   }
 
-  print("PATH = $path");
-  return Directory("$workingDirectoryPath/$path");
+  /// In case of the new package_name being longer than previous one like :
+  /// com.example.one becoming com.example.one.two
+  if (foundADifference) {
+    return Directory("$workingDirectoryPath/$path");
+  }
 }