sheldon 0.8.5

//! Open the config file in the default text editor.

use std::env;
use std::fs;
use std::path::{Path, PathBuf};
use std::process::{self, Command};
use std::result;
use std::str;

use anyhow::{anyhow, bail, Context as ResultExt, Result};
use thiserror::Error;

use crate::config::EditConfig;
use crate::context::Context;
use crate::util::TempPath;

/// Possible environment variables.
const ENV_VARS: &[&str] = &["VISUAL", "EDITOR"];

/// Possible editors to use.
#[cfg(not(target_os = "windows"))]
const EDITORS: &[&str] = &["code --wait", "nano", "vim", "vi", "emacs"];

/// Possible editors to use.
#[cfg(target_os = "windows")]
const EDITORS: &[&str] = &["code.exe --wait", "notepad.exe"];

/// Represents the default editor.
pub struct Editor {
    /// The path to the editor binary.
    bin: PathBuf,
    /// Extra args for the editor that might be required.
    args: Vec<String>,
}

/// Representation of a running or exited editor process.
pub struct Child {
    /// A handle for the editor child process.
    child: process::Child,
    /// The temporary file that the editor is editing.
    temp: TempPath,
}

/// The choice the user must provide when deciding what to do with an existing
/// temporary file.
#[derive(Debug)]
enum Choice {
    Abort,
    Reopen,
    Overwrite,
}

#[derive(Debug, Error)]
#[error("`{}` is not a valid choice", self.0)]
pub struct ParseChoiceError(String);

impl str::FromStr for Choice {
    type Err = ParseChoiceError;

    fn from_str(s: &str) -> result::Result<Self, Self::Err> {
        match s {
            "a" | "A" => Ok(Self::Abort),
            "r" | "R" => Ok(Self::Reopen),
            "o" | "O" => Ok(Self::Overwrite),
            s => Err(ParseChoiceError(s.to_string())),
        }
    }
}

/// Convert a string command to a binary and the rest of the arguments.
fn to_bin_and_args<S>(cmd: S) -> Option<(PathBuf, Vec<String>)>
where
    S: AsRef<str>,
{
    let mut split = cmd.as_ref().split_whitespace();
    let bin: PathBuf = split.next()?.into();
    let args: Vec<String> = split.map(Into::into).collect();
    Some((bin, args))
}

impl Editor {
    /// Create a new default `Editor`.
    ///
    /// This function tries to read from `ENV_VARS` environment variables.
    /// Otherwise it will fallback to any of `EDITORS`.
    pub fn default() -> Result<Self> {
        let (bin, args) = ENV_VARS
            .iter()
            .filter_map(|e| env::var(e).ok())
            .filter_map(to_bin_and_args)
            .chain(EDITORS.iter().filter_map(to_bin_and_args))
            .find(|(bin, _)| which::which(bin).is_ok())
            .ok_or_else(|| anyhow!("failed to determine default editor"))?;
        Ok(Self { bin, args })
    }

    /// Open a file for editing with initial contents.
    pub fn edit(self, ctx: &Context, path: &Path, contents: &str) -> Result<Child> {
        let (overwrite, temp) = match TempPath::new(path) {
            Ok(temp) => (true, temp),
            Err(path) => {
                let temp_contents =
                    fs::read_to_string(&path).context("failed to read from temporary file")?;
                let temp = || TempPath::new_unchecked(path);
                if temp_contents == contents {
                    (false, temp())
                } else if ctx.interactive {
                    match casual::prompt(
                        "It looks like you already started editing the config file, what do you \
                         want to do?\n  [A] Abort, [R] Reopen, [O] Overwrite: ",
                    )
                    .get()
                    {
                        Choice::Abort => bail!("aborted!"),
                        Choice::Reopen => (false, temp()),
                        Choice::Overwrite => (true, temp()),
                    }
                } else {
                    (true, temp())
                }
            }
        };
        let Self { bin, args } = self;
        if overwrite {
            fs::write(temp.path(), contents).context("failed to write to temporary file")?;
        }
        let child = Command::new(bin)
            .args(args)
            .arg(temp.path())
            .spawn()
            .context("failed to spawn editor subprocess")?;
        Ok(Child { child, temp })
    }
}

impl Child {
    /// Wait for the child process to exit and then update the config file.
    pub fn wait_and_update(self, original_contents: &str) -> Result<EditConfig> {
        let Self { mut child, temp } = self;
        let exit_status = child.wait()?;
        if exit_status.success() {
            let contents =
                fs::read_to_string(temp.path()).context("failed to read from temporary file")?;
            if contents == original_contents {
                bail!("aborted, no changes!");
            } else {
                EditConfig::from_str(&contents)
                    .context("edited config is invalid, not updating config file")
            }
        } else {
            bail!("editor terminated with {exit_status}")
        }
    }
}