Move string utils from services/correction to utilities; more generally used

srawlins · commit-bot@chromium.org · commit 680a880c1063 · 2019-10-17T15:04:00.000Z
Change-Id: Idb81b54fe380e6af00af5ddee3977705ff58c741 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/121912 Reviewed-by: Paul Berry <paulberry@google.com> Commit-Queue: Samuel Rawlins <srawlins@google.com>
diff --git a/pkg/analysis_server/lib/src/edit/nnbd_migration/info_builder.dart b/pkg/analysis_server/lib/src/edit/nnbd_migration/info_builder.dart
@@ -10,6 +10,7 @@ import 'package:analysis_server/src/edit/fix/dartfix_listener.dart';
 import 'package:analysis_server/src/edit/nnbd_migration/instrumentation_information.dart';
 import 'package:analysis_server/src/edit/nnbd_migration/migration_info.dart';
 import 'package:analysis_server/src/edit/nnbd_migration/offset_mapper.dart';
+import 'package:analysis_server/src/utilities/strings.dart';
 import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer/dart/analysis/session.dart';
 import 'package:analyzer/dart/ast/ast.dart';
@@ -106,11 +107,9 @@ class InfoBuilder {
     }
     String nullableValue =
         node is NullLiteral ? "an explicit 'null'" : "a nullable value";
-    String nullableValue2 =
-        node is NullLiteral ? "An explicit 'null'" : "A nullable value";
     AstNode parent = node.parent;
     if (parent is ArgumentList) {
-      return "$nullableValue2 is passed as an argument";
+      return capitalize("$nullableValue is passed as an argument");
     }
 
     /// If the [node] is inside the return expression for a function body,
@@ -171,7 +170,7 @@ class InfoBuilder {
     } else if (parent is AsExpression) {
       return "The value of the expression is nullable";
     }
-    return "$nullableValue2 is assigned";
+    return capitalize("$nullableValue is assigned");
   }
 
   /// Return details for a fix built from the given [edge], or `null` if the
diff --git a/pkg/analysis_server/lib/src/services/completion/dart/local_reference_contributor.dart b/pkg/analysis_server/lib/src/services/completion/dart/local_reference_contributor.dart
@@ -10,7 +10,7 @@ import 'package:analysis_server/src/provisional/completion/dart/completion_dart.
 import 'package:analysis_server/src/services/completion/dart/completion_manager.dart'
     show DartCompletionRequestImpl;
 import 'package:analysis_server/src/services/completion/dart/utilities.dart';
-import 'package:analysis_server/src/services/correction/strings.dart';
+import 'package:analysis_server/src/utilities/strings.dart';
 import 'package:analyzer/dart/analysis/features.dart';
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/ast/token.dart';
diff --git a/pkg/analysis_server/lib/src/services/correction/fix/analysis_options/fix_generator.dart b/pkg/analysis_server/lib/src/services/correction/fix/analysis_options/fix_generator.dart
@@ -6,7 +6,7 @@ import 'dart:math' as math;
 
 import 'package:analysis_server/plugin/edit/fix/fix_core.dart';
 import 'package:analysis_server/src/services/correction/fix.dart';
-import 'package:analysis_server/src/services/correction/strings.dart';
+import 'package:analysis_server/src/utilities/strings.dart';
 import 'package:analysis_server/src/utilities/yaml_node_locator.dart';
 import 'package:analyzer/error/error.dart';
 import 'package:analyzer/source/line_info.dart';
diff --git a/pkg/analysis_server/lib/src/services/correction/fix/manifest/fix_generator.dart b/pkg/analysis_server/lib/src/services/correction/fix/manifest/fix_generator.dart
@@ -5,7 +5,7 @@
 import 'dart:math' as math;
 
 import 'package:analysis_server/plugin/edit/fix/fix_core.dart';
-import 'package:analysis_server/src/services/correction/strings.dart';
+import 'package:analysis_server/src/utilities/strings.dart';
 import 'package:analyzer/error/error.dart';
 import 'package:analyzer/source/line_info.dart';
 import 'package:analyzer/source/source_range.dart';
