feat!: add deprecated-return-keyword rule fix and deprecate ReplaceReturns formatter (#1643)

New fix to deprecared-return-keyword rule which made ReplaceReturns formatter obsolete.

Author: bhirsz

docs/formatter/formatter.md

@@ -142,7 +142,6 @@ To see the list of formatters included with `Robocop` use ``robocop list formatt
 │ SmartSortKeywords          │ No      │
 │ RenameTestCases            │ No      │
 │ RenameKeywords             │ No      │
-│ ReplaceReturns             │ Yes     │
 │ ReplaceBreakContinue       │ Yes     │
 │ InlineIf                   │ Yes     │
 │ Translate                  │ No      │

docs/formatter/formatters/ReplaceReturns.md

@@ -91,7 +91,6 @@ nav:
           - RenameVariables: formatter/formatters/RenameVariables.md
           - ReplaceBreakContinue: formatter/formatters/ReplaceBreakContinue.md
           - ReplaceEmptyValues: formatter/formatters/ReplaceEmptyValues.md
-          - ReplaceReturns: formatter/formatters/ReplaceReturns.md
           - ReplaceRunKeywordIf: formatter/formatters/ReplaceRunKeywordIf.md
           - ReplaceWithVAR: formatter/formatters/ReplaceWithVAR.md
           - SmartSortKeywords: formatter/formatters/SmartSortKeywords.md

mkdocs.yml

@@ -63,7 +63,6 @@
     "SmartSortKeywords",
     "RenameTestCases",
     "RenameKeywords",
-    "ReplaceReturns",
     "ReplaceBreakContinue",
     "InlineIf",
     "Translate",

src/robocop/formatter/formatters/ReplaceReturns.py

@@ -196,7 +196,7 @@ def create_statement_from_tokens(statement, tokens: Iterable, indent: Token):
     return statement([indent, Token(statement.type), *tokens])
 
 
-def wrap_in_if_and_replace_statement(node, statement, default_separator):
+def wrap_in_if_and_replace_statement(node, statement, default_separator: str):
     if len(node.data_tokens) < 2:
         return node
     condition = node.data_tokens[1]

src/robocop/formatter/formatters/__init__.py

@@ -288,21 +288,21 @@ def _apply_edit(lines: list[str], edit: TextEdit) -> None:
             start_line_idx = edit.start_line - 1
             end_line_idx = edit.end_line - 1
             if edit.start_col is None or edit.end_col is None:  # replace_lines
-                lines[start_line_idx : end_line_idx + 1] = [edit.replacement]
+                lines[start_line_idx : end_line_idx + 1] = edit.replacement.splitlines(keepends=True)
                 return
             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
+                lines[start_line_idx : start_line_idx + 1] = new_line.splitlines(keepends=True)
             else:  # Multi-line edit
                 # When edit is multiline, we replace the lines fully
-                lines[start_line_idx : end_line_idx + 2] = [edit.replacement]
+                lines[start_line_idx : end_line_idx + 2] = edit.replacement.splitlines(keepends=True)
         elif edit.kind == TextEditKind.INSERTION:
             start_line_idx = edit.start_line - 1
-            lines.insert(start_line_idx, edit.replacement)
+            lines[start_line_idx:start_line_idx] = edit.replacement.splitlines(keepends=True)
         else:  # edit.kind == TextEditKind.DELETION
             start_line_idx = edit.start_line - 1
             del lines[start_line_idx : edit.end_line]

src/robocop/formatter/utils/misc.py

@@ -1,7 +1,14 @@
+try:
+    from robot.api.parsing import ReturnStatement
+except ImportError:
+    ReturnStatement = None
+
+from robocop.formatter.utils import misc as format_utils
 from robocop.linter import sonar_qube
 from robocop.linter.diagnostics import Diagnostic
 from robocop.linter.fix import Fix, FixApplicability, FixAvailability, TextEdit
 from robocop.linter.rules import FixableRule, Rule, RuleSeverity
+from robocop.source_file import StatementLinesCollector
 
 
 class IfCanBeUsedRule(Rule):
@@ -345,7 +352,7 @@ class DeprecatedLoopKeywordRule(Rule):
     }
 
 
-class DeprecatedReturnKeyword(Rule):
+class DeprecatedReturnKeyword(FixableRule):
     """
     ``Return From Keyword`` and ``Return From Keyword If`` keywords are deprecated.
 
@@ -361,8 +368,36 @@ class DeprecatedReturnKeyword(Rule):
     sonar_qube_attrs = sonar_qube.SonarQubeAttributes(
         clean_code=sonar_qube.CleanCodeAttribute.CONVENTIONAL, issue_type=sonar_qube.SonarQubeIssueType.CODE_SMELL
     )
-
     deprecated_names = {"returnfromkeyword": "RETURN", "returnfromkeywordif": "IF and RETURN"}
+    fix_availability = FixAvailability.ALWAYS
+
+    def fix(self, diag: Diagnostic, source_lines: list[str]) -> Fix | None:  # noqa: ARG002
+        """Fix Return From Keyword. Return From Keyword If is handled inside a rule check."""
+        if "if" in diag.reported_arguments["statement_name"].lower():
+            if diag.node is None or not ReturnStatement:
+                return None
+            replacement_node = format_utils.wrap_in_if_and_replace_statement(diag.node, ReturnStatement, "    ")
+            if replacement_node is diag.node:  # no changes
+                return None
+            replacement_text = StatementLinesCollector(replacement_node).text
+            return Fix(
+                edits=[
+                    TextEdit.replace_lines(
+                        rule_id=self.rule_id,
+                        rule_name=self.name,
+                        start_line=diag.node.lineno,
+                        end_line=diag.node.end_lineno,
+                        replacement=replacement_text,
+                    )
+                ],
+                message="Replace Return From Keyword If keyword with IF and RETURN",
+                applicability=FixApplicability.SAFE,
+            )
+        return Fix(
+            edits=[TextEdit.replace_at_range(self.rule_id, self.name, diag.range, "RETURN")],
+            message="Replace Return From Keyword keyword with RETURN",
+            applicability=FixApplicability.SAFE,
+        )
 
 
 class DeprecatedReturnSetting(FixableRule):

src/robocop/linter/fix.py

@@ -14,7 +14,7 @@
 from robocop.formatter.utils.misc import decorate_diff_with_color
 from robocop.run import format_files
 
-VERSION_MATRIX = {"ReplaceReturns": 5, "InlineIf": 5, "ReplaceBreakContinue": 5, "Translate": 6, "ReplaceWithVAR": 7}
+VERSION_MATRIX = {"InlineIf": 5, "ReplaceBreakContinue": 5, "Translate": 6, "ReplaceWithVAR": 7}
 ROBOT_VERSION = version.parse(RF_VERSION)