[dartfix] remove the 'dartfix upgrade sdk' command (prefer 'dartdev migrate')

Change-Id: I981e2b1805a81210cfb0ed7af809a07eb3eabb5f
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/137221
Commit-Queue: Devon Carew <[email protected]>
Reviewed-by: Janice Collins <[email protected]>

Author: devoncarew

pkg/dartfix/lib/src/driver.dart

@@ -16,8 +16,12 @@ import 'package:dartfix/listener/bad_message_listener.dart';
 import 'package:dartfix/src/context.dart';
 import 'package:dartfix/src/options.dart';
 import 'package:dartfix/src/util.dart';
+import 'package:path/path.dart' as path;
 import 'package:pub_semver/pub_semver.dart';
 
+import 'migrate/display.dart';
+import 'util.dart';
+
 class Driver {
   Context context;
   _Handler handler;
@@ -140,20 +144,7 @@ class Driver {
 
   /// Return `true` if the changes should be applied.
   bool shouldApplyFixes(EditDartfixResult result) {
-    if (result.edits.isEmpty) {
-      logger.stdout('');
-      logger.stdout(result.otherSuggestions.isNotEmpty
-          ? 'None of the recommended changes can be automatically applied.'
-          : 'There are no recommended changes.');
-      return false;
-    }
-    if (overwrite || force) {
-      return true;
-    }
-    logger.stdout('');
-    logger.stdout('Would you like to apply these changes? (yes/no)');
-    var response = stdin.readLineSync();
-    return response.toLowerCase() == 'yes';
+    return overwrite || force;
   }
 
   void showDescriptions(String title, List<DartFixSuggestion> suggestions) {
@@ -241,8 +232,6 @@ These fixes can be enabled using --$includeFixOption:''');
     Progress progress;
     if (options.showHelp) {
       progress = logger.progress('${ansi.emphasized('Listing fixes')}');
-    } else if (options.isUpgrade) {
-      progress = logger.progress('${ansi.emphasized('Calculating changes')}');
     } else {
       progress = logger.progress('${ansi.emphasized('Calculating fixes')}');
     }
@@ -280,57 +269,28 @@ These fixes can be enabled using --$includeFixOption:''');
         editCount += fileEdit.edits.length;
       }
       logger.stdout('Found $editCount changes in ${fileEdits.length} files.');
+
+      previewFixes(logger, result);
+
       //
-      // Print instructions for opening the preview tool.
+      // Stop the server.
       //
-      var urls = result.urls;
-      if (urls != null) {
-        // Server has already started the preview server.
-        if (result.hasErrors) {
-          // TODO(brianwilkerson) When we have previews for fixes, tailor the
-          //  message to be appropriate for fixes.
-          logger.stdout('');
-          String warning = ansi.emphasized('WARNING');
-          logger.stdout('$warning: The unmodified code contains errors that '
-              'might affect the accuracy of the upgrade.');
-          options.overwrite = false;
-        }
-        if (options.isUpgrade && options.upgradeOptions.preview) {
-          logger.stdout('');
-          String open;
-          if (urls.length == 1) {
-            open = ansi.emphasized('Please open this URL');
-          } else {
-            open = ansi.emphasized('Please open these URLs');
-          }
-          logger.stdout('$open in your browser to see the changes:');
-          for (var url in urls) {
-            logger.stdout('  $url');
-          }
-          logger.stdout('');
-          String enter = ansi.emphasized('ENTER');
-          logger.stdout('When done previewing, press $enter.');
-          stdin.readLineSync();
-        }
-        //
-        // Stop the server.
-        //
-        serverStopped = server.stop();
-        if (shouldApplyFixes(result)) {
-          applyFixes();
-          logger.stdout('Changes have been applied.');
-        } else {
-          logger.stdout('No changes applied.');
-        }
-        await serverStopped;
+      serverStopped = server.stop();
+
+      logger.stdout('');
+
+      // Check if we should apply fixes.
+      if (result.edits.isEmpty) {
+        logger.stdout(result.otherSuggestions.isNotEmpty
+            ? 'None of the recommended changes can be automatically applied.'
+            : 'There are no recommended changes.');
+      } else if (shouldApplyFixes(result)) {
+        applyFixes();
+        logger.stdout('Changes have been applied.');
       } else {
-        //
-        // Stop the server.
-        //
-        serverStopped = server.stop();
-        await printAndApplyFixes();
-        await serverStopped;
+        logger.stdout('Re-run with --overwrite to apply the above changes.');
       }
+      await serverStopped;
     } finally {
       // If we didn't already try to stop the server, then stop it now.
       if (serverStopped == null) {
@@ -398,6 +358,53 @@ analysis server
 The --$option option is not supported by analysis server version $version.
 Please upgrade to a newer version of the Dart SDK to use this option.''');
   }
+
+  void previewFixes(
+    Logger logger,
+    EditDartfixResult results,
+  ) {
+    final Ansi ansi = logger.ansi;
+
+    Map<String, List<DartFixSuggestion>> fileSuggestions = {};
+    for (DartFixSuggestion suggestion in results.suggestions) {
+      String file = suggestion.location.file;
+      fileSuggestions.putIfAbsent(file, () => <DartFixSuggestion>[]);
+      fileSuggestions[file].add(suggestion);
+    }
+
+    // present a diff-like view
+    for (SourceFileEdit sourceFileEdit in results.edits) {
+      String file = sourceFileEdit.file;
+      String relPath = path.relative(file);
+      int count = sourceFileEdit.edits.length;
+
+      logger.stdout('');
+      logger.stdout('${ansi.emphasized(relPath)} '
+          '($count ${pluralize('change', count)}):');
+
+      String source;
+      try {
+        source = File(file).readAsStringSync();
+      } catch (_) {}
+
+      if (source == null) {
+        logger.stdout('  (unable to retrieve source for file)');
+      } else {
+        SourcePrinter sourcePrinter = SourcePrinter(source);
+
+        List<SourceEdit> edits = sortEdits(sourceFileEdit);
+
+        // Apply edits.
+        sourcePrinter.applyEdits(edits);
+
+        // Render the changed lines.
+        sourcePrinter.processChangedLines((lineNumber, lineText) {
+          String prefix = '  line ${lineNumber.toString().padRight(3)} •';
+          logger.stdout('$prefix ${lineText.trim()}');
+        });
+      }
+    }
+  }
 }
 
 class _Handler
@@ -454,15 +461,15 @@ class _Handler
     if (version > expectedVersion) {
       logger.stdout('''
 This version of dartfix is incompatible with the current Dart SDK.
-Try installing a newer version of dartfix by running
+Try installing a newer version of dartfix by running:
 
     pub global activate dartfix
 ''');
     } else {
       logger.stdout('''
-This version of dartfix is too new to be used with the current Dart SDK.
-Try upgrading the Dart SDK to a newer version
-or installing an older version of dartfix using
+This version of dartfix is too new to be used with the current Dart SDK. Try
+upgrading the Dart SDK to a newer version or installing an older version of
+dartfix using:
 
     pub global activate dartfix <version>
 ''');

pkg/dartfix/lib/src/migrate/apply.dart

@@ -4,14 +4,11 @@
 
 import 'package:analysis_server_client/protocol.dart';
 
+import '../util.dart';
+
 /// Perform the indicated source edits to the given source, returning the
 /// resulting transformed text.
 String applyEdits(SourceFileEdit sourceFileEdit, String source) {
-  // Sort edits in reverse offset order.
-  List<SourceEdit> edits = sourceFileEdit.edits.toList();
-  edits.sort((a, b) {
-    return b.offset - a.offset;
-  });
-
+  List<SourceEdit> edits = sortEdits(sourceFileEdit);
   return SourceEdit.applySequence(source, edits);
 }

pkg/dartfix/lib/src/migrate/display.dart

@@ -41,9 +41,21 @@ class SourcePrinter {
 
   SourcePrinter(this.source);
 
-  void deleteRange(int offset, int length) {
-    // \u001b[31m - red
+  void applyEdits(List<SourceEdit> edits) {
+    for (SourceEdit edit in edits) {
+      if (edit.replacement.isNotEmpty) {
+        // an addition
+        insertText(edit.offset + edit.length, edit.replacement);
+      }
 
+      if (edit.length != 0) {
+        // a removal
+        deleteRange(edit.offset, edit.length);
+      }
+    }
+  }
+
+  void deleteRange(int offset, int length) {
     source = source.substring(0, offset) +
         red +
         reversed +

pkg/dartfix/lib/src/migrate/migrate.dart

@@ -13,6 +13,7 @@ import 'package:args/command_runner.dart';
 import 'package:cli_util/cli_logging.dart';
 import 'package:path/path.dart' as path;
 
+import '../util.dart';
 import 'apply.dart';
 import 'display.dart';
 import 'options.dart';
@@ -106,7 +107,7 @@ class MigrateCommand extends Command {
       int issueCount =
           fileErrors.values.map((list) => list.length).reduce((a, b) => a + b);
       logger.stdout(
-          '$issueCount analysis ${_pluralize('issue', issueCount)} found:');
+          '$issueCount analysis ${pluralize('issue', issueCount)} found:');
       _displayIssues(
         logger,
         options.directory,
@@ -163,8 +164,8 @@ class MigrateCommand extends Command {
         migrationResults.edits.map((edit) => edit.file).toList();
 
     logger.stdout('Found ${allEdits.length} '
-        'suggested ${_pluralize('change', allEdits.length)} in '
-        '${files.length} ${_pluralize('file', files.length)}.');
+        'suggested ${pluralize('change', allEdits.length)} in '
+        '${files.length} ${pluralize('file', files.length)}.');
 
     logger.stdout('');
 
@@ -175,7 +176,7 @@ class MigrateCommand extends Command {
 
       logger.stdout('');
       logger.stdout(
-          'Applied ${allEdits.length} ${_pluralize('edit', allEdits.length)}.');
+          'Applied ${allEdits.length} ${pluralize('edit', allEdits.length)}.');
 
       return 0;
     }
@@ -284,7 +285,7 @@ class MigrateCommand extends Command {
 
       logger.stdout('');
       logger.stdout('${ansi.emphasized(relPath)} '
-          '($count ${_pluralize('change', count)}):');
+          '($count ${pluralize('change', count)}):');
 
       String source;
       try {
@@ -296,24 +297,10 @@ class MigrateCommand extends Command {
       } else {
         SourcePrinter sourcePrinter = SourcePrinter(source);
 
-        // Sort edits in reverse offset order.
-        List<SourceEdit> edits = sourceFileEdit.edits;
-        edits.sort((a, b) {
-          return b.offset - a.offset;
-        });
+        List<SourceEdit> edits = sortEdits(sourceFileEdit);
 
-        for (SourceEdit edit in sourceFileEdit.edits) {
-          if (edit.replacement.isNotEmpty) {
-            // an addition
-            sourcePrinter.insertText(
-                edit.offset + edit.length, edit.replacement);
-          }
-
-          if (edit.length != 0) {
-            // a removal
-            sourcePrinter.deleteRange(edit.offset, edit.length);
-          }
-        }
+        // Apply edits.
+        sourcePrinter.applyEdits(edits);
 
         // Render the changed lines.
         sourcePrinter.processChangedLines((lineNumber, lineText) {
@@ -333,7 +320,7 @@ class MigrateCommand extends Command {
     for (SourceFileEdit sourceFileEdit in migrationResults.edits) {
       String relPath = path.relative(sourceFileEdit.file, from: directory);
       int count = sourceFileEdit.edits.length;
-      logger.stdout('  $relPath ($count ${_pluralize('change', count)})');
+      logger.stdout('  $relPath ($count ${pluralize('change', count)})');
 
       String source;
       try {
@@ -441,5 +428,3 @@ String get _dartSdkVersion {
 
   return version;
 }
-
-String _pluralize(String word, int count) => count == 1 ? word : '${word}s';