phpantom_lsp 0.7.0

//! "Generate property hooks" code action (PHP 8.4+).
//!
//! When the cursor is on a property declaration inside a class-like body,
//! this module offers up to three code actions:
//!
//! 1. **Generate get hook** — adds a `get` hook to the property.
//! 2. **Generate set hook** — adds a `set` hook to the property.
//! 3. **Generate get and set hooks** — adds both hooks.
//!
//! **Code action kind:** `refactor`.
//!
//! - **Static properties** are skipped (PHP 8.4 does not support hooks on
//!   static properties).
//! - **Readonly properties** only get the "Generate get hook" action.
//! - **Interface / abstract class properties** generate abstract hook
//!   signatures (no body).
//! - **Properties that already have hooks** only offer the missing hook(s).
//! - **Default values** are preserved when rewriting.
//! - **Constructor-promoted properties** are supported.

use std::collections::HashMap;

use bumpalo::Bump;
use mago_span::HasSpan;
use mago_syntax::ast::class_like::property::Property;
use mago_syntax::ast::modifier::Modifier;
use tower_lsp::lsp_types::*;

use super::cursor_context::{
    ClassLikeContextKind, CursorContext, MemberContext, find_cursor_context,
};
use super::detect_indent_from_members;
use crate::Backend;
use crate::util::offset_to_position;

// ── Data types ──────────────────────────────────────────────────────────────

/// Describes a property for which hooks can be generated.
struct HookableProperty {
    /// Property name without the `$` prefix.
    name: String,
}

// ── Which hooks already exist ───────────────────────────────────────────────

/// Check which hook names already exist on a hooked property.
fn existing_hook_names<'a>(property: &Property<'a>) -> (bool, bool) {
    match property {
        Property::Hooked(hooked) => {
            let mut has_get = false;
            let mut has_set = false;
            for hook in hooked.hook_list.hooks.iter() {
                match hook.name.value {
                    "get" => has_get = true,
                    "set" => has_set = true,
                    _ => {}
                }
            }
            (has_get, has_set)
        }
        Property::Plain(_) => (false, false),
    }
}

/// Check if the modifier list includes `readonly`.
fn has_readonly<'a>(modifiers: impl Iterator<Item = &'a Modifier<'a>>) -> bool {
    modifiers
        .into_iter()
        .any(|m| matches!(m, Modifier::Readonly(_)))
}

/// Check if the modifier list includes `static`.
fn has_static<'a>(modifiers: impl Iterator<Item = &'a Modifier<'a>>) -> bool {
    modifiers.into_iter().any(|m| m.is_static())
}

// ── Hook text generation ────────────────────────────────────────────────────

/// Build the replacement text for a property declaration with hooks.
///
/// This replaces the entire property declaration (from its start to its
/// end) with a new declaration that includes the requested hooks.
fn build_hooked_property_text(
    prop: &HookableProperty,
    original_text: &str,
    indent: &str,
    gen_get: bool,
    gen_set: bool,
    is_interface: bool,
    existing_hooks_text: Option<&str>,
) -> String {
    // For a plain property, we rewrite the whole declaration.
    // For a hooked property, we insert into the existing hook block.
    //
    // The approach for plain properties:
    //   Strip the trailing semicolon and add a hook block.
    //
    // The approach for hooked properties (adding missing hook):
    //   Insert the new hook(s) before the closing brace.

    let mut result = String::new();

    if let Some(existing) = existing_hooks_text {
        // We're adding hooks to an already-hooked property.
        // `existing` is the full property text including the hook block.
        // We need to insert the new hook(s) before the closing `}`.
        let trimmed = existing.trim_end();
        let close_brace_pos = trimmed.rfind('}');
        if let Some(pos) = close_brace_pos {
            result.push_str(&trimmed[..pos]);
            // Add the new hooks.
            if gen_get {
                result.push_str(&build_single_hook("get", prop, indent, is_interface));
            }
            if gen_set {
                result.push_str(&build_single_hook("set", prop, indent, is_interface));
            }
            result.push_str(indent);
            result.push('}');
        }
    } else {
        // Plain property: strip the semicolon, add the hook block.
        let trimmed = original_text.trim_end();
        let base = if let Some(stripped) = trimmed.strip_suffix(';') {
            stripped.trim_end()
        } else {
            trimmed
        };
        result.push_str(base);
        result.push_str(" {\n");

        if gen_get {
            result.push_str(&build_single_hook("get", prop, indent, is_interface));
        }
        if gen_set {
            result.push_str(&build_single_hook("set", prop, indent, is_interface));
        }

        result.push_str(indent);
        result.push('}');
    }

    result
}