diff --git a/pkg/analysis_server/lib/src/services/correction/fix/pubspec/fix_generator.dart b/pkg/analysis_server/lib/src/services/correction/fix/pubspec/fix_generator.dart
@@ -5,7 +5,7 @@
 import 'dart:math' as math;
 
 import 'package:analysis_server/plugin/edit/fix/fix_core.dart';
-import 'package:analysis_server/src/services/correction/strings.dart';
+import 'package:analysis_server/src/utilities/strings.dart';
 import 'package:analysis_server/src/utilities/yaml_node_locator.dart';
 import 'package:analyzer/error/error.dart';
 import 'package:analyzer/source/line_info.dart';
diff --git a/pkg/analysis_server/lib/src/services/correction/fix_internal.dart b/pkg/analysis_server/lib/src/services/correction/fix_internal.dart
@@ -14,10 +14,10 @@ import 'package:analysis_server/src/services/correction/fix.dart';
 import 'package:analysis_server/src/services/correction/fix/dart/top_level_declarations.dart';
 import 'package:analysis_server/src/services/correction/levenshtein.dart';
 import 'package:analysis_server/src/services/correction/namespace.dart';
-import 'package:analysis_server/src/services/correction/strings.dart';
 import 'package:analysis_server/src/services/correction/util.dart';
 import 'package:analysis_server/src/services/linter/lint_names.dart';
 import 'package:analysis_server/src/services/search/hierarchy.dart';
+import 'package:analysis_server/src/utilities/strings.dart';
 import 'package:analyzer/dart/analysis/features.dart';
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/ast/precedence.dart';
diff --git a/pkg/analysis_server/lib/src/services/correction/name_suggestion.dart b/pkg/analysis_server/lib/src/services/correction/name_suggestion.dart
@@ -2,7 +2,7 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-import 'package:analysis_server/src/services/correction/strings.dart';
+import 'package:analysis_server/src/utilities/strings.dart';
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/dart/element/type.dart';
diff --git a/pkg/analysis_server/lib/src/services/correction/organize_directives.dart b/pkg/analysis_server/lib/src/services/correction/organize_directives.dart
@@ -2,7 +2,7 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-import 'package:analysis_server/src/services/correction/strings.dart';
+import 'package:analysis_server/src/utilities/strings.dart';
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/ast/token.dart';
 import 'package:analyzer/error/error.dart';
diff --git a/pkg/analysis_server/lib/src/services/correction/sort_members.dart b/pkg/analysis_server/lib/src/services/correction/sort_members.dart
@@ -2,7 +2,7 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-import 'package:analysis_server/src/services/correction/strings.dart';
+import 'package:analysis_server/src/utilities/strings.dart';
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer_plugin/protocol/protocol_common.dart' hide Element;
 
diff --git a/pkg/analysis_server/lib/src/services/correction/util.dart b/pkg/analysis_server/lib/src/services/correction/util.dart
@@ -6,7 +6,7 @@ import 'dart:math';
 
 import 'package:analysis_server/src/protocol_server.dart'
     show doSourceChange_addElementEdit;
-import 'package:analysis_server/src/services/correction/strings.dart';
+import 'package:analysis_server/src/utilities/strings.dart';
 import 'package:analyzer/dart/analysis/features.dart';
 import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer/dart/analysis/session.dart';
