Skip to content

fix(rename): handle variables in dynamic property selectors #174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
calebdw wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(rename): handle variables in dynamic property selectors #174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ mago-type-syntax = "=1.29.0"
mago-formatter = "=1.29.0"
mago-php-version = "=1.29.0"
mago-composer = "=1.29.0"
mago-text-edit = "=1.29.0"
bumpalo = "3"
ignore = "0.4"
memchr = "2"
Expand Down
16 changes: 16 additions & 0 deletions src/diagnostics/unused_variables.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -622,6 +622,22 @@ function foo() {
assert!(diags.is_empty());
}

#[test]
fn no_diagnostic_when_variable_is_used_in_dynamic_property_access() {
let diags = collect(
r#"<?php
function foo(object $message, string $type) {
$attribute = strtolower($type);
return $message->{$attribute};
}
"#,
);
assert!(
diags.is_empty(),
"dynamic property selector should count as a read"
);
}

#[test]
fn skips_unused_parameter() {
// Parameters are intentionally not flagged until suppression
Expand Down
30 changes: 30 additions & 0 deletions src/rename/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,36 @@ async fn rename_variable_updates_compact_string() {
assert!(updated.contains("compact('person')"));
}

#[tokio::test]
async fn rename_variable_updates_dynamic_property_selector() {
let backend = Backend::new_test();
let uri = Url::parse("file:///test.php").unwrap();
let text = concat!(
"<?php\n",
"function demo(object $message, string $type): void {\n",
" $attribute = strtolower($type);\n",
" if (empty($message->{$attribute})) {\n",
" return;\n",
" }\n",
" echo $attribute;\n",
"}\n",
);

open_file(&backend, &uri, text).await;

let edit = rename(&backend, &uri, 2, 6, "$field").await;
assert!(
edit.is_some(),
"Expected a workspace edit for variable rename"
);

let file_edits = edits_for_uri(&edit.unwrap(), &uri);
let updated = apply_edits(text, &file_edits);
assert!(updated.contains("$field = strtolower($type);"));
assert!(updated.contains("$message->{$field}"));
assert!(updated.contains("echo $field;"));
}

#[tokio::test]
async fn rename_from_compact_string_updates_variable() {
let backend = Backend::new_test();
Expand Down
31 changes: 30 additions & 1 deletion src/scope_collector/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1046,10 +1046,25 @@ fn walk_expression(expr: &Expression<'_>, collector: &mut Collector<'_>) {
Expression::Access(access) => match access {
Access::Property(pa) => {
walk_expression(pa.object, collector);
// property selector is not a variable read
match &pa.property {
ClassLikeMemberSelector::Identifier(_)
| ClassLikeMemberSelector::Missing(_) => {}
ClassLikeMemberSelector::Variable(var) => walk_variable_read(var, collector),
ClassLikeMemberSelector::Expression(selector) => {
walk_expression(selector.expression, collector)
}
}
}
Access::NullSafeProperty(pa) => {
walk_expression(pa.object, collector);
match &pa.property {
ClassLikeMemberSelector::Identifier(_)
| ClassLikeMemberSelector::Missing(_) => {}
ClassLikeMemberSelector::Variable(var) => walk_variable_read(var, collector),
ClassLikeMemberSelector::Expression(selector) => {
walk_expression(selector.expression, collector)
}
}
}
Access::StaticProperty(spa) => {
walk_expression(spa.class, collector);
Expand Down Expand Up @@ -1354,9 +1369,23 @@ fn walk_expression_as_write(expr: &Expression<'_>, collector: &mut Collector<'_>
Expression::Access(Access::Property(pa)) => {
// `$obj->prop = …` — $obj is read, prop is written.
walk_expression(pa.object, collector);
match &pa.property {
ClassLikeMemberSelector::Identifier(_) | ClassLikeMemberSelector::Missing(_) => {}
ClassLikeMemberSelector::Variable(var) => walk_variable_read(var, collector),
ClassLikeMemberSelector::Expression(selector) => {
walk_expression(selector.expression, collector)
}
}
}
Expression::Access(Access::NullSafeProperty(pa)) => {
walk_expression(pa.object, collector);
match &pa.property {
ClassLikeMemberSelector::Identifier(_) | ClassLikeMemberSelector::Missing(_) => {}
ClassLikeMemberSelector::Variable(var) => walk_variable_read(var, collector),
ClassLikeMemberSelector::Expression(selector) => {
walk_expression(selector.expression, collector)
}
}
}
Expression::Access(Access::StaticProperty(spa)) => {
walk_expression(spa.class, collector);
Expand Down
14 changes: 14 additions & 0 deletions src/scope_collector/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -532,6 +532,20 @@ function test() {
assert_eq!(count_kind(&scope_map, "$config", AccessKind::Read), 1);
}

#[test]
fn dynamic_property_selector_reads_variable() {
let php = r#"<?php
function test(object $message, string $type) {
$attribute = strtolower($type);
return $message->{$attribute};
}
"#;
let scope_map = collect_from_function(php);

assert_eq!(count_kind(&scope_map, "$attribute", AccessKind::Write), 1);
assert_eq!(count_kind(&scope_map, "$attribute", AccessKind::Read), 1);
}

// ─── Unset ──────────────────────────────────────────────────────────────────

#[test]
Expand Down
98 changes: 72 additions & 26 deletions src/symbol_map/extraction.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1767,6 +1767,34 @@ fn extract_from_hint_ctx(hint: &Hint<'_>, spans: &mut Vec<SymbolSpan>, ref_ctx:

// ─── Expression extractor ───────────────────────────────────────────────────

fn extract_variable_symbol_spans<'a>(
var: &'a Variable<'a>,
ctx: &mut ExtractionCtx<'a>,
scope_start: u32,
) {
match var {
Variable::Direct(dv) => {
let raw = bytes_to_str(dv.name);
if raw == "$this" {
ctx.spans.push(SymbolSpan {
start: dv.span.start.offset,
end: dv.span.end.offset,
kind: SymbolKind::SelfStaticParent(SelfStaticParentKind::This),
});
} else {
let name = raw.strip_prefix('$').unwrap_or(raw).to_string();
ctx.spans.push(SymbolSpan {
start: dv.span.start.offset,
end: dv.span.end.offset,
kind: SymbolKind::Variable { name },
});
}
}
Variable::Indirect(iv) => extract_from_expression(iv.expression, ctx, scope_start),
Variable::Nested(nv) => extract_variable_symbol_spans(nv.variable, ctx, scope_start),
}
}

fn extract_from_expression<'a>(
expr: &'a Expression<'a>,
ctx: &mut ExtractionCtx<'a>,
Expand Down Expand Up @@ -2105,38 +2133,56 @@ fn extract_from_expression<'a>(
let subject_text = expr_to_subject_text(pa.object);
extract_from_expression(pa.object, ctx, scope_start);

if let ClassLikeMemberSelector::Identifier(ident) = &pa.property {
let member_name = bytes_to_str(ident.value).to_string();
ctx.spans.push(SymbolSpan {
start: ident.span.start.offset,
end: ident.span.end.offset,
kind: SymbolKind::MemberAccess {
subject_text,
member_name,
is_static: false,
is_method_call: false,
is_docblock_reference: false,
},
});
match &pa.property {
ClassLikeMemberSelector::Identifier(ident) => {
let member_name = bytes_to_str(ident.value).to_string();
ctx.spans.push(SymbolSpan {
start: ident.span.start.offset,
end: ident.span.end.offset,
kind: SymbolKind::MemberAccess {
subject_text,
member_name,
is_static: false,
is_method_call: false,
is_docblock_reference: false,
},
});
}
ClassLikeMemberSelector::Variable(var) => {
extract_variable_symbol_spans(var, ctx, scope_start)
}
ClassLikeMemberSelector::Expression(selector) => {
extract_from_expression(selector.expression, ctx, scope_start)
}
ClassLikeMemberSelector::Missing(_) => {}
}
}
Access::NullSafeProperty(pa) => {
let subject_text = expr_to_subject_text(pa.object);
extract_from_expression(pa.object, ctx, scope_start);

if let ClassLikeMemberSelector::Identifier(ident) = &pa.property {
let member_name = bytes_to_str(ident.value).to_string();
ctx.spans.push(SymbolSpan {
start: ident.span.start.offset,
end: ident.span.end.offset,
kind: SymbolKind::MemberAccess {
subject_text,
member_name,
is_static: false,
is_method_call: false,
is_docblock_reference: false,
},
});
match &pa.property {
ClassLikeMemberSelector::Identifier(ident) => {
let member_name = bytes_to_str(ident.value).to_string();
ctx.spans.push(SymbolSpan {
start: ident.span.start.offset,
end: ident.span.end.offset,
kind: SymbolKind::MemberAccess {
subject_text,
member_name,
is_static: false,
is_method_call: false,
is_docblock_reference: false,
},
});
}
ClassLikeMemberSelector::Variable(var) => {
extract_variable_symbol_spans(var, ctx, scope_start)
}
ClassLikeMemberSelector::Expression(selector) => {
extract_from_expression(selector.expression, ctx, scope_start)
}
ClassLikeMemberSelector::Missing(_) => {}
}
}
Access::StaticProperty(spa) => {
Expand Down
31 changes: 31 additions & 0 deletions tests/integration/references.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,6 +387,37 @@ function test(): void {
);
}

#[test]
fn variable_references_include_dynamic_property_selector() {
let backend = create_test_backend();
let uri = "file:///tmp/test_refs_dynamic_selector.php";
let content = r#"<?php

function test(object $message, string $type): void {
$attribute = strtolower($type);
if (empty($message->{$attribute})) {
return;
}
echo $attribute;
}
"#;

open_file(&backend, uri, content);

let results = backend
.find_references(uri, content, Position::new(3, 5), true)
.expect("should find references");

assert_no_duplicates(&results, "variable_references_dynamic_selector");
assert_eq!(
results.len(),
3,
"Expected 3 references (definition + dynamic selector + echo), got {}: {:#?}",
results.len(),
results
);
}

// ─── Static member references ───────────────────────────────────────────────

#[test]
Expand Down
Loading