/// Build a single hook body (`get` or `set`).
fn build_single_hook(
    kind: &str,
    prop: &HookableProperty,
    indent: &str,
    is_interface: bool,
) -> String {
    let mut s = String::new();
    let hook_indent = format!(
        "{indent}{indent_unit}",
        indent_unit = detect_indent_unit(indent)
    );

    if is_interface {
        // Abstract hook: just the signature with a semicolon.
        s.push_str(&hook_indent);
        s.push_str(kind);
        s.push_str(";\n");
    } else {
        // Concrete hook with arrow expression.
        s.push_str(&hook_indent);
        s.push_str(kind);
        s.push_str(" => ");
        match kind {
            "get" => {
                s.push_str("$this->");
                s.push_str(&prop.name);
                s.push_str(";\n");
            }
            "set" => {
                s.push_str("$this->");
                s.push_str(&prop.name);
                s.push_str(" = $value;\n");
            }
            _ => {}
        }
    }

    s
}

/// Detect the indent unit from the member indent string.
///
/// If the indent is tabs, return a single tab.  Otherwise return four
/// spaces (matching the most common convention).
fn detect_indent_unit(indent: &str) -> &str {
    if indent.contains('\t') { "\t" } else { "    " }
}

// ── Public API ──────────────────────────────────────────────────────────────