@@ -734,7 +734,7 @@ class CorrectionUtils {
     // skip whitespace characters
     while (index < length) {
       int c = _buffer.codeUnitAt(index);
-      if (!isWhitespace(c) || c == 0x0D || c == 0x0A) {
+      if (!isWhitespace(c) || isEOL(c)) {
         break;
       }
       index++;
diff --git a/pkg/analysis_server/lib/src/services/refactoring/extract_local.dart b/pkg/analysis_server/lib/src/services/refactoring/extract_local.dart
@@ -8,12 +8,12 @@ import 'dart:collection';
 import 'package:analysis_server/src/protocol_server.dart' hide Element;
 import 'package:analysis_server/src/services/correction/name_suggestion.dart';
 import 'package:analysis_server/src/services/correction/status.dart';
-import 'package:analysis_server/src/services/correction/strings.dart';
 import 'package:analysis_server/src/services/correction/util.dart';
 import 'package:analysis_server/src/services/linter/lint_names.dart';
 import 'package:analysis_server/src/services/refactoring/naming_conventions.dart';
 import 'package:analysis_server/src/services/refactoring/refactoring.dart';
 import 'package:analysis_server/src/services/refactoring/refactoring_internal.dart';
+import 'package:analysis_server/src/utilities/strings.dart';
 import 'package:analyzer/dart/analysis/features.dart';
 import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer/dart/ast/ast.dart';
diff --git a/pkg/analysis_server/lib/src/services/refactoring/inline_method.dart b/pkg/analysis_server/lib/src/services/refactoring/inline_method.dart
@@ -6,13 +6,13 @@ import 'dart:async';
 
 import 'package:analysis_server/src/protocol_server.dart' hide Element;
 import 'package:analysis_server/src/services/correction/status.dart';
-import 'package:analysis_server/src/services/correction/strings.dart';
 import 'package:analysis_server/src/services/correction/util.dart';
 import 'package:analysis_server/src/services/refactoring/refactoring.dart';
 import 'package:analysis_server/src/services/refactoring/refactoring_internal.dart';
 import 'package:analysis_server/src/services/refactoring/visible_ranges_computer.dart';
 import 'package:analysis_server/src/services/search/hierarchy.dart';
 import 'package:analysis_server/src/services/search/search_engine.dart';
+import 'package:analysis_server/src/utilities/strings.dart';
 import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/ast/precedence.dart';
diff --git a/pkg/analysis_server/lib/src/services/refactoring/naming_conventions.dart b/pkg/analysis_server/lib/src/services/refactoring/naming_conventions.dart
@@ -3,7 +3,7 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:analysis_server/src/services/correction/status.dart';
-import 'package:analysis_server/src/services/correction/strings.dart';
+import 'package:analysis_server/src/utilities/strings.dart';
 import 'package:analyzer_plugin/src/utilities/string_utilities.dart';
 import 'package:front_end/src/scanner/token.dart' show Keyword;
 
diff --git a/pkg/analysis_server/lib/src/utilities/flutter.dart b/pkg/analysis_server/lib/src/utilities/flutter.dart
@@ -2,7 +2,7 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-import 'package:analysis_server/src/services/correction/strings.dart';
+import 'package:analysis_server/src/utilities/strings.dart';
 import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/ast/visitor.dart';
diff --git a/pkg/analysis_server/lib/src/utilities/strings.dart b/pkg/analysis_server/lib/src/utilities/strings.dart
@@ -6,14 +6,10 @@ import 'dart:math';
 
 import 'package:analyzer_plugin/src/utilities/string_utilities.dart';
 
-/**
- * "$"
- */
+/// "$"
 const int CHAR_DOLLAR = 0x24;
 
-/**
- * "_"
- */
+/// "_"
 const int CHAR_UNDERSCORE = 0x5F;
 
 String capitalize(String str) {
@@ -36,9 +32,7 @@ int compareStrings(String a, String b) {
   return a.compareTo(b);
 }
 
-/**
- * Return a simple difference between the given [oldStr] and [newStr].
- */
+/// Return a simple difference between the given [oldStr] and [newStr].
 SimpleDiff computeSimpleDiff(String oldStr, String newStr) {
   int prefixLength = findCommonPrefix(oldStr, newStr);
   int suffixLength = findCommonSuffix(oldStr, newStr);
@@ -65,9 +59,7 @@ int countLeadingWhitespaces(String str) {
   return i;
 }
 
-/**
- * Counts how many times [sub] appears in [str].
- */
+/// Counts how many times [sub] appears in [str].
 int countMatches(String str, String sub) {
   if (isEmpty(str) || isEmpty(sub)) {
     return 0;
@@ -92,9 +84,7 @@ int countTrailingWhitespaces(String str) {
   return i;
 }
 
-/**
- * Return the number of characters common to the start of [a] and [b].
- */
+/// Returns the number of characters common to the start of [a] and [b].
 int findCommonPrefix(String a, String b) {
   int n = min(a.length, b.length);
   for (int i = 0; i < n; i++) {
@@ -105,9 +95,7 @@ int findCommonPrefix(String a, String b) {
   return n;
 }
 
-/**
- * Return the number of characters common to the end of [a] and [b].
- */
+/// Returns the number of characters common to the end of [a] and [b].
 int findCommonSuffix(String a, String b) {
   int a_length = a.length;
   int b_length = b.length;
@@ -120,9 +108,7 @@ int findCommonSuffix(String a, String b) {
   return n;
 }
 
-/**
- * Checks if [str] is `null`, empty or is whitespace.
- */
+/// Checks if [str] is `null`, empty or is whitespace.
 bool isBlank(String str) {
   if (str == null) {
     return true;
@@ -173,9 +159,7 @@ String repeat(String s, int n) {
   return sb.toString();
 }
 
-/**
- * If the [text] length is above the [limit], replace the middle with `...`.
- */
+/// If the [text] length is above the [limit], replace the middle with `...`.
 String shorten(String text, int limit) {
   if (text.length > limit) {
     int headLength = limit ~/ 2 - 1;
@@ -187,10 +171,8 @@ String shorten(String text, int limit) {
   return text;
 }
 
-/**
- * Information about a single replacement that should be made to convert the
- * "old" string to the "new" one.
- */
+/// Information about a single replacement that should be made to convert the
+/// "old" string to the "new" one.
 class SimpleDiff {
   final int offset;
   final int length;
diff --git a/pkg/analysis_server/test/services/correction/test_all.dart b/pkg/analysis_server/test/services/correction/test_all.dart
@@ -10,7 +10,6 @@ import 'name_suggestion_test.dart' as name_suggestion_test;
 import 'organize_directives_test.dart' as organize_directives_test;
 import 'sort_members_test.dart' as sort_members_test;
 import 'status_test.dart' as status_test;
-import 'strings_test.dart' as strings_test;
 import 'util_test.dart' as util_test;
 
 /// Utility for manually running all tests.
@@ -22,7 +21,6 @@ main() {
     organize_directives_test.main();
     sort_members_test.main();
     status_test.main();
-    strings_test.main();
     util_test.main();
   }, name: 'correction');
 }
diff --git a/pkg/analysis_server/test/src/utilities/strings_test.dart b/pkg/analysis_server/test/src/utilities/strings_test.dart
@@ -2,7 +2,7 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-import 'package:analysis_server/src/services/correction/strings.dart';
+import 'package:analysis_server/src/utilities/strings.dart';
 import 'package:test/test.dart' hide isEmpty;
 import 'package:test_reflective_loader/test_reflective_loader.dart';
 
diff --git a/pkg/analysis_server/test/src/utilities/test_all.dart b/pkg/analysis_server/test/src/utilities/test_all.dart
@@ -6,10 +6,12 @@ import 'package:test_reflective_loader/test_reflective_loader.dart';
 
 import 'flutter_test.dart' as flutter_test;
 import 'profiling_test.dart' as profiling_test;
+import 'strings_test.dart' as strings_test;
 
 main() {
   defineReflectiveSuite(() {
     flutter_test.main();
     profiling_test.main();
+    strings_test.main();
   });
 }
diff --git a/pkg/analysis_server/tool/lsp_spec/generate_all.dart b/pkg/analysis_server/tool/lsp_spec/generate_all.dart
@@ -5,7 +5,7 @@
 import 'dart:async';
 import 'dart:io';
 
-import 'package:analysis_server/src/services/correction/strings.dart';
+import 'package:analysis_server/src/utilities/strings.dart';
 import 'package:args/args.dart';
 import 'package:http/http.dart' as http;
 import 'package:path/path.dart' as path;
diff --git a/pkg/analysis_server/tool/lsp_spec/typescript_parser.dart b/pkg/analysis_server/tool/lsp_spec/typescript_parser.dart
@@ -4,8 +4,7 @@
 
 import 'dart:math';
 
-import 'package:analysis_server/src/services/correction/strings.dart'
-    show capitalize;
+import 'package:analysis_server/src/utilities/strings.dart' show capitalize;
 
 import 'codegen_dart.dart';
 import 'typescript.dart';
