php-lsp 0.1.54

/// Code action: "Extract method" — moves selected statements inside a class method
/// into a new `private function extractedMethod()` on the same class.
///
/// Variable analysis:
/// - Variables that appear in the selection **and** were assigned/used before the
///   selection starts become **parameters** of the extracted method (`mixed $x`).
/// - Variables that are **assigned inside** the selection and referenced **after**
///   the selection ends become the **return value** (single variable for now).
use std::collections::HashMap;

use php_ast::{ClassMemberKind, NamespaceBody, StmtKind};
use tower_lsp::lsp_types::{
    CodeAction, CodeActionKind, CodeActionOrCommand, Position, Range, TextEdit, Url, WorkspaceEdit,
};

use crate::ast::{ParsedDoc, offset_to_position};
use crate::util::utf16_offset_to_byte;

// ── Public entry point ────────────────────────────────────────────────────────

/// Return a "Extract method" code action when `range` spans multiple lines inside
/// a class method body. Returns an empty vec when the preconditions are not met.
pub fn extract_method_actions(
    source: &str,
    doc: &ParsedDoc,
    range: Range,
    uri: &Url,
) -> Vec<CodeActionOrCommand> {
    // Only trigger on multi-line selections.
    if range.start.line >= range.end.line {
        return vec![];
    }

    // Find the enclosing class and method.
    let stmts = &doc.program().stmts;
    let (class_end_offset, method_is_static) = match find_enclosing_class(stmts, source, range) {
        Some(info) => info,
        None => return vec![],
    };

    let selected = selected_text(source, range);
    if selected.trim().is_empty() {
        return vec![];
    }

    // Split the source at the selection boundaries so we can compare variable
    // usage in each region.
    let before = text_before(source, range);
    let after = text_after(source, range);

    // Variables that appear before the selection and also inside it → parameters.
    let vars_before = collect_assigned_vars(&before);
    let vars_in_selection = collect_vars_in_text(&selected);
    let params: Vec<String> = vars_in_selection
        .iter()
        .filter(|v| vars_before.contains(v))
        .cloned()
        .collect();

    // Variables assigned inside the selection that are also used after it → return value.
    let vars_assigned_in = collect_assigned_vars(&selected);
    let vars_used_after = collect_vars_in_text(&after);
    let returned: Option<String> = vars_assigned_in
        .into_iter()
        .find(|v| vars_used_after.contains(v));

    // ── Build the replacement call ────────────────────────────────────────────
    let indent = line_indent(source, range.start.line);
    let call_prefix = if method_is_static {
        "self::"
    } else {
        "$this->"
    };
    let params_call_list = params.join(", ");
    let call_text = match &returned {
        Some(ret_var) => {
            format!("{indent}{ret_var} = {call_prefix}extractedMethod({params_call_list});\n")
        }
        None => format!("{indent}{call_prefix}extractedMethod({params_call_list});\n"),
    };

    // ── Build the new method ──────────────────────────────────────────────────
    let static_kw = if method_is_static { "static " } else { "" };
    let param_decls: String = params
        .iter()
        .map(|v| format!("mixed {v}"))
        .collect::<Vec<_>>()
        .join(", ");
    let return_type = match &returned {
        Some(_) => ": mixed",
        None => ": void",
    };
    let method_body = selected.trim_end_matches('\n').to_string();

    let return_stmt = match &returned {
        Some(ret_var) => format!("\n        return {ret_var};"),
        None => String::new(),
    };

    let new_method = format!(
        "\n    private {static_kw}function extractedMethod({param_decls}){return_type}\n    {{\n{body}{return_stmt}\n    }}\n",
        body = indent_block(&method_body, "        "),
    );

    // Insert the new method just before the closing brace of the class.
    let closing_line = offset_to_position(source, class_end_offset.saturating_sub(1)).line;
    let insert_pos = Position {
        line: closing_line,
        character: 0,
    };

    let mut changes = HashMap::new();
    changes.insert(
        uri.clone(),
        vec![
            // Replace the selected lines with the method call.
            TextEdit {
                range,
                new_text: call_text,
            },
            // Insert the extracted method before the class closing brace.
            TextEdit {
                range: Range {
                    start: insert_pos,
                    end: insert_pos,
                },
                new_text: new_method,
            },
        ],
    );

    vec![CodeActionOrCommand::CodeAction(CodeAction {
        title: "Extract method".to_string(),
        kind: Some(CodeActionKind::REFACTOR_EXTRACT),
        edit: Some(WorkspaceEdit {
            changes: Some(changes),
            ..Default::default()
        }),
        ..Default::default()
    })]
}

// ── Helpers ───────────────────────────────────────────────────────────────────

