Avoid manual tempfile implementation in get_text::from_editor()

Let's set an example in code that is supposed to be used in many comands,
more akind to a CLI-STD.

Author: Byron

Cargo.lock

@@ -116,6 +116,7 @@ minus = { version = "5.6.1", default-features = false, features = [
 ] }
 unicode-width = "0.2"
 cfg-if = "1.0.4"
+tempfile.workspace = true
 
 [dev-dependencies]
 but-core = { workspace = true, features = ["testing"] }

crates/but/Cargo.toml

@@ -497,7 +497,7 @@ fn get_commit_message_from_editor(
     template.push_str("#\n");
 
     // Read the result from the editor and strip comments
-    let message = tui::get_text::from_editor_no_comments("but_commit_msg", &template)?;
+    let message = tui::get_text::from_editor_no_comments("commit_msg", &template)?;
     Ok(message)
 }
 

crates/but/src/command/legacy/commit.rs

@@ -236,7 +236,7 @@ fn get_commit_message_from_editor(
     template.push_str("#\n");
 
     // Read the result and strip comments
-    let message = tui::get_text::from_editor_no_comments("but_commit_msg", &template)?;
+    let message = tui::get_text::from_editor_no_comments("commit_msg", &template)?;
 
     if message.is_empty() {
         bail!("Aborting due to empty commit message");
@@ -255,7 +255,7 @@ fn get_branch_name_from_editor(current_name: &str) -> Result<String> {
     template.push_str("# with '#' will be ignored, and an empty name aborts the operation.\n");
     template.push_str("#\n");
 
-    let branch_name = tui::get_text::from_editor_no_comments("but_branch_name", &template)?;
+    let branch_name = tui::get_text::from_editor_no_comments("branch_name", &template)?;
 
     if branch_name.is_empty() {
         bail!("Aborting due to empty branch name");

crates/but/src/command/legacy/describe.rs

@@ -564,7 +564,7 @@ fn get_review_body_from_editor(
     template.push_str("# with '#' will be ignored, and an empty body is allowed.\n");
     template.push_str("#\n");
 
-    let body = get_text::from_editor_no_comments("but_review_body", &template)?;
+    let body = get_text::from_editor_no_comments("review_body", &template)?;
     Ok(body)
 }
 
@@ -606,7 +606,7 @@ fn get_review_title_from_editor(
     template.push_str("# with '#' will be ignored, and an empty title aborts the operation.\n");
     template.push_str("#\n");
 
-    let title = get_text::from_editor_no_comments("but_review_title", &template)?;
+    let title = get_text::from_editor_no_comments("review_title", &template)?;
 
     if title.is_empty() {
         anyhow::bail!("Aborting due to empty review title");

crates/but/src/command/legacy/forge/review.rs

@@ -3,11 +3,13 @@ use anyhow::Result;
 use bstr::ByteSlice;
 use std::ffi::OsStr;
 
-/// Launches the user's preferred text editor to edit some initial text,
-/// identified by a unique identifier (to avoid temp file collisions).
-/// Returns the edited text, with comment lines (starting with '#') removed.
-pub fn from_editor_no_comments(identifier: &str, initial_text: &str) -> Result<String> {
-    let content = from_editor(identifier, initial_text)?;
+/// Launches the user's preferred text editor to edit some `initial_text`,
+/// identified by a `filename_safe_intent` to help the user understand what's wanted of them.
+/// Note that this string must be valid in filenames.
+///
+/// Returns the edited text, with comment lines (starting with `#`) removed.
+pub fn from_editor_no_comments(filename_safe_intent: &str, initial_text: &str) -> Result<String> {
+    let content = from_editor(filename_safe_intent, initial_text)?;
 
     // Strip comment lines (starting with '#')
     let filtered_lines: Vec<&str> = content
@@ -18,22 +20,25 @@ pub fn from_editor_no_comments(identifier: &str, initial_text: &str) -> Result<S
     Ok(filtered_lines.join("\n").trim().to_string())
 }
 
-/// Launches the user's preferred text editor to edit some initial text,
-/// identified by a unique identifier (to avoid temp file collisions).
-/// Returns the edited text.
+/// Launches the user's preferred text editor to edit some `initial_text`,
+/// identified by a `filename_safe_intent` to help the user understand what's wanted of them.
+/// Note that this string must be valid in filenames.
+///
+/// Returns the edited text verbatim.
 pub fn from_editor(identifier: &str, initial_text: &str) -> Result<String> {
     let editor_cmd = get_editor_command()?;
 
     // Create a temporary file with the initial text
-    let temp_dir = std::env::temp_dir();
-    let temp_file = temp_dir.join(format!("{}_{}", identifier, std::process::id()));
-
-    std::fs::write(&temp_file, initial_text)?;
+    let tempfile = tempfile::Builder::new()
+        .prefix(&format!("but_{identifier}_"))
+        .suffix(".txt")
+        .tempfile()?;
+    std::fs::write(&tempfile, initial_text)?;
 
     // The editor command is allowed to be a shell expression, e.g. "code --wait" is somewhat common.
     // We need to execute within a shell to make sure we don't get "No such file or directory" errors.
     let status = gix::command::prepare(editor_cmd)
-        .arg(&temp_file)
+        .arg(tempfile.path())
         .stdin(std::process::Stdio::inherit())
         .stdout(std::process::Stdio::inherit())
         .with_shell()
@@ -43,11 +48,7 @@ pub fn from_editor(identifier: &str, initial_text: &str) -> Result<String> {
     if !status.success() {
         return Err(anyhow::anyhow!("Editor exited with non-zero status"));
     }
-
-    // Read the edited text back
-    let edited_text = std::fs::read_to_string(&temp_file)?;
-    std::fs::remove_file(&temp_file).ok(); // Best effort to clean up
-    Ok(edited_text)
+    Ok(std::fs::read_to_string(&tempfile)?)
 }
 
 /// Get the user's preferred editor command.