From 7568d0770934345be183670652e8064c06c05caf Mon Sep 17 00:00:00 2001 From: Timo Freiberg Date: Sun, 3 May 2020 01:01:59 +0200 Subject: Trigger change_visibility assist when on a path to an invisible def --- .../ra_assists/src/handlers/change_visibility.rs | 329 ++++++++++++++++++++- 1 file changed, 328 insertions(+), 1 deletion(-) (limited to 'crates/ra_assists/src/handlers') diff --git a/crates/ra_assists/src/handlers/change_visibility.rs b/crates/ra_assists/src/handlers/change_visibility.rs index e631766ef..573f94a46 100644 --- a/crates/ra_assists/src/handlers/change_visibility.rs +++ b/crates/ra_assists/src/handlers/change_visibility.rs @@ -5,8 +5,10 @@ use ra_syntax::{ ATTR, COMMENT, CONST_DEF, ENUM_DEF, FN_DEF, MODULE, STRUCT_DEF, TRAIT_DEF, VISIBILITY, WHITESPACE, }, - SyntaxNode, TextSize, T, + SyntaxNode, TextRange, TextSize, T, }; + +use hir::{db::HirDatabase, HasSource, PathResolution}; use test_utils::tested_by; use crate::{AssistContext, AssistId, Assists}; @@ -72,6 +74,88 @@ fn add_vis(acc: &mut Assists, ctx: &AssistContext) -> Option<()> { }) } +fn add_missing_vis(ctx: AssistCtx) -> Option { + let path: ast::Path = ctx.find_node_at_offset()?; + let path_res = dbg!(ctx.sema.resolve_path(&path))?; + let def = match path_res { + PathResolution::Def(def) => def, + _ => return None, + }; + dbg!(&def); + + let current_module = dbg!(ctx.sema.scope(&path.syntax()).module())?; + let target_module = dbg!(def.module(ctx.db))?; + + let vis = dbg!(target_module.visibility_of(ctx.db, &def))?; + if vis.is_visible_from(ctx.db, current_module.into()) { + return None; + }; + let target_name; + + let (offset, target) = match def { + hir::ModuleDef::Function(f) => { + target_name = Some(f.name(ctx.db)); + offset_and_target(ctx.db, f) + } + hir::ModuleDef::Adt(adt) => { + target_name = Some(adt.name(ctx.db)); + match adt { + hir::Adt::Struct(s) => offset_and_target(ctx.db, s), + hir::Adt::Union(u) => offset_and_target(ctx.db, u), + hir::Adt::Enum(e) => offset_and_target(ctx.db, e), + } + } + hir::ModuleDef::Const(c) => { + target_name = c.name(ctx.db); + offset_and_target(ctx.db, c) + } + hir::ModuleDef::Static(s) => { + target_name = s.name(ctx.db); + offset_and_target(ctx.db, s) + } + hir::ModuleDef::Trait(t) => { + target_name = Some(t.name(ctx.db)); + offset_and_target(ctx.db, t) + } + hir::ModuleDef::TypeAlias(t) => { + target_name = Some(t.name(ctx.db)); + offset_and_target(ctx.db, t) + } + hir::ModuleDef::Module(m) => { + target_name = m.name(ctx.db); + let source = dbg!(m.declaration_source(ctx.db))?.value; + let syntax = source.syntax(); + (vis_offset(syntax), syntax.text_range()) + } + // Enum variants can't be private, we can't modify builtin types + hir::ModuleDef::EnumVariant(_) | hir::ModuleDef::BuiltinType(_) => return None, + }; + + // FIXME if target is in another crate, add `pub` instead of `pub(crate)` + + let assist_label = match target_name { + None => "Change visibility to pub(crate)".to_string(), + Some(name) => format!("Change visibility of {} to pub(crate)", name), + }; + let target_file = target_module.definition_source(ctx.db).file_id.original_file(ctx.db); + + ctx.add_assist(AssistId("change_visibility"), assist_label, target, |edit| { + edit.set_file(target_file); + edit.insert(offset, "pub(crate) "); + edit.set_cursor(offset); + }) +} + +fn offset_and_target(db: &dyn HirDatabase, x: S) -> (TextSize, TextRange) +where + S: HasSource, + Ast: AstNode, +{ + let source = x.source(db); + let syntax = source.syntax().value; + (vis_offset(syntax), syntax.text_range()) +} + fn vis_offset(node: &SyntaxNode) -> TextSize { node.children_with_tokens() .skip_while(|it| match it.kind() { @@ -191,6 +275,249 @@ mod tests { ) } + #[test] + fn change_visibility_of_fn_via_path() { + check_assist( + change_visibility, + r"mod foo { fn foo() {} } + fn main() { foo::foo<|>() } ", + r"mod foo { <|>pub(crate) fn foo() {} } + fn main() { foo::foo() } ", + ); + check_assist_not_applicable( + change_visibility, + r"mod foo { pub fn foo() {} } + fn main() { foo::foo<|>() } ", + ) + } + + #[test] + fn change_visibility_of_adt_in_submodule_via_path() { + check_assist( + change_visibility, + r"mod foo { struct Foo; } + fn main() { foo::Foo<|> } ", + r"mod foo { <|>pub(crate) struct Foo; } + fn main() { foo::Foo } ", + ); + check_assist_not_applicable( + change_visibility, + r"mod foo { pub struct Foo; } + fn main() { foo::Foo<|> } ", + ); + check_assist( + change_visibility, + r"mod foo { enum Foo; } + fn main() { foo::Foo<|> } ", + r"mod foo { <|>pub(crate) enum Foo; } + fn main() { foo::Foo } ", + ); + check_assist_not_applicable( + change_visibility, + r"mod foo { pub enum Foo; } + fn main() { foo::Foo<|> } ", + ); + check_assist( + change_visibility, + r"mod foo { union Foo; } + fn main() { foo::Foo<|> } ", + r"mod foo { <|>pub(crate) union Foo; } + fn main() { foo::Foo } ", + ); + check_assist_not_applicable( + change_visibility, + r"mod foo { pub union Foo; } + fn main() { foo::Foo<|> } ", + ); + } + + #[test] + fn change_visibility_of_adt_in_other_file_via_path() { + check_assist( + change_visibility, + r" + //- /main.rs + mod foo; + fn main() { foo::Foo<|> } + + //- /foo.rs + struct Foo; + ", + r"<|>pub(crate) struct Foo; + +", + ); + } + + #[test] + // FIXME this requires a separate implementation, struct fields are not a ast::Path + fn change_visibility_of_struct_field_via_path() { + check_assist( + change_visibility, + r"mod foo { pub struct Foo { bar: (), } } + fn main() { foo::Foo { <|>bar: () }; } ", + r"mod foo { pub struct Foo { <|>pub(crate) bar: (), } } + fn main() { foo::Foo { bar: () }; } ", + ); + check_assist_not_applicable( + change_visibility, + r"mod foo { pub struct Foo { pub bar: (), } } + fn main() { foo::Foo { <|>bar: () }; } ", + ); + } + + #[test] + fn not_applicable_for_enum_variants() { + check_assist_not_applicable( + change_visibility, + r"mod foo { pub enum Foo {Foo1} } + fn main() { foo::Foo::Foo1<|> } ", + ); + } + + #[test] + fn change_visibility_of_const_via_path() { + check_assist( + change_visibility, + r"mod foo { const FOO: () = (); } + fn main() { foo::FOO<|> } ", + r"mod foo { <|>pub(crate) const FOO: () = (); } + fn main() { foo::FOO } ", + ); + check_assist_not_applicable( + change_visibility, + r"mod foo { pub const FOO: () = (); } + fn main() { foo::FOO<|> } ", + ); + } + + #[test] + fn change_visibility_of_static_via_path() { + check_assist( + change_visibility, + r"mod foo { static FOO: () = (); } + fn main() { foo::FOO<|> } ", + r"mod foo { <|>pub(crate) static FOO: () = (); } + fn main() { foo::FOO } ", + ); + check_assist_not_applicable( + change_visibility, + r"mod foo { pub static FOO: () = (); } + fn main() { foo::FOO<|> } ", + ); + } + + #[test] + fn change_visibility_of_trait_via_path() { + check_assist( + change_visibility, + r"mod foo { trait Foo { fn foo(&self) {} } } + fn main() { let x: &dyn foo::<|>Foo; } ", + r"mod foo { <|>pub(crate) trait Foo { fn foo(&self) {} } } + fn main() { let x: &dyn foo::Foo; } ", + ); + check_assist_not_applicable( + change_visibility, + r"mod foo { pub trait Foo { fn foo(&self) {} } } + fn main() { let x: &dyn foo::Foo<|>; } ", + ); + } + + #[test] + fn change_visibility_of_type_alias_via_path() { + check_assist( + change_visibility, + r"mod foo { type Foo = (); } + fn main() { let x: foo::Foo<|>; } ", + r"mod foo { <|>pub(crate) type Foo = (); } + fn main() { let x: foo::Foo; } ", + ); + check_assist_not_applicable( + change_visibility, + r"mod foo { pub type Foo = (); } + fn main() { let x: foo::Foo<|>; } ", + ); + } + + #[test] + fn change_visibility_of_module_via_path() { + check_assist( + change_visibility, + r"mod foo { mod bar { fn bar() {} } } + fn main() { foo::bar<|>::bar(); } ", + r"mod foo { <|>pub(crate) mod bar { fn bar() {} } } + fn main() { foo::bar::bar(); } ", + ); + + check_assist( + change_visibility, + r" + //- /main.rs + mod foo; + fn main() { foo::bar<|>::baz(); } + + //- /foo.rs + mod bar { + pub fn baz() {} + } + ", + r"<|>pub(crate) mod bar { + pub fn baz() {} +} + +", + ); + + check_assist_not_applicable( + change_visibility, + r"mod foo { pub mod bar { pub fn bar() {} } } + fn main() { foo::bar<|>::bar(); } ", + ); + } + + #[test] + fn change_visibility_of_inline_module_in_other_file_via_path() { + check_assist( + change_visibility, + r" + //- /main.rs + mod foo; + fn main() { foo::bar<|>::baz(); } + + //- /foo.rs + mod bar; + + //- /foo/bar.rs + pub fn baz() {} + } + ", + r"<|>pub(crate) mod bar; +", + ); + } + + #[test] + fn change_visibility_of_module_declaration_in_other_file_via_path() { + check_assist( + change_visibility, + r" + //- /main.rs + mod foo; + fn main() { foo::bar<|>>::baz(); } + + //- /foo.rs + mod bar { + pub fn baz() {} + } + ", + r"<|>pub(crate) mod bar { + pub fn baz() {} +} + +", + ); + } + #[test] fn change_visibility_target() { check_assist_target(change_visibility, "<|>fn foo() {}", "fn"); -- cgit v1.2.3 From 66db88d226704a75a2fa38782ee3b82fd7829d5e Mon Sep 17 00:00:00 2001 From: Timo Freiberg Date: Thu, 7 May 2020 00:10:56 +0200 Subject: Trigger change_visibility assist when on an invisible struct field Union fields apparently don't work :( --- .../ra_assists/src/handlers/change_visibility.rs | 309 +++++++++++++++++---- 1 file changed, 248 insertions(+), 61 deletions(-) (limited to 'crates/ra_assists/src/handlers') diff --git a/crates/ra_assists/src/handlers/change_visibility.rs b/crates/ra_assists/src/handlers/change_visibility.rs index 573f94a46..40cf4b422 100644 --- a/crates/ra_assists/src/handlers/change_visibility.rs +++ b/crates/ra_assists/src/handlers/change_visibility.rs @@ -8,10 +8,11 @@ use ra_syntax::{ SyntaxNode, TextRange, TextSize, T, }; -use hir::{db::HirDatabase, HasSource, PathResolution}; +use hir::{db::HirDatabase, HasSource, HasVisibility, PathResolution}; use test_utils::tested_by; use crate::{AssistContext, AssistId, Assists}; +use ra_db::FileId; // Assist: change_visibility // @@ -29,6 +30,8 @@ pub(crate) fn change_visibility(acc: &mut Assists, ctx: &AssistContext) -> Optio return change_vis(acc, vis); } add_vis(acc, ctx) + .or_else(|| add_vis_to_referenced_module_def(acc, ctx)) + .or_else(|| add_vis_to_referenced_record_field(acc, ctx)) } fn add_vis(acc: &mut Assists, ctx: &AssistContext) -> Option<()> { @@ -74,86 +77,141 @@ fn add_vis(acc: &mut Assists, ctx: &AssistContext) -> Option<()> { }) } -fn add_missing_vis(ctx: AssistCtx) -> Option { +fn add_vis_to_referenced_module_def(acc: &mut Assists, ctx: &AssistContext) -> Option<()> { let path: ast::Path = ctx.find_node_at_offset()?; - let path_res = dbg!(ctx.sema.resolve_path(&path))?; + let path_res = ctx.sema.resolve_path(&path)?; let def = match path_res { PathResolution::Def(def) => def, _ => return None, }; - dbg!(&def); - let current_module = dbg!(ctx.sema.scope(&path.syntax()).module())?; - let target_module = dbg!(def.module(ctx.db))?; + let current_module = ctx.sema.scope(&path.syntax()).module()?; + let target_module = def.module(ctx.db)?; - let vis = dbg!(target_module.visibility_of(ctx.db, &def))?; + let vis = target_module.visibility_of(ctx.db, &def)?; if vis.is_visible_from(ctx.db, current_module.into()) { return None; }; - let target_name; - let (offset, target) = match def { + let (offset, target, target_file, target_name) = target_data_for_def(ctx.db, def)?; + + let missing_visibility = + if current_module.krate() == target_module.krate() { "pub(crate)" } else { "pub" }; + + let assist_label = match target_name { + None => format!("Change visibility to {}", missing_visibility), + Some(name) => format!("Change visibility of {} to {}", name, missing_visibility), + }; + + acc.add(AssistId("change_visibility"), assist_label, target, |edit| { + edit.set_file(target_file); + edit.insert(offset, format!("{} ", missing_visibility)); + edit.set_cursor(offset); + }) +} + +fn add_vis_to_referenced_record_field(acc: &mut Assists, ctx: &AssistContext) -> Option<()> { + let record_field: ast::RecordField = ctx.find_node_at_offset()?; + let (record_field_def, _) = ctx.sema.resolve_record_field(&record_field)?; + + let current_module = ctx.sema.scope(record_field.syntax()).module()?; + let visibility = record_field_def.visibility(ctx.db); + if visibility.is_visible_from(ctx.db, current_module.into()) { + return None; + } + + let parent = record_field_def.parent_def(ctx.db); + let parent_name = parent.name(ctx.db); + let target_module = parent.module(ctx.db); + + let in_file_source = record_field_def.source(ctx.db); + let (offset, target) = match in_file_source.value { + hir::FieldSource::Named(it) => { + let s = it.syntax(); + (vis_offset(s), s.text_range()) + } + hir::FieldSource::Pos(it) => { + let s = it.syntax(); + (vis_offset(s), s.text_range()) + } + }; + + let missing_visibility = + if current_module.krate() == target_module.krate() { "pub(crate)" } else { "pub" }; + let target_file = in_file_source.file_id.original_file(ctx.db); + + let target_name = record_field_def.name(ctx.db); + let assist_label = + format!("Change visibility of {}.{} to {}", parent_name, target_name, missing_visibility); + + acc.add(AssistId("change_visibility"), assist_label, target, |edit| { + edit.set_file(target_file); + edit.insert(offset, format!("{} ", missing_visibility)); + edit.set_cursor(offset) + }) +} + +fn target_data_for_def( + db: &dyn HirDatabase, + def: hir::ModuleDef, +) -> Option<(TextSize, TextRange, FileId, Option)> { + fn offset_target_and_file_id( + db: &dyn HirDatabase, + x: S, + ) -> (TextSize, TextRange, FileId) + where + S: HasSource, + Ast: AstNode, + { + let source = x.source(db); + let in_file_syntax = source.syntax(); + let file_id = in_file_syntax.file_id; + let syntax = in_file_syntax.value; + (vis_offset(syntax), syntax.text_range(), file_id.original_file(db.upcast())) + } + + let target_name; + let (offset, target, target_file) = match def { hir::ModuleDef::Function(f) => { - target_name = Some(f.name(ctx.db)); - offset_and_target(ctx.db, f) + target_name = Some(f.name(db)); + offset_target_and_file_id(db, f) } hir::ModuleDef::Adt(adt) => { - target_name = Some(adt.name(ctx.db)); + target_name = Some(adt.name(db)); match adt { - hir::Adt::Struct(s) => offset_and_target(ctx.db, s), - hir::Adt::Union(u) => offset_and_target(ctx.db, u), - hir::Adt::Enum(e) => offset_and_target(ctx.db, e), + hir::Adt::Struct(s) => offset_target_and_file_id(db, s), + hir::Adt::Union(u) => offset_target_and_file_id(db, u), + hir::Adt::Enum(e) => offset_target_and_file_id(db, e), } } hir::ModuleDef::Const(c) => { - target_name = c.name(ctx.db); - offset_and_target(ctx.db, c) + target_name = c.name(db); + offset_target_and_file_id(db, c) } hir::ModuleDef::Static(s) => { - target_name = s.name(ctx.db); - offset_and_target(ctx.db, s) + target_name = s.name(db); + offset_target_and_file_id(db, s) } hir::ModuleDef::Trait(t) => { - target_name = Some(t.name(ctx.db)); - offset_and_target(ctx.db, t) + target_name = Some(t.name(db)); + offset_target_and_file_id(db, t) } hir::ModuleDef::TypeAlias(t) => { - target_name = Some(t.name(ctx.db)); - offset_and_target(ctx.db, t) + target_name = Some(t.name(db)); + offset_target_and_file_id(db, t) } hir::ModuleDef::Module(m) => { - target_name = m.name(ctx.db); - let source = dbg!(m.declaration_source(ctx.db))?.value; - let syntax = source.syntax(); - (vis_offset(syntax), syntax.text_range()) + target_name = m.name(db); + let in_file_source = m.declaration_source(db)?; + let file_id = in_file_source.file_id.original_file(db.upcast()); + let syntax = in_file_source.value.syntax(); + (vis_offset(syntax), syntax.text_range(), file_id) } // Enum variants can't be private, we can't modify builtin types hir::ModuleDef::EnumVariant(_) | hir::ModuleDef::BuiltinType(_) => return None, }; - // FIXME if target is in another crate, add `pub` instead of `pub(crate)` - - let assist_label = match target_name { - None => "Change visibility to pub(crate)".to_string(), - Some(name) => format!("Change visibility of {} to pub(crate)", name), - }; - let target_file = target_module.definition_source(ctx.db).file_id.original_file(ctx.db); - - ctx.add_assist(AssistId("change_visibility"), assist_label, target, |edit| { - edit.set_file(target_file); - edit.insert(offset, "pub(crate) "); - edit.set_cursor(offset); - }) -} - -fn offset_and_target(db: &dyn HirDatabase, x: S) -> (TextSize, TextRange) -where - S: HasSource, - Ast: AstNode, -{ - let source = x.source(db); - let syntax = source.syntax().value; - (vis_offset(syntax), syntax.text_range()) + Some((offset, target, target_file, target_name)) } fn vis_offset(node: &SyntaxNode) -> TextSize { @@ -350,7 +408,6 @@ mod tests { } #[test] - // FIXME this requires a separate implementation, struct fields are not a ast::Path fn change_visibility_of_struct_field_via_path() { check_assist( change_visibility, @@ -359,11 +416,108 @@ mod tests { r"mod foo { pub struct Foo { <|>pub(crate) bar: (), } } fn main() { foo::Foo { bar: () }; } ", ); + check_assist( + change_visibility, + r"//- /lib.rs + mod foo; + fn main() { foo::Foo { <|>bar: () }; } + //- /foo.rs + pub struct Foo { bar: () } + ", + r"pub struct Foo { <|>pub(crate) bar: () } + +", + ); + check_assist_not_applicable( + change_visibility, + r"mod foo { pub struct Foo { pub bar: (), } } + fn main() { foo::Foo { <|>bar: () }; } ", + ); + check_assist_not_applicable( + change_visibility, + r"//- /lib.rs + mod foo; + fn main() { foo::Foo { <|>bar: () }; } + //- /foo.rs + pub struct Foo { pub bar: () } + ", + ); + } + + #[test] + fn change_visibility_of_enum_variant_field_via_path() { + check_assist( + change_visibility, + r"mod foo { pub enum Foo { Bar { bar: () } } } + fn main() { foo::Foo::Bar { <|>bar: () }; } ", + r"mod foo { pub enum Foo { Bar { <|>pub(crate) bar: () } } } + fn main() { foo::Foo::Bar { bar: () }; } ", + ); + check_assist( + change_visibility, + r"//- /lib.rs + mod foo; + fn main() { foo::Foo::Bar { <|>bar: () }; } + //- /foo.rs + pub enum Foo { Bar { bar: () } } + ", + r"pub enum Foo { Bar { <|>pub(crate) bar: () } } + +", + ); check_assist_not_applicable( change_visibility, r"mod foo { pub struct Foo { pub bar: (), } } fn main() { foo::Foo { <|>bar: () }; } ", ); + check_assist_not_applicable( + change_visibility, + r"//- /lib.rs + mod foo; + fn main() { foo::Foo { <|>bar: () }; } + //- /foo.rs + pub struct Foo { pub bar: () } + ", + ); + } + + #[test] + #[ignore] + // FIXME reenable this test when `Semantics::resolve_record_field` works with union fields + fn change_visibility_of_union_field_via_path() { + check_assist( + change_visibility, + r"mod foo { pub union Foo { bar: (), } } + fn main() { foo::Foo { <|>bar: () }; } ", + r"mod foo { pub union Foo { <|>pub(crate) bar: (), } } + fn main() { foo::Foo { bar: () }; } ", + ); + check_assist( + change_visibility, + r"//- /lib.rs + mod foo; + fn main() { foo::Foo { <|>bar: () }; } + //- /foo.rs + pub union Foo { bar: () } + ", + r"pub union Foo { <|>pub(crate) bar: () } + +", + ); + check_assist_not_applicable( + change_visibility, + r"mod foo { pub union Foo { pub bar: (), } } + fn main() { foo::Foo { <|>bar: () }; } ", + ); + check_assist_not_applicable( + change_visibility, + r"//- /lib.rs + mod foo; + fn main() { foo::Foo { <|>bar: () }; } + //- /foo.rs + pub union Foo { pub bar: () } + ", + ); } #[test] @@ -500,24 +654,57 @@ mod tests { fn change_visibility_of_module_declaration_in_other_file_via_path() { check_assist( change_visibility, - r" - //- /main.rs - mod foo; - fn main() { foo::bar<|>>::baz(); } + r"//- /main.rs + mod foo; + fn main() { foo::bar<|>>::baz(); } - //- /foo.rs - mod bar { - pub fn baz() {} - } - ", + //- /foo.rs + mod bar { + pub fn baz() {} + }", r"<|>pub(crate) mod bar { pub fn baz() {} } - ", ); } + #[test] + #[ignore] + // FIXME handle reexports properly + fn change_visibility_of_reexport() { + check_assist( + change_visibility, + r" + mod foo { + use bar::Baz; + mod bar { pub(super) struct Baz; } + } + foo::Baz<|> + ", + r" + mod foo { + <|>pub(crate) use bar::Baz; + mod bar { pub(super) struct Baz; } + } + foo::Baz + ", + ) + } + + #[test] + fn adds_pub_when_target_is_in_another_crate() { + check_assist( + change_visibility, + r"//- /main.rs crate:a deps:foo + foo::Bar<|> + //- /lib.rs crate:foo + struct Bar;", + r"<|>pub struct Bar; +", + ) + } + #[test] fn change_visibility_target() { check_assist_target(change_visibility, "<|>fn foo() {}", "fn"); -- cgit v1.2.3