human_regex 0.3.0

//! Functions for directly matching text or adding known regex strings

use super::humanregex::{fmt, HumanRegex};
use regex::escape;

/// Add matching text to the regex string. Text that is added through this function is automatically escaped.
/// ```
/// let regex_string = human_regex::text("asdf");
/// assert!(regex_string.to_regex().is_match("asdf"));
/// assert!(!regex_string.to_regex().is_match("asddf"));
/// ```
pub fn text<T>(text: T) -> HumanRegex
where
    T: Into<String> + fmt::Display,
{
    HumanRegex(format!("(?:{})", escape(&*text.to_string())))
}

/// Escapes an entire list for use in something like an [or] or an [and] expression.
///
/// See the [cookbook] stop words example for an example of the utility of this function.
/// ```
/// use human_regex::direct::escape_all;
/// let escaped_vec = escape_all(&vec!["et-al", "short-term", "full-scale"]);
/// assert_eq!(escaped_vec, vec![r"et\-al", r"short\-term", r"full\-scale"]);
///```
pub fn escape_all<T>(options: &[T]) -> Vec<String>
where
    T: Into<String> + fmt::Display,
{
    options
        .iter()
        .map(|string| {
            string
                .to_string()
                .replace("-", r"\-")
                .replace("[", r"\[")
                .replace("]", r"\]")
                .replace("{", r"\{")
                .replace("}", r"\}")
        })
        .collect()
}

/// This text is not escaped. You can use it, for instance, to add a regex string directly to the object.
/// ```
/// let regex_string = human_regex::nonescaped_text(r"^\d{2}$");
/// println!("{}", regex_string.to_string());
/// assert!(regex_string.to_regex().is_match("21"));
/// assert!(!regex_string.to_regex().is_match("007"));
/// ```
pub fn nonescaped_text(text: &str) -> HumanRegex {
    HumanRegex(format!("(?:{})", text.to_string()))
}