feat(refactor): add core library foundation with internal abstractions [1 of 8] #273
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| [package] | ||
| name = "dx-scope" | ||
| version = "0.0.0-dev" | ||
| edition = "2024" | ||
| default-run = "scope" | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| //! CLI-specific implementations for interactive usage. | ||
| //! | ||
| //! This module provides implementations of the library traits that are | ||
| //! suitable for command-line interface usage, including: | ||
| //! | ||
| //! - Interactive prompts using the `inquire` crate | ||
| //! - Visual progress reporting using `tracing-indicatif` | ||
| //! | ||
| //! # When to Use | ||
| //! | ||
| //! Use the implementations in this module when building CLI applications | ||
| //! that need interactive user prompts. For library usage, automated | ||
| //! environments, or testing, use the implementations in [`crate::internal`]. | ||
| //! | ||
| //! # Examples | ||
| //! | ||
| //! ## Interactive CLI Application | ||
| //! | ||
| //! ```rust | ||
| //! use dx_scope::InquireInteraction; | ||
| //! use dx_scope::internal::prompts::UserInteraction; | ||
| //! | ||
| //! let interaction = InquireInteraction; | ||
| //! | ||
| //! // This will show an interactive prompt in the terminal | ||
| //! // In non-TTY environments (like this doc test), it returns false | ||
| //! let result = interaction.confirm("Apply this fix?", Some("This will modify files")); | ||
| //! // result is false in doc test environment (no TTY) | ||
| //! ``` | ||
| //! | ||
| //! # TTY Detection | ||
| //! | ||
| //! `InquireInteraction` automatically detects when stdin is not a TTY | ||
| //! (e.g., when running in a pipe or CI environment) and returns `false` | ||
| //! instead of crashing. For explicit control in non-interactive environments, | ||
| //! use [`AutoApprove`](crate::AutoApprove) or [`DenyAll`](crate::DenyAll). | ||
|
|
||
| use crate::internal::prompts::UserInteraction; | ||
| use inquire::InquireError; | ||
| use tracing::warn; | ||
|
|
||
| /// CLI user interaction using the `inquire` crate. | ||
| /// | ||
| /// This implementation provides interactive prompts suitable for terminal usage. | ||
| /// It handles TTY detection and gracefully falls back to denial when running | ||
| /// in non-interactive environments. | ||
| /// | ||
| /// # Example | ||
| /// | ||
| /// ```rust | ||
| /// use dx_scope::InquireInteraction; | ||
| /// use dx_scope::internal::prompts::UserInteraction; | ||
| /// | ||
| /// let interaction = InquireInteraction; | ||
| /// // In non-TTY environments, confirm() returns false gracefully | ||
| /// let confirmed = interaction.confirm("Apply fix?", Some("This will modify files")); | ||
| /// ``` | ||
| #[derive(Debug, Clone, Copy, Default)] | ||
| pub struct InquireInteraction; | ||
|
|
||
| impl UserInteraction for InquireInteraction { | ||
| fn confirm(&self, prompt: &str, help_text: Option<&str>) -> bool { | ||
| tracing_indicatif::suspend_tracing_indicatif(|| { | ||
| let base_prompt = inquire::Confirm::new(prompt).with_default(false); | ||
| let prompt = match help_text { | ||
| Some(text) => base_prompt.with_help_message(text), | ||
| None => base_prompt, | ||
| }; | ||
|
|
||
| match prompt.prompt() { | ||
| Ok(result) => result, | ||
| Err(InquireError::NotTTY) => { | ||
| warn!(target: "user", "Prompting user, but input device is not a TTY. Skipping."); | ||
| false | ||
| } | ||
| Err(_) => false, | ||
| } | ||
| }) | ||
| } | ||
|
|
||
| fn notify(&self, message: &str) { | ||
| println!("{}", message); | ||
| } | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use super::*; | ||
|
|
||
| #[test] | ||
| fn test_inquire_interaction_is_send_sync() { | ||
| fn assert_send_sync<T: Send + Sync>() {} | ||
| assert_send_sync::<InquireInteraction>(); | ||
|
Contributor
There was a problem hiding this comment. This test appears to be testing the compiler's type system. |
||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| //! Internal abstractions for library-first design. | ||
| //! | ||
| //! This module contains traits and implementations that allow the scope library | ||
| //! to be used both as a CLI tool and as a programmatic library. These abstractions | ||
| //! decouple the core logic from specific UI implementations. | ||
| //! | ||
| //! # Overview | ||
| //! | ||
| //! The internal module provides: | ||
| //! - [`prompts`] - User interaction abstractions (confirmations, notifications) | ||
| //! - [`progress`] - Progress reporting abstractions | ||
| //! | ||
| //! # Choosing an Implementation | ||
| //! | ||
| //! | Use Case | UserInteraction | ProgressReporter | | ||
| //! |----------|-----------------|------------------| | ||
| //! | CLI/Interactive | `InquireInteraction` | (use tracing-indicatif) | | ||
| //! | CI/Automated | `AutoApprove` | `NoOpProgress` | | ||
| //! | Dry-run/Testing | `DenyAll` | `NoOpProgress` | | ||
| //! | Custom | Implement trait | Implement trait | | ||
| //! | ||
| //! # Examples | ||
| //! | ||
| //! ## Automated Environment (CI) | ||
| //! | ||
| //! ```rust | ||
| //! use dx_scope::internal::prompts::{UserInteraction, AutoApprove}; | ||
| //! use dx_scope::internal::progress::{ProgressReporter, NoOpProgress}; | ||
| //! | ||
| //! let interaction = AutoApprove; | ||
| //! let progress = NoOpProgress; | ||
| //! | ||
| //! // All prompts will be automatically approved | ||
| //! assert!(interaction.confirm("Apply fix?", None)); | ||
| //! | ||
| //! // Progress calls are silent | ||
| //! progress.start_group("build", 5); | ||
| //! progress.finish_group(); | ||
| //! ``` | ||
| //! | ||
| //! ## Dry-Run Mode | ||
| //! | ||
| //! ```rust | ||
| //! use dx_scope::internal::prompts::{UserInteraction, DenyAll}; | ||
| //! | ||
| //! let interaction = DenyAll; | ||
| //! | ||
| //! // All prompts will be denied - no changes made | ||
| //! assert!(!interaction.confirm("Apply fix?", None)); | ||
| //! ``` | ||
| //! | ||
| //! ## Custom Implementation | ||
| //! | ||
| //! ```rust | ||
| //! use dx_scope::internal::prompts::UserInteraction; | ||
| //! | ||
| //! struct AlwaysAskUser; | ||
| //! | ||
| //! impl UserInteraction for AlwaysAskUser { | ||
| //! fn confirm(&self, prompt: &str, _help: Option<&str>) -> bool { | ||
| //! // Custom logic - maybe read from a config file | ||
| //! println!("Would prompt: {}", prompt); | ||
| //! false | ||
| //! } | ||
| //! | ||
| //! fn notify(&self, message: &str) { | ||
| //! println!("[INFO] {}", message); | ||
| //! } | ||
| //! } | ||
| //! ``` | ||
| //! | ||
| //! # Thread Safety | ||
| //! | ||
| //! All provided implementations are `Send + Sync`, making them safe to use | ||
| //! across async tasks and threads. | ||
|
|
||
| pub mod progress; | ||
| pub mod prompts; | ||
|
|
||
| // Re-export commonly used types at the module level | ||
| pub use progress::{NoOpProgress, ProgressReporter}; | ||
| pub use prompts::{AutoApprove, DenyAll, UserInteraction}; | ||
|
Contributor
There was a problem hiding this comment. As part of this, we should stop reexporting everything all the time. |
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good comment. Says why not what. Double plus good.