/// Returns `(class_span_end_offset, method_is_static)` when `range` is inside a
/// class method body, walking into namespaced blocks as needed.
fn find_enclosing_class(
    stmts: &[php_ast::Stmt<'_, '_>],
    source: &str,
    range: Range,
) -> Option<(u32, bool)> {
    for stmt in stmts {
        match &stmt.kind {
            StmtKind::Class(c) => {
                let class_start = offset_to_position(source, stmt.span.start).line;
                let class_end = offset_to_position(source, stmt.span.end).line;
                if range.start.line < class_start || range.end.line > class_end {
                    continue;
                }
                for member in c.members.iter() {
                    if let ClassMemberKind::Method(m) = &member.kind {
                        let method_start = offset_to_position(source, member.span.start).line;
                        let method_end = offset_to_position(source, member.span.end).line;
                        if range.start.line >= method_start && range.end.line <= method_end {
                            return Some((stmt.span.end, m.is_static));
                        }
                    }
                }
            }
            StmtKind::Namespace(ns) => {
                if let NamespaceBody::Braced(inner) = &ns.body
                    && let Some(r) = find_enclosing_class(inner, source, range)
                {
                    return Some(r);
                }
            }
            _ => {}
        }
    }
    None
}

/// Collect every `$varName` (excluding `$this`) appearing anywhere in `text`.
fn collect_vars_in_text(text: &str) -> Vec<String> {
    let mut vars: Vec<String> = Vec::new();
    let bytes = text.as_bytes();
    let mut i = 0;
    while i < bytes.len() {
        if bytes[i] == b'$' {
            let start = i + 1;
            let mut end = start;
            while end < bytes.len() && (bytes[end].is_ascii_alphanumeric() || bytes[end] == b'_') {
                end += 1;
            }
            if end > start {
                let name = &text[start..end];
                let full = format!("${name}");
                if name != "this" && !vars.contains(&full) {
                    vars.push(full);
                }
            }
            i = end;
        } else {
            i += 1;
        }
    }
    vars
}

/// Collect variable names that appear on the left-hand side of a simple assignment
/// (`$var =`) in `text`.  This is a heuristic text scan; it handles the common
/// cases (`$x = …`, `$x +=`, etc.) without a full parse.
fn collect_assigned_vars(text: &str) -> Vec<String> {
    let mut vars: Vec<String> = Vec::new();
    let bytes = text.as_bytes();
    let mut i = 0;
    while i < bytes.len() {
        if bytes[i] == b'$' {
            let start = i + 1;
            let mut end = start;
            while end < bytes.len() && (bytes[end].is_ascii_alphanumeric() || bytes[end] == b'_') {
                end += 1;
            }
            if end > start {
                // Skip whitespace after the variable name.
                let mut j = end;
                while j < bytes.len() && bytes[j] == b' ' {
                    j += 1;
                }
                // Check for assignment operator (=, +=, -=, *=, /=, .=, etc.)
                // but NOT == or ===.
                let is_assignment = j < bytes.len()
                    && bytes[j] == b'='
                    && (j + 1 >= bytes.len() || bytes[j + 1] != b'=');
                let is_compound = j + 1 < bytes.len()
                    && (bytes[j] == b'+'
                        || bytes[j] == b'-'
                        || bytes[j] == b'*'
                        || bytes[j] == b'/'
                        || bytes[j] == b'.')
                    && bytes[j + 1] == b'=';
                if is_assignment || is_compound {
                    let name = &text[start..end];
                    let full = format!("${name}");
                    if name != "this" && !vars.contains(&full) {
                        vars.push(full);
                    }
                }
            }
            i = end;
        } else {
            i += 1;
        }
    }
    vars
}

/// Return the source text that comes before `range`.
fn text_before(source: &str, range: Range) -> String {
    let lines: Vec<&str> = source.lines().collect();
    let mut result = String::new();
    for (i, line) in lines.iter().enumerate() {
        let i = i as u32;
        if i < range.start.line {
            result.push_str(line);
            result.push('\n');
        } else if i == range.start.line {
            let end = utf16_offset_to_byte(line, range.start.character as usize);
            result.push_str(&line[..end]);
            break;
        } else {
            break;
        }
    }
    result
}

/// Return the source text that comes after `range`.
fn text_after(source: &str, range: Range) -> String {
    let lines: Vec<&str> = source.lines().collect();
    let mut result = String::new();
    for (i, line) in lines.iter().enumerate() {
        let i = i as u32;
        if i > range.end.line {
            result.push_str(line);
            result.push('\n');
        } else if i == range.end.line {
            let start = utf16_offset_to_byte(line, range.end.character as usize);
            result.push_str(&line[start..]);
            result.push('\n');
        }
    }
    result
}

