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 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
use crate::common;
use lazy_static::lazy_static;
use precis_core::profile::stabilize;
use precis_core::profile::{PrecisFastInvocation, Profile, Rules};
use precis_core::Error;
use precis_core::{FreeformClass, StringClass};
use std::borrow::Cow;
// This function is used to check whether the input label will require any
// modifications to apply the additional mapping rule for Nickname profile or not.
// It makes a quick check to see if we can avoid making a copy of the input label,
// for such purpose, it processes characters starting from the beginning of
// the label looking for spaces characters. It stops processing characters
// as soon as a non-ASCII character is found and returns its index. If it is a
// ASCII character, it processes the next character and if it is a space separator
// stops processing more characters returning the position of the next separator,
// otherwise it continues iterating over the label. If not modifications will be
// required, then the function will return None
fn find_disallowed_space(label: &str) -> Option<usize> {
let mut begin = true;
let mut prev_space = false;
let mut last_c: Option<char> = None;
let mut offset = 0;
for (index, c) in label.chars().enumerate() {
offset = index;
if !common::is_space_separator(c) {
last_c = Some(c);
prev_space = false;
begin = false;
continue;
}
if begin {
// Starts with space
return Some(index);
}
if prev_space {
// More than one separator
return Some(index);
}
if c == common::SPACE {
prev_space = true;
last_c = Some(c);
} else {
// non-ASCII space
return Some(index);
}
}
if let Some(common::SPACE) = last_c {
// last character is a space
Some(offset)
} else {
// The string might have ASCII separators, but it does not contain
// more than one spaces in a row and it does not ends with a space
None
}
}
// Additional Mapping Rule: The additional mapping rule consists of
// the following sub-rules.
// a. Map any instances of non-ASCII space to SPACE (`U+0020`); a
// non-ASCII space is any Unicode code point having a general
// category of "Zs", naturally with the exception of SPACE
// (`U+0020`). (The inclusion of only ASCII space prevents
// confusion with various non-ASCII space code points, many of
// which are difficult to reproduce across different input
// methods.)
//
// b. Remove any instances of the ASCII space character at the
// beginning or end of a nickname.
//
// c. Map interior sequences of more than one ASCII space character
// to a single ASCII space character.
fn trim_spaces<'a, T>(s: T) -> Result<Cow<'a, str>, Error>
where
T: Into<Cow<'a, str>>,
{
let s = s.into();
match find_disallowed_space(&s) {
None => Ok(s),
Some(pos) => {
let mut res = String::from(&s[..pos]);
res.reserve(s.len() - res.len());
let mut begin = true;
let mut prev_space = false;
for c in s[pos..].chars() {
if !common::is_space_separator(c) {
res.push(c);
prev_space = false;
begin = false;
continue;
}
if begin {
// skip spaces at the beginning
continue;
}
if !prev_space {
res.push(common::SPACE);
}
prev_space = true;
}
// Skip last space character
if let Some(c) = res.pop() {
if c != common::SPACE {
res.push(c);
}
}
Ok(res.into())
}
}
}
/// [`Nickname`](https://datatracker.ietf.org/doc/html/rfc8266#section-2).
/// Nicknames or display names in messaging and text conferencing technologies;
/// pet names for devices, accounts, and people; and other uses of nicknames,
/// display names, or pet names. Look at the
/// [`IANA` Considerations](https://datatracker.ietf.org/doc/html/rfc8266#section-5)
/// section for more details.
/// # Example
/// ```rust
/// # use precis_core::profile::Profile;
/// # use precis_profiles::Nickname;
/// # use std::borrow::Cow;
/// // create Nickname profile
/// let profile = Nickname::new();
///
/// // prepare string
/// assert_eq!(profile.prepare("Guybrush Threepwood"),
/// Ok(Cow::from("Guybrush Threepwood")));
///
/// // enforce string
/// assert_eq!(profile.enforce(" Guybrush Threepwood "),
/// Ok(Cow::from("Guybrush Threepwood")));
///
/// // compare strings
/// assert_eq!(profile.compare("Guybrush Threepwood ",
/// "guybrush threepwood"), Ok(true));
/// ```
#[derive(Debug, Default, Copy, Clone, PartialEq, Eq)]
pub struct Nickname(FreeformClass);
impl Nickname {
/// Creates a [`Nickname`] profile.
pub fn new() -> Self {
Self(FreeformClass::default())
}
fn apply_prepare_rules<'a, T>(&self, s: T) -> Result<Cow<'a, str>, Error>
where
T: Into<Cow<'a, str>>,
{
let s = s.into();
let s = (!s.is_empty()).then_some(s).ok_or(Error::Invalid)?;
self.0.allows(&s)?;
Ok(s)
}
fn apply_enforce_rules<'a, T>(&self, s: T) -> Result<Cow<'a, str>, Error>
where
T: Into<Cow<'a, str>>,
{
let s = self.apply_prepare_rules(s)?;
let s = self.additional_mapping_rule(s)?;
let s = self.normalization_rule(s)?;
(!s.is_empty()).then_some(s).ok_or(Error::Invalid)
}
fn apply_compare_rules<'a, T>(&self, s: T) -> Result<Cow<'a, str>, Error>
where
T: Into<Cow<'a, str>>,
{
let s = self.apply_prepare_rules(s)?;
let s = self.additional_mapping_rule(s)?;
let s = self.case_mapping_rule(s)?;
self.normalization_rule(s)
}
}
impl Profile for Nickname {
fn prepare<'a, S>(&self, s: S) -> Result<Cow<'a, str>, Error>
where
S: Into<Cow<'a, str>>,
{
self.apply_prepare_rules(s)
}
fn enforce<'a, S>(&self, s: S) -> Result<Cow<'a, str>, Error>
where
S: Into<Cow<'a, str>>,
{
stabilize(s, |s| self.apply_enforce_rules(s))
}
fn compare<A, B>(&self, s1: A, s2: B) -> Result<bool, Error>
where
A: AsRef<str>,
B: AsRef<str>,
{
Ok(stabilize(s1.as_ref(), |s| self.apply_compare_rules(s))?
== stabilize(s2.as_ref(), |s| self.apply_compare_rules(s))?)
}
}
impl Rules for Nickname {
fn additional_mapping_rule<'a, T>(&self, s: T) -> Result<Cow<'a, str>, Error>
where
T: Into<Cow<'a, str>>,
{
trim_spaces(s)
}
fn case_mapping_rule<'a, T>(&self, s: T) -> Result<Cow<'a, str>, Error>
where
T: Into<Cow<'a, str>>,
{
common::case_mapping_rule(s)
}
fn normalization_rule<'a, T>(&self, s: T) -> Result<Cow<'a, str>, Error>
where
T: Into<Cow<'a, str>>,
{
common::normalization_form_nfkc(s)
}
}
fn get_nickname_profile() -> &'static Nickname {
lazy_static! {
static ref NICKNAME: Nickname = Nickname::default();
}
&NICKNAME
}
impl PrecisFastInvocation for Nickname {
fn prepare<'a, S>(s: S) -> Result<Cow<'a, str>, Error>
where
S: Into<Cow<'a, str>>,
{
get_nickname_profile().prepare(s)
}
fn enforce<'a, S>(s: S) -> Result<Cow<'a, str>, Error>
where
S: Into<Cow<'a, str>>,
{
get_nickname_profile().enforce(s)
}
fn compare<A, B>(s1: A, s2: B) -> Result<bool, Error>
where
A: AsRef<str>,
B: AsRef<str>,
{
get_nickname_profile().compare(s1, s2)
}
}
#[cfg(test)]
mod test_nicknames {
use crate::nicknames::*;
#[test]
fn test_find_disallowed_space() {
assert_eq!(find_disallowed_space(""), None);
assert_eq!(find_disallowed_space("test"), None);
assert_eq!(find_disallowed_space("test "), Some(4));
assert_eq!(find_disallowed_space("test good"), None);
// Two ASCII spaces in a row
assert_eq!(find_disallowed_space(" test"), Some(0));
assert_eq!(find_disallowed_space("t est"), Some(2));
// Starts with ASCII space
assert_eq!(find_disallowed_space(" test"), Some(0));
// Non ASCII separator
assert_eq!(find_disallowed_space("\u{00a0}test"), Some(0));
assert_eq!(find_disallowed_space("te\u{00a0}st"), Some(2));
assert_eq!(find_disallowed_space("test\u{00a0}"), Some(4));
}
#[test]
fn test_trim_spaces() {
// Check ASCII spaces
assert_eq!(trim_spaces(" "), Ok(Cow::from("")));
assert_eq!(trim_spaces(" test"), Ok(Cow::from("test")));
assert_eq!(trim_spaces("test "), Ok(Cow::from("test")));
assert_eq!(trim_spaces("hello world"), Ok(Cow::from("hello world")));
assert_eq!(trim_spaces(""), Ok(Cow::from("")));
assert_eq!(trim_spaces(" test"), Ok(Cow::from("test")));
assert_eq!(trim_spaces("test "), Ok(Cow::from("test")));
assert_eq!(
trim_spaces(" hello world "),
Ok(Cow::from("hello world"))
);
// Check non-ASCII spaces
assert_eq!(trim_spaces("\u{205f}test\u{205f}"), Ok(Cow::from("test")));
assert_eq!(
trim_spaces("\u{205f}\u{205f}hello\u{205f}\u{205f}world\u{205f}\u{205f}"),
Ok(Cow::from("hello world"))
);
// Mix ASCII and non-ASCII spaces
assert_eq!(trim_spaces(" \u{205f}test\u{205f} "), Ok(Cow::from("test")));
assert_eq!(
trim_spaces("\u{205f} hello \u{205f} world \u{205f} "),
Ok(Cow::from("hello world"))
);
}
#[test]
fn nick_name_profile() {
let profile = Nickname::new();
let res = profile.prepare("Foo Bar");
assert_eq!(res, Ok(Cow::from("Foo Bar")));
let res = profile.enforce("Foo Bar");
assert_eq!(res, Ok(Cow::from("Foo Bar")));
let res = profile.compare("Foo Bar", "foo bar");
assert_eq!(res, Ok(true));
}
}