cursus 0.2.0

Library crate for the cursus release management CLI
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

//! Shell quoting utilities.
//!
//! Delegates to the [`shell_escape`] crate, which handles both Unix (POSIX
//! single-quote wrapping) and Windows (`cmd.exe` double-quote wrapping).

use std::borrow::Cow;

/// Quotes a string for safe embedding in a platform shell command.
///
/// Delegates to [`shell_escape::escape`], which selects the appropriate
/// quoting strategy automatically: POSIX single-quote wrapping on Unix (and
/// on MSYS2/Git Bash via the `MSYSTEM` env var), and `cmd.exe`-compatible
/// double-quote wrapping on Windows.
///
/// The resulting value is safe to embed in the platform shell command string
/// (i.e. the argument passed to `run_shell`): the shell treats the entire
/// quoted span as a single token regardless of spaces, glob characters, or
/// other metacharacters. Strings that contain only shell-safe characters are
/// returned unmodified (no unnecessary quoting).
pub fn shell_quote(s: &str) -> String {
	shell_escape::escape(Cow::Borrowed(s)).into_owned()
}

#[cfg(test)]
mod tests {
	// --- Unix quoting ---

	#[test]
	fn unix_quote_safe_string_needs_no_quotes() {
		let result = shell_escape::unix::escape(std::borrow::Cow::Borrowed("hello"));
		assert_eq!(result, "hello");
	}

	#[test]
	fn unix_quote_handles_spaces() {
		let result = shell_escape::unix::escape(std::borrow::Cow::Borrowed("hello world"));
		assert_eq!(result, "'hello world'");
	}

	#[test]
	fn unix_quote_escapes_single_quote() {
		let result = shell_escape::unix::escape(std::borrow::Cow::Borrowed("it's"));
		assert_eq!(result, "'it'\\''s'");
	}

	#[test]
	fn unix_quote_handles_empty_string() {
		let result = shell_escape::unix::escape(std::borrow::Cow::Borrowed(""));
		assert_eq!(result, "''");
	}

	// --- Windows quoting ---

	#[test]
	fn windows_quote_handles_spaces() {
		let result = shell_escape::windows::escape(std::borrow::Cow::Borrowed("hello world"));
		assert!(result.starts_with('"'), "should be double-quoted: {result}");
		assert!(result.ends_with('"'), "should be double-quoted: {result}");
		assert!(
			result.contains("hello world"),
			"should preserve content: {result}"
		);
	}

	#[test]
	fn windows_quote_handles_empty_string() {
		let result = shell_escape::windows::escape(std::borrow::Cow::Borrowed(""));
		assert_eq!(result, "\"\"");
	}

	// --- Public dispatch ---

	#[cfg(unix)]
	#[test]
	fn shell_quote_safe_string_on_unix() {
		assert_eq!(super::shell_quote("hello"), "hello");
	}

	#[cfg(unix)]
	#[test]
	fn shell_quote_handles_spaces_on_unix() {
		assert_eq!(super::shell_quote("hello world"), "'hello world'");
	}

	#[cfg(unix)]
	#[test]
	fn shell_quote_escapes_single_quote_on_unix() {
		assert_eq!(super::shell_quote("it's"), "'it'\\''s'");
	}

	#[cfg(windows)]
	#[test]
	fn shell_quote_handles_spaces_on_windows() {
		let result = super::shell_quote("hello world");
		assert!(result.starts_with('"'));
		assert!(result.ends_with('"'));
	}
}