/// Return the selected text defined by `range`.
fn selected_text(source: &str, range: Range) -> String {
    let lines: Vec<&str> = source.lines().collect();
    if range.start.line == range.end.line {
        let line = match lines.get(range.start.line as usize) {
            Some(l) => l,
            None => return String::new(),
        };
        let start = utf16_offset_to_byte(line, range.start.character as usize);
        let end = utf16_offset_to_byte(line, range.end.character as usize);
        line[start..end].to_string()
    } else {
        let mut result = String::new();
        for i in range.start.line..=range.end.line {
            let line = match lines.get(i as usize) {
                Some(l) => *l,
                None => break,
            };
            if i == range.start.line {
                let start = utf16_offset_to_byte(line, range.start.character as usize);
                result.push_str(&line[start..]);
            } else if i == range.end.line {
                let end = utf16_offset_to_byte(line, range.end.character as usize);
                result.push_str(&line[..end]);
            } else {
                result.push_str(line);
            }
            if i < range.end.line {
                result.push('\n');
            }
        }
        result
    }
}

/// Return the leading whitespace of line `line` in `source`.
fn line_indent(source: &str, line: u32) -> String {
    source
        .lines()
        .nth(line as usize)
        .map(|l| l.chars().take_while(|c| c.is_whitespace()).collect())
        .unwrap_or_default()
}

/// Re-indent a block of text so every non-empty line starts with `prefix`.
fn indent_block(text: &str, prefix: &str) -> String {
    text.lines()
        .map(|line| {
            if line.trim().is_empty() {
                line.to_string()
            } else {
                format!("{prefix}{}", line.trim_start())
            }
        })
        .collect::<Vec<_>>()
        .join("\n")
}

// ── Tests ─────────────────────────────────────────────────────────────────────

#[cfg(test)]
mod tests {
    use super::*;
    use tower_lsp::lsp_types::Position;

    fn uri() -> Url {
        Url::parse("file:///test.php").unwrap()
    }

    fn range(sl: u32, sc: u32, el: u32, ec: u32) -> Range {
        Range {
            start: Position {
                line: sl,
                character: sc,
            },
            end: Position {
                line: el,
                character: ec,
            },
        }
    }

    // ── single-line selection → no action ────────────────────────────────────

    #[test]
    fn single_line_selection_produces_no_action() {
        let src = "<?php\nclass A {\n    public function foo() {\n        $x = 1;\n    }\n}";
        let doc = ParsedDoc::parse(src.to_string());
        // Select only within line 3 (single-line)
        let r = range(3, 8, 3, 14);
        let actions = extract_method_actions(src, &doc, r, &uri());
        assert!(
            actions.is_empty(),
            "single-line selection should produce no action"
        );
    }

    // ── selection outside a class → no action ────────────────────────────────

    #[test]
    fn selection_outside_class_produces_no_action() {
        let src = "<?php\n$a = 1;\n$b = 2;\n$c = 3;\n";
        let doc = ParsedDoc::parse(src.to_string());
        let r = range(1, 0, 3, 0);
        let actions = extract_method_actions(src, &doc, r, &uri());
        assert!(
            actions.is_empty(),
            "selection outside a class should produce no action"
        );
    }

    // ── basic extraction with no parameters ──────────────────────────────────

    #[test]
    fn basic_extraction_void_no_params() {
        // Select lines 3-4 (the two echo statements).
        let src = concat!(
            "<?php\n",
            "class Foo {\n",
            "    public function run(): void {\n",
            "        echo 'hello';\n",
            "        echo 'world';\n",
            "    }\n",
            "}\n"
        );
        let doc = ParsedDoc::parse(src.to_string());
        // Select from start of line 3 to end of line 4 (character 0 of line 5).
        let r = range(3, 0, 5, 0);
        let actions = extract_method_actions(src, &doc, r, &uri());
        assert!(!actions.is_empty(), "expected an Extract method action");

        if let CodeActionOrCommand::CodeAction(a) = &actions[0] {
            assert_eq!(a.title, "Extract method");
            let edits = a.edit.as_ref().unwrap().changes.as_ref().unwrap();
            let texts: Vec<&str> = edits
                .values()
                .next()
                .unwrap()
                .iter()
                .map(|e| e.new_text.as_str())
                .collect();
            // The call replacement must use $this-> and no arguments.
            assert!(
                texts.iter().any(|t| t.contains("$this->extractedMethod()")),
                "call should be $this->extractedMethod(), got: {texts:?}"
            );
            // The new method must be void with the echo statements inside.
            assert!(
                texts.iter().any(|t| t.contains(": void")),
                "method should have void return type, got: {texts:?}"
            );
            assert!(
                texts.iter().any(|t| t.contains("echo 'hello'")),
                "new method should contain the extracted statements, got: {texts:?}"
            );
        } else {
            panic!("expected a CodeAction");
        }
    }

