feat: Add different kind of TextEdit for convenience (#1641)

Author: bhirsz

src/robocop/linter/fix.py

@@ -13,6 +13,22 @@
     from robocop.source_file import SourceFile
 
 
+class TextEditKind(Enum):
+    """
+    Enumeration of edit operation types.
+
+    Attributes:
+        REPLACEMENT (str): Replace an existing line or part of it with the new content.
+        INSERTION (str): Insert a new line or lines without changing existing lines.
+        DELETION (str): Delete line or lines.
+
+    """
+
+    REPLACEMENT = "replace"
+    INSERTION = "insert"
+    DELETION = "delete"
+
+
 @dataclass
 class TextEdit:
     """
@@ -38,11 +54,18 @@ class TextEdit:
     rule_id: str
     rule_name: str
     start_line: int
-    start_col: int
-    end_line: int
-    start_line: int
-    end_col: int
-    replacement: str
+    start_col: int | None
+    end_line: int | None
+    end_col: int | None
+    replacement: str | None
+
+    @property
+    def kind(self) -> TextEditKind:
+        if self.replacement is None:
+            return TextEditKind.DELETION
+        if self.end_line is None:
+            return TextEditKind.INSERTION
+        return TextEditKind.REPLACEMENT
 
     @classmethod
     def replace_at_range(cls, rule_id: str, rule_name: str, diag_range: Range, replacement: str) -> TextEdit:
@@ -56,6 +79,32 @@ def replace_at_range(cls, rule_id: str, rule_name: str, diag_range: Range, repla
             replacement=replacement,
         )
 
+    @classmethod
+    def remove_at_range(cls, rule_id: str, rule_name: str, diag_range: Range) -> TextEdit:
+        """Remove lines between start_line and end_line from the edit range."""
+        return cls(
+            rule_id=rule_id,
+            rule_name=rule_name,
+            start_line=diag_range.start.line,
+            start_col=None,
+            end_line=diag_range.end.line,
+            end_col=None,
+            replacement=None,
+        )
+
+    @classmethod
+    def insert_at_range(cls, rule_id: str, rule_name: str, diag_range: Range, replacement: str) -> TextEdit:
+        """Insert new content at start_line."""
+        return cls(
+            rule_id=rule_id,
+            rule_name=rule_name,
+            start_line=diag_range.start.line,
+            start_col=None,
+            end_line=None,
+            end_col=None,
+            replacement=replacement,
+        )
+
 
 class FixApplicability(Enum):
     """
@@ -220,17 +269,24 @@ def _apply_edit(lines: list[str], edit: TextEdit) -> None:
             edit: The edit to apply (uses 1-indexed line/col numbers).
 
         """
-        if edit.end_line > len(lines) or edit.start_line < 1:
-            return
-        start_line_idx = edit.start_line - 1
-        end_line_idx = edit.end_line - 1
-        start_col_idx = edit.start_col - 1
-        end_col_idx = edit.end_col - 1
-
-        if start_line_idx == end_line_idx:  # single line
-            line = lines[edit.start_line - 1]  # TODO: store for diff view, + surrounding lines
-            new_line = line[:start_col_idx] + edit.replacement + line[end_col_idx:]
-            lines[start_line_idx] = new_line
-        else:  # Multi-line edit
-            # When edit is multiline, we replace the lines fully
-            lines[start_line_idx : end_line_idx + 2] = [edit.replacement]
+        if edit.kind == TextEditKind.REPLACEMENT:
+            if edit.end_line > len(lines) or edit.start_line < 1:
+                return
+            start_line_idx = edit.start_line - 1
+            end_line_idx = edit.end_line - 1
+            start_col_idx = edit.start_col - 1
+            end_col_idx = edit.end_col - 1
+
+            if start_line_idx == end_line_idx:  # single line
+                line = lines[edit.start_line - 1]
+                new_line = line[:start_col_idx] + edit.replacement + line[end_col_idx:]
+                lines[start_line_idx] = new_line
+            else:  # Multi-line edit
+                # When edit is multiline, we replace the lines fully
+                lines[start_line_idx : end_line_idx + 2] = [edit.replacement]
+        elif edit.kind == TextEditKind.INSERTION:
+            start_line_idx = edit.start_line - 1
+            lines.insert(start_line_idx, edit.replacement)
+        else:  # edit.kind == TextEditKind.DELETION
+            start_line_idx = edit.start_line - 1
+            del lines[start_line_idx : edit.end_line]

tests/linter/test_fix.py

@@ -4,6 +4,7 @@
 
 import pytest
 
+from robocop.linter.diagnostics import Position, Range
 from robocop.linter.fix import Fix, FixApplicability, FixApplier, FixStats, TextEdit
 from robocop.source_file import SourceFile
 
@@ -686,3 +687,40 @@ def test_diff_mode_does_not_modify_file(sample_source_file):
     # But original should be preserved
     assert "Hello World" in sample_source_file.original_source_lines[7]
     assert sample_source_file.original_source_lines == original_content
+
+
+def test_edit_kind(sample_source_file):
+    applier = FixApplier()
+
+    replace_range = Range(start=Position(line=3, character=12), end=Position(line=3, character=23))
+    remove_range = Range(start=Position(line=4, character=1), end=Position(line=4, character=1000))
+    insert_range = Range(start=Position(line=5, character=1), end=Position(line=5, character=1))
+    fixes = [
+        Fix(
+            edits=[
+                TextEdit.replace_at_range(
+                    rule_id="W001", rule_name="update-library", diag_range=replace_range, replacement="Replaced"
+                ),
+                TextEdit.remove_at_range(rule_id="W001", rule_name="update-library", diag_range=remove_range),
+            ],
+            message="Range helpers",
+            applicability=FixApplicability.SAFE,
+        ),
+        Fix(
+            edits=[
+                TextEdit.insert_at_range(
+                    rule_id="W001", rule_name="update-library", diag_range=insert_range, replacement="Library    Name\n"
+                )
+            ],
+            message="Range helpers",
+            applicability=FixApplicability.SAFE,
+        ),
+    ]
+
+    applier.apply_fixes(sample_source_file, fixes)
+
+    assert applier.fix_stats.total_fixes == 0
+    assert "Replaced" in sample_source_file.source_lines[2]
+    assert "String" not in sample_source_file.source_lines[3]
+    assert "Name" in sample_source_file.source_lines[3]
+    assert applier.fix_stats.by_file[sample_source_file.path][("W001", "update-library")] == 3