Merge #7186

7186: Align config's API with usage r=matklad a=matklad

bors r+
🤖

Co-authored-by: Aleksey Kladov <aleksey.kladov@gmail.com>

Author: bors[bot]

crates/assists/src/assist_config.rs

@@ -4,8 +4,7 @@
 //! module, and we use to statically check that we only produce snippet
 //! assists if we are allowed to.
 
-use hir::PrefixKind;
-use ide_db::helpers::insert_use::MergeBehavior;
+use ide_db::helpers::{insert_use::MergeBehavior, SnippetCap};
 
 use crate::AssistKind;
 
@@ -16,35 +15,8 @@ pub struct AssistConfig {
     pub insert_use: InsertUseConfig,
 }
 
-impl AssistConfig {
-    pub fn allow_snippets(&mut self, yes: bool) {
-        self.snippet_cap = if yes { Some(SnippetCap { _private: () }) } else { None }
-    }
-}
-
-#[derive(Clone, Copy, Debug, PartialEq, Eq)]
-pub struct SnippetCap {
-    _private: (),
-}
-
-impl Default for AssistConfig {
-    fn default() -> Self {
-        AssistConfig {
-            snippet_cap: Some(SnippetCap { _private: () }),
-            allowed: None,
-            insert_use: InsertUseConfig::default(),
-        }
-    }
-}
-
 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
 pub struct InsertUseConfig {
     pub merge: Option<MergeBehavior>,
-    pub prefix_kind: PrefixKind,
-}
-
-impl Default for InsertUseConfig {
-    fn default() -> Self {
-        InsertUseConfig { merge: Some(MergeBehavior::Full), prefix_kind: PrefixKind::Plain }
-    }
+    pub prefix_kind: hir::PrefixKind,
 }

crates/assists/src/assist_context.rs

@@ -4,7 +4,10 @@ use std::mem;
 
 use algo::find_covering_element;
 use hir::Semantics;