    // ── extraction with a parameter ───────────────────────────────────────────

    #[test]
    fn extraction_passes_outer_variable_as_parameter() {
        // $name is assigned before the selection; inside the selection it is used.
        let src = concat!(
            "<?php\n",
            "class Greeter {\n",
            "    public function greet(): void {\n",
            "        $name = 'Alice';\n",
            "        $greeting = 'Hello, ' . $name;\n",
            "        echo $greeting;\n",
            "    }\n",
            "}\n"
        );
        let doc = ParsedDoc::parse(src.to_string());
        // Select lines 4-5 (the two lines that use $name).
        let r = range(4, 0, 6, 0);
        let actions = extract_method_actions(src, &doc, r, &uri());
        assert!(!actions.is_empty(), "expected an Extract method action");

        if let CodeActionOrCommand::CodeAction(a) = &actions[0] {
            let edits = a.edit.as_ref().unwrap().changes.as_ref().unwrap();
            let texts: Vec<&str> = edits
                .values()
                .next()
                .unwrap()
                .iter()
                .map(|e| e.new_text.as_str())
                .collect();
            // $name was defined outside → must appear as parameter in both the
            // call and the method signature.
            assert!(
                texts.iter().any(|t| t.contains("extractedMethod($name)")),
                "$name should be passed as argument, got: {texts:?}"
            );
            assert!(
                texts.iter().any(|t| t.contains("mixed $name")),
                "method signature should declare mixed $name, got: {texts:?}"
            );
        } else {
            panic!("expected a CodeAction");
        }
    }

    // ── extraction with a return value ────────────────────────────────────────

    #[test]
    fn extraction_returns_variable_used_after_selection() {
        // $result is assigned inside the selection and used after.
        let src = concat!(
            "<?php\n",
            "class Calc {\n",
            "    public function compute(): int {\n",
            "        $a = 10;\n",
            "        $result = $a * 2;\n",
            "        $result += 5;\n",
            "        return $result;\n",
            "    }\n",
            "}\n"
        );
        let doc = ParsedDoc::parse(src.to_string());
        // Select lines 4-5 ($result is assigned there and used on line 6).
        let r = range(4, 0, 6, 0);
        let actions = extract_method_actions(src, &doc, r, &uri());
        assert!(!actions.is_empty(), "expected an Extract method action");

        if let CodeActionOrCommand::CodeAction(a) = &actions[0] {
            let edits = a.edit.as_ref().unwrap().changes.as_ref().unwrap();
            let texts: Vec<&str> = edits
                .values()
                .next()
                .unwrap()
                .iter()
                .map(|e| e.new_text.as_str())
                .collect();
            // The call must capture the return value.
            assert!(
                texts
                    .iter()
                    .any(|t| t.contains("$result = $this->extractedMethod(")),
                "call should assign return to $result, got: {texts:?}"
            );
            // The new method must declare mixed return type.
            assert!(
                texts.iter().any(|t| t.contains(": mixed")),
                "method should have mixed return type, got: {texts:?}"
            );
            // The method must end with return $result;
            assert!(
                texts.iter().any(|t| t.contains("return $result")),
                "method should return $result, got: {texts:?}"
            );
        } else {
            panic!("expected a CodeAction");
        }
    }

    // ── static method extraction ──────────────────────────────────────────────

    #[test]
    fn extraction_inside_static_method_uses_self_prefix() {
        let src = concat!(
            "<?php\n",
            "class MathHelper {\n",
            "    public static function run(): void {\n",
            "        $x = 1;\n",
            "        $y = 2;\n",
            "    }\n",
            "}\n"
        );
        let doc = ParsedDoc::parse(src.to_string());
        let r = range(3, 0, 5, 0);
        let actions = extract_method_actions(src, &doc, r, &uri());
        assert!(!actions.is_empty(), "expected an Extract method action");

        if let CodeActionOrCommand::CodeAction(a) = &actions[0] {
            let edits = a.edit.as_ref().unwrap().changes.as_ref().unwrap();
            let texts: Vec<&str> = edits
                .values()
                .next()
                .unwrap()
                .iter()
                .map(|e| e.new_text.as_str())
                .collect();
            assert!(
                texts.iter().any(|t| t.contains("self::extractedMethod(")),
                "static method should call self::extractedMethod, got: {texts:?}"
            );
            assert!(
                texts
                    .iter()
                    .any(|t| t.contains("private static function extractedMethod(")),
                "extracted method should be private static, got: {texts:?}"
            );
        } else {
            panic!("expected a CodeAction");
        }
    }
}