use { super::*, heck::{ ToKebabCase, ToLowerCamelCase, ToShoutyKebabCase, ToShoutySnakeCase, ToSnakeCase, ToTitleCase, ToUpperCamelCase, }, rand::{seq::SliceRandom, thread_rng}, semver::{Version, VersionReq}, std::collections::HashSet, Function::*, }; pub(crate) enum Function { Nullary(fn(&Evaluator) -> Result), Unary(fn(&Evaluator, &str) -> Result), UnaryOpt(fn(&Evaluator, &str, Option<&str>) -> Result), UnaryPlus(fn(&Evaluator, &str, &[String]) -> Result), Binary(fn(&Evaluator, &str, &str) -> Result), BinaryPlus(fn(&Evaluator, &str, &str, &[String]) -> Result), Ternary(fn(&Evaluator, &str, &str, &str) -> Result), } pub(crate) fn get(name: &str) -> Option { let function = match name { "absolute_path" => Unary(absolute_path), "append" => Binary(append), "arch" => Nullary(arch), "blake3" => Unary(blake3), "blake3_file" => Unary(blake3_file), "cache_directory" => Nullary(|_| dir("cache", dirs::cache_dir)), "canonicalize" => Unary(canonicalize), "capitalize" => Unary(capitalize), "choose" => Binary(choose), "clean" => Unary(clean), "config_directory" => Nullary(|_| dir("config", dirs::config_dir)), "config_local_directory" => Nullary(|_| dir("local config", dirs::config_local_dir)), "data_directory" => Nullary(|_| dir("data", dirs::data_dir)), "data_local_directory" => Nullary(|_| dir("local data", dirs::data_local_dir)), "encode_uri_component" => Unary(encode_uri_component), "env" => UnaryOpt(env), "env_var" => Unary(env_var), "env_var_or_default" => Binary(env_var_or_default), "error" => Unary(error), "executable_directory" => Nullary(|_| dir("executable", dirs::executable_dir)), "extension" => Unary(extension), "file_name" => Unary(file_name), "file_stem" => Unary(file_stem), "home_directory" => Nullary(|_| dir("home", dirs::home_dir)), "invocation_directory" => Nullary(invocation_directory), "invocation_directory_native" => Nullary(invocation_directory_native), "join" => BinaryPlus(join), "just_executable" => Nullary(just_executable), "just_pid" => Nullary(just_pid), "justfile" => Nullary(justfile), "justfile_directory" => Nullary(justfile_directory), "kebabcase" => Unary(kebabcase), "lowercamelcase" => Unary(lowercamelcase), "lowercase" => Unary(lowercase), "num_cpus" => Nullary(num_cpus), "os" => Nullary(os), "os_family" => Nullary(os_family), "parent_directory" => Unary(parent_directory), "path_exists" => Unary(path_exists), "prepend" => Binary(prepend), "quote" => Unary(quote), "replace" => Ternary(replace), "replace_regex" => Ternary(replace_regex), "semver_matches" => Binary(semver_matches), "sha256" => Unary(sha256), "sha256_file" => Unary(sha256_file), "shell" => UnaryPlus(shell), "shoutykebabcase" => Unary(shoutykebabcase), "shoutysnakecase" => Unary(shoutysnakecase), "snakecase" => Unary(snakecase), "titlecase" => Unary(titlecase), "trim" => Unary(trim), "trim_end" => Unary(trim_end), "trim_end_match" => Binary(trim_end_match), "trim_end_matches" => Binary(trim_end_matches), "trim_start" => Unary(trim_start), "trim_start_match" => Binary(trim_start_match), "trim_start_matches" => Binary(trim_start_matches), "uppercamelcase" => Unary(uppercamelcase), "uppercase" => Unary(uppercase), "uuid" => Nullary(uuid), "without_extension" => Unary(without_extension), _ => return None, }; Some(function) } impl Function { pub(crate) fn argc(&self) -> Range { match *self { Nullary(_) => 0..0, Unary(_) => 1..1, UnaryOpt(_) => 1..2, UnaryPlus(_) => 1..usize::MAX, Binary(_) => 2..2, BinaryPlus(_) => 2..usize::MAX, Ternary(_) => 3..3, } } } fn absolute_path(evaluator: &Evaluator, path: &str) -> Result { let abs_path_unchecked = evaluator.search.working_directory.join(path).lexiclean(); match abs_path_unchecked.to_str() { Some(absolute_path) => Ok(absolute_path.to_owned()), None => Err(format!( "Working directory is not valid unicode: {}", evaluator.search.working_directory.display() )), } } fn append(_evaluator: &Evaluator, suffix: &str, s: &str) -> Result { Ok( s.split_whitespace() .map(|s| format!("{s}{suffix}")) .collect::>() .join(" "), ) } fn arch(_evaluator: &Evaluator) -> Result { Ok(target::arch().to_owned()) } fn blake3(_evaluator: &Evaluator, s: &str) -> Result { Ok(blake3::hash(s.as_bytes()).to_string()) } fn blake3_file(evaluator: &Evaluator, path: &str) -> Result { let path = evaluator.search.working_directory.join(path); let mut hasher = blake3::Hasher::new(); hasher .update_mmap_rayon(&path) .map_err(|err| format!("Failed to hash `{}`: {err}", path.display()))?; Ok(hasher.finalize().to_string()) } fn canonicalize(_evaluator: &Evaluator, path: &str) -> Result { let canonical = std::fs::canonicalize(path).map_err(|err| format!("I/O error canonicalizing path: {err}"))?; canonical.to_str().map(str::to_string).ok_or_else(|| { format!( "Canonical path is not valid unicode: {}", canonical.display(), ) }) } fn capitalize(_evaluator: &Evaluator, s: &str) -> Result { let mut capitalized = String::new(); for (i, c) in s.chars().enumerate() { if i == 0 { capitalized.extend(c.to_uppercase()); } else { capitalized.extend(c.to_lowercase()); } } Ok(capitalized) } fn choose(_evaluator: &Evaluator, n: &str, alphabet: &str) -> Result { if alphabet.is_empty() { return Err("empty alphabet".into()); } let mut chars = HashSet::::with_capacity(alphabet.len()); for c in alphabet.chars() { if !chars.insert(c) { return Err(format!("alphabet contains repeated character `{c}`")); } } let alphabet = alphabet.chars().collect::>(); let n = n .parse::() .map_err(|err| format!("failed to parse `{n}` as positive integer: {err}"))?; let mut rng = thread_rng(); Ok((0..n).map(|_| alphabet.choose(&mut rng).unwrap()).collect()) } fn clean(_evaluator: &Evaluator, path: &str) -> Result { Ok(Path::new(path).lexiclean().to_str().unwrap().to_owned()) } fn dir(name: &'static str, f: fn() -> Option) -> Result { match f() { Some(path) => path .as_os_str() .to_str() .map(str::to_string) .ok_or_else(|| { format!( "unable to convert {name} directory path to string: {}", path.display(), ) }), None => Err(format!("{name} directory not found")), } } fn encode_uri_component(_evaluator: &Evaluator, s: &str) -> Result { static PERCENT_ENCODE: percent_encoding::AsciiSet = percent_encoding::NON_ALPHANUMERIC .remove(b'-') .remove(b'_') .remove(b'.') .remove(b'!') .remove(b'~') .remove(b'*') .remove(b'\'') .remove(b'(') .remove(b')'); Ok(percent_encoding::utf8_percent_encode(s, &PERCENT_ENCODE).to_string()) } fn env_var(evaluator: &Evaluator, key: &str) -> Result { use std::env::VarError::*; if let Some(value) = evaluator.dotenv.get(key) { return Ok(value.clone()); } match env::var(key) { Err(NotPresent) => Err(format!("environment variable `{key}` not present")), Err(NotUnicode(os_string)) => Err(format!( "environment variable `{key}` not unicode: {os_string:?}" )), Ok(value) => Ok(value), } } fn env_var_or_default(evaluator: &Evaluator, key: &str, default: &str) -> Result { use std::env::VarError::*; if let Some(value) = evaluator.dotenv.get(key) { return Ok(value.clone()); } match env::var(key) { Err(NotPresent) => Ok(default.to_owned()), Err(NotUnicode(os_string)) => Err(format!( "environment variable `{key}` not unicode: {os_string:?}" )), Ok(value) => Ok(value), } } fn env(evaluator: &Evaluator, key: &str, default: Option<&str>) -> Result { match default { Some(val) => env_var_or_default(evaluator, key, val), None => env_var(evaluator, key), } } fn error(_evaluator: &Evaluator, message: &str) -> Result { Err(message.to_owned()) } fn extension(_evaluator: &Evaluator, path: &str) -> Result { Utf8Path::new(path) .extension() .map(str::to_owned) .ok_or_else(|| format!("Could not extract extension from `{path}`")) } fn file_name(_evaluator: &Evaluator, path: &str) -> Result { Utf8Path::new(path) .file_name() .map(str::to_owned) .ok_or_else(|| format!("Could not extract file name from `{path}`")) } fn file_stem(_evaluator: &Evaluator, path: &str) -> Result { Utf8Path::new(path) .file_stem() .map(str::to_owned) .ok_or_else(|| format!("Could not extract file stem from `{path}`")) } fn invocation_directory(evaluator: &Evaluator) -> Result { Platform::convert_native_path( &evaluator.search.working_directory, &evaluator.config.invocation_directory, ) .map_err(|e| format!("Error getting shell path: {e}")) } fn invocation_directory_native(evaluator: &Evaluator) -> Result { evaluator .config .invocation_directory .to_str() .map(str::to_owned) .ok_or_else(|| { format!( "Invocation directory is not valid unicode: {}", evaluator.config.invocation_directory.display() ) }) } fn prepend(_evaluator: &Evaluator, prefix: &str, s: &str) -> Result { Ok( s.split_whitespace() .map(|s| format!("{prefix}{s}")) .collect::>() .join(" "), ) } fn join(_evaluator: &Evaluator, base: &str, with: &str, and: &[String]) -> Result { let mut result = Utf8Path::new(base).join(with); for arg in and { result.push(arg); } Ok(result.to_string()) } fn just_executable(_evaluator: &Evaluator) -> Result { let exe_path = env::current_exe().map_err(|e| format!("Error getting current executable: {e}"))?; exe_path.to_str().map(str::to_owned).ok_or_else(|| { format!( "Executable path is not valid unicode: {}", exe_path.display() ) }) } fn just_pid(_evaluator: &Evaluator) -> Result { Ok(std::process::id().to_string()) } fn justfile(evaluator: &Evaluator) -> Result { evaluator .search .justfile .to_str() .map(str::to_owned) .ok_or_else(|| { format!( "Justfile path is not valid unicode: {}", evaluator.search.justfile.display() ) }) } fn justfile_directory(evaluator: &Evaluator) -> Result { let justfile_directory = evaluator.search.justfile.parent().ok_or_else(|| { format!( "Could not resolve justfile directory. Justfile `{}` had no parent.", evaluator.search.justfile.display() ) })?; justfile_directory .to_str() .map(str::to_owned) .ok_or_else(|| { format!( "Justfile directory is not valid unicode: {}", justfile_directory.display() ) }) } fn kebabcase(_evaluator: &Evaluator, s: &str) -> Result { Ok(s.to_kebab_case()) } fn lowercamelcase(_evaluator: &Evaluator, s: &str) -> Result { Ok(s.to_lower_camel_case()) } fn lowercase(_evaluator: &Evaluator, s: &str) -> Result { Ok(s.to_lowercase()) } fn num_cpus(_evaluator: &Evaluator) -> Result { let num = num_cpus::get(); Ok(num.to_string()) } fn os(_evaluator: &Evaluator) -> Result { Ok(target::os().to_owned()) } fn os_family(_evaluator: &Evaluator) -> Result { Ok(target::family().to_owned()) } fn parent_directory(_evaluator: &Evaluator, path: &str) -> Result { Utf8Path::new(path) .parent() .map(Utf8Path::to_string) .ok_or_else(|| format!("Could not extract parent directory from `{path}`")) } fn path_exists(evaluator: &Evaluator, path: &str) -> Result { Ok( evaluator .search .working_directory .join(path) .exists() .to_string(), ) } fn quote(_evaluator: &Evaluator, s: &str) -> Result { Ok(format!("'{}'", s.replace('\'', "'\\''"))) } fn replace(_evaluator: &Evaluator, s: &str, from: &str, to: &str) -> Result { Ok(s.replace(from, to)) } fn replace_regex( _evaluator: &Evaluator, s: &str, regex: &str, replacement: &str, ) -> Result { Ok( Regex::new(regex) .map_err(|err| err.to_string())? .replace_all(s, replacement) .to_string(), ) } fn sha256(_evaluator: &Evaluator, s: &str) -> Result { use sha2::{Digest, Sha256}; let mut hasher = Sha256::new(); hasher.update(s); let hash = hasher.finalize(); Ok(format!("{hash:x}")) } fn sha256_file(evaluator: &Evaluator, path: &str) -> Result { use sha2::{Digest, Sha256}; let path = evaluator.search.working_directory.join(path); let mut hasher = Sha256::new(); let mut file = fs::File::open(&path).map_err(|err| format!("Failed to open `{}`: {err}", path.display()))?; std::io::copy(&mut file, &mut hasher) .map_err(|err| format!("Failed to read `{}`: {err}", path.display()))?; let hash = hasher.finalize(); Ok(format!("{hash:x}")) } fn shell(evaluator: &Evaluator, command: &str, args: &[String]) -> Result { let args = iter::once(command) .chain(args.iter().map(String::as_str)) .collect::>(); evaluator .run_command(command, &args) .map_err(|output_error| output_error.to_string()) } fn shoutykebabcase(_evaluator: &Evaluator, s: &str) -> Result { Ok(s.to_shouty_kebab_case()) } fn shoutysnakecase(_evaluator: &Evaluator, s: &str) -> Result { Ok(s.to_shouty_snake_case()) } fn snakecase(_evaluator: &Evaluator, s: &str) -> Result { Ok(s.to_snake_case()) } fn titlecase(_evaluator: &Evaluator, s: &str) -> Result { Ok(s.to_title_case()) } fn trim(_evaluator: &Evaluator, s: &str) -> Result { Ok(s.trim().to_owned()) } fn trim_end(_evaluator: &Evaluator, s: &str) -> Result { Ok(s.trim_end().to_owned()) } fn trim_end_match(_evaluator: &Evaluator, s: &str, pat: &str) -> Result { Ok(s.strip_suffix(pat).unwrap_or(s).to_owned()) } fn trim_end_matches(_evaluator: &Evaluator, s: &str, pat: &str) -> Result { Ok(s.trim_end_matches(pat).to_owned()) } fn trim_start(_evaluator: &Evaluator, s: &str) -> Result { Ok(s.trim_start().to_owned()) } fn trim_start_match(_evaluator: &Evaluator, s: &str, pat: &str) -> Result { Ok(s.strip_prefix(pat).unwrap_or(s).to_owned()) } fn trim_start_matches(_evaluator: &Evaluator, s: &str, pat: &str) -> Result { Ok(s.trim_start_matches(pat).to_owned()) } fn uppercamelcase(_evaluator: &Evaluator, s: &str) -> Result { Ok(s.to_upper_camel_case()) } fn uppercase(_evaluator: &Evaluator, s: &str) -> Result { Ok(s.to_uppercase()) } fn uuid(_evaluator: &Evaluator) -> Result { Ok(uuid::Uuid::new_v4().to_string()) } fn without_extension(_evaluator: &Evaluator, path: &str) -> Result { let parent = Utf8Path::new(path) .parent() .ok_or_else(|| format!("Could not extract parent from `{path}`"))?; let file_stem = Utf8Path::new(path) .file_stem() .ok_or_else(|| format!("Could not extract file stem from `{path}`"))?; Ok(parent.join(file_stem).to_string()) } /// Check whether a string processes properly as semver (e.x. "0.1.0") /// and matches a given semver requirement (e.x. ">=0.1.0") fn semver_matches( _evaluator: &Evaluator, version: &str, requirement: &str, ) -> Result { Ok( requirement .parse::() .map_err(|err| format!("invalid semver requirement: {err}"))? .matches( &version .parse::() .map_err(|err| format!("invalid semver version: {err}"))?, ) .to_string(), ) } #[cfg(test)] mod tests { use super::*; #[test] fn dir_not_found() { assert_eq!(dir("foo", || None).unwrap_err(), "foo directory not found"); } #[cfg(unix)] #[test] fn dir_not_unicode() { use std::os::unix::ffi::OsStrExt; assert_eq!( dir("foo", || Some( std::ffi::OsStr::from_bytes(b"\xe0\x80\x80").into() )) .unwrap_err(), "unable to convert foo directory path to string: ���", ); } }