toodoux 0.4.1

A modern task management tool
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

//! Interactive editor session.
//!
//! This module provides a way to open an editor based on the `$EDITOR` environment variable or what is defined in the
//! configuration.

use std::{
  env, error, fmt, fs, io,
  path::{Path, PathBuf},
  process,
  string::FromUtf8Error,
};

use toodoux::config::Config;

/// Errors that can happen while interactively editing files.
#[derive(Debug)]
pub enum InteractiveEditingError {
  FileError(io::Error),
  MissingInteractiveEditor,
  InteractiveEditorError(PathBuf, io::Error),
  Utf8Error(FromUtf8Error),
}

impl fmt::Display for InteractiveEditingError {
  fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
    match *self {
      InteractiveEditingError::FileError(ref err) => write!(f, "unable to open file: {}", err),
      InteractiveEditingError::MissingInteractiveEditor => f.write_str(
        "no interactive editor was found; consider configuring either $EDITOR or the configuration",
      ),
      InteractiveEditingError::InteractiveEditorError(ref path, ref err) => {
        write!(
          f,
          "interactive editor error at path {}: {}",
          path.display(),
          err
        )
      }
      InteractiveEditingError::Utf8Error(ref err) => {
        write!(f, "error while decoding UTF-8: {}", err)
      }
    }
  }
}

impl error::Error for InteractiveEditingError {}

impl From<io::Error> for InteractiveEditingError {
  fn from(err: io::Error) -> Self {
    Self::FileError(err)
  }
}

impl From<FromUtf8Error> for InteractiveEditingError {
  fn from(err: FromUtf8Error) -> Self {
    Self::Utf8Error(err)
  }
}

/// Open an interactive editor for the file named `file_name` and once the file is saved and the editor
/// exits, returns what the file contains.
///
/// If `content` contains a non-empty [`String`], its content will be automatically inserted in the file before opening
/// the editor.
pub fn interactively_edit(
  config: &Config,
  file_name: &str,
  content: &str,
) -> Result<String, InteractiveEditingError> {
  log::debug!("creating temporary directory for interactive session");
  let dir = tempdir::TempDir::new("")?;
  let file_path = dir.path().join(Path::new(file_name));

  log::debug!("creating temporary file {}", file_path.display());
  fs::write(&file_path, content)?;

  let editor;
  if let Ok(env_editor) = env::var("EDITOR") {
    if env_editor.is_empty() {
      return Err(InteractiveEditingError::MissingInteractiveEditor);
    }

    log::debug!("editing via $EDITOR ({})", env_editor);
    editor = env_editor;
  } else if let Some(conf_editor) = config.interactive_editor() {
    if conf_editor.is_empty() {
      return Err(InteractiveEditingError::MissingInteractiveEditor);
    }

    log::debug!("editing via configuration editor ({})", conf_editor);
    editor = conf_editor.to_owned();
  } else {
    log::error!("cannot find a suitable interactive editor");
    return Err(InteractiveEditingError::MissingInteractiveEditor);
  }

  let _ = process::Command::new(editor)
    .arg(&file_path)
    .arg("+$")
    .spawn()
    .map_err(|e| InteractiveEditingError::InteractiveEditorError(file_path.clone(), e))?
    .wait()
    .map_err(|e| InteractiveEditingError::InteractiveEditorError(file_path.clone(), e))?;
  let content = fs::read_to_string(file_path)?;

  Ok(content)
}