Jakub Konka
2551721adb
Zed's `fs_embed!` macro normally reads assets from the checkout in debug builds. The new `util/debug-embed` feature is intended to compile those assets into debug binaries, but it previously changed only the `rust_embed::Filenames` variant while leaving file loading on the runtime path. That breaks downstream workspaces such as Delta: the runtime loader identifies Delta as the repository root, then looks for Zed grammar assets under Delta's checkout. Tests consequently panic when language configuration files cannot be found. This makes `util/debug-embed` select a compile-time `RustEmbed` expansion in every profile. Builds without the feature retain live filesystem loading in debug mode. The runtime iterator no longer depends on a feature-specific `rust_embed::Filenames` variant, so Cargo feature unification remains safe when another package enables `rust-embed/debug-embed` directly. The regression fixture uses a deliberately invalid runtime path when `debug-embed` is enabled, so it proves that the embedded path is used rather than passing only because the Zed checkout contains the test assets. Testing performed: - `cargo fmt --all -- --check` - `cargo nextest run -p util --lib` - `cargo nextest run -p util --lib --features debug-embed` - `cargo check -p remote_server --features debug-embed` - `./script/clippy -p util` - Delta's previously failing `tools::edit_file::tests::test_edit_file_rejects_scratch_paths_as_read_only` against this PR's head commit Release Notes: - N/A
1470 lines
48 KiB
Rust
1470 lines
48 KiB
Rust
#[cfg(test)]
|
||
extern crate self as util;
|
||
|
||
#[cfg(not(target_family = "wasm"))]
|
||
pub mod archive;
|
||
#[cfg(not(target_family = "wasm"))]
|
||
pub mod command;
|
||
#[cfg(not(target_family = "wasm"))]
|
||
pub mod fs;
|
||
#[cfg(not(target_family = "wasm"))]
|
||
pub mod process;
|
||
#[cfg(not(target_family = "wasm"))]
|
||
pub mod shell;
|
||
#[cfg(not(target_family = "wasm"))]
|
||
pub mod shell_builder;
|
||
#[cfg(not(target_family = "wasm"))]
|
||
pub mod shell_env;
|
||
|
||
pub mod disambiguate;
|
||
pub mod markdown;
|
||
pub mod path_list;
|
||
pub mod paths;
|
||
pub mod redact;
|
||
pub mod schemars;
|
||
pub mod serde;
|
||
pub mod size;
|
||
#[cfg(any(test, feature = "test-support"))]
|
||
pub mod test;
|
||
pub mod time;
|
||
|
||
use anyhow::Result;
|
||
use itertools::Either;
|
||
use regex::Regex;
|
||
use std::path::PathBuf;
|
||
use std::sync::LazyLock;
|
||
use std::{
|
||
borrow::Cow,
|
||
cmp::{self, Ordering},
|
||
ops::{Range, RangeInclusive},
|
||
};
|
||
use unicase::UniCase;
|
||
|
||
pub use gpui_util::*;
|
||
pub use path::PathExt;
|
||
pub use path::normalize_path;
|
||
pub use path::rel_path;
|
||
|
||
pub use take_until::*;
|
||
#[cfg(any(test, feature = "test-support"))]
|
||
pub use util_macros::{line_endings, path, uri};
|
||
|
||
#[cfg(not(target_family = "wasm"))]
|
||
pub use self::shell::{
|
||
get_default_system_shell, get_default_system_shell_preferring_bash, get_system_shell,
|
||
};
|
||
|
||
#[inline]
|
||
pub const fn is_utf8_char_boundary(u8: u8) -> bool {
|
||
// This is bit magic equivalent to: b < 128 || b >= 192
|
||
(u8 as i8) >= -0x40
|
||
}
|
||
|
||
pub fn truncate(s: &str, max_chars: usize) -> &str {
|
||
match s.char_indices().nth(max_chars) {
|
||
None => s,
|
||
Some((idx, _)) => &s[..idx],
|
||
}
|
||
}
|
||
|
||
/// Parses the contents of an `os-release` file (as found at `/etc/os-release`
|
||
/// and described by the systemd spec) into a human-readable string such as
|
||
/// `"ubuntu 24.04"`, combining the `ID` and `VERSION_ID` fields.
|
||
///
|
||
/// Returns `None` if no `ID` field is present. When `VERSION_ID` is absent
|
||
/// (e.g. on rolling releases), only the `ID` is returned.
|
||
pub fn parse_os_release(content: &str) -> Option<String> {
|
||
let mut id = None;
|
||
let mut version_id = None;
|
||
for line in content.lines() {
|
||
match line.split_once('=') {
|
||
Some(("ID", value)) => id = Some(value.trim_matches('"')),
|
||
Some(("VERSION_ID", value)) => version_id = Some(value.trim_matches('"')),
|
||
_ => {}
|
||
}
|
||
}
|
||
let id = id?;
|
||
Some(match version_id {
|
||
Some(version) => format!("{id} {version}"),
|
||
None => id.to_string(),
|
||
})
|
||
}
|
||
|
||
/// Removes characters from the end of the string if its length is greater than `max_chars` and
|
||
/// appends "..." to the string. Returns string unchanged if its length is smaller than max_chars.
|
||
pub fn truncate_and_trailoff(s: &str, max_chars: usize) -> String {
|
||
debug_assert!(max_chars >= 5);
|
||
|
||
// If the string's byte length is <= max_chars, walking the string can be skipped since the
|
||
// number of chars is <= the number of bytes.
|
||
if s.len() <= max_chars {
|
||
return s.to_string();
|
||
}
|
||
let truncation_ix = s.char_indices().map(|(i, _)| i).nth(max_chars);
|
||
match truncation_ix {
|
||
Some(index) => s[..index].to_string() + "…",
|
||
_ => s.to_string(),
|
||
}
|
||
}
|
||
|
||
/// Removes characters from the front of the string if its length is greater than `max_chars` and
|
||
/// prepends the string with "...". Returns string unchanged if its length is smaller than max_chars.
|
||
pub fn truncate_and_remove_front(s: &str, max_chars: usize) -> String {
|
||
debug_assert!(max_chars >= 5);
|
||
|
||
// If the string's byte length is <= max_chars, walking the string can be skipped since the
|
||
// number of chars is <= the number of bytes.
|
||
if s.len() <= max_chars {
|
||
return s.to_string();
|
||
}
|
||
let suffix_char_length = max_chars.saturating_sub(1);
|
||
let truncation_ix = s
|
||
.char_indices()
|
||
.map(|(i, _)| i)
|
||
.nth_back(suffix_char_length);
|
||
match truncation_ix {
|
||
Some(index) if index > 0 => "…".to_string() + &s[index..],
|
||
_ => s.to_string(),
|
||
}
|
||
}
|
||
|
||
/// Takes only `max_lines` from the string and, if there were more than `max_lines-1`, appends a
|
||
/// a newline and "..." to the string, so that `max_lines` are returned.
|
||
/// Returns string unchanged if its length is smaller than max_lines.
|
||
pub fn truncate_lines_and_trailoff(s: &str, max_lines: usize) -> String {
|
||
let mut lines = s.lines().take(max_lines).collect::<Vec<_>>();
|
||
if lines.len() > max_lines - 1 {
|
||
lines.pop();
|
||
lines.join("\n") + "\n…"
|
||
} else {
|
||
lines.join("\n")
|
||
}
|
||
}
|
||
|
||
/// Truncates the string at a character boundary, such that the result is less than `max_bytes` in
|
||
/// length.
|
||
pub fn truncate_to_byte_limit(s: &str, max_bytes: usize) -> &str {
|
||
if s.len() < max_bytes {
|
||
return s;
|
||
}
|
||
|
||
for i in (0..max_bytes).rev() {
|
||
if s.is_char_boundary(i) {
|
||
return &s[..i];
|
||
}
|
||
}
|
||
|
||
""
|
||
}
|
||
|
||
/// Takes a prefix of complete lines which fit within the byte limit. If the first line is longer
|
||
/// than the limit, truncates at a character boundary.
|
||
pub fn truncate_lines_to_byte_limit(s: &str, max_bytes: usize) -> &str {
|
||
if s.len() < max_bytes {
|
||
return s;
|
||
}
|
||
|
||
for i in (0..max_bytes).rev() {
|
||
if s.is_char_boundary(i) && s.as_bytes()[i] == b'\n' {
|
||
// Since the i-th character is \n, valid to slice at i + 1.
|
||
return &s[..i + 1];
|
||
}
|
||
}
|
||
|
||
truncate_to_byte_limit(s, max_bytes)
|
||
}
|
||
|
||
#[test]
|
||
fn test_truncate_lines_to_byte_limit() {
|
||
let text = "Line 1\nLine 2\nLine 3\nLine 4";
|
||
|
||
// Limit that includes all lines
|
||
assert_eq!(truncate_lines_to_byte_limit(text, 100), text);
|
||
|
||
// Exactly the first line
|
||
assert_eq!(truncate_lines_to_byte_limit(text, 7), "Line 1\n");
|
||
|
||
// Limit between lines
|
||
assert_eq!(truncate_lines_to_byte_limit(text, 13), "Line 1\n");
|
||
assert_eq!(truncate_lines_to_byte_limit(text, 20), "Line 1\nLine 2\n");
|
||
|
||
// Limit before first newline
|
||
assert_eq!(truncate_lines_to_byte_limit(text, 6), "Line ");
|
||
|
||
// Test with non-ASCII characters
|
||
let text_utf8 = "Line 1\nLíne 2\nLine 3";
|
||
assert_eq!(
|
||
truncate_lines_to_byte_limit(text_utf8, 15),
|
||
"Line 1\nLíne 2\n"
|
||
);
|
||
}
|
||
|
||
/// Extend a sorted vector with a sorted sequence of items, maintaining the vector's sort order and
|
||
/// enforcing a maximum length. This also de-duplicates items. Sort the items according to the given callback. Before calling this,
|
||
/// both `vec` and `new_items` should already be sorted according to the `cmp` comparator.
|
||
pub fn extend_sorted<T, I, F>(vec: &mut Vec<T>, new_items: I, limit: usize, mut cmp: F)
|
||
where
|
||
I: IntoIterator<Item = T>,
|
||
F: FnMut(&T, &T) -> Ordering,
|
||
{
|
||
let mut start_index = 0;
|
||
for new_item in new_items {
|
||
if let Err(i) = vec[start_index..].binary_search_by(|m| cmp(m, &new_item)) {
|
||
let index = start_index + i;
|
||
if vec.len() < limit {
|
||
vec.insert(index, new_item);
|
||
} else if index < vec.len() {
|
||
vec.pop();
|
||
vec.insert(index, new_item);
|
||
}
|
||
start_index = index;
|
||
}
|
||
}
|
||
}
|
||
|
||
/// Prevents execution of the application with root privileges on Unix systems.
|
||
///
|
||
/// This function checks if the current process is running with root privileges
|
||
/// and terminates the program with an error message unless explicitly allowed via the
|
||
/// `ZED_ALLOW_ROOT` environment variable.
|
||
#[cfg(unix)]
|
||
pub fn prevent_root_execution() {
|
||
let is_root = nix::unistd::geteuid().is_root();
|
||
let allow_root = std::env::var("ZED_ALLOW_ROOT").is_ok_and(|val| val == "true");
|
||
|
||
if is_root && !allow_root {
|
||
eprintln!(
|
||
"\
|
||
Error: Running Zed as root or via sudo is unsupported.
|
||
Doing so (even once) may subtly break things for all subsequent non-root usage of Zed.
|
||
It is untested and not recommended, don't complain when things break.
|
||
If you wish to proceed anyways, set `ZED_ALLOW_ROOT=true` in your environment."
|
||
);
|
||
std::process::exit(1);
|
||
}
|
||
}
|
||
|
||
#[cfg(unix)]
|
||
fn load_shell_from_passwd() -> Result<()> {
|
||
let buflen = match unsafe { libc::sysconf(libc::_SC_GETPW_R_SIZE_MAX) } {
|
||
n if n < 0 => 1024,
|
||
n => n as usize,
|
||
};
|
||
let mut buffer = Vec::with_capacity(buflen);
|
||
|
||
let mut pwd: std::mem::MaybeUninit<libc::passwd> = std::mem::MaybeUninit::uninit();
|
||
let mut result: *mut libc::passwd = std::ptr::null_mut();
|
||
|
||
let uid = unsafe { libc::getuid() };
|
||
let status = unsafe {
|
||
libc::getpwuid_r(
|
||
uid,
|
||
pwd.as_mut_ptr(),
|
||
buffer.as_mut_ptr() as *mut libc::c_char,
|
||
buflen,
|
||
&mut result,
|
||
)
|
||
};
|
||
anyhow::ensure!(!result.is_null(), "passwd entry for uid {} not found", uid);
|
||
|
||
// SAFETY: If `getpwuid_r` doesn't error, we have the entry here.
|
||
let entry = unsafe { pwd.assume_init() };
|
||
|
||
anyhow::ensure!(
|
||
status == 0,
|
||
"call to getpwuid_r failed. uid: {}, status: {}",
|
||
uid,
|
||
status
|
||
);
|
||
anyhow::ensure!(
|
||
entry.pw_uid == uid,
|
||
"passwd entry has different uid ({}) than getuid ({}) returned",
|
||
entry.pw_uid,
|
||
uid,
|
||
);
|
||
|
||
let shell = unsafe { std::ffi::CStr::from_ptr(entry.pw_shell).to_str().unwrap() };
|
||
let should_set_shell = std::env::var("SHELL").map_or(true, |shell_env| {
|
||
shell_env != shell && !std::path::Path::new(&shell_env).exists()
|
||
});
|
||
|
||
if should_set_shell {
|
||
log::info!(
|
||
"updating SHELL environment variable to value from passwd entry: {:?}",
|
||
shell,
|
||
);
|
||
unsafe { std::env::set_var("SHELL", shell) };
|
||
}
|
||
|
||
Ok(())
|
||
}
|
||
|
||
/// Returns a shell escaped path for the current zed executable
|
||
#[cfg(not(target_family = "wasm"))]
|
||
pub fn get_shell_safe_zed_path(shell_kind: shell::ShellKind) -> anyhow::Result<String> {
|
||
use anyhow::Context as _;
|
||
use paths::PathExt;
|
||
let mut zed_path =
|
||
std::env::current_exe().context("Failed to determine current zed executable path.")?;
|
||
if cfg!(target_os = "linux")
|
||
&& !zed_path.is_file()
|
||
&& let Some(truncated) = zed_path
|
||
.clone()
|
||
.file_name()
|
||
.and_then(|s| s.to_str())
|
||
.and_then(|n| n.strip_suffix(" (deleted)"))
|
||
{
|
||
// Might have been deleted during update; let's use the new binary if there is one.
|
||
zed_path.set_file_name(truncated);
|
||
}
|
||
|
||
zed_path
|
||
.try_shell_safe(shell_kind)
|
||
.context("Failed to shell-escape Zed executable path.")
|
||
}
|
||
|
||
/// Returns a path for the zed cli executable, this function
|
||
/// should be called from the zed executable, not zed-cli.
|
||
pub fn get_zed_cli_path() -> Result<PathBuf> {
|
||
use anyhow::Context as _;
|
||
let zed_path =
|
||
std::env::current_exe().context("Failed to determine current zed executable path.")?;
|
||
let parent = zed_path
|
||
.parent()
|
||
.context("Failed to determine parent directory of zed executable path.")?;
|
||
|
||
let possible_locations: &[&str] = if cfg!(target_os = "macos") {
|
||
// On macOS, the zed executable and zed-cli are inside the app bundle,
|
||
// so here ./cli is for both installed and development builds.
|
||
&["./cli"]
|
||
} else if cfg!(target_os = "windows") {
|
||
// bin/zed.exe is for installed builds, ./cli.exe is for development builds.
|
||
&["bin/zed.exe", "./cli.exe"]
|
||
} else if cfg!(target_os = "linux") || cfg!(target_os = "freebsd") {
|
||
// bin is the standard, ./cli is for the target directory in development builds.
|
||
&["../bin/zed", "./cli"]
|
||
} else {
|
||
anyhow::bail!("unsupported platform for determining zed-cli path");
|
||
};
|
||
|
||
possible_locations
|
||
.iter()
|
||
.find_map(|p| {
|
||
parent
|
||
.join(p)
|
||
.canonicalize()
|
||
.ok()
|
||
.filter(|p| p != &zed_path)
|
||
})
|
||
.with_context(|| {
|
||
format!(
|
||
"could not find zed-cli from any of: {}",
|
||
possible_locations.join(", ")
|
||
)
|
||
})
|
||
}
|
||
|
||
#[cfg(unix)]
|
||
pub async fn load_login_shell_environment() -> Result<()> {
|
||
use anyhow::Context as _;
|
||
|
||
load_shell_from_passwd().log_err();
|
||
|
||
// If possible, we want to `cd` in the user's `$HOME` to trigger programs
|
||
// such as direnv, asdf, mise, ... to adjust the PATH. These tools often hook
|
||
// into shell's `cd` command (and hooks) to manipulate env.
|
||
// We do this so that we get the env a user would have when spawning a shell
|
||
// in home directory.
|
||
for (name, value) in shell_env::capture(get_system_shell(), &[], paths::home_dir())
|
||
.await
|
||
.with_context(|| format!("capturing environment with {:?}", get_system_shell()))?
|
||
{
|
||
// Skip SHLVL to prevent it from polluting Zed's process environment.
|
||
// The login shell used for env capture increments SHLVL, and if we propagate it,
|
||
// terminals spawned by Zed will inherit it and increment again, causing SHLVL
|
||
// to start at 2 instead of 1 (and increase by 2 on each reload).
|
||
if name == "SHLVL" {
|
||
continue;
|
||
}
|
||
unsafe { std::env::set_var(&name, &value) };
|
||
}
|
||
|
||
log::info!(
|
||
"set environment variables from shell:{}, path:{}",
|
||
std::env::var("SHELL").unwrap_or_default(),
|
||
std::env::var("PATH").unwrap_or_default(),
|
||
);
|
||
|
||
Ok(())
|
||
}
|
||
|
||
/// Configures the process to start a new session, to prevent interactive shells from taking control
|
||
/// of the terminal.
|
||
///
|
||
/// For more details: <https://registerspill.thorstenball.com/p/how-to-lose-control-of-your-shell>
|
||
pub fn set_pre_exec_to_start_new_session(
|
||
command: &mut std::process::Command,
|
||
) -> &mut std::process::Command {
|
||
// safety: code in pre_exec should be signal safe.
|
||
// https://man7.org/linux/man-pages/man7/signal-safety.7.html
|
||
#[cfg(unix)]
|
||
unsafe {
|
||
use std::os::unix::process::CommandExt;
|
||
command.pre_exec(|| {
|
||
libc::setsid();
|
||
Ok(())
|
||
});
|
||
};
|
||
command
|
||
}
|
||
|
||
pub fn merge_json_lenient_value_into(
|
||
source: serde_json_lenient::Value,
|
||
target: &mut serde_json_lenient::Value,
|
||
) {
|
||
match (source, target) {
|
||
(serde_json_lenient::Value::Object(source), serde_json_lenient::Value::Object(target)) => {
|
||
for (key, value) in source {
|
||
if let Some(target) = target.get_mut(&key) {
|
||
merge_json_lenient_value_into(value, target);
|
||
} else {
|
||
target.insert(key, value);
|
||
}
|
||
}
|
||
}
|
||
|
||
(serde_json_lenient::Value::Array(source), serde_json_lenient::Value::Array(target)) => {
|
||
for value in source {
|
||
target.push(value);
|
||
}
|
||
}
|
||
|
||
(source, target) => *target = source,
|
||
}
|
||
}
|
||
|
||
/// Merges `source` into `target`: objects are merged recursively, key by key;
|
||
/// any other colliding value in `target` — including arrays — is replaced by
|
||
/// `source`'s value wholesale.
|
||
pub fn merge_json_value_into(source: serde_json::Value, target: &mut serde_json::Value) {
|
||
use serde_json::Value;
|
||
|
||
match (source, target) {
|
||
(Value::Object(source), Value::Object(target)) => {
|
||
for (key, value) in source {
|
||
if let Some(target) = target.get_mut(&key) {
|
||
merge_json_value_into(value, target);
|
||
} else {
|
||
target.insert(key, value);
|
||
}
|
||
}
|
||
}
|
||
(source, target) => *target = source,
|
||
}
|
||
}
|
||
|
||
pub fn union_json_value_into(source: serde_json::Value, target: &mut serde_json::Value) {
|
||
use serde_json::Value;
|
||
|
||
match (source, target) {
|
||
(Value::Object(source), Value::Object(target)) => {
|
||
for (key, value) in source {
|
||
if let Some(target) = target.get_mut(&key) {
|
||
union_json_value_into(value, target);
|
||
} else {
|
||
target.insert(key, value);
|
||
}
|
||
}
|
||
}
|
||
(Value::Array(source), Value::Array(target)) => {
|
||
for value in source {
|
||
if !target.contains(&value) {
|
||
target.push(value);
|
||
}
|
||
}
|
||
}
|
||
(source, target) => *target = source,
|
||
}
|
||
}
|
||
|
||
pub fn merge_non_null_json_value_into(source: serde_json::Value, target: &mut serde_json::Value) {
|
||
use serde_json::Value;
|
||
if let Value::Object(source_object) = source {
|
||
let target_object = if let Value::Object(target) = target {
|
||
target
|
||
} else {
|
||
*target = Value::Object(Default::default());
|
||
target.as_object_mut().unwrap()
|
||
};
|
||
for (key, value) in source_object {
|
||
if let Some(target) = target_object.get_mut(&key) {
|
||
merge_non_null_json_value_into(value, target);
|
||
} else if !value.is_null() {
|
||
target_object.insert(key, value);
|
||
}
|
||
}
|
||
} else if !source.is_null() {
|
||
*target = source
|
||
}
|
||
}
|
||
|
||
pub fn expanded_and_wrapped_usize_range(
|
||
range: Range<usize>,
|
||
additional_before: usize,
|
||
additional_after: usize,
|
||
wrap_length: usize,
|
||
) -> impl Iterator<Item = usize> {
|
||
let start_wraps = range.start < additional_before;
|
||
let end_wraps = wrap_length < range.end + additional_after;
|
||
if start_wraps && end_wraps {
|
||
Either::Left(0..wrap_length)
|
||
} else if start_wraps {
|
||
let wrapped_start = (range.start + wrap_length).saturating_sub(additional_before);
|
||
if wrapped_start <= range.end {
|
||
Either::Left(0..wrap_length)
|
||
} else {
|
||
Either::Right((0..range.end + additional_after).chain(wrapped_start..wrap_length))
|
||
}
|
||
} else if end_wraps {
|
||
let wrapped_end = range.end + additional_after - wrap_length;
|
||
if range.start <= wrapped_end {
|
||
Either::Left(0..wrap_length)
|
||
} else {
|
||
Either::Right((0..wrapped_end).chain(range.start - additional_before..wrap_length))
|
||
}
|
||
} else {
|
||
Either::Left((range.start - additional_before)..(range.end + additional_after))
|
||
}
|
||
}
|
||
|
||
/// Yields `[i, i + 1, i - 1, i + 2, ..]`, each modulo `wrap_length` and bounded by
|
||
/// `additional_before` and `additional_after`. If the wrapping causes overlap, duplicates are not
|
||
/// emitted. If wrap_length is 0, nothing is yielded.
|
||
pub fn wrapped_usize_outward_from(
|
||
start: usize,
|
||
additional_before: usize,
|
||
additional_after: usize,
|
||
wrap_length: usize,
|
||
) -> impl Iterator<Item = usize> {
|
||
let mut count = 0;
|
||
let mut after_offset = 1;
|
||
let mut before_offset = 1;
|
||
|
||
std::iter::from_fn(move || {
|
||
count += 1;
|
||
if count > wrap_length {
|
||
None
|
||
} else if count == 1 {
|
||
Some(start % wrap_length)
|
||
} else if after_offset <= additional_after && after_offset <= before_offset {
|
||
let value = (start + after_offset) % wrap_length;
|
||
after_offset += 1;
|
||
Some(value)
|
||
} else if before_offset <= additional_before {
|
||
let value = (start + wrap_length - before_offset) % wrap_length;
|
||
before_offset += 1;
|
||
Some(value)
|
||
} else if after_offset <= additional_after {
|
||
let value = (start + after_offset) % wrap_length;
|
||
after_offset += 1;
|
||
Some(value)
|
||
} else {
|
||
None
|
||
}
|
||
})
|
||
}
|
||
|
||
#[cfg(any(test, feature = "test-support"))]
|
||
mod rng {
|
||
use rand::prelude::*;
|
||
|
||
pub struct RandomCharIter<T: Rng> {
|
||
rng: T,
|
||
simple_text: bool,
|
||
}
|
||
|
||
impl<T: Rng> RandomCharIter<T> {
|
||
pub fn new(rng: T) -> Self {
|
||
Self {
|
||
rng,
|
||
simple_text: std::env::var("SIMPLE_TEXT").is_ok_and(|v| !v.is_empty()),
|
||
}
|
||
}
|
||
|
||
pub fn with_simple_text(mut self) -> Self {
|
||
self.simple_text = true;
|
||
self
|
||
}
|
||
}
|
||
|
||
impl<T: Rng> Iterator for RandomCharIter<T> {
|
||
type Item = char;
|
||
|
||
fn next(&mut self) -> Option<Self::Item> {
|
||
if self.simple_text {
|
||
return if self.rng.random_range(0..100) < 5 {
|
||
Some('\n')
|
||
} else {
|
||
Some(self.rng.random_range(b'a'..b'z' + 1).into())
|
||
};
|
||
}
|
||
|
||
match self.rng.random_range(0..100) {
|
||
// whitespace
|
||
0..=19 => [' ', '\n', '\r', '\t'].choose(&mut self.rng).copied(),
|
||
// two-byte greek letters
|
||
20..=32 => char::from_u32(self.rng.random_range(('α' as u32)..('ω' as u32 + 1))),
|
||
// // three-byte characters
|
||
33..=45 => ['✋', '✅', '❌', '❎', '⭐']
|
||
.choose(&mut self.rng)
|
||
.copied(),
|
||
// // four-byte characters
|
||
46..=58 => ['🍐', '🏀', '🍗', '🎉'].choose(&mut self.rng).copied(),
|
||
// ascii letters
|
||
_ => Some(self.rng.random_range(b'a'..b'z' + 1).into()),
|
||
}
|
||
}
|
||
}
|
||
}
|
||
#[cfg(any(test, feature = "test-support"))]
|
||
pub use rng::RandomCharIter;
|
||
|
||
/// Get an embedded file as a string.
|
||
pub fn asset_str<A: rust_embed::RustEmbed>(path: &str) -> Cow<'static, str> {
|
||
match A::get(path).expect(path).data {
|
||
Cow::Borrowed(bytes) => Cow::Borrowed(std::str::from_utf8(bytes).unwrap()),
|
||
Cow::Owned(bytes) => Cow::Owned(String::from_utf8(bytes).unwrap()),
|
||
}
|
||
}
|
||
|
||
/// The checkout that produced this binary, resolved at runtime by walking up to
|
||
/// the first ancestor that contains a `.git` entry (a directory in a normal
|
||
/// clone, a file in a git worktree or submodule). Cargo and corgi both place
|
||
/// built binaries under `<repo>/target/<profile>/`, so the repository root is
|
||
/// always an ancestor of the executable.
|
||
///
|
||
/// Dev-only affordances use this instead of baking a build-time path into the
|
||
/// artifact: such a path points at the wrong checkout from any other worktree
|
||
/// and, under corgi, is rejected because artifacts must be checkout-independent
|
||
/// to be shared across worktrees.
|
||
///
|
||
/// The executable's launch path is tried first, then its canonical form, then
|
||
/// the working directory. In CI, `target/` (or the checkout root) can be a
|
||
/// symlink onto another volume, so canonicalizing the executable alone can walk
|
||
/// off the checkout and miss `.git`; the launch path and the test runner's cwd
|
||
/// (a crate dir under the checkout) stay inside it.
|
||
pub fn dev_repo_root() -> Option<&'static std::path::Path> {
|
||
use std::path::PathBuf;
|
||
static ROOT: std::sync::OnceLock<Option<PathBuf>> = std::sync::OnceLock::new();
|
||
ROOT.get_or_init(|| {
|
||
let exe = std::env::current_exe().ok();
|
||
let candidates = [
|
||
exe.clone(),
|
||
exe.and_then(|exe| exe.canonicalize().ok()),
|
||
std::env::current_dir().ok(),
|
||
];
|
||
candidates.into_iter().flatten().find_map(|start| {
|
||
Some(
|
||
start
|
||
.ancestors()
|
||
.find(|dir| dir.join(".git").exists())?
|
||
.to_path_buf(),
|
||
)
|
||
})
|
||
})
|
||
.as_deref()
|
||
}
|
||
|
||
/// Re-exports that back [`fs_embed!`] so a caller only needs to depend on `util`,
|
||
/// not on `rust_embed` directly (the macro's dependency is an implementation
|
||
/// detail). Hidden from the public API.
|
||
#[doc(hidden)]
|
||
pub mod __rust_embed {
|
||
pub use rust_embed::{EmbeddedFile, Filenames, Metadata, RustEmbed, utils};
|
||
}
|
||
|
||
/// Backs the dev arm of [`fs_embed!`]'s `iter`: every file under the root-relative
|
||
/// directory that passes the same rust_embed include/exclude globs the
|
||
/// release derive uses, so the dev and release file sets are identical. Reuses
|
||
/// rust_embed's own matcher rather than reimplementing glob semantics.
|
||
#[cfg(all(debug_assertions, not(feature = "debug-embed")))]
|
||
#[doc(hidden)]
|
||
pub fn __fs_embed_iter(
|
||
root_relative: &str,
|
||
includes: &[&str],
|
||
excludes: &[&str],
|
||
) -> impl Iterator<Item = std::borrow::Cow<'static, str>> + 'static {
|
||
fs_embed_file_names(root_relative, includes, excludes)
|
||
.into_iter()
|
||
.map(std::borrow::Cow::Owned)
|
||
}
|
||
|
||
#[cfg(all(debug_assertions, not(feature = "debug-embed")))]
|
||
fn fs_embed_file_names(root_relative: &str, includes: &[&str], excludes: &[&str]) -> Vec<String> {
|
||
let Some(root) = dev_repo_root().map(|root| root.join(root_relative)) else {
|
||
return Vec::new();
|
||
};
|
||
let matcher = rust_embed::utils::PathMatcher::new(includes, excludes);
|
||
rust_embed::utils::get_files(root.to_string_lossy().into_owned(), matcher)
|
||
.map(|entry| entry.rel_path)
|
||
.collect()
|
||
}
|
||
|
||
/// Backs the dev arm of [`fs_embed!`]'s `get`: reads a single file from the
|
||
/// checkout, returning `None` when the include/exclude globs filter it out so
|
||
/// `get` matches release's embedded set exactly.
|
||
#[cfg(all(debug_assertions, not(feature = "debug-embed")))]
|
||
#[doc(hidden)]
|
||
pub fn __fs_embed_get(
|
||
root_relative: &str,
|
||
file_path: &str,
|
||
includes: &[&str],
|
||
excludes: &[&str],
|
||
) -> Option<rust_embed::EmbeddedFile> {
|
||
let matcher = rust_embed::utils::PathMatcher::new(includes, excludes);
|
||
if !matcher.is_path_included(file_path) {
|
||
return None;
|
||
}
|
||
let root = dev_repo_root()
|
||
.expect("dev asset loading requires running from within the checkout")
|
||
.join(root_relative);
|
||
rust_embed::utils::read_file_from_fs(&root.join(file_path)).ok()
|
||
}
|
||
|
||
#[cfg(feature = "debug-embed")]
|
||
#[doc(hidden)]
|
||
#[macro_export]
|
||
macro_rules! __fs_embed {
|
||
(
|
||
$vis:vis struct $name:ident,
|
||
crate_relative = $crate_relative:literal,
|
||
root_relative = $root_relative:literal
|
||
$(, include = [$($include:literal),* $(,)?])?
|
||
$(, exclude = [$($exclude:literal),* $(,)?])?
|
||
$(,)?
|
||
) => {
|
||
#[derive($crate::__rust_embed::RustEmbed)]
|
||
#[crate_path = "::util::__rust_embed"]
|
||
#[folder = $crate_relative]
|
||
$($(#[include = $include])*)?
|
||
$($(#[exclude = $exclude])*)?
|
||
$vis struct $name;
|
||
};
|
||
}
|
||
|
||
#[cfg(not(feature = "debug-embed"))]
|
||
#[doc(hidden)]
|
||
#[macro_export]
|
||
macro_rules! __fs_embed {
|
||
(
|
||
$vis:vis struct $name:ident,
|
||
crate_relative = $crate_relative:literal,
|
||
root_relative = $root_relative:literal
|
||
$(, include = [$($include:literal),* $(,)?])?
|
||
$(, exclude = [$($exclude:literal),* $(,)?])?
|
||
$(,)?
|
||
) => {
|
||
// `crate_path` points the derive's generated code at util's re-export so
|
||
// the caller needs no direct `rust_embed` dependency.
|
||
#[cfg(not(debug_assertions))]
|
||
#[derive($crate::__rust_embed::RustEmbed)]
|
||
#[crate_path = "::util::__rust_embed"]
|
||
#[folder = $crate_relative]
|
||
$($(#[include = $include])*)?
|
||
$($(#[exclude = $exclude])*)?
|
||
$vis struct $name;
|
||
|
||
#[cfg(debug_assertions)]
|
||
$vis struct $name;
|
||
|
||
// Mirror the derive's public surface: inherent `get`/`iter` (callable
|
||
// without the trait in scope) plus the trait impl (for generic bounds
|
||
// like `util::asset_str` and `handlebars::register_embed_templates`), so
|
||
// the two arms are interchangeable at call sites.
|
||
#[cfg(debug_assertions)]
|
||
impl $name {
|
||
pub fn get(
|
||
file_path: &str,
|
||
) -> ::core::option::Option<$crate::__rust_embed::EmbeddedFile> {
|
||
$crate::__fs_embed_get(
|
||
$root_relative,
|
||
file_path,
|
||
&[$($($include),*)?],
|
||
&[$($($exclude),*)?],
|
||
)
|
||
}
|
||
|
||
pub fn iter(
|
||
) -> impl ::core::iter::Iterator<Item = ::std::borrow::Cow<'static, str>> + 'static
|
||
{
|
||
$crate::__fs_embed_iter(
|
||
$root_relative,
|
||
&[$($($include),*)?],
|
||
&[$($($exclude),*)?],
|
||
)
|
||
}
|
||
}
|
||
|
||
#[cfg(debug_assertions)]
|
||
impl $crate::__rust_embed::RustEmbed for $name {
|
||
fn get(
|
||
file_path: &str,
|
||
) -> ::core::option::Option<$crate::__rust_embed::EmbeddedFile> {
|
||
<$name>::get(file_path)
|
||
}
|
||
|
||
fn iter(
|
||
) -> impl ::core::iter::Iterator<Item = ::std::borrow::Cow<'static, str>> + 'static
|
||
{
|
||
$crate::__fs_embed_iter(
|
||
$root_relative,
|
||
&[$($($include),*)?],
|
||
&[$($($exclude),*)?],
|
||
)
|
||
}
|
||
}
|
||
};
|
||
}
|
||
|
||
/// A `rust_embed` asset source that embeds files in release builds. Dev builds
|
||
/// read from the checkout at runtime unless the `debug-embed` feature is enabled,
|
||
/// in which case they embed the files too.
|
||
///
|
||
/// It expands to one of these arms:
|
||
/// * Release (`not(debug_assertions)`): `#[derive(RustEmbed)]` embedding
|
||
/// `crate_relative` at build time, with the given `include`/`exclude` globs.
|
||
/// * Dev with `debug-embed`: the same compile-time embedding as release.
|
||
/// * Dev without `debug-embed`: a runtime filesystem source rooted at
|
||
/// `root_relative`; edits appear on the next launch without a rebuild.
|
||
///
|
||
/// Two paths are required because the arms resolve from different bases: the
|
||
/// derive reads `crate_relative` relative to the crate's `Cargo.toml`, while the
|
||
/// runtime dev arm resolves `root_relative` relative to the repository root via
|
||
/// [`dev_repo_root`]. Baking the build-time path into that arm would point at the
|
||
/// wrong checkout from another worktree and is rejected by corgi, whose sandbox
|
||
/// requires checkout-independent output.
|
||
///
|
||
/// ```ignore
|
||
/// util::fs_embed! {
|
||
/// pub struct Assets,
|
||
/// crate_relative = "../../assets",
|
||
/// root_relative = "assets",
|
||
/// include = ["fonts/**/*", "themes/**/*", "*.md"],
|
||
/// exclude = ["themes/src/*", "*.DS_Store"],
|
||
/// }
|
||
/// ```
|
||
#[macro_export]
|
||
macro_rules! fs_embed {
|
||
($($tokens:tt)*) => {
|
||
$crate::__fs_embed!($($tokens)*);
|
||
};
|
||
}
|
||
|
||
pub trait RangeExt<T> {
|
||
fn sorted(&self) -> Self;
|
||
fn to_inclusive(&self) -> RangeInclusive<T>;
|
||
fn overlaps(&self, other: &Range<T>) -> bool;
|
||
fn contains_inclusive(&self, other: &Range<T>) -> bool;
|
||
}
|
||
|
||
impl<T: Ord + Clone> RangeExt<T> for Range<T> {
|
||
fn sorted(&self) -> Self {
|
||
cmp::min(&self.start, &self.end).clone()..cmp::max(&self.start, &self.end).clone()
|
||
}
|
||
|
||
fn to_inclusive(&self) -> RangeInclusive<T> {
|
||
self.start.clone()..=self.end.clone()
|
||
}
|
||
|
||
fn overlaps(&self, other: &Range<T>) -> bool {
|
||
self.start < other.end && other.start < self.end
|
||
}
|
||
|
||
fn contains_inclusive(&self, other: &Range<T>) -> bool {
|
||
self.start <= other.start && other.end <= self.end
|
||
}
|
||
}
|
||
|
||
impl<T: Ord + Clone> RangeExt<T> for RangeInclusive<T> {
|
||
fn sorted(&self) -> Self {
|
||
cmp::min(self.start(), self.end()).clone()..=cmp::max(self.start(), self.end()).clone()
|
||
}
|
||
|
||
fn to_inclusive(&self) -> RangeInclusive<T> {
|
||
self.clone()
|
||
}
|
||
|
||
fn overlaps(&self, other: &Range<T>) -> bool {
|
||
self.start() < &other.end && &other.start <= self.end()
|
||
}
|
||
|
||
fn contains_inclusive(&self, other: &Range<T>) -> bool {
|
||
self.start() <= &other.start && &other.end <= self.end()
|
||
}
|
||
}
|
||
|
||
/// A way to sort strings with starting numbers numerically first, falling back to alphanumeric one,
|
||
/// case-insensitive.
|
||
///
|
||
/// This is useful for turning regular alphanumerically sorted sequences as `1-abc, 10, 11-def, .., 2, 21-abc`
|
||
/// into `1-abc, 2, 10, 11-def, .., 21-abc`
|
||
#[derive(Debug, PartialEq, Eq)]
|
||
pub struct NumericPrefixWithSuffix<'a>(Option<u64>, &'a str);
|
||
|
||
impl<'a> NumericPrefixWithSuffix<'a> {
|
||
pub fn from_numeric_prefixed_str(str: &'a str) -> Self {
|
||
let i = str.chars().take_while(|c| c.is_ascii_digit()).count();
|
||
let (prefix, remainder) = str.split_at(i);
|
||
|
||
let prefix = prefix.parse().ok();
|
||
Self(prefix, remainder)
|
||
}
|
||
}
|
||
|
||
/// When dealing with equality, we need to consider the case of the strings to achieve strict equality
|
||
/// to handle cases like "a" < "A" instead of "a" == "A".
|
||
impl Ord for NumericPrefixWithSuffix<'_> {
|
||
fn cmp(&self, other: &Self) -> Ordering {
|
||
match (self.0, other.0) {
|
||
(None, None) => UniCase::new(self.1)
|
||
.cmp(&UniCase::new(other.1))
|
||
.then_with(|| self.1.cmp(other.1).reverse()),
|
||
(None, Some(_)) => Ordering::Greater,
|
||
(Some(_), None) => Ordering::Less,
|
||
(Some(a), Some(b)) => a.cmp(&b).then_with(|| {
|
||
UniCase::new(self.1)
|
||
.cmp(&UniCase::new(other.1))
|
||
.then_with(|| self.1.cmp(other.1).reverse())
|
||
}),
|
||
}
|
||
}
|
||
}
|
||
|
||
impl PartialOrd for NumericPrefixWithSuffix<'_> {
|
||
fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
|
||
Some(self.cmp(other))
|
||
}
|
||
}
|
||
|
||
fn emoji_regex() -> &'static Regex {
|
||
static EMOJI_REGEX: LazyLock<Regex> =
|
||
LazyLock::new(|| Regex::new("(\\p{Emoji}|\u{200D})").unwrap());
|
||
&EMOJI_REGEX
|
||
}
|
||
|
||
/// Returns true if the given string consists of emojis only.
|
||
/// E.g. "👨👩👧👧👋" will return true, but "👋!" will return false.
|
||
pub fn word_consists_of_emojis(s: &str) -> bool {
|
||
let mut prev_end = 0;
|
||
for capture in emoji_regex().find_iter(s) {
|
||
if capture.start() != prev_end {
|
||
return false;
|
||
}
|
||
prev_end = capture.end();
|
||
}
|
||
prev_end == s.len()
|
||
}
|
||
|
||
/// Similar to `str::split`, but also provides byte-offset ranges of the results. Unlike
|
||
/// `str::split`, this is not generic on pattern types and does not return an `Iterator`.
|
||
pub fn split_str_with_ranges<'s>(
|
||
s: &'s str,
|
||
pat: &dyn Fn(char) -> bool,
|
||
) -> Vec<(Range<usize>, &'s str)> {
|
||
let mut result = Vec::new();
|
||
let mut start = 0;
|
||
|
||
for (i, ch) in s.char_indices() {
|
||
if pat(ch) {
|
||
if i > start {
|
||
result.push((start..i, &s[start..i]));
|
||
}
|
||
start = i + ch.len_utf8();
|
||
}
|
||
}
|
||
|
||
if s.len() > start {
|
||
result.push((start..s.len(), &s[start..s.len()]));
|
||
}
|
||
|
||
result
|
||
}
|
||
|
||
pub fn default<D: Default>() -> D {
|
||
Default::default()
|
||
}
|
||
|
||
#[derive(Debug)]
|
||
pub enum ConnectionResult<O> {
|
||
Timeout,
|
||
ConnectionReset,
|
||
Result(anyhow::Result<O>),
|
||
}
|
||
|
||
impl<O> ConnectionResult<O> {
|
||
pub fn into_response(self) -> anyhow::Result<O> {
|
||
match self {
|
||
ConnectionResult::Timeout => anyhow::bail!("Request timed out"),
|
||
ConnectionResult::ConnectionReset => anyhow::bail!("Server reset the connection"),
|
||
ConnectionResult::Result(r) => r,
|
||
}
|
||
}
|
||
}
|
||
|
||
impl<O> From<anyhow::Result<O>> for ConnectionResult<O> {
|
||
fn from(result: anyhow::Result<O>) -> Self {
|
||
ConnectionResult::Result(result)
|
||
}
|
||
}
|
||
|
||
#[cfg(test)]
|
||
mod tests {
|
||
use super::*;
|
||
|
||
#[test]
|
||
fn test_fs_embed_iter_and_get() {
|
||
let inherent_names: Vec<_> = FsEmbedTestAssets::iter().collect();
|
||
assert!(
|
||
inherent_names.iter().any(|name| name == "util.rs"),
|
||
"iter should list files matching the include globs, got {inherent_names:?}"
|
||
);
|
||
assert!(
|
||
!inherent_names.iter().any(|name| name.ends_with(".toml")),
|
||
"iter should filter files excluded by the globs, got {inherent_names:?}"
|
||
);
|
||
|
||
let trait_names: Vec<_> =
|
||
<FsEmbedTestAssets as crate::__rust_embed::RustEmbed>::iter().collect();
|
||
assert_eq!(inherent_names, trait_names);
|
||
|
||
let file = FsEmbedTestAssets::get("util.rs").expect("util.rs should be readable");
|
||
assert!(
|
||
std::str::from_utf8(&file.data)
|
||
.expect("util.rs should be utf-8")
|
||
.contains("fs_embed"),
|
||
"get should read the real file contents"
|
||
);
|
||
assert!(
|
||
FsEmbedTestAssets::get("Cargo.toml").is_none(),
|
||
"get should filter files excluded by the globs"
|
||
);
|
||
}
|
||
|
||
#[cfg(not(feature = "debug-embed"))]
|
||
crate::fs_embed! {
|
||
struct FsEmbedTestAssets,
|
||
crate_relative = "src",
|
||
root_relative = "crates/util/src",
|
||
include = ["*.rs"],
|
||
exclude = ["test/**/*"],
|
||
}
|
||
|
||
// A consuming workspace does not contain a git dependency's files at this
|
||
// repository-relative path, so `debug-embed` must not consult it.
|
||
#[cfg(feature = "debug-embed")]
|
||
crate::fs_embed! {
|
||
struct FsEmbedTestAssets,
|
||
crate_relative = "src",
|
||
root_relative = "this-path-must-not-be-read",
|
||
include = ["*.rs"],
|
||
exclude = ["test/**/*"],
|
||
}
|
||
|
||
#[test]
|
||
fn test_parse_os_release() {
|
||
let os_release =
|
||
"NAME=\"Ubuntu\"\nID=ubuntu\nVERSION_ID=\"24.04\"\nPRETTY_NAME=\"Ubuntu 24.04 LTS\"\n";
|
||
assert_eq!(
|
||
parse_os_release(os_release),
|
||
Some("ubuntu 24.04".to_string())
|
||
);
|
||
|
||
// VERSION_ID may be absent (e.g. rolling releases like Arch).
|
||
assert_eq!(parse_os_release("ID=arch\n"), Some("arch".to_string()));
|
||
|
||
// Without an ID there is nothing usable to report.
|
||
assert_eq!(parse_os_release("VERSION_ID=1\n"), None);
|
||
assert_eq!(parse_os_release(""), None);
|
||
}
|
||
|
||
#[test]
|
||
fn test_extend_sorted() {
|
||
let mut vec = vec![];
|
||
|
||
extend_sorted(&mut vec, vec![21, 17, 13, 8, 1, 0], 5, |a, b| b.cmp(a));
|
||
assert_eq!(vec, &[21, 17, 13, 8, 1]);
|
||
|
||
extend_sorted(&mut vec, vec![101, 19, 17, 8, 2], 8, |a, b| b.cmp(a));
|
||
assert_eq!(vec, &[101, 21, 19, 17, 13, 8, 2, 1]);
|
||
|
||
extend_sorted(&mut vec, vec![1000, 19, 17, 9, 5], 8, |a, b| b.cmp(a));
|
||
assert_eq!(vec, &[1000, 101, 21, 19, 17, 13, 9, 8]);
|
||
}
|
||
|
||
#[test]
|
||
fn test_truncate_to_bottom_n_sorted_by() {
|
||
let mut vec: Vec<u32> = vec![5, 2, 3, 4, 1];
|
||
truncate_to_bottom_n_sorted_by(&mut vec, 10, &u32::cmp);
|
||
assert_eq!(vec, &[1, 2, 3, 4, 5]);
|
||
|
||
vec = vec![5, 2, 3, 4, 1];
|
||
truncate_to_bottom_n_sorted_by(&mut vec, 5, &u32::cmp);
|
||
assert_eq!(vec, &[1, 2, 3, 4, 5]);
|
||
|
||
vec = vec![5, 2, 3, 4, 1];
|
||
truncate_to_bottom_n_sorted_by(&mut vec, 4, &u32::cmp);
|
||
assert_eq!(vec, &[1, 2, 3, 4]);
|
||
|
||
vec = vec![5, 2, 3, 4, 1];
|
||
truncate_to_bottom_n_sorted_by(&mut vec, 1, &u32::cmp);
|
||
assert_eq!(vec, &[1]);
|
||
|
||
vec = vec![5, 2, 3, 4, 1];
|
||
truncate_to_bottom_n_sorted_by(&mut vec, 0, &u32::cmp);
|
||
assert!(vec.is_empty());
|
||
}
|
||
|
||
#[test]
|
||
fn test_iife() {
|
||
fn option_returning_function() -> Option<()> {
|
||
None
|
||
}
|
||
|
||
let foo = maybe!({
|
||
option_returning_function()?;
|
||
Some(())
|
||
});
|
||
|
||
assert_eq!(foo, None);
|
||
}
|
||
|
||
#[test]
|
||
fn test_truncate_and_trailoff() {
|
||
assert_eq!(truncate_and_trailoff("", 5), "");
|
||
assert_eq!(truncate_and_trailoff("aaaaaa", 7), "aaaaaa");
|
||
assert_eq!(truncate_and_trailoff("aaaaaa", 6), "aaaaaa");
|
||
assert_eq!(truncate_and_trailoff("aaaaaa", 5), "aaaaa…");
|
||
assert_eq!(truncate_and_trailoff("èèèèèè", 7), "èèèèèè");
|
||
assert_eq!(truncate_and_trailoff("èèèèèè", 6), "èèèèèè");
|
||
assert_eq!(truncate_and_trailoff("èèèèèè", 5), "èèèèè…");
|
||
}
|
||
|
||
#[test]
|
||
fn test_truncate_and_remove_front() {
|
||
assert_eq!(truncate_and_remove_front("", 5), "");
|
||
assert_eq!(truncate_and_remove_front("aaaaaa", 7), "aaaaaa");
|
||
assert_eq!(truncate_and_remove_front("aaaaaa", 6), "aaaaaa");
|
||
assert_eq!(truncate_and_remove_front("aaaaaa", 5), "…aaaaa");
|
||
assert_eq!(truncate_and_remove_front("èèèèèè", 7), "èèèèèè");
|
||
assert_eq!(truncate_and_remove_front("èèèèèè", 6), "èèèèèè");
|
||
assert_eq!(truncate_and_remove_front("èèèèèè", 5), "…èèèèè");
|
||
}
|
||
|
||
#[test]
|
||
fn test_numeric_prefix_str_method() {
|
||
let target = "1a";
|
||
assert_eq!(
|
||
NumericPrefixWithSuffix::from_numeric_prefixed_str(target),
|
||
NumericPrefixWithSuffix(Some(1), "a")
|
||
);
|
||
|
||
let target = "12ab";
|
||
assert_eq!(
|
||
NumericPrefixWithSuffix::from_numeric_prefixed_str(target),
|
||
NumericPrefixWithSuffix(Some(12), "ab")
|
||
);
|
||
|
||
let target = "12_ab";
|
||
assert_eq!(
|
||
NumericPrefixWithSuffix::from_numeric_prefixed_str(target),
|
||
NumericPrefixWithSuffix(Some(12), "_ab")
|
||
);
|
||
|
||
let target = "1_2ab";
|
||
assert_eq!(
|
||
NumericPrefixWithSuffix::from_numeric_prefixed_str(target),
|
||
NumericPrefixWithSuffix(Some(1), "_2ab")
|
||
);
|
||
|
||
let target = "1.2";
|
||
assert_eq!(
|
||
NumericPrefixWithSuffix::from_numeric_prefixed_str(target),
|
||
NumericPrefixWithSuffix(Some(1), ".2")
|
||
);
|
||
|
||
let target = "1.2_a";
|
||
assert_eq!(
|
||
NumericPrefixWithSuffix::from_numeric_prefixed_str(target),
|
||
NumericPrefixWithSuffix(Some(1), ".2_a")
|
||
);
|
||
|
||
let target = "12.2_a";
|
||
assert_eq!(
|
||
NumericPrefixWithSuffix::from_numeric_prefixed_str(target),
|
||
NumericPrefixWithSuffix(Some(12), ".2_a")
|
||
);
|
||
|
||
let target = "12a.2_a";
|
||
assert_eq!(
|
||
NumericPrefixWithSuffix::from_numeric_prefixed_str(target),
|
||
NumericPrefixWithSuffix(Some(12), "a.2_a")
|
||
);
|
||
}
|
||
|
||
#[test]
|
||
fn test_numeric_prefix_with_suffix() {
|
||
let mut sorted = vec!["1-abc", "10", "11def", "2", "21-abc"];
|
||
sorted.sort_by_key(|s| NumericPrefixWithSuffix::from_numeric_prefixed_str(s));
|
||
assert_eq!(sorted, ["1-abc", "2", "10", "11def", "21-abc"]);
|
||
|
||
for numeric_prefix_less in ["numeric_prefix_less", "aaa", "~™£"] {
|
||
assert_eq!(
|
||
NumericPrefixWithSuffix::from_numeric_prefixed_str(numeric_prefix_less),
|
||
NumericPrefixWithSuffix(None, numeric_prefix_less),
|
||
"String without numeric prefix `{numeric_prefix_less}` should not be converted into NumericPrefixWithSuffix"
|
||
)
|
||
}
|
||
}
|
||
|
||
#[test]
|
||
fn test_word_consists_of_emojis() {
|
||
let words_to_test = vec![
|
||
("👨👩👧👧👋🥒", true),
|
||
("👋", true),
|
||
("!👋", false),
|
||
("👋!", false),
|
||
("👋 ", false),
|
||
(" 👋", false),
|
||
("Test", false),
|
||
];
|
||
|
||
for (text, expected_result) in words_to_test {
|
||
assert_eq!(word_consists_of_emojis(text), expected_result);
|
||
}
|
||
}
|
||
|
||
#[test]
|
||
fn test_truncate_lines_and_trailoff() {
|
||
let text = r#"Line 1
|
||
Line 2
|
||
Line 3"#;
|
||
|
||
assert_eq!(
|
||
truncate_lines_and_trailoff(text, 2),
|
||
r#"Line 1
|
||
…"#
|
||
);
|
||
|
||
assert_eq!(
|
||
truncate_lines_and_trailoff(text, 3),
|
||
r#"Line 1
|
||
Line 2
|
||
…"#
|
||
);
|
||
|
||
assert_eq!(
|
||
truncate_lines_and_trailoff(text, 4),
|
||
r#"Line 1
|
||
Line 2
|
||
Line 3"#
|
||
);
|
||
}
|
||
|
||
#[test]
|
||
fn test_expanded_and_wrapped_usize_range() {
|
||
// Neither wrap
|
||
assert_eq!(
|
||
expanded_and_wrapped_usize_range(2..4, 1, 1, 8).collect::<Vec<usize>>(),
|
||
(1..5).collect::<Vec<usize>>()
|
||
);
|
||
// Start wraps
|
||
assert_eq!(
|
||
expanded_and_wrapped_usize_range(2..4, 3, 1, 8).collect::<Vec<usize>>(),
|
||
((0..5).chain(7..8)).collect::<Vec<usize>>()
|
||
);
|
||
// Start wraps all the way around
|
||
assert_eq!(
|
||
expanded_and_wrapped_usize_range(2..4, 5, 1, 8).collect::<Vec<usize>>(),
|
||
(0..8).collect::<Vec<usize>>()
|
||
);
|
||
// Start wraps all the way around and past 0
|
||
assert_eq!(
|
||
expanded_and_wrapped_usize_range(2..4, 10, 1, 8).collect::<Vec<usize>>(),
|
||
(0..8).collect::<Vec<usize>>()
|
||
);
|
||
// End wraps
|
||
assert_eq!(
|
||
expanded_and_wrapped_usize_range(3..5, 1, 4, 8).collect::<Vec<usize>>(),
|
||
(0..1).chain(2..8).collect::<Vec<usize>>()
|
||
);
|
||
// End wraps all the way around
|
||
assert_eq!(
|
||
expanded_and_wrapped_usize_range(3..5, 1, 5, 8).collect::<Vec<usize>>(),
|
||
(0..8).collect::<Vec<usize>>()
|
||
);
|
||
// End wraps all the way around and past the end
|
||
assert_eq!(
|
||
expanded_and_wrapped_usize_range(3..5, 1, 10, 8).collect::<Vec<usize>>(),
|
||
(0..8).collect::<Vec<usize>>()
|
||
);
|
||
// Both start and end wrap
|
||
assert_eq!(
|
||
expanded_and_wrapped_usize_range(3..5, 4, 4, 8).collect::<Vec<usize>>(),
|
||
(0..8).collect::<Vec<usize>>()
|
||
);
|
||
}
|
||
|
||
#[test]
|
||
fn test_wrapped_usize_outward_from() {
|
||
// No wrapping
|
||
assert_eq!(
|
||
wrapped_usize_outward_from(4, 2, 2, 10).collect::<Vec<usize>>(),
|
||
vec![4, 5, 3, 6, 2]
|
||
);
|
||
// Wrapping at end
|
||
assert_eq!(
|
||
wrapped_usize_outward_from(8, 2, 3, 10).collect::<Vec<usize>>(),
|
||
vec![8, 9, 7, 0, 6, 1]
|
||
);
|
||
// Wrapping at start
|
||
assert_eq!(
|
||
wrapped_usize_outward_from(1, 3, 2, 10).collect::<Vec<usize>>(),
|
||
vec![1, 2, 0, 3, 9, 8]
|
||
);
|
||
// All values wrap around
|
||
assert_eq!(
|
||
wrapped_usize_outward_from(5, 10, 10, 8).collect::<Vec<usize>>(),
|
||
vec![5, 6, 4, 7, 3, 0, 2, 1]
|
||
);
|
||
// None before / after
|
||
assert_eq!(
|
||
wrapped_usize_outward_from(3, 0, 0, 8).collect::<Vec<usize>>(),
|
||
vec![3]
|
||
);
|
||
// Starting point already wrapped
|
||
assert_eq!(
|
||
wrapped_usize_outward_from(15, 2, 2, 10).collect::<Vec<usize>>(),
|
||
vec![5, 6, 4, 7, 3]
|
||
);
|
||
// wrap_length of 0
|
||
assert_eq!(
|
||
wrapped_usize_outward_from(4, 2, 2, 0).collect::<Vec<usize>>(),
|
||
Vec::<usize>::new()
|
||
);
|
||
}
|
||
|
||
#[test]
|
||
fn test_split_with_ranges() {
|
||
let input = "hi";
|
||
let result = split_str_with_ranges(input, &|c| c == ' ');
|
||
|
||
assert_eq!(result.len(), 1);
|
||
assert_eq!(result[0], (0..2, "hi"));
|
||
|
||
let input = "héllo🦀world";
|
||
let result = split_str_with_ranges(input, &|c| c == '🦀');
|
||
|
||
assert_eq!(result.len(), 2);
|
||
assert_eq!(result[0], (0..6, "héllo")); // 'é' is 2 bytes
|
||
assert_eq!(result[1], (10..15, "world")); // '🦀' is 4 bytes
|
||
}
|
||
|
||
#[test]
|
||
fn test_merge_json_values() {
|
||
use serde_json::json;
|
||
|
||
let mut target = json!({
|
||
"unchanged": 1,
|
||
"replaced_scalar": "old",
|
||
"replaced_array": ["default-1", "default-2"],
|
||
"nulled": true,
|
||
"array_becomes_object": [1, 2],
|
||
"object_becomes_scalar": { "x": 1 },
|
||
"nested": {
|
||
"kept": true,
|
||
"overridden": 2,
|
||
"args": ["--default"],
|
||
"deeper": { "list": [1, 2], "other": "kept" },
|
||
},
|
||
});
|
||
let source = json!({
|
||
"replaced_scalar": "new",
|
||
"replaced_array": ["default-2", "user"],
|
||
"nulled": null,
|
||
"array_becomes_object": { "y": 2 },
|
||
"object_becomes_scalar": 3,
|
||
"inserted": ["brand-new"],
|
||
"nested": {
|
||
"overridden": 20,
|
||
"args": ["--user"],
|
||
"deeper": { "list": [3] },
|
||
"inserted": { "z": true },
|
||
},
|
||
});
|
||
|
||
merge_json_value_into(source, &mut target);
|
||
|
||
assert_eq!(
|
||
target,
|
||
json!({
|
||
"unchanged": 1,
|
||
"replaced_scalar": "new",
|
||
"replaced_array": ["default-2", "user"],
|
||
"nulled": null,
|
||
"array_becomes_object": { "y": 2 },
|
||
"object_becomes_scalar": 3,
|
||
"inserted": ["brand-new"],
|
||
"nested": {
|
||
"kept": true,
|
||
"overridden": 20,
|
||
"args": ["--user"],
|
||
"deeper": { "list": [3], "other": "kept" },
|
||
"inserted": { "z": true },
|
||
},
|
||
})
|
||
);
|
||
}
|
||
|
||
#[test]
|
||
fn test_union_json_values() {
|
||
use serde_json::json;
|
||
|
||
let mut target = json!({
|
||
"unchanged": 1,
|
||
"replaced_scalar": "old",
|
||
"unioned_array": ["shared", "first"],
|
||
"nested": {
|
||
"kept": true,
|
||
"plugins": [{ "name": "first-plugin" }],
|
||
"scalar": 2,
|
||
},
|
||
});
|
||
let source = json!({
|
||
"replaced_scalar": "new",
|
||
"unioned_array": ["shared", "second"],
|
||
"inserted": ["brand-new"],
|
||
"nested": {
|
||
"plugins": [{ "name": "second-plugin" }],
|
||
"scalar": 20,
|
||
},
|
||
});
|
||
|
||
union_json_value_into(source, &mut target);
|
||
|
||
assert_eq!(
|
||
target,
|
||
json!({
|
||
"unchanged": 1,
|
||
"replaced_scalar": "new",
|
||
"unioned_array": ["shared", "first", "second"],
|
||
"inserted": ["brand-new"],
|
||
"nested": {
|
||
"kept": true,
|
||
"plugins": [{ "name": "first-plugin" }, { "name": "second-plugin" }],
|
||
"scalar": 20,
|
||
},
|
||
})
|
||
);
|
||
}
|
||
}
|