-use ide_db::base_db::{AnchoredPathBuf, FileId, FileRange};
+use ide_db::{
+    base_db::{AnchoredPathBuf, FileId, FileRange},
+    helpers::SnippetCap,
+};
 use ide_db::{
     label::Label,
     source_change::{FileSystemEdit, SourceChange, SourceFileEdit},
@@ -17,10 +20,7 @@ use syntax::{
 };
 use text_edit::{TextEdit, TextEditBuilder};
 
-use crate::{
-    assist_config::{AssistConfig, SnippetCap},
-    Assist, AssistId, AssistKind, GroupLabel,
-};
+use crate::{assist_config::AssistConfig, Assist, AssistId, AssistKind, GroupLabel};
 
 /// `AssistContext` allows to apply an assist or check if it could be applied.
 ///

crates/assists/src/handlers/generate_function.rs

@@ -1,5 +1,5 @@
 use hir::HirDisplay;
-use ide_db::base_db::FileId;
+use ide_db::{base_db::FileId, helpers::SnippetCap};
 use rustc_hash::{FxHashMap, FxHashSet};
 use syntax::{
     ast::{
@@ -11,7 +11,6 @@ use syntax::{
 };
 
 use crate::{
-    assist_config::SnippetCap,
     utils::{render_snippet, Cursor},
     AssistContext, AssistId, AssistKind, Assists,
 };

crates/assists/src/lib.rs

@@ -24,7 +24,7 @@ use syntax::TextRange;
 
 pub(crate) use crate::assist_context::{AssistContext, Assists};
 
-pub use assist_config::AssistConfig;
+pub use assist_config::{AssistConfig, InsertUseConfig};
 
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 pub enum AssistKind {

crates/assists/src/tests.rs

@@ -1,15 +1,29 @@
 mod generated;
 
 use hir::Semantics;
-use ide_db::base_db::{fixture::WithFixture, FileId, FileRange, SourceDatabaseExt};
-use ide_db::source_change::FileSystemEdit;
-use ide_db::RootDatabase;
+use ide_db::{
+    base_db::{fixture::WithFixture, FileId, FileRange, SourceDatabaseExt},
+    helpers::{insert_use::MergeBehavior, SnippetCap},
+    source_change::FileSystemEdit,
+    RootDatabase,
+};
 use syntax::TextRange;
 use test_utils::{assert_eq_text, extract_offset, extract_range};
 
-use crate::{handlers::Handler, Assist, AssistConfig, AssistContext, AssistKind, Assists};
+use crate::{
+    handlers::Handler, Assist, AssistConfig, AssistContext, AssistKind, Assists, InsertUseConfig,
+};
 use stdx::{format_to, trim_indent};
 
+pub(crate) const TEST_CONFIG: AssistConfig = AssistConfig {
+    snippet_cap: SnippetCap::new(true),
+    allowed: None,
+    insert_use: InsertUseConfig {
+        merge: Some(MergeBehavior::Full),
+        prefix_kind: hir::PrefixKind::Plain,
+    },
+};
+
 pub(crate) fn with_single_file(text: &str) -> (RootDatabase, FileId) {
     RootDatabase::with_single_file(text)
 }
@@ -48,14 +62,14 @@ fn check_doc_test(assist_id: &str, before: &str, after: &str) {
     let before = db.file_text(file_id).to_string();
     let frange = FileRange { file_id, range: selection.into() };
 
-    let assist = Assist::get(&db, &AssistConfig::default(), true, frange)
+    let assist = Assist::get(&db, &TEST_CONFIG, true, frange)
         .into_iter()
         .find(|assist| assist.id.0 == assist_id)
         .unwrap_or_else(|| {
             panic!(
                 "\n\nAssist is not applicable: {}\nAvailable assists: {}",
                 assist_id,
-                Assist::get(&db, &AssistConfig::default(), false, frange)
+                Assist::get(&db, &TEST_CONFIG, false, frange)
                     .into_iter()
                     .map(|assist| assist.id.0)
                     .collect::<Vec<_>>()
@@ -89,7 +103,7 @@ fn check(handler: Handler, before: &str, expected: ExpectedResult, assist_label:
     let frange = FileRange { file_id: file_with_caret_id, range: range_or_offset.into() };
 
     let sema = Semantics::new(&db);
-    let config = AssistConfig::default();
+    let config = TEST_CONFIG;
     let ctx = AssistContext::new(sema, &config, frange);
     let mut acc = Assists::new(&ctx, true);
     handler(&mut acc, &ctx);
@@ -156,7 +170,7 @@ fn assist_order_field_struct() {
     let (before_cursor_pos, before) = extract_offset(before);
     let (db, file_id) = with_single_file(&before);
     let frange = FileRange { file_id, range: TextRange::empty(before_cursor_pos) };
-    let assists = Assist::get(&db, &AssistConfig::default(), false, frange);
+    let assists = Assist::get(&db, &TEST_CONFIG, false, frange);
     let mut assists = assists.iter();
 
     assert_eq!(assists.next().expect("expected assist").label, "Change visibility to pub(crate)");
@@ -176,7 +190,7 @@ fn assist_order_if_expr() {
     let (range, before) = extract_range(before);
     let (db, file_id) = with_single_file(&before);
     let frange = FileRange { file_id, range };
-    let assists = Assist::get(&db, &AssistConfig::default(), false, frange);
+    let assists = Assist::get(&db, &TEST_CONFIG, false, frange);
     let mut assists = assists.iter();
 
     assert_eq!(assists.next().expect("expected assist").label, "Extract into variable");
@@ -198,7 +212,7 @@ fn assist_filter_works() {
     let frange = FileRange { file_id, range };
 
     {
-        let mut cfg = AssistConfig::default();
+        let mut cfg = TEST_CONFIG;
         cfg.allowed = Some(vec![AssistKind::Refactor]);
 
         let assists = Assist::get(&db, &cfg, false, frange);
@@ -209,7 +223,7 @@ fn assist_filter_works() {
     }
 
     {
-        let mut cfg = AssistConfig::default();
+        let mut cfg = TEST_CONFIG;
         cfg.allowed = Some(vec![AssistKind::RefactorExtract]);
         let assists = Assist::get(&db, &cfg, false, frange);
         assert_eq!(assists.len(), 1);
@@ -219,7 +233,7 @@ fn assist_filter_works() {
     }
 
     {
-        let mut cfg = AssistConfig::default();
+        let mut cfg = TEST_CONFIG;
         cfg.allowed = Some(vec![AssistKind::QuickFix]);
         let assists = Assist::get(&db, &cfg, false, frange);
         assert!(assists.is_empty(), "All asserts but quickfixes should be filtered out");

crates/assists/src/utils.rs

@@ -4,7 +4,7 @@ pub(crate) mod import_assets;
 use std::ops;
 
 use hir::HasSource;
-use ide_db::RootDatabase;
+use ide_db::{helpers::SnippetCap, RootDatabase};
 use itertools::Itertools;
 use syntax::{
     ast::edit::AstNodeEdit,
@@ -16,10 +16,7 @@ use syntax::{
     SyntaxNode, TextSize, T,
 };
 
-use crate::{
-    assist_config::SnippetCap,
-    ast_transform::{self, AstTransform, QualifyPaths, SubstituteTypeParams},
-};
+use crate::ast_transform::{self, AstTransform, QualifyPaths, SubstituteTypeParams};
 
 pub(crate) fn unwrap_trivial_block(block: ast::BlockExpr) -> ast::Expr {
     extract_trivial_expression(&block)

crates/completion/src/completions/postfix.rs

@@ -2,17 +2,16 @@
 
 mod format_like;
 
-use ide_db::ty_filter::TryEnum;
+use ide_db::{helpers::SnippetCap, ty_filter::TryEnum};
 use syntax::{
     ast::{self, AstNode, AstToken},
     SyntaxKind::{BLOCK_EXPR, EXPR_STMT},
     TextRange, TextSize,
 };
 use text_edit::TextEdit;
 
-use self::format_like::add_format_like_completions;
 use crate::{
-    config::SnippetCap,
+    completions::postfix::format_like::add_format_like_completions,
     context::CompletionContext,
     item::{Builder, CompletionKind},
     CompletionItem, CompletionItemKind, Completions,

crates/completion/src/completions/postfix/format_like.rs

@@ -14,12 +14,11 @@
 //   + `logw` -> `log::warn!(...)`
 //   + `loge` -> `log::error!(...)`
 
-use crate::{
-    completions::postfix::postfix_snippet, config::SnippetCap, context::CompletionContext,
-    Completions,
-};
+use ide_db::helpers::SnippetCap;
 use syntax::ast::{self, AstToken};
 
+use crate::{completions::postfix::postfix_snippet, context::CompletionContext, Completions};
+
 /// Mapping ("postfix completion item" => "macro to use")
 static KINDS: &[(&str, &str)] = &[
     ("format", "format!"),

crates/completion/src/completions/snippet.rs

@@ -1,8 +1,10 @@
 //! This file provides snippet completions, like `pd` => `eprintln!(...)`.
 
+use ide_db::helpers::SnippetCap;
+
 use crate::{
-    config::SnippetCap, item::Builder, CompletionContext, CompletionItem, CompletionItemKind,
-    CompletionKind, Completions,
+    item::Builder, CompletionContext, CompletionItem, CompletionItemKind, CompletionKind,
+    Completions,
 };
 
 fn snippet(ctx: &CompletionContext, cap: SnippetCap, label: &str, snippet: &str) -> Builder {

crates/completion/src/completions/unqualified_path.rs

@@ -192,23 +192,21 @@ mod tests {
     use test_utils::mark;
 
     use crate::{
-        test_utils::{check_edit, check_edit_with_config, completion_list_with_config},
+        test_utils::{
+            check_edit, check_edit_with_config, completion_list_with_config, TEST_CONFIG,
+        },
         CompletionConfig, CompletionKind,
     };
 
     fn check(ra_fixture: &str, expect: Expect) {
-        check_with_config(CompletionConfig::default(), ra_fixture, expect);
+        check_with_config(TEST_CONFIG, ra_fixture, expect);
     }
 
     fn check_with_config(config: CompletionConfig, ra_fixture: &str, expect: Expect) {
         let actual = completion_list_with_config(config, ra_fixture, CompletionKind::Reference);
         expect.assert_eq(&actual)
     }
 
-    fn fuzzy_completion_config() -> CompletionConfig {
-        CompletionConfig::default()
-    }
-
     #[test]
     fn self_fulfilling_completion() {
         mark::check!(self_fulfilling_completion);
@@ -832,7 +830,7 @@ impl My<|>
     #[test]
     fn function_fuzzy_completion() {
         check_edit_with_config(
-            fuzzy_completion_config(),
+            TEST_CONFIG,
             "stdin",
             r#"
 //- /lib.rs crate:dep
@@ -858,7 +856,7 @@ fn main() {
     #[test]
     fn macro_fuzzy_completion() {
         check_edit_with_config(
-            fuzzy_completion_config(),
+            TEST_CONFIG,
             "macro_with_curlies!",
             r#"
 //- /lib.rs crate:dep
@@ -886,7 +884,7 @@ fn main() {
     #[test]
     fn struct_fuzzy_completion() {
         check_edit_with_config(
-            fuzzy_completion_config(),
+            TEST_CONFIG,
             "ThirdStruct",
             r#"
 //- /lib.rs crate:dep
@@ -917,7 +915,7 @@ fn main() {
     fn fuzzy_completions_come_in_specific_order() {
         mark::check!(certain_fuzzy_order_test);
         check_with_config(
-            fuzzy_completion_config(),
+            TEST_CONFIG,
             r#"
 //- /lib.rs crate:dep
 pub struct FirstStruct;