impl Backend {
    /// Collect "Generate get hook", "Generate set hook", and
    /// "Generate get and set hooks" code actions for the cursor position.
    pub(crate) fn collect_generate_property_hook_actions(
        &self,
        uri: &str,
        content: &str,
        params: &CodeActionParams,
        out: &mut Vec<CodeActionOrCommand>,
    ) {
        let doc_uri: Url = match uri.parse() {
            Ok(u) => u,
            Err(_) => return,
        };

        let cursor_offset = crate::util::position_to_offset(content, params.range.start);

        let arena = Bump::new();
        let file_id = mago_database::file::FileId::new("input.php");
        let program = mago_syntax::parser::parse_file_content(&arena, file_id, content);

        let ctx = find_cursor_context(&program.statements, cursor_offset);

        let (property, all_members, class_kind, class_readonly) = match &ctx {
            CursorContext::InClassLike {
                kind,
                class_readonly,
                member: MemberContext::Property(prop),
                all_members,
            } => (*prop, *all_members, *kind, *class_readonly),
            _ => return,
        };

        // Enums cannot have properties (only backed enum cases), and
        // PHP 8.4 does not support hooks on enum properties anyway.
        if class_kind == ClassLikeContextKind::Enum {
            return;
        }

        let is_interface = class_kind == ClassLikeContextKind::Interface;

        // Check for static — hooks are not supported on static properties.
        let is_static = match property {
            Property::Plain(plain) => has_static(plain.modifiers.iter()),
            Property::Hooked(hooked) => has_static(hooked.modifiers.iter()),
        };
        if is_static {
            return;
        }

        let prop_readonly = match property {
            Property::Plain(plain) => has_readonly(plain.modifiers.iter()),
            Property::Hooked(hooked) => has_readonly(hooked.modifiers.iter()),
        };
        let is_readonly = prop_readonly || class_readonly;

        // PHP 8.4 does not allow hooks on readonly properties at all.
        // A `readonly class` makes every property readonly implicitly.
        if is_readonly {
            return;
        }

        // Get the property name.
        let prop_name = match property {
            Property::Plain(plain) => {
                // For multi-variable declarations like `public int $a, $b;`,
                // use the first variable name. Multi-variable declarations
                // can't have hooks anyway.
                if let Some(first_item) = plain.items.first() {
                    let var = first_item.variable();
                    var.name.strip_prefix('$').unwrap_or(var.name).to_string()
                } else {
                    return;
                }
            }
            Property::Hooked(hooked) => {
                let var = hooked.item.variable();
                var.name.strip_prefix('$').unwrap_or(var.name).to_string()
            }
        };

        // For plain properties with multiple variables, hooks cannot be
        // generated (PHP does not support hooks on multi-variable
        // declarations).
        if let Property::Plain(plain) = property
            && plain.items.len() > 1
        {
            return;
        }

        // Check which hooks already exist.
        let (has_get, has_set) = existing_hook_names(property);

        let can_get = !has_get;
        let can_set = !has_set;

        if !can_get && !can_set {
            return;
        }

        let prop_info = HookableProperty { name: prop_name };

        let indent = detect_indent_from_members(all_members, content);

        // Get the property's full span so we can replace it.
        let prop_span = property.span();
        let prop_start = prop_span.start.offset as usize;
        let prop_end = prop_span.end.offset as usize;

        let original_text = &content[prop_start..prop_end];

        let start_pos = offset_to_position(content, prop_start);
        let end_pos = offset_to_position(content, prop_end);
        let replace_range = Range {
            start: start_pos,
            end: end_pos,
        };

        let existing_hooks_text = match property {
            Property::Hooked(_) => Some(original_text),
            Property::Plain(_) => None,
        };

        // ── Generate get hook ───────────────────────────────────────────
        if can_get {
            let new_text = build_hooked_property_text(
                &prop_info,
                original_text,
                &indent,
                true,
                false,
                is_interface,
                existing_hooks_text,
            );

            let edit = TextEdit {
                range: replace_range,
                new_text,
            };

            let mut changes = HashMap::new();
            changes.insert(doc_uri.clone(), vec![edit]);

            out.push(CodeActionOrCommand::CodeAction(CodeAction {
                title: "Generate get hook".to_string(),
                kind: Some(CodeActionKind::REFACTOR),
                diagnostics: None,
                edit: Some(WorkspaceEdit {
                    changes: Some(changes),
                    document_changes: None,
                    change_annotations: None,
                }),
                command: None,
                is_preferred: Some(false),
                disabled: None,
                data: None,
            }));
        }

        // ── Generate set hook ───────────────────────────────────────────
        if can_set {
            let new_text = build_hooked_property_text(
                &prop_info,
                original_text,
                &indent,
                false,
                true,
                is_interface,
                existing_hooks_text,
            );

            let edit = TextEdit {
                range: replace_range,
                new_text,
            };

            let mut changes = HashMap::new();
            changes.insert(doc_uri.clone(), vec![edit]);

            out.push(CodeActionOrCommand::CodeAction(CodeAction {
                title: "Generate set hook".to_string(),
                kind: Some(CodeActionKind::REFACTOR),
                diagnostics: None,
                edit: Some(WorkspaceEdit {
                    changes: Some(changes),
                    document_changes: None,
                    change_annotations: None,
                }),
                command: None,
                is_preferred: Some(false),
                disabled: None,
                data: None,
            }));
        }

        // ── Generate get and set hooks ──────────────────────────────────
        if can_get && can_set {
            let new_text = build_hooked_property_text(
                &prop_info,
                original_text,
                &indent,
                true,
                true,
                is_interface,
                existing_hooks_text,
            );

            let edit = TextEdit {
                range: replace_range,
                new_text,
            };

            let mut changes = HashMap::new();
            changes.insert(doc_uri, vec![edit]);

            out.push(CodeActionOrCommand::CodeAction(CodeAction {
                title: "Generate get and set hooks".to_string(),
                kind: Some(CodeActionKind::REFACTOR),
                diagnostics: None,
                edit: Some(WorkspaceEdit {
                    changes: Some(changes),
                    document_changes: None,
                    change_annotations: None,
                }),
                command: None,
                is_preferred: Some(false),
                disabled: None,
                data: None,
            }));
        }
    }
}

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

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

    // ── Unit tests for hook text builders ────────────────────────────────

    fn make_prop(name: &str) -> HookableProperty {
        HookableProperty {
            name: name.to_string(),
        }
    }

    #[test]
    fn builds_get_hook_for_plain_property() {
        let prop = make_prop("name");
        let original = "public string $name;";
        let result = build_hooked_property_text(&prop, original, "    ", true, false, false, None);
        assert!(result.contains("get => $this->name;"), "got: {result}");
        assert!(!result.contains("set"), "got: {result}");
        assert!(result.starts_with("public string $name {"), "got: {result}");
        assert!(result.ends_with('}'), "got: {result}");
    }

    #[test]
    fn builds_set_hook_for_plain_property() {
        let prop = make_prop("name");
        let original = "public string $name;";
        let result = build_hooked_property_text(&prop, original, "    ", false, true, false, None);
        assert!(
            result.contains("set => $this->name = $value;"),
            "got: {result}"
        );
        assert!(!result.contains("get"), "got: {result}");
    }

    #[test]
    fn builds_both_hooks_for_plain_property() {
        let prop = make_prop("name");
        let original = "public string $name;";
        let result = build_hooked_property_text(&prop, original, "    ", true, true, false, None);
        assert!(result.contains("get => $this->name;"), "got: {result}");
        assert!(
            result.contains("set => $this->name = $value;"),
            "got: {result}"
        );
    }

    #[test]
    fn builds_abstract_hooks_for_interface() {
        let prop = make_prop("name");
        let original = "public string $name;";
        let result = build_hooked_property_text(&prop, original, "    ", true, true, true, None);
        assert!(result.contains("get;"), "got: {result}");
        assert!(result.contains("set;"), "got: {result}");
        assert!(!result.contains("=>"), "got: {result}");
    }

    #[test]
    fn preserves_default_value() {
        let prop = make_prop("name");
        let original = "public string $name = 'default';";
        let result = build_hooked_property_text(&prop, original, "    ", true, false, false, None);
        assert!(
            result.contains("$name = 'default'"),
            "default value should be preserved, got: {result}"
        );
        assert!(result.contains("get => $this->name;"), "got: {result}");
    }

    #[test]
    fn adds_hook_to_existing_hooked_property() {
        let prop = make_prop("name");
        let existing = "public string $name {\n        get => $this->name;\n    }";
        let result =
            build_hooked_property_text(&prop, existing, "    ", false, true, false, Some(existing));
        assert!(result.contains("get => $this->name;"), "got: {result}");
        assert!(
            result.contains("set => $this->name = $value;"),
            "got: {result}"
        );
    }

    #[test]
    fn tab_indentation() {
        let prop = make_prop("name");
        let original = "public string $name;";
        let result = build_hooked_property_text(&prop, original, "\t", true, false, false, None);
        assert!(result.contains("\t\tget =>"), "got: {result}");
    }

    #[test]
    fn detect_indent_unit_spaces() {
        assert_eq!(detect_indent_unit("    "), "    ");
    }

    #[test]
    fn detect_indent_unit_tabs() {
        assert_eq!(detect_indent_unit("\t"), "\t");
    }

    // ── Integration: code action on Backend ─────────────────────────────

    #[test]
    fn offers_all_three_actions_for_plain_property() {
        let backend = crate::Backend::new_test();
        let uri = "file:///test.php";
        let content = "<?php\nclass Foo {\n    public string $name;\n}";

        let pos = content.find("public string").unwrap() as u32;
        let position = offset_to_position(content, pos as usize);

        let params = CodeActionParams {
            text_document: TextDocumentIdentifier {
                uri: uri.parse().unwrap(),
            },
            range: Range {
                start: position,
                end: position,
            },
            context: CodeActionContext {
                diagnostics: vec![],
                only: None,
                trigger_kind: None,
            },
            work_done_progress_params: Default::default(),
            partial_result_params: Default::default(),
        };

        let actions = backend.handle_code_action(uri, content, &params);
        let hook_actions: Vec<_> = actions
            .iter()
            .filter(
                |a| matches!(a, CodeActionOrCommand::CodeAction(ca) if ca.title.contains("hook")),
            )
            .collect();

        assert_eq!(
            hook_actions.len(),
            3,
            "Expected 3 hook actions, got: {:?}",
            hook_actions
                .iter()
                .map(|a| match a {
                    CodeActionOrCommand::CodeAction(ca) => ca.title.clone(),
                    CodeActionOrCommand::Command(cmd) => cmd.title.clone(),
                })
                .collect::<Vec<_>>()
        );
    }

    #[test]
    fn readonly_property_offers_no_hooks() {
        let backend = crate::Backend::new_test();
        let uri = "file:///test.php";
        let content = "<?php\nclass Foo {\n    public readonly string $name;\n}";

        let pos = content.find("public readonly").unwrap() as u32;
        let position = offset_to_position(content, pos as usize);

        let params = CodeActionParams {
            text_document: TextDocumentIdentifier {
                uri: uri.parse().unwrap(),
            },
            range: Range {
                start: position,
                end: position,
            },
            context: CodeActionContext {
                diagnostics: vec![],
                only: None,
                trigger_kind: None,
            },
            work_done_progress_params: Default::default(),
            partial_result_params: Default::default(),
        };

        let actions = backend.handle_code_action(uri, content, &params);
        let hook_actions: Vec<_> = actions
            .iter()
            .filter(
                |a| matches!(a, CodeActionOrCommand::CodeAction(ca) if ca.title.contains("hook")),
            )
            .collect();

        assert_eq!(
            hook_actions.len(),
            0,
            "readonly properties cannot have hooks in PHP 8.4"
        );
    }

    #[test]
    fn static_property_offers_no_hooks() {
        let backend = crate::Backend::new_test();
        let uri = "file:///test.php";
        let content = "<?php\nclass Foo {\n    public static string $name;\n}";

        let pos = content.find("public static").unwrap() as u32;
        let position = offset_to_position(content, pos as usize);

        let params = CodeActionParams {
            text_document: TextDocumentIdentifier {
                uri: uri.parse().unwrap(),
            },
            range: Range {
                start: position,
                end: position,
            },
            context: CodeActionContext {
                diagnostics: vec![],
                only: None,
                trigger_kind: None,
            },
            work_done_progress_params: Default::default(),
            partial_result_params: Default::default(),
        };

        let actions = backend.handle_code_action(uri, content, &params);
        let hook_actions: Vec<_> = actions
            .iter()
            .filter(
                |a| matches!(a, CodeActionOrCommand::CodeAction(ca) if ca.title.contains("hook")),
            )
            .collect();

        assert_eq!(
            hook_actions.len(),
            0,
            "static properties should not offer hook actions"
        );
    }

    #[test]
    fn interface_property_generates_abstract_hooks() {
        let backend = crate::Backend::new_test();
        let uri = "file:///test.php";
        let content = "<?php\ninterface Foo {\n    public string $name { get; }\n}";

        let pos = content.find("public string").unwrap() as u32;
        let position = offset_to_position(content, pos as usize);

        let params = CodeActionParams {
            text_document: TextDocumentIdentifier {
                uri: uri.parse().unwrap(),
            },
            range: Range {
                start: position,
                end: position,
            },
            context: CodeActionContext {
                diagnostics: vec![],
                only: None,
                trigger_kind: None,
            },
            work_done_progress_params: Default::default(),
            partial_result_params: Default::default(),
        };

        let actions = backend.handle_code_action(uri, content, &params);
        let hook_actions: Vec<_> = actions
            .iter()
            .filter(
                |a| matches!(a, CodeActionOrCommand::CodeAction(ca) if ca.title.contains("hook")),
            )
            .collect();

        // The property already has `get;` so only `set` should be offered.
        assert_eq!(
            hook_actions.len(),
            1,
            "interface with existing get hook should only offer set, got: {:?}",
            hook_actions
                .iter()
                .map(|a| match a {
                    CodeActionOrCommand::CodeAction(ca) => ca.title.clone(),
                    CodeActionOrCommand::Command(cmd) => cmd.title.clone(),
                })
                .collect::<Vec<_>>()
        );

        if let CodeActionOrCommand::CodeAction(ca) = &hook_actions[0] {
            assert_eq!(ca.title, "Generate set hook");
            // Verify the generated text uses abstract hook syntax.
            if let Some(ref edit) = ca.edit
                && let Some(ref changes) = edit.changes
            {
                let edits = changes.values().next().unwrap();
                let new_text = &edits[0].new_text;
                assert!(
                    new_text.contains("set;"),
                    "interface hook should be abstract, got: {new_text}"
                );
            }
        }
    }

    #[test]
    fn get_hook_edit_contains_correct_php() {
        let backend = crate::Backend::new_test();
        let uri = "file:///test.php";
        let content = "<?php\nclass Foo {\n    public string $name;\n}";

        let pos = content.find("public string").unwrap() as u32;
        let position = offset_to_position(content, pos as usize);

        let params = CodeActionParams {
            text_document: TextDocumentIdentifier {
                uri: uri.parse().unwrap(),
            },
            range: Range {
                start: position,
                end: position,
            },
            context: CodeActionContext {
                diagnostics: vec![],
                only: None,
                trigger_kind: None,
            },
            work_done_progress_params: Default::default(),
            partial_result_params: Default::default(),
        };

        let actions = backend.handle_code_action(uri, content, &params);
        let get_action = actions.iter().find(
            |a| matches!(a, CodeActionOrCommand::CodeAction(ca) if ca.title == "Generate get hook"),
        );

        assert!(
            get_action.is_some(),
            "should have a 'Generate get hook' action"
        );

        if let Some(CodeActionOrCommand::CodeAction(ca)) = get_action {
            let edit = ca.edit.as_ref().unwrap();
            let changes = edit.changes.as_ref().unwrap();
            let edits = changes.values().next().unwrap();
            let new_text = &edits[0].new_text;

            assert!(
                new_text.contains("get => $this->name;"),
                "get hook should reference $this->name, got: {new_text}"
            );
            assert!(
                new_text.starts_with("public string $name {"),
                "should start with property declaration, got: {new_text}"
            );
        }
    }

    #[test]
    fn set_hook_edit_contains_correct_php() {
        let backend = crate::Backend::new_test();
        let uri = "file:///test.php";
        let content = "<?php\nclass Foo {\n    public string $name;\n}";

        let pos = content.find("public string").unwrap() as u32;
        let position = offset_to_position(content, pos as usize);

        let params = CodeActionParams {
            text_document: TextDocumentIdentifier {
                uri: uri.parse().unwrap(),
            },
            range: Range {
                start: position,
                end: position,
            },
            context: CodeActionContext {
                diagnostics: vec![],
                only: None,
                trigger_kind: None,
            },
            work_done_progress_params: Default::default(),
            partial_result_params: Default::default(),
        };

        let actions = backend.handle_code_action(uri, content, &params);
        let set_action = actions.iter().find(
            |a| matches!(a, CodeActionOrCommand::CodeAction(ca) if ca.title == "Generate set hook"),
        );

        assert!(
            set_action.is_some(),
            "should have a 'Generate set hook' action"
        );

        if let Some(CodeActionOrCommand::CodeAction(ca)) = set_action {
            let edit = ca.edit.as_ref().unwrap();
            let changes = edit.changes.as_ref().unwrap();
            let edits = changes.values().next().unwrap();
            let new_text = &edits[0].new_text;

            assert!(
                new_text.contains("set => $this->name = $value;"),
                "set hook should assign $value, got: {new_text}"
            );
        }
    }

    #[test]
    fn both_hooks_edit_contains_correct_php() {
        let backend = crate::Backend::new_test();
        let uri = "file:///test.php";
        let content = "<?php\nclass Foo {\n    public string $name;\n}";

        let pos = content.find("public string").unwrap() as u32;
        let position = offset_to_position(content, pos as usize);

        let params = CodeActionParams {
            text_document: TextDocumentIdentifier {
                uri: uri.parse().unwrap(),
            },
            range: Range {
                start: position,
                end: position,
            },
            context: CodeActionContext {
                diagnostics: vec![],
                only: None,
                trigger_kind: None,
            },
            work_done_progress_params: Default::default(),
            partial_result_params: Default::default(),
        };

        let actions = backend.handle_code_action(uri, content, &params);
        let both_action = actions.iter().find(|a| {
            matches!(a, CodeActionOrCommand::CodeAction(ca) if ca.title == "Generate get and set hooks")
        });

        assert!(
            both_action.is_some(),
            "should have a 'Generate get and set hooks' action"
        );

        if let Some(CodeActionOrCommand::CodeAction(ca)) = both_action {
            let edit = ca.edit.as_ref().unwrap();
            let changes = edit.changes.as_ref().unwrap();
            let edits = changes.values().next().unwrap();
            let new_text = &edits[0].new_text;

            assert!(
                new_text.contains("get => $this->name;"),
                "both hooks should include get, got: {new_text}"
            );
            assert!(
                new_text.contains("set => $this->name = $value;"),
                "both hooks should include set, got: {new_text}"
            );
        }
    }

    #[test]
    fn property_with_default_preserves_default() {
        let backend = crate::Backend::new_test();
        let uri = "file:///test.php";
        let content = "<?php\nclass Foo {\n    public string $name = 'default';\n}";

        let pos = content.find("public string").unwrap() as u32;
        let position = offset_to_position(content, pos as usize);

        let params = CodeActionParams {
            text_document: TextDocumentIdentifier {
                uri: uri.parse().unwrap(),
            },
            range: Range {
                start: position,
                end: position,
            },
            context: CodeActionContext {
                diagnostics: vec![],
                only: None,
                trigger_kind: None,
            },
            work_done_progress_params: Default::default(),
            partial_result_params: Default::default(),
        };

        let actions = backend.handle_code_action(uri, content, &params);
        let get_action = actions.iter().find(
            |a| matches!(a, CodeActionOrCommand::CodeAction(ca) if ca.title == "Generate get hook"),
        );

        if let Some(CodeActionOrCommand::CodeAction(ca)) = get_action {
            let edit = ca.edit.as_ref().unwrap();
            let changes = edit.changes.as_ref().unwrap();
            let edits = changes.values().next().unwrap();
            let new_text = &edits[0].new_text;

            assert!(
                new_text.contains("= 'default'"),
                "default value should be preserved, got: {new_text}"
            );
        }
    }

    #[test]
    fn existing_hooked_property_with_get_only_offers_set() {
        let backend = crate::Backend::new_test();
        let uri = "file:///test.php";
        let content =
            "<?php\nclass Foo {\n    public string $name {\n        get => $this->name;\n    }\n}";

        let pos = content.find("public string").unwrap() as u32;
        let position = offset_to_position(content, pos as usize);

        let params = CodeActionParams {
            text_document: TextDocumentIdentifier {
                uri: uri.parse().unwrap(),
            },
            range: Range {
                start: position,
                end: position,
            },
            context: CodeActionContext {
                diagnostics: vec![],
                only: None,
                trigger_kind: None,
            },
            work_done_progress_params: Default::default(),
            partial_result_params: Default::default(),
        };

        let actions = backend.handle_code_action(uri, content, &params);
        let hook_actions: Vec<_> = actions
            .iter()
            .filter(
                |a| matches!(a, CodeActionOrCommand::CodeAction(ca) if ca.title.contains("hook")),
            )
            .collect();

        assert_eq!(
            hook_actions.len(),
            1,
            "property with existing get hook should only offer set, got: {:?}",
            hook_actions
                .iter()
                .map(|a| match a {
                    CodeActionOrCommand::CodeAction(ca) => ca.title.clone(),
                    CodeActionOrCommand::Command(cmd) => cmd.title.clone(),
                })
                .collect::<Vec<_>>()
        );

        if let CodeActionOrCommand::CodeAction(ca) = &hook_actions[0] {
            assert_eq!(ca.title, "Generate set hook");
        }
    }

    #[test]
    fn existing_hooked_property_with_both_hooks_offers_nothing() {
        let backend = crate::Backend::new_test();
        let uri = "file:///test.php";
        let content = "<?php\nclass Foo {\n    public string $name {\n        get => $this->name;\n        set => $this->name = $value;\n    }\n}";

        let pos = content.find("public string").unwrap() as u32;
        let position = offset_to_position(content, pos as usize);

        let params = CodeActionParams {
            text_document: TextDocumentIdentifier {
                uri: uri.parse().unwrap(),
            },
            range: Range {
                start: position,
                end: position,
            },
            context: CodeActionContext {
                diagnostics: vec![],
                only: None,
                trigger_kind: None,
            },
            work_done_progress_params: Default::default(),
            partial_result_params: Default::default(),
        };

        let actions = backend.handle_code_action(uri, content, &params);
        let hook_actions: Vec<_> = actions
            .iter()
            .filter(
                |a| matches!(a, CodeActionOrCommand::CodeAction(ca) if ca.title.contains("hook")),
            )
            .collect();

        assert_eq!(
            hook_actions.len(),
            0,
            "property with both hooks should not offer any hook actions"
        );
    }

    #[test]
    fn no_hooks_for_enum_property() {
        let backend = crate::Backend::new_test();
        let uri = "file:///test.php";
        // Enums can't have regular properties, but let's make sure
        // the code action doesn't crash or offer hooks for enum members.
        let content = "<?php\nenum Foo: string {\n    case Bar = 'bar';\n}";

        let pos = content.find("case").unwrap() as u32;
        let position = offset_to_position(content, pos as usize);

        let params = CodeActionParams {
            text_document: TextDocumentIdentifier {
                uri: uri.parse().unwrap(),
            },
            range: Range {
                start: position,
                end: position,
            },
            context: CodeActionContext {
                diagnostics: vec![],
                only: None,
                trigger_kind: None,
            },
            work_done_progress_params: Default::default(),
            partial_result_params: Default::default(),
        };

        let actions = backend.handle_code_action(uri, content, &params);
        let hook_actions: Vec<_> = actions
            .iter()
            .filter(
                |a| matches!(a, CodeActionOrCommand::CodeAction(ca) if ca.title.contains("hook")),
            )
            .collect();

        assert_eq!(hook_actions.len(), 0, "enums should not offer hook actions");
    }

    #[test]
    fn untyped_property_generates_hooks() {
        let backend = crate::Backend::new_test();
        let uri = "file:///test.php";
        let content = "<?php\nclass Foo {\n    public $name;\n}";

        let pos = content.find("public $name").unwrap() as u32;
        let position = offset_to_position(content, pos as usize);

        let params = CodeActionParams {
            text_document: TextDocumentIdentifier {
                uri: uri.parse().unwrap(),
            },
            range: Range {
                start: position,
                end: position,
            },
            context: CodeActionContext {
                diagnostics: vec![],
                only: None,
                trigger_kind: None,
            },
            work_done_progress_params: Default::default(),
            partial_result_params: Default::default(),
        };

        let actions = backend.handle_code_action(uri, content, &params);
        let hook_actions: Vec<_> = actions
            .iter()
            .filter(
                |a| matches!(a, CodeActionOrCommand::CodeAction(ca) if ca.title.contains("hook")),
            )
            .collect();

        assert_eq!(
            hook_actions.len(),
            3,
            "untyped property should offer all three hook actions, got: {:?}",
            hook_actions
                .iter()
                .map(|a| match a {
                    CodeActionOrCommand::CodeAction(ca) => ca.title.clone(),
                    CodeActionOrCommand::Command(cmd) => cmd.title.clone(),
                })
                .collect::<Vec<_>>()
        );
    }

    #[test]
    fn multi_variable_property_offers_no_hooks() {
        let backend = crate::Backend::new_test();
        let uri = "file:///test.php";
        let content = "<?php\nclass Foo {\n    public string $a, $b;\n}";

        let pos = content.find("public string").unwrap() as u32;
        let position = offset_to_position(content, pos as usize);

        let params = CodeActionParams {
            text_document: TextDocumentIdentifier {
                uri: uri.parse().unwrap(),
            },
            range: Range {
                start: position,
                end: position,
            },
            context: CodeActionContext {
                diagnostics: vec![],
                only: None,
                trigger_kind: None,
            },
            work_done_progress_params: Default::default(),
            partial_result_params: Default::default(),
        };

        let actions = backend.handle_code_action(uri, content, &params);
        let hook_actions: Vec<_> = actions
            .iter()
            .filter(
                |a| matches!(a, CodeActionOrCommand::CodeAction(ca) if ca.title.contains("hook")),
            )
            .collect();

        assert_eq!(
            hook_actions.len(),
            0,
            "multi-variable properties cannot have hooks"
        );
    }

    #[test]
    fn trait_property_generates_concrete_hooks() {
        let backend = crate::Backend::new_test();
        let uri = "file:///test.php";
        let content = "<?php\ntrait Foo {\n    public string $name;\n}";

        let pos = content.find("public string").unwrap() as u32;
        let position = offset_to_position(content, pos as usize);

        let params = CodeActionParams {
            text_document: TextDocumentIdentifier {
                uri: uri.parse().unwrap(),
            },
            range: Range {
                start: position,
                end: position,
            },
            context: CodeActionContext {
                diagnostics: vec![],
                only: None,
                trigger_kind: None,
            },
            work_done_progress_params: Default::default(),
            partial_result_params: Default::default(),
        };

        let actions = backend.handle_code_action(uri, content, &params);
        let get_action = actions.iter().find(
            |a| matches!(a, CodeActionOrCommand::CodeAction(ca) if ca.title == "Generate get hook"),
        );

        assert!(get_action.is_some(), "trait should offer hook actions");

        if let Some(CodeActionOrCommand::CodeAction(ca)) = get_action {
            let edit = ca.edit.as_ref().unwrap();
            let changes = edit.changes.as_ref().unwrap();
            let edits = changes.values().next().unwrap();
            let new_text = &edits[0].new_text;
            assert!(
                new_text.contains("get => $this->name;"),
                "trait hooks should be concrete, got: {new_text}"
            );
        }
    }

    #[test]
    fn readonly_class_property_offers_no_hooks() {
        let backend = crate::Backend::new_test();
        let uri = "file:///test.php";
        let content = "<?php\nfinal readonly class Foo {\n    public string $name;\n}";

        let pos = content.find("public string").unwrap() as u32;
        let position = offset_to_position(content, pos as usize);

        let params = CodeActionParams {
            text_document: TextDocumentIdentifier {
                uri: uri.parse().unwrap(),
            },
            range: Range {
                start: position,
                end: position,
            },
            context: CodeActionContext {
                diagnostics: vec![],
                only: None,
                trigger_kind: None,
            },
            work_done_progress_params: Default::default(),
            partial_result_params: Default::default(),
        };

        let actions = backend.handle_code_action(uri, content, &params);
        let hook_actions: Vec<_> = actions
            .iter()
            .filter(
                |a| matches!(a, CodeActionOrCommand::CodeAction(ca) if ca.title.contains("hook")),
            )
            .collect();

        assert_eq!(
            hook_actions.len(),
            0,
            "readonly class properties cannot have hooks in PHP 8.4"
        );
    }
}