Minor improvements based on feedback at PR#231

DzmitrySalauyeuAnadea · DzmitrySalauyeuAkvelon · commit 67a6a1b0cf56 · 2025-03-07T16:15:10.000+01:00
diff --git a/lib/src/code_field/code_controller.dart b/lib/src/code_field/code_controller.dart
@@ -11,8 +11,8 @@ import 'package:meta/meta.dart';
 import '../../flutter_code_editor.dart';
 import '../autocomplete/autocompleter.dart';
 import '../code/code_edit_result.dart';
-import '../code_modifiers/insertion.dart';
 import '../code/key_event.dart';
+import '../code_modifiers/insertion.dart';
 import '../history/code_history_controller.dart';
 import '../history/code_history_record.dart';
 import '../search/controller.dart';
@@ -51,6 +51,7 @@ class CodeController extends TextEditingController {
   /// Calls [AbstractAnalyzer.analyze] after change with 500ms debounce.
   AbstractAnalyzer get analyzer => _analyzer;
   AbstractAnalyzer _analyzer;
+
   set analyzer(AbstractAnalyzer analyzer) {
     if (_analyzer == analyzer) {
       return;
@@ -108,6 +109,7 @@ class CodeController extends TextEditingController {
 
   SearchSettingsController get _searchSettingsController =>
       searchController.settingsController;
+
   SearchNavigationController get _searchNavigationController =>
       searchController.navigationController;
 
@@ -134,16 +136,16 @@ class CodeController extends TextEditingController {
   };
 
   static const defaultCodeModifiers = [
-      IndentModifier(),
-      CloseBlockModifier(),
-      TabModifier(),
-      InsertionCodeModifier.backticks,
-      InsertionCodeModifier.braces,
-      InsertionCodeModifier.brackets,
-      InsertionCodeModifier.doubleQuotes,
-      InsertionCodeModifier.parentheses,
-      InsertionCodeModifier.singleQuotes,
-    ];
+    IndentModifier(),
+    CloseBlockModifier(),
+    TabModifier(),
+    InsertionCodeModifier.backticks,
+    InsertionCodeModifier.braces,
+    InsertionCodeModifier.brackets,
+    InsertionCodeModifier.doubleQuotes,
+    InsertionCodeModifier.parentheses,
+    InsertionCodeModifier.singleQuotes,
+  ];
 
   CodeController({
     String? text,
diff --git a/lib/src/code_modifiers/close_block_code_modifier.dart b/lib/src/code_modifiers/close_block_code_modifier.dart
@@ -5,7 +5,7 @@ import 'package:flutter/widgets.dart';
 import '../code_field/editor_params.dart';
 import 'code_modifier.dart';
 
-/// [CloseBlockModifier] is an implementation of [CodeModifier] 
+/// [CloseBlockModifier] is an implementation of [CodeModifier]
 /// that remove spaces before the closing bracket, if required.
 class CloseBlockModifier extends CodeModifier {
   const CloseBlockModifier() : super('}');
diff --git a/lib/src/code_modifiers/code_modifier.dart b/lib/src/code_modifiers/code_modifier.dart
@@ -7,7 +7,7 @@ abstract class CodeModifier {
 
   const CodeModifier(this.char);
 
-  // Helper to insert [str] in [text] between [start] and [end]
+  /// Helper to insert [str] in [text] between [start] and [end]
   TextEditingValue replace(String text, int start, int end, String str) {
     final len = str.length;
     return TextEditingValue(
diff --git a/lib/src/wip/autocomplete/popup.dart b/lib/src/wip/autocomplete/popup.dart
@@ -45,6 +45,7 @@ class Popup extends StatefulWidget {
 
 class PopupState extends State<Popup> {
   final pageStorageBucket = PageStorageBucket();
+
   @override
   void initState() {
     widget.controller.reset();
diff --git a/lib/src/wip/autocomplete/popup_controller.dart b/lib/src/wip/autocomplete/popup_controller.dart
@@ -24,11 +24,13 @@ class PopupController extends ChangeNotifier {
   int get selectedIndex => _selectedIndex;
 
   void reset() {
-    itemScrollController = ItemScrollController();
+    if (itemScrollController.isAttached) {
+      itemScrollController.jumpTo(index: 0);
+    }
   }
 
   void show(List<String> suggestions) {
-    if (enabled == false) {
+    if (!enabled) {
       return;
     }
 
diff --git a/test/src/code_modifiers/insertion_test.dart b/test/src/code_modifiers/insertion_test.dart
@@ -4,72 +4,70 @@ import 'package:flutter_code_editor/src/code_modifiers/insertion.dart';
 import 'package:flutter_test/flutter_test.dart';
 
 void main() {
-  test('inserts at the start of string correctly', () {
+  group('InsertionCodeModifier', () {
     const modifier = InsertionCodeModifier(openChar: '1', closeString: '23');
-    const text = 'Hello World';
-    final selection = TextSelection.fromPosition(const TextPosition(offset: 0));
     const editorParams = EditorParams();
 
-    final result = modifier.updateString(text, selection, editorParams);
+    test('inserts at the start of string correctly', () {
+      const text = 'Hello World';
+      final selection =
+          TextSelection.fromPosition(const TextPosition(offset: 0));
 
-    expect(result!.text, '123Hello World');
-    expect(result.selection.baseOffset, 1);
-    expect(result.selection.extentOffset, 1);
-  });
+      final result = modifier.updateString(text, selection, editorParams);
 
-  test('inserts in the middle of string correctly', () {
-    const modifier = InsertionCodeModifier(openChar: '1', closeString: '23');
-    const text = 'Hello World';
-    final selection = TextSelection.fromPosition(const TextPosition(offset: 5));
-    const editorParams = EditorParams();
+      expect(result!.text, '123Hello World');
+      expect(result.selection.baseOffset, 1);
+      expect(result.selection.extentOffset, 1);
+    });
 
-    final result = modifier.updateString(text, selection, editorParams);
+    test('inserts in the middle of string correctly', () {
+      const text = 'Hello World';
+      final selection =
+          TextSelection.fromPosition(const TextPosition(offset: 5));
 
-    expect(result!.text, 'Hello123 World');
-    expect(result.selection.baseOffset, 6);
-    expect(result.selection.extentOffset, 6);
-  });
+      final result = modifier.updateString(text, selection, editorParams);
 
-  test('inserts at the end of string correctly', () {
-    const modifier = InsertionCodeModifier(openChar: '1', closeString: '23');
-    const text = 'Hello World';
-    final selection =
-        TextSelection.fromPosition(const TextPosition(offset: text.length));
-    const editorParams = EditorParams();
+      expect(result!.text, 'Hello123 World');
+      expect(result.selection.baseOffset, 6);
+      expect(result.selection.extentOffset, 6);
+    });
 
-    final result = modifier.updateString(text, selection, editorParams);
+    test('inserts at the end of string correctly', () {
+      const text = 'Hello World';
+      final selection =
+          TextSelection.fromPosition(const TextPosition(offset: text.length));
 
-    expect(result!.text, 'Hello World123');
-    expect(result.selection.baseOffset, text.length + 1);
-    expect(result.selection.extentOffset, text.length + 1);
-  });
+      final result = modifier.updateString(text, selection, editorParams);
 
-  test('inserts in the middle of string with selection correctly', () {
-    const modifier = InsertionCodeModifier(openChar: '1', closeString: '23');
-    const text = 'Hello World';
-    const selection = TextSelection(
-      baseOffset: 5,
-      extentOffset: 7,
-    );
-    const editorParams = EditorParams();
+      expect(result!.text, 'Hello World123');
+      expect(result.selection.baseOffset, text.length + 1);
+      expect(result.selection.extentOffset, text.length + 1);
+    });
 
-    final result = modifier.updateString(text, selection, editorParams);
+    test('inserts in the middle of string with selection correctly', () {
+      const text = 'Hello World';
+      const selection = TextSelection(
+        baseOffset: 5,
+        extentOffset: 7,
+      );
 
-    expect(result!.text, 'Hello123orld');
-    expect(result.selection.baseOffset, 6);
-    expect(result.selection.extentOffset, 6);
-  });
+      final result = modifier.updateString(text, selection, editorParams);
 
-  test('inserts at empty string correctly', () {
-    const modifier = InsertionCodeModifier(openChar: '1', closeString: '23');
-    const text = '';
-    final selection = TextSelection.fromPosition(const TextPosition(offset: 0));
-    const editorParams = EditorParams();
+      expect(result!.text, 'Hello123orld');
+      expect(result.selection.baseOffset, 6);
+      expect(result.selection.extentOffset, 6);
+    });
+
+    test('inserts at empty string correctly', () {
+      const text = '';
+      final selection =
+          TextSelection.fromPosition(const TextPosition(offset: 0));
 
-    final result = modifier.updateString(text, selection, editorParams);
+      final result = modifier.updateString(text, selection, editorParams);
 
-    expect(result!.text, '123');
-    expect(result.selection.baseOffset, 1);
-    expect(result.selection.extentOffset, 1);
+      expect(result!.text, '123');
+      expect(result.selection.baseOffset, 1);
+      expect(result.selection.extentOffset, 1);
+    });
   });
 }
diff --git a/test/src/search/code_controller_test.dart b/test/src/search/code_controller_test.dart
@@ -1,4 +1,5 @@
 import 'package:flutter/services.dart';
+import 'package:flutter_code_editor/flutter_code_editor.dart';
 import 'package:flutter_code_editor/src/search/match.dart';
 import 'package:flutter_code_editor/src/search/result.dart';
 import 'package:flutter_code_editor/src/search/settings.dart';
@@ -7,7 +8,7 @@ import 'package:flutter_test/flutter_test.dart';
 import '../common/create_app.dart';
 
 void main() {
-  group('CodeController', () {
+  group('CodeController, Search-related functionality', () {
     testWidgets('CTRL + F shows search, Escape hides', (wt) async {
       const text = 'AaAa';
       final controller = await pumpController(wt, text);
@@ -60,4 +61,102 @@ void main() {
       await wt.pumpAndSettle();
     });
   });
+
+  /// Requested to add at {@link https://github.com/akvelon/flutter-code-editor/pull/231}
+  group('CodeController-related formatting checks [Default params]', () {
+    /// tests insertion of existing modifiers into the code controller
+    /// at the defined index
+    void testInsertionAtIndex(
+      CodeController controller,
+      String initialText,
+      String insertedStart,
+      String insertedEnd,
+      int insertionIndex,
+    ) {
+      final selection = TextSelection(
+        baseOffset: insertionIndex,
+        extentOffset: insertionIndex,
+      );
+      // to move selection of textEditingValue at defined place
+      controller.value = TextEditingValue(
+        text: initialText,
+        selection: selection,
+      );
+
+      final textWithInsertedStart = initialText.replaceRange(
+        insertionIndex,
+        insertionIndex,
+        insertedStart,
+      );
+      controller.value = TextEditingValue(
+        text: textWithInsertedStart,
+        selection: selection,
+      );
+
+      final expectedText = initialText.replaceRange(
+        insertionIndex,
+        insertionIndex,
+        '$insertedStart$insertedEnd',
+      );
+      expect(controller.value.text, expectedText);
+    }
+
+    /// tests insertion at the start, middle and end of the initial text
+    Future<void> testInsertion(
+      WidgetTester wt,
+      String insertedStart, {
+      String? insertedEnd,
+    }) async {
+      insertedEnd ??= insertedStart;
+
+      const initialText = 'Hello';
+      final controller = await pumpController(wt, initialText);
+
+      testInsertionAtIndex(
+        controller,
+        initialText,
+        insertedStart,
+        insertedEnd,
+        0,
+      );
+      testInsertionAtIndex(
+        controller,
+        initialText,
+        insertedStart,
+        insertedEnd,
+        2,
+      );
+      testInsertionAtIndex(
+        controller,
+        initialText,
+        insertedStart,
+        insertedEnd,
+        initialText.length,
+      );
+    }
+
+    testWidgets('controller handles insertion of backticks', (wt) async {
+      await testInsertion(wt, '`');
+    });
+
+    testWidgets('controller handles insertion of single quotes', (wt) async {
+      await testInsertion(wt, '\'');
+    });
+
+    testWidgets('controller handles insertion of double quotes', (wt) async {
+      await testInsertion(wt, '"');
+    });
+
+    testWidgets('controller handles insertion of parentheses', (wt) async {
+      await testInsertion(wt, '(', insertedEnd: ')');
+    });
+
+    testWidgets('controller handles insertion of braces', (wt) async {
+      await testInsertion(wt, '{', insertedEnd: '}');
+    });
+
+    testWidgets('controller handles insertion of square brackets', (wt) async {
+      await testInsertion(wt, '[', insertedEnd: ']');
+    });
+  });
 }

Original file line number	Diff line number	Diff line change
`@@ -24,11 +24,13 @@ class PopupController extends ChangeNotifier {`
`24`	`24`	`int get selectedIndex => _selectedIndex;`
`25`	`25`
`26`	`26`	`void reset() {`
`27`		`- itemScrollController = ItemScrollController();`
	`27`	`+ if (itemScrollController.isAttached) {`
	`28`	`+ itemScrollController.jumpTo(index: 0);`
	`29`	`+ }`
`28`	`30`	`}`
`29`	`31`
`30`	`32`	`void show(List<String> suggestions) {`
`31`		`- if (enabled == false) {`
	`33`	`+ if (!enabled) {`
`32`	`34`	`return;`
`33`	`35`	`}`
`34`	`36`