refactor: move workspace features to own mod (#276)

Author: juleswritescode

crates/pgt_completions/src/builder.rs

@@ -1,4 +1,4 @@
-use crate::{CompletionResult, item::CompletionItem};
+use crate::item::CompletionItem;
 
 pub(crate) struct CompletionBuilder {
     items: Vec<CompletionItem>,
@@ -13,7 +13,7 @@ impl CompletionBuilder {
         self.items.push(item);
     }
 
-    pub fn finish(mut self) -> CompletionResult {
+    pub fn finish(mut self) -> Vec<CompletionItem> {
         self.items
             .sort_by(|a, b| b.score.cmp(&a.score).then_with(|| a.label.cmp(&b.label)));
 
@@ -22,8 +22,7 @@ impl CompletionBuilder {
 
         let should_preselect_first_item = self.should_preselect_first_item();
 
-        let items: Vec<CompletionItem> = self
-            .items
+        self.items
             .into_iter()
             .enumerate()
             .map(|(idx, mut item)| {
@@ -32,9 +31,7 @@ impl CompletionBuilder {
                 }
                 item
             })
-            .collect();
-
-        CompletionResult { items }
+            .collect()
     }
 
     fn should_preselect_first_item(&mut self) -> bool {

crates/pgt_completions/src/complete.rs

@@ -1,5 +1,4 @@
 use pgt_text_size::TextSize;
-use serde::{Deserialize, Serialize};
 
 use crate::{
     builder::CompletionBuilder,
@@ -18,21 +17,7 @@ pub struct CompletionParams<'a> {
     pub tree: Option<&'a tree_sitter::Tree>,
 }
 
-#[derive(Debug, Default, Serialize, Deserialize)]
-#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
-pub struct CompletionResult {
-    pub(crate) items: Vec<CompletionItem>,
-}
-
-impl IntoIterator for CompletionResult {
-    type Item = CompletionItem;
-    type IntoIter = <Vec<CompletionItem> as IntoIterator>::IntoIter;
-    fn into_iter(self) -> Self::IntoIter {
-        self.items.into_iter()
-    }
-}
-
-pub fn complete(params: CompletionParams) -> CompletionResult {
+pub fn complete(params: CompletionParams) -> Vec<CompletionItem> {
     let ctx = CompletionContext::new(&params);
 
     let mut builder = CompletionBuilder::new();

crates/pgt_completions/src/providers/columns.rs

@@ -141,13 +141,13 @@ mod tests {
 
         let (tree, cache) = get_test_deps(setup, case.get_input_query()).await;
         let params = get_test_params(&tree, &cache, case.get_input_query());
-        let mut results = complete(params);
+        let mut items = complete(params);
 
-        let _ = results.items.split_off(3);
+        let _ = items.split_off(3);
 
-        results.items.sort_by(|a, b| a.label.cmp(&b.label));
+        items.sort_by(|a, b| a.label.cmp(&b.label));
 
-        let labels: Vec<String> = results.items.into_iter().map(|c| c.label).collect();
+        let labels: Vec<String> = items.into_iter().map(|c| c.label).collect();
 
         assert_eq!(labels, vec!["name", "narrator", "narrator_id"]);
     }

crates/pgt_completions/src/providers/tables.rs

@@ -43,11 +43,11 @@ mod tests {
 
         let (tree, cache) = get_test_deps(setup, query.as_str().into()).await;
         let params = get_test_params(&tree, &cache, query.as_str().into());
-        let results = complete(params);
+        let items = complete(params);
 
-        assert!(!results.items.is_empty());
+        assert!(!items.is_empty());
 
-        let best_match = &results.items[0];
+        let best_match = &items[0];
 
         assert_eq!(
             best_match.label, "users",
@@ -81,11 +81,11 @@ mod tests {
         for (query, expected_label) in test_cases {
             let (tree, cache) = get_test_deps(setup, query.as_str().into()).await;
             let params = get_test_params(&tree, &cache, query.as_str().into());
-            let results = complete(params);
+            let items = complete(params);
 
-            assert!(!results.items.is_empty());
+            assert!(!items.is_empty());
 
-            let best_match = &results.items[0];
+            let best_match = &items[0];
 
             assert_eq!(
                 best_match.label, expected_label,
@@ -126,11 +126,11 @@ mod tests {
         for (query, expected_label) in test_cases {
             let (tree, cache) = get_test_deps(setup, query.as_str().into()).await;
             let params = get_test_params(&tree, &cache, query.as_str().into());
-            let results = complete(params);
+            let items = complete(params);
 
-            assert!(!results.items.is_empty());
+            assert!(!items.is_empty());
 
-            let best_match = &results.items[0];
+            let best_match = &items[0];
 
             assert_eq!(
                 best_match.label, expected_label,
@@ -163,9 +163,9 @@ mod tests {
 
         let (tree, cache) = get_test_deps(setup, query.as_str().into()).await;
         let params = get_test_params(&tree, &cache, query.as_str().into());
-        let results = complete(params);
+        let items = complete(params);
 
-        let CompletionItem { label, kind, .. } = results
+        let CompletionItem { label, kind, .. } = items
             .into_iter()
             .next()
             .expect("Should return at least one completion item");

crates/pgt_lsp/src/capabilities.rs

@@ -1,6 +1,6 @@
 use crate::adapters::{PositionEncoding, WideEncoding, negotiated_encoding};
-use pgt_workspace::code_actions::{CommandActionCategory, CommandActionCategoryIter};
-use strum::{EnumIter, IntoEnumIterator};
+use pgt_workspace::features::code_actions::CommandActionCategory;
+use strum::IntoEnumIterator;
 use tower_lsp::lsp_types::{
     ClientCapabilities, CompletionOptions, ExecuteCommandOptions, PositionEncodingKind,
     SaveOptions, ServerCapabilities, TextDocumentSyncCapability, TextDocumentSyncKind,

crates/pgt_lsp/src/handlers/code_actions.rs

@@ -5,7 +5,7 @@ use tower_lsp::lsp_types::{
     MessageType,
 };
 
-use pgt_workspace::code_actions::{
+use pgt_workspace::features::code_actions::{
     CodeActionKind, CodeActionsParams, CommandActionCategory, ExecuteStatementParams,
 };
 

crates/pgt_lsp/src/handlers/completions.rs

@@ -1,6 +1,6 @@
 use crate::session::Session;
 use anyhow::Result;
-use pgt_workspace::{WorkspaceError, workspace};
+use pgt_workspace::{WorkspaceError, features::completions::GetCompletionsParams};
 use tower_lsp::lsp_types::{self, CompletionItem, CompletionItemLabelDetails};
 
 use super::helper;
@@ -13,27 +13,24 @@ pub fn get_completions(
     let url = params.text_document_position.text_document.uri;
     let path = session.file_path(&url)?;
 
-    let completion_result =
-        match session
-            .workspace
-            .get_completions(workspace::GetCompletionsParams {
-                path,
-                position: helper::get_cursor_position(
-                    session,
-                    &url,
-                    params.text_document_position.position,
-                )?,
-            }) {
-            Ok(result) => result,
-            Err(e) => match e {
-                WorkspaceError::DatabaseConnectionError(_) => {
-                    return Ok(lsp_types::CompletionResponse::Array(vec![]));
-                }
-                _ => {
-                    return Err(e.into());
-                }
-            },
-        };
+    let completion_result = match session.workspace.get_completions(GetCompletionsParams {
+        path,
+        position: helper::get_cursor_position(
+            session,
+            &url,
+            params.text_document_position.position,
+        )?,
+    }) {
+        Ok(result) => result,
+        Err(e) => match e {
+            WorkspaceError::DatabaseConnectionError(_) => {
+                return Ok(lsp_types::CompletionResponse::Array(vec![]));
+            }
+            _ => {
+                return Err(e.into());
+            }
+        },
+    };
 
     let items: Vec<CompletionItem> = completion_result
         .into_iter()

crates/pgt_lsp/src/session.rs

@@ -11,8 +11,9 @@ use pgt_diagnostics::{DiagnosticExt, Error};
 use pgt_fs::{FileSystem, PgTPath};
 use pgt_workspace::Workspace;
 use pgt_workspace::configuration::{LoadedConfiguration, load_configuration};
+use pgt_workspace::features;
 use pgt_workspace::settings::PartialConfigurationExt;
-use pgt_workspace::workspace::{PullDiagnosticsParams, UpdateSettingsParams};
+use pgt_workspace::workspace::UpdateSettingsParams;
 use pgt_workspace::{DynRef, WorkspaceError};
 use rustc_hash::FxHashMap;
 use serde_json::Value;
@@ -265,13 +266,15 @@ impl Session {
         let categories = RuleCategoriesBuilder::default().all();
 
         let diagnostics: Vec<lsp_types::Diagnostic> = {
-            let result = self.workspace.pull_diagnostics(PullDiagnosticsParams {
-                path: pgt_path.clone(),
-                max_diagnostics: u64::MAX,
-                categories: categories.build(),
-                only: Vec::new(),
-                skip: Vec::new(),
-            })?;
+            let result =
+                self.workspace
+                    .pull_diagnostics(features::diagnostics::PullDiagnosticsParams {
+                        path: pgt_path.clone(),
+                        max_diagnostics: u64::MAX,
+                        categories: categories.build(),
+                        only: Vec::new(),
+                        skip: Vec::new(),
+                    })?;
 
             result
                 .diagnostics

crates/pgt_workspace/src/code_actions.rs renamed to crates/pgt_workspace/src/features/code_actions.rs

@@ -0,0 +1,26 @@
+use pgt_completions::CompletionItem;
+use pgt_fs::PgTPath;
+use pgt_text_size::TextSize;
+
+#[derive(Debug, serde::Serialize, serde::Deserialize)]
+#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
+pub struct GetCompletionsParams {
+    /// The File for which a completion is requested.
+    pub path: PgTPath,
+    /// The Cursor position in the file for which a completion is requested.
+    pub position: TextSize,
+}
+
+#[derive(Debug, serde::Serialize, serde::Deserialize, Default)]
+#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
+pub struct CompletionsResult {
+    pub(crate) items: Vec<CompletionItem>,
+}
+
+impl IntoIterator for CompletionsResult {
+    type Item = CompletionItem;
+    type IntoIter = <Vec<CompletionItem> as IntoIterator>::IntoIter;
+    fn into_iter(self) -> Self::IntoIter {
+        self.items.into_iter()
+    }
+}