Updating various parts of super_editor to support AttributedSpans wit…

…h exclusive end positions
superlistapp · Jun 24, 2022 · ddb1af5 · ddb1af5
1 parent 79b9e84
commit ddb1af5
Show file tree

Hide file tree

Showing 8 changed files with 46 additions and 50 deletions.
diff --git a/attributed_text/lib/src/attributed_spans.dart b/attributed_text/lib/src/attributed_spans.dart
@@ -559,7 +559,7 @@ class AttributedSpans {
     required AttributedSpans other,
     required int index,
   }) {
-    if (markers.isNotEmpty && markers.last.offset >= index) {
+    if (markers.isNotEmpty && markers.last.offset > index) {
       throw Exception(
           'Another AttributedSpans can only be appended after the final marker in this AttributedSpans. Final marker: ${markers.last}');
     }
@@ -605,7 +605,7 @@ class AttributedSpans {
     // Look for any compatible attributions at
     // `mergePoint - 1` and `mergePoint` and combine them.
     final endAtMergePointMarkers =
-        attributions.where((marker) => marker.isEnd && marker.offset == mergePoint - 1).toList();
+        attributions.where((marker) => marker.isEnd && marker.offset == mergePoint).toList();
     final startAtMergePointMarkers =
         attributions.where((marker) => marker.isStart && marker.offset == mergePoint).toList();
     for (final startMarker in startAtMergePointMarkers) {

diff --git a/attributed_text/lib/src/attributed_text.dart b/attributed_text/lib/src/attributed_text.dart
@@ -186,16 +186,14 @@ class AttributedText {
   AttributedText copyText(int startOffset, [int? endOffset]) {
     _log.fine('start: $startOffset, end: $endOffset');
 
-    // Note: -1 because copyText() uses an exclusive `start` and `end` but
-    // _copyAttributionRegion() uses an inclusive `start` and `end`.
     final startCopyOffset = startOffset < text.length ? startOffset : text.length - 1;
     int endCopyOffset;
     if (endOffset == startOffset) {
       endCopyOffset = startCopyOffset;
     } else if (endOffset != null) {
-      endCopyOffset = endOffset - 1;
+      endCopyOffset = endOffset;
     } else {
-      endCopyOffset = text.length - 1;
+      endCopyOffset = text.length;
     }
     _log.fine('offsets, start: $startCopyOffset, end: $endCopyOffset');
 
@@ -269,7 +267,7 @@ class AttributedText {
     final insertedText = AttributedText(
       text: textToInsert,
     );
-    final insertTextRange = SpanRange(start: 0, end: textToInsert.length - 1);
+    final insertTextRange = SpanRange(start: 0, end: textToInsert.length);
     for (dynamic attribution in applyAttributions) {
       insertedText.addAttribution(attribution, insertTextRange);
     }

diff --git a/...src/infrastructure/super_textfield/infrastructure/attributed_text_editing_controller.dart b/...src/infrastructure/super_textfield/infrastructure/attributed_text_editing_controller.dart
@@ -119,7 +119,7 @@ class AttributedTextEditingController with ChangeNotifier {
     for (final attribution in attributions) {
       _text.toggleAttribution(
         attribution,
-        SpanRange(start: selection.start, end: selection.end - 1),
+        SpanRange(start: selection.start, end: selection.end),
       );
     }
 
@@ -133,7 +133,7 @@ class AttributedTextEditingController with ChangeNotifier {
     }
 
     _text.clearAttributions(
-      SpanRange(start: selection.start, end: selection.end - 1),
+      SpanRange(start: selection.start, end: selection.end),
     );
 
     notifyListeners();

diff --git a/super_editor/test/src/attributed_text_styles_test.dart b/super_editor/test/src/attributed_text_styles_test.dart
@@ -21,7 +21,7 @@ void main() {
         spans: AttributedSpans(
           attributions: [
             const SpanMarker(attribution: ExpectedSpans.bold, offset: 0, markerType: SpanMarkerType.start),
-            const SpanMarker(attribution: ExpectedSpans.bold, offset: 9, markerType: SpanMarkerType.end),
+            const SpanMarker(attribution: ExpectedSpans.bold, offset: 10, markerType: SpanMarkerType.end),
           ],
         ),
       );
@@ -38,7 +38,7 @@ void main() {
         spans: AttributedSpans(
           attributions: [
             const SpanMarker(attribution: ExpectedSpans.bold, offset: 1, markerType: SpanMarkerType.start),
-            const SpanMarker(attribution: ExpectedSpans.bold, offset: 1, markerType: SpanMarkerType.end),
+            const SpanMarker(attribution: ExpectedSpans.bold, offset: 2, markerType: SpanMarkerType.end),
           ],
         ),
       );
@@ -61,7 +61,7 @@ void main() {
             // Notice that the markers are provided in reverse order:
             // end then start. Order shouldn't matter within a single
             // position index. This test ensures that.
-            const SpanMarker(attribution: ExpectedSpans.bold, offset: 1, markerType: SpanMarkerType.end),
+            const SpanMarker(attribution: ExpectedSpans.bold, offset: 2, markerType: SpanMarkerType.end),
             const SpanMarker(attribution: ExpectedSpans.bold, offset: 1, markerType: SpanMarkerType.start),
           ],
         ),
@@ -79,7 +79,7 @@ void main() {
 
     test('add single character style', () {
       final text = AttributedText(text: 'abcdefghij');
-      text.addAttribution(ExpectedSpans.bold, const SpanRange(start: 1, end: 1));
+      text.addAttribution(ExpectedSpans.bold, const SpanRange(start: 1, end: 2));
       final textSpan = text.computeTextSpan(_styleBuilder);
 
       expect(textSpan.text, null);
@@ -97,7 +97,7 @@ void main() {
         spans: AttributedSpans(
           attributions: [
             const SpanMarker(attribution: ExpectedSpans.bold, offset: 2, markerType: SpanMarkerType.start),
-            const SpanMarker(attribution: ExpectedSpans.bold, offset: 7, markerType: SpanMarkerType.end),
+            const SpanMarker(attribution: ExpectedSpans.bold, offset: 8, markerType: SpanMarkerType.end),
           ],
         ),
       );
@@ -117,7 +117,7 @@ void main() {
         spans: AttributedSpans(
           attributions: [
             const SpanMarker(attribution: ExpectedSpans.bold, offset: 9, markerType: SpanMarkerType.start),
-            const SpanMarker(attribution: ExpectedSpans.bold, offset: 9, markerType: SpanMarkerType.end),
+            const SpanMarker(attribution: ExpectedSpans.bold, offset: 10, markerType: SpanMarkerType.end),
           ],
         ),
       );
@@ -127,7 +127,7 @@ void main() {
         spans: AttributedSpans(
           attributions: [
             const SpanMarker(attribution: ExpectedSpans.bold, offset: 0, markerType: SpanMarkerType.start),
-            const SpanMarker(attribution: ExpectedSpans.bold, offset: 0, markerType: SpanMarkerType.end),
+            const SpanMarker(attribution: ExpectedSpans.bold, offset: 1, markerType: SpanMarkerType.end),
           ],
         ),
       ));
@@ -152,9 +152,9 @@ void main() {
         spans: AttributedSpans(
           attributions: [
             const SpanMarker(attribution: ExpectedSpans.bold, offset: 0, markerType: SpanMarkerType.start),
-            const SpanMarker(attribution: ExpectedSpans.bold, offset: 4, markerType: SpanMarkerType.end),
+            const SpanMarker(attribution: ExpectedSpans.bold, offset: 5, markerType: SpanMarkerType.end),
             const SpanMarker(attribution: ExpectedSpans.italics, offset: 5, markerType: SpanMarkerType.start),
-            const SpanMarker(attribution: ExpectedSpans.italics, offset: 9, markerType: SpanMarkerType.end),
+            const SpanMarker(attribution: ExpectedSpans.italics, offset: 10, markerType: SpanMarkerType.end),
           ],
         ),
       );
@@ -177,8 +177,8 @@ void main() {
           attributions: [
             const SpanMarker(attribution: ExpectedSpans.bold, offset: 2, markerType: SpanMarkerType.start),
             const SpanMarker(attribution: ExpectedSpans.italics, offset: 4, markerType: SpanMarkerType.start),
-            const SpanMarker(attribution: ExpectedSpans.bold, offset: 5, markerType: SpanMarkerType.end),
-            const SpanMarker(attribution: ExpectedSpans.italics, offset: 7, markerType: SpanMarkerType.end),
+            const SpanMarker(attribution: ExpectedSpans.bold, offset: 6, markerType: SpanMarkerType.end),
+            const SpanMarker(attribution: ExpectedSpans.italics, offset: 8, markerType: SpanMarkerType.end),
           ],
         ),
       );

diff --git a/super_editor/test/super_textfield/attributed_text_editing_controller_test.dart b/super_editor/test/super_textfield/attributed_text_editing_controller_test.dart
@@ -83,7 +83,7 @@ void main() {
             spans: AttributedSpans(
               attributions: [
                 const SpanMarker(attribution: boldAttribution, offset: 7, markerType: SpanMarkerType.start),
-                const SpanMarker(attribution: boldAttribution, offset: 8, markerType: SpanMarkerType.end),
+                const SpanMarker(attribution: boldAttribution, offset: 9, markerType: SpanMarkerType.end),
               ],
             ),
           ),
@@ -105,7 +105,7 @@ void main() {
             spans: AttributedSpans(
               attributions: [
                 const SpanMarker(attribution: boldAttribution, offset: 7, markerType: SpanMarkerType.start),
-                const SpanMarker(attribution: boldAttribution, offset: 8, markerType: SpanMarkerType.end),
+                const SpanMarker(attribution: boldAttribution, offset: 9, markerType: SpanMarkerType.end),
               ],
             ),
           ),
@@ -404,7 +404,7 @@ void main() {
             spans: AttributedSpans(
               attributions: [
                 const SpanMarker(attribution: boldAttribution, offset: 0, markerType: SpanMarkerType.start),
-                const SpanMarker(attribution: boldAttribution, offset: 0, markerType: SpanMarkerType.end),
+                const SpanMarker(attribution: boldAttribution, offset: 1, markerType: SpanMarkerType.end),
               ],
             ),
           ),
@@ -500,7 +500,7 @@ void main() {
             spans: AttributedSpans(
               attributions: [
                 const SpanMarker(attribution: boldAttribution, offset: 0, markerType: SpanMarkerType.start),
-                const SpanMarker(attribution: boldAttribution, offset: 10, markerType: SpanMarkerType.end),
+                const SpanMarker(attribution: boldAttribution, offset: 11, markerType: SpanMarkerType.end),
               ],
             ),
           ),

diff --git a/super_editor/test/super_textfield/ime_attributed_text_editing_controller_test.dart b/super_editor/test/super_textfield/ime_attributed_text_editing_controller_test.dart
@@ -189,7 +189,7 @@ void main() {
               spans: AttributedSpans(
                 attributions: [
                   const SpanMarker(attribution: boldAttribution, offset: 7, markerType: SpanMarkerType.start),
-                  const SpanMarker(attribution: boldAttribution, offset: 8, markerType: SpanMarkerType.end),
+                  const SpanMarker(attribution: boldAttribution, offset: 9, markerType: SpanMarkerType.end),
                 ],
               ),
             ),
@@ -221,7 +221,7 @@ void main() {
               spans: AttributedSpans(
                 attributions: [
                   const SpanMarker(attribution: boldAttribution, offset: 7, markerType: SpanMarkerType.start),
-                  const SpanMarker(attribution: boldAttribution, offset: 8, markerType: SpanMarkerType.end),
+                  const SpanMarker(attribution: boldAttribution, offset: 9, markerType: SpanMarkerType.end),
                 ],
               ),
             ),

diff --git a/super_editor_markdown/lib/src/markdown.dart b/super_editor_markdown/lib/src/markdown.dart
@@ -381,23 +381,23 @@ class _InlineMarkdownToDocument implements md.NodeVisitor {
         boldAttribution,
         SpanRange(
           start: 0,
-          end: styledText.text.length - 1,
+          end: styledText.text.length,
         ),
       );
     } else if (element.tag == 'em') {
       styledText.addAttribution(
         italicsAttribution,
         SpanRange(
           start: 0,
-          end: styledText.text.length - 1,
+          end: styledText.text.length,
         ),
       );
     } else if (element.tag == 'a') {
       styledText.addAttribution(
         LinkAttribution(url: Uri.parse(element.attributes['href']!)),
         SpanRange(
           start: 0,
-          end: styledText.text.length - 1,
+          end: styledText.text.length,
         ),
       );
     }
@@ -478,10 +478,8 @@ extension on AttributedText {
             ..write(markdownStyles);
           break;
         case AttributionVisitEvent.end:
-          // +1 on end index because this visitor has inclusive indices
-          // whereas substring() expects an exclusive ending index.
           buffer
-            ..write(fullText.text.substring(spanStart, index + 1))
+            ..write(fullText.text.substring(spanStart, index))
             ..write(markdownStyles)
             ..write(linkMarker);
           break;

diff --git a/super_editor_markdown/test/super_editor_markdown_test.dart b/super_editor_markdown/test/super_editor_markdown_test.dart
@@ -1,5 +1,5 @@
-import 'package:super_editor/super_editor.dart';
 import 'package:flutter_test/flutter_test.dart';
+import 'package:super_editor/super_editor.dart';
 import 'package:super_editor_markdown/super_editor_markdown.dart';
 
 void main() {
@@ -41,7 +41,7 @@ void main() {
               spans: AttributedSpans(
                 attributions: [
                   const SpanMarker(attribution: boldAttribution, offset: 3, markerType: SpanMarkerType.start),
-                  const SpanMarker(attribution: boldAttribution, offset: 8, markerType: SpanMarkerType.end),
+                  const SpanMarker(attribution: boldAttribution, offset: 9, markerType: SpanMarkerType.end),
                 ],
               ),
             ),
@@ -73,7 +73,7 @@ void main() {
               spans: AttributedSpans(
                 attributions: [
                   const SpanMarker(attribution: boldAttribution, offset: 10, markerType: SpanMarkerType.start),
-                  const SpanMarker(attribution: boldAttribution, offset: 19, markerType: SpanMarkerType.end),
+                  const SpanMarker(attribution: boldAttribution, offset: 20, markerType: SpanMarkerType.end),
                 ],
               ),
             ),
@@ -122,7 +122,7 @@ This is some code
               spans: AttributedSpans(
                 attributions: [
                   const SpanMarker(attribution: boldAttribution, offset: 5, markerType: SpanMarkerType.start),
-                  const SpanMarker(attribution: boldAttribution, offset: 8, markerType: SpanMarkerType.end),
+                  const SpanMarker(attribution: boldAttribution, offset: 9, markerType: SpanMarkerType.end),
                 ],
               ),
             ),
@@ -141,9 +141,9 @@ This is some code
               spans: AttributedSpans(
                 attributions: [
                   const SpanMarker(attribution: boldAttribution, offset: 5, markerType: SpanMarkerType.start),
-                  const SpanMarker(attribution: boldAttribution, offset: 8, markerType: SpanMarkerType.end),
+                  const SpanMarker(attribution: boldAttribution, offset: 9, markerType: SpanMarkerType.end),
                   const SpanMarker(attribution: italicsAttribution, offset: 5, markerType: SpanMarkerType.start),
-                  const SpanMarker(attribution: italicsAttribution, offset: 8, markerType: SpanMarkerType.end),
+                  const SpanMarker(attribution: italicsAttribution, offset: 9, markerType: SpanMarkerType.end),
                 ],
               ),
             ),
@@ -162,9 +162,9 @@ This is some code
               spans: AttributedSpans(
                 attributions: [
                   const SpanMarker(attribution: boldAttribution, offset: 5, markerType: SpanMarkerType.start),
-                  const SpanMarker(attribution: boldAttribution, offset: 8, markerType: SpanMarkerType.end),
+                  const SpanMarker(attribution: boldAttribution, offset: 9, markerType: SpanMarkerType.end),
                   const SpanMarker(attribution: italicsAttribution, offset: 5, markerType: SpanMarkerType.start),
-                  const SpanMarker(attribution: italicsAttribution, offset: 18, markerType: SpanMarkerType.end),
+                  const SpanMarker(attribution: italicsAttribution, offset: 19, markerType: SpanMarkerType.end),
                 ],
               ),
             ),
@@ -184,9 +184,9 @@ This is some code
               spans: AttributedSpans(
                 attributions: [
                   const SpanMarker(attribution: boldAttribution, offset: 5, markerType: SpanMarkerType.start),
-                  const SpanMarker(attribution: boldAttribution, offset: 8, markerType: SpanMarkerType.end),
+                  const SpanMarker(attribution: boldAttribution, offset: 9, markerType: SpanMarkerType.end),
                   const SpanMarker(attribution: codeAttribution, offset: 5, markerType: SpanMarkerType.start),
-                  const SpanMarker(attribution: codeAttribution, offset: 8, markerType: SpanMarkerType.end),
+                  const SpanMarker(attribution: codeAttribution, offset: 9, markerType: SpanMarkerType.end),
                 ],
               ),
             ),
@@ -210,7 +210,7 @@ This is some code
                       markerType: SpanMarkerType.start),
                   SpanMarker(
                       attribution: LinkAttribution(url: Uri.https('example.org', '')),
-                      offset: 18,
+                      offset: 19,
                       markerType: SpanMarkerType.end),
                 ],
               ),
@@ -235,10 +235,10 @@ This is some code
                       markerType: SpanMarkerType.start),
                   SpanMarker(
                       attribution: LinkAttribution(url: Uri.https('example.org', '')),
-                      offset: 18,
+                      offset: 19,
                       markerType: SpanMarkerType.end),
                   const SpanMarker(attribution: boldAttribution, offset: 10, markerType: SpanMarkerType.start),
-                  const SpanMarker(attribution: boldAttribution, offset: 18, markerType: SpanMarkerType.end),
+                  const SpanMarker(attribution: boldAttribution, offset: 19, markerType: SpanMarkerType.end),
                 ],
               ),
             ),
@@ -265,7 +265,7 @@ This is some code
                       offset: 18,
                       markerType: SpanMarkerType.end),
                   const SpanMarker(attribution: boldAttribution, offset: 5, markerType: SpanMarkerType.start),
-                  const SpanMarker(attribution: boldAttribution, offset: 8, markerType: SpanMarkerType.end),
+                  const SpanMarker(attribution: boldAttribution, offset: 9, markerType: SpanMarkerType.end),
                 ],
               ),
             ),
@@ -350,7 +350,7 @@ This is some code
               spans: AttributedSpans(
                 attributions: [
                   const SpanMarker(attribution: boldAttribution, offset: 0, markerType: SpanMarkerType.start),
-                  const SpanMarker(attribution: boldAttribution, offset: 8, markerType: SpanMarkerType.end),
+                  const SpanMarker(attribution: boldAttribution, offset: 9, markerType: SpanMarkerType.end),
                 ],
               ),
             ),
@@ -412,7 +412,7 @@ This is some code
               spans: AttributedSpans(
                 attributions: [
                   const SpanMarker(attribution: boldAttribution, offset: 0, markerType: SpanMarkerType.start),
-                  const SpanMarker(attribution: boldAttribution, offset: 6, markerType: SpanMarkerType.end),
+                  const SpanMarker(attribution: boldAttribution, offset: 7, markerType: SpanMarkerType.end),
                 ],
               ),
             ),
@@ -566,8 +566,8 @@ This is some code
         expect(styledText.getAllAttributionsAt(0).isEmpty, true);
         expect(styledText.getAllAttributionsAt(8).contains(boldAttribution), true);
         expect(styledText.getAllAttributionsAt(13).containsAll([boldAttribution, italicsAttribution]), true);
-        expect(styledText.getAllAttributionsAt(19).isEmpty, true);
-        expect(styledText.getAllAttributionsAt(40).single, LinkAttribution(url: Uri.https('example.org', '')));
+        expect(styledText.getAllAttributionsAt(20).isEmpty, true);
+        expect(styledText.getAllAttributionsAt(41).single, LinkAttribution(url: Uri.https('example.org', '')));
       });
 
       test('link within multiple styles', () {