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 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652
//!
//!
//! # Fact
//! The Fact object is a representation of a character based on its context within a data entity.
//! Facts are created during the analyze process and then later used to generate data from the algorithm.
//!
//! ## Example
//!
//! ```rust
//! extern crate test_data_generation;
//!
//! use test_data_generation::engine::Fact;
//!
//! fn main() {
//! //fact created for the character 'r' in the string "word"
//! let mut fact = Fact::new('r','c',0,0,2);
//!
//! // set the char that appears after the 'r'
//! fact.set_next_key('d');
//!
//! // set the char that appears before the 'r'
//! fact.set_prior_key('o');
//! }
//! ```
//!
//! # PatternDefinition
//! The PatternDefinition provides functionality to retrieve symbols that are used in defining a pattern.
//!
//! Here is the list of symbols that identify a type of character:</br>
//! @ = unknown [Unknonw]</br>
//! C = upper case consonant [ConsonantUpper]</br>
//! c = lower case consonant [ConsonantLower]</br>
//! V = upper case vowel [VowelUpper]</br>
//! v = lower case vowel [VowelLower]</br>
//! \# = numeric digit [Numeric]</br>
//! ~ = special regex character [RegExSpcChar]</br>
//! S = white space [WhiteSpace]</br>
//! p = punctuation [Punctuation]</br>
//!
//! ## Example
//!
//! ```rust
//! extern crate test_data_generation;
//!
//! use test_data_generation::engine::PatternDefinition;
//!
//! fn main() {
//! let pttrn_def = PatternDefinition::new();
//! println!("Upper case vowel symbol: {:?}", pttrn_def.get(&"VowelUpper".to_string()));
//! }
//! ```
use regex::Regex;
use serde_json;
use std::collections::BTreeMap;
use std::sync::mpsc;
use std::sync::mpsc::{Receiver, Sender};
use std::thread;
use crate::Profile;
//use async_trait::async_trait;
macro_rules! regex {
($re:literal $(,)?) => {{
static RE: once_cell::sync::OnceCell<regex::Regex> = once_cell::sync::OnceCell::new();
RE.get_or_init(|| regex::Regex::new($re).unwrap())
}};
}
#[allow(dead_code)]
type PatternMap = BTreeMap<String, char>;
#[derive(Clone, Serialize, Deserialize, Debug)]
/// Represents a Fact for a character in a sample data entity that has been analyzed
pub struct Fact {
/// the char that the fact defines (.e.g: 'a', '1', '%', etc.)
pub key: char,
/// the char that appears before (-1) the key in the entity
pub prior_key: Option<char>,
/// the char that appears after (+1) the key in the entity
pub next_key: Option<char>,
/// the PatternPlaceholder symbol that represents the type of key
pub pattern_placeholder: char,
/// indicates if the key is the first char in the entity (0=no, 1=yes)
pub starts_with: u32,
/// indicates if the key is the last char in the entity (0=no, 1=yes)
pub ends_with: u32,
/// indicates the number of positions from the index zero (where the char is located in the entity from the first position)
pub index_offset: u32,
}
impl Fact {
/// Constructs a new Fact
///
/// # Arguments
///
/// * `k: char` - The char that the Fact represents (also known as the `key`).</br>
/// * `pp: char` - The char that represents the patter placeholder for the key.</br>
/// * `sw: u32` - Indicates is the key is the first char in the entity. (0=no, 1=yes)</br>
/// * `ew: u32` - Indicates is the key is the last char in the entity. (0=no, 1=yes)</br>
/// * `idx_off: u32` - The index that represents the postion of the key from the beginning of the entity (zero based).</br>
///
/// # Example
///
/// ```rust
/// extern crate test_data_generation;
///
/// use test_data_generation::engine::Fact;
///
/// fn main() {
/// //fact created for the character 'r' in the string "word"
/// let mut fact = Fact::new('r','c',0,0,2);
/// }
/// ```
#[inline]
pub fn new(k: char, pp: char, sw: u32, ew: u32, idx_off: u32) -> Fact {
Fact {
key: k,
prior_key: None,
next_key: None,
pattern_placeholder: pp,
starts_with: sw,
ends_with: ew,
index_offset: idx_off,
}
}
/// Constructs a new Fact from a serialized (JSON) string of the Fact object. This is used when restoring from "archive"
///
/// # Arguments
///
/// * `serialized: &str` - The JSON string that represents the archived Fact object.</br>
///
/// # Example
///
/// ```rust
/// extern crate test_data_generation;
///
/// use test_data_generation::engine::Fact;
///
/// fn main() {
/// let serialized = "{\"key\":\"r\",\"prior_key\":null,\"next_key\":null,\"pattern_placeholder\":\"c\",\"starts_with\":0,\"ends_with\":0,\"index_offset\":2}";
/// let mut fact = Fact::from_serialized(&serialized);
/// fact.set_prior_key('a');
/// fact.set_next_key('e');
///
/// assert_eq!(fact.pattern_placeholder, 'c');
/// }
/// ```
#[inline]
pub fn from_serialized(serialized: &str) -> Fact {
serde_json::from_str(&serialized).unwrap()
}
/// This function converts the Fact to a serialize JSON string.
///
/// # Example
///
/// ```rust
/// extern crate test_data_generation;
///
/// use test_data_generation::engine::Fact;
///
/// fn main() {
/// //fact created for the character 'r' in the string "word"
/// let mut fact = Fact::new('r','c',0,0,2);
///
/// println!("{}", fact.serialize());
/// // {"key":"r","prior_key":null,"next_key":null,"pattern_placeholder":"c","starts_with":0,"ends_with":0,"index_offset":2}
/// }
///
#[inline]
pub fn serialize(&mut self) -> String {
serde_json::to_string(&self).unwrap()
}
/// This function sets the next key attribute to the specified char.
///
/// # Arguments
///
/// * `nk: char` - The character that represents the next character in the entity
///
/// # Example
///
/// ```rust
/// extern crate test_data_generation;
///
/// use test_data_generation::engine::Fact;
///
/// fn main() {
/// //fact created for the character 'r' in the string "word"
/// let mut fact = Fact::new('r','c',0,0,2);
/// fact.set_next_key('d');
/// }
///
#[inline]
pub fn set_next_key(&mut self, nk: char) {
self.next_key = Some(nk);
}
/// This function sets the prior key attribute to the specified char.
///
/// # Arguments
///
/// * `pk: char` - The character that represents the prior character in the entity
///
/// # Example
///
/// ```rust
/// extern crate test_data_generation;
///
/// use test_data_generation::engine::Fact;
///
/// fn main() {
/// //fact created for the character 'r' in the string "word"
/// let mut fact = Fact::new('r','c',0,0,2);
/// fact.set_prior_key('o');
/// }
///
#[inline]
pub fn set_prior_key(&mut self, pk: char) {
self.prior_key = Some(pk);
}
}
/// Represents a symbolic pattern of an entity (String)
pub struct Pattern {
/// The regex rule used to find upper case consonants
regex_consonant_upper: &'static Regex,
/// The regex rule used to find lower case consonants
regex_consonant_lower: &'static Regex,
/// The regex rule used to find upper case vowels
regex_vowel_upper: &'static Regex,
/// The regex rule used to find lower case vowels
regex_vowel_lower: &'static Regex,
/// The regex rule used to find numeric digits
regex_numeric: &'static Regex,
/// The regex rule used to find punctuation
regex_punctuation: &'static Regex,
/// The regex rule used to find white spaces
regex_space: &'static Regex,
}
impl Default for Pattern {
fn default() -> Self {
Pattern {
regex_consonant_upper: regex!(r"(?-u)[B-DF-HJ-NP-TV-Z]"),
regex_consonant_lower: regex!(r"(?-u)[b-df-hj-np-tv-z]"),
regex_vowel_upper: regex!(r"(?-u)[A|E|I|O|U]"),
regex_vowel_lower: regex!(r"(?-u)[a|e|i|o|u]"),
regex_numeric: regex!(r"(?-u)[0-9]"),
regex_punctuation: regex!(r"(?-u)[.,\\/#!$%\\^&\\*;:{}=\\-_`~()\\?]"),
regex_space: regex!(r"(?-u)[\s]"),
}
}
}
/// Represents the object managing all the symbols used in pattern definitions
pub struct PatternDefinition {
pattern_map: PatternMap,
pattern: Pattern,
}
impl PatternDefinition {
/// Constructs a new PatternDefinition
///
/// # Example
///
/// ```rust
/// extern crate test_data_generation;
///
/// use test_data_generation::engine::PatternDefinition;
///
/// fn main() {
/// let pttrn_def = PatternDefinition::new();
/// }
/// ```
pub fn new() -> PatternDefinition {
let symbols: [char; 9] = ['@', 'C', 'c', 'V', 'v', '#', '~', 'S', 'p'];
let mut pttrn_def = PatternMap::new();
pttrn_def.insert("Unknown".to_string(), symbols[0]);
pttrn_def.insert("ConsonantUpper".to_string(), symbols[1]);
pttrn_def.insert("ConsonantLower".to_string(), symbols[2]);
pttrn_def.insert("VowelUpper".to_string(), symbols[3]);
pttrn_def.insert("VowelLower".to_string(), symbols[4]);
pttrn_def.insert("Numeric".to_string(), symbols[5]);
pttrn_def.insert("RegExSpcChar".to_string(), symbols[6]);
pttrn_def.insert("WhiteSpace".to_string(), symbols[7]);
pttrn_def.insert("Punctuation".to_string(), symbols[8]);
PatternDefinition {
pattern_map: pttrn_def,
pattern: Pattern::default(),
}
}
/// This function converts an entity (&str) into a tuplet (String, Vec<Fact>)</br>
///
/// # Arguments
///
/// * `entity: String` - The textual str of the value to analyze.</br>
///
/// # Example
///
/// ```rust
/// extern crate test_data_generation;
///
/// use test_data_generation::engine::PatternDefinition;
///
/// fn main() {
/// let mut pttrn_def = PatternDefinition::new();
/// //async {
/// let rslt = pttrn_def.analyze("Hello World");
/// assert_eq!(rslt.0, "CvccvSCvccc");
/// //}
/// }
/// ```
#[inline]
pub fn analyze(&mut self, entity: &str) -> (String, Vec<Fact>) {
// record the length of the passed value
//self.size = entity.len() as u32;
// String to hold the pattern
let mut pttrn = String::new();
// Vec to hold all the Facts to be returned
let mut facts = Vec::new();
// record the pattern of the passed value
for (i, _c) in entity.chars().enumerate() {
//let fact = self.factualize(&entity, i as u32);
let idx: u32 = i as u32;
let fact = self.factualize(entity, idx);
pttrn.push_str(&*fact.pattern_placeholder.to_string());
facts.push(fact);
}
(pttrn, facts)
}
/// This function converts a char in an entity (&str) based on the index specified into a Fact</br>
///
/// # Arguments
///
/// * `entity: String` - The textual str of the value to analyze.</br>
/// * `idx: u32` - The index that specifies the position of the char in the entity to convert to a Fact.</br>
///
/// # Example
///
/// ```rust
/// extern crate test_data_generation;
///
/// use test_data_generation::engine::PatternDefinition;
///
/// fn main() {
/// let mut pttrn_def = PatternDefinition::new();
/// let fact = pttrn_def.factualize("Word",0);
/// // will return a Fact that represents the char `W`
/// }
/// ```
#[inline]
pub fn factualize(&mut self, entity: &str, idx: u32) -> Fact {
let c = entity.chars().nth(idx as usize).unwrap();
let pp = self.symbolize_char(c);
let pk = if idx > 0 {
entity.chars().nth(idx as usize - 1)
} else {
None
};
let nk = if idx < entity.len() as u32 - 1 {
entity.chars().nth(idx as usize + 1)
} else {
None
};
let sw = if idx == 0 { 1 } else { 0 };
let ew = if idx == entity.len() as u32 - 1 { 1 } else { 0 };
let mut fact = Fact::new(c, pp, sw, ew, idx);
// only if there is a next key
if nk.is_some() {
let _ = &fact.set_next_key(nk.unwrap());
}
// only if there is a prior key
if pk.is_some() {
let _ = &fact.set_prior_key(pk.unwrap());
}
fact
}
/// This function returns a pattern symbol that represents the type of character
///
/// # Example
///
/// ```rust
/// extern crate test_data_generation;
///
/// use test_data_generation::engine::PatternDefinition;
///
/// fn main() {
/// let pttrn_def = PatternDefinition::new();
/// println!("Upper case vowel symbol: {:?}", pttrn_def.get(&"VowelUpper".to_string()));
/// }
/// ```
#[inline]
pub fn get(&self, key: &str) -> char {
*self.pattern_map.get(key).unwrap()
}
/// This function converts a char into a pattern symbol
///
/// # Example
///
/// ```rust
/// extern crate test_data_generation;
///
/// use test_data_generation::engine::PatternDefinition;
///
/// fn main() {
/// let pttrn_def = PatternDefinition::new();
/// println!("The pattern symbol for 'A' is {:?}", pttrn_def.symbolize_char('A'));
/// // The pattern symbol for 'A' is V
/// }
/// ```
#[inline]
pub fn symbolize_char(&self, c: char) -> char {
// if you have to escape regex special characters: &*regex::escape(&*$c.to_string())
let mut symbol = self.pattern_map.get("Unknown");
let mut found = false;
if !found && self.pattern.regex_consonant_upper.is_match(&c.to_string()) {
symbol = self.pattern_map.get("ConsonantUpper");
found = true;
}
if !found && self.pattern.regex_consonant_lower.is_match(&c.to_string()) {
symbol = self.pattern_map.get("ConsonantLower");
found = true;
}
if !found && self.pattern.regex_vowel_upper.is_match(&c.to_string()) {
symbol = self.pattern_map.get("VowelUpper");
found = true;
}
if !found && self.pattern.regex_vowel_lower.is_match(&c.to_string()) {
symbol = self.pattern_map.get("VowelLower");
found = true;
}
if !found && self.pattern.regex_numeric.is_match(&c.to_string()) {
symbol = self.pattern_map.get("Numeric");
found = true;
}
if !found && self.pattern.regex_space.is_match(&c.to_string()) {
symbol = self.pattern_map.get("WhiteSpace");
found = true;
}
if !found && self.pattern.regex_punctuation.is_match(&c.to_string()) {
symbol = self.pattern_map.get("Punctuation");
found = true;
}
// if not matched, then use "Unknown" placeholder symbol
if !found {
symbol = self.pattern_map.get("Unknown");
}
*symbol.unwrap()
}
}
pub trait Engine {
fn analyze_entities(entities: Vec<String>) -> Vec<(String, Vec<Fact>)> {
let (tx, rx): (Sender<(String, Vec<Fact>)>, Receiver<(String, Vec<Fact>)>) =
mpsc::channel();
let mut children = Vec::new();
for entity in entities.clone() {
let thread_tx = tx.clone();
let child = thread::spawn(move || {
thread_tx
.send(PatternDefinition::new().analyze(&entity))
.unwrap();
debug!("PatternDefinition::analyze thread finished for {}", entity);
});
children.push(child);
}
let mut results = Vec::new();
for entity in entities {
results.push(match rx.recv() {
Ok(result) => result,
Err(_) => {
error!("Error: Could not analyze the entity: {}", entity);
panic!("Error: Could not analyze the data!")
}
});
}
for child in children {
child.join().expect("Error: Could not analyze the data!");
}
results
}
fn profile_entities(mut profile: Profile, entities: Vec<String>) -> Result<Profile, String> {
let results = Self::analyze_entities(entities);
for result in results {
match profile.apply_facts(result.0, result.1) {
Ok(_) => {}
Err(e) => {
return Err(format!(
"Error: Couldn't apply the Pattern and Facts to the Profile. Error Message: {}",
e.to_string()
))
}
}
}
Ok(profile)
}
fn profile_entities_with_container(container: EngineContainer) -> Result<Profile, String> {
Self::profile_entities(container.profile, container.entities)
}
}
pub struct EngineContainer {
pub profile: Profile,
pub entities: Vec<String>,
}
// Unit Tests
#[cfg(test)]
mod tests {
use super::*;
struct Xtest {}
impl Engine for Xtest {}
#[test]
fn test_fact_new() {
//fact created for the character 'r' in the string "word"
let _fact = Fact::new('r', 'c', 0, 0, 2);
assert!(true);
}
#[test]
fn test_fact_new_from_serialized() {
let serialized = "{\"key\":\"r\",\"prior_key\":null,\"next_key\":null,\"pattern_placeholder\":\"c\",\"starts_with\":0,\"ends_with\":0,\"index_offset\":2}";
let fact = Fact::from_serialized(&serialized);
assert_eq!(fact.pattern_placeholder, 'c');
}
#[test]
fn test_fact_serialize() {
//fact created for the character 'r' in the string "word"
let mut fact = Fact::new('r', 'c', 0, 0, 2);
let serialized = fact.serialize();
assert_eq!(serialized,"{\"key\":\"r\",\"prior_key\":null,\"next_key\":null,\"pattern_placeholder\":\"c\",\"starts_with\":0,\"ends_with\":0,\"index_offset\":2}");
}
#[test]
fn test_fact_set_next_key() {
//fact created for the character 'r' in the string "word"
let mut fact = Fact::new('r', 'c', 0, 0, 2);
fact.set_next_key('d');
}
#[test]
fn test_fact_set_prior_key() {
//fact created for the character 'r' in the string "word"
let mut fact = Fact::new('r', 'c', 0, 0, 2);
fact.set_prior_key('o');
}
#[test]
fn test_pattern_definition_new() {
let pttrn_def = PatternDefinition::new();
assert_eq!(pttrn_def.get("VowelUpper"), 'V');
}
#[test]
fn test_pattern_definition_symbolize_char() {
let pttrn_def = PatternDefinition::new();
assert_eq!(pttrn_def.symbolize_char('A'), 'V');
}
#[test]
fn test_pattern_definition_factualize() {
let mut pttrn_def = PatternDefinition::new();
let mut fact1 = pttrn_def.factualize("Word", 1);
let mut fact2 = Fact::new('o', 'v', 0, 0, 1);
fact2.set_prior_key('W');
fact2.set_next_key('r');
assert_eq!(fact1.serialize(), fact2.serialize());
}
#[test]
fn test_pattern_definition_analyze() {
let mut pttrn_def = PatternDefinition::new();
let word = pttrn_def.analyze("HELlo0?^@");
assert_eq!(word.0, "CVCcv#pp@");
assert_eq!(word.1.len(), 9);
}
#[test]
fn test_pattern_definition_analyze_multithread() {
let words = vec![
"word-one".to_string(),
"word-two".to_string(),
"word-three".to_string(),
"word-four".to_string(),
"word-five".to_string(),
];
let results = Xtest::analyze_entities(words);
println!("{:?}", results);
assert_eq!(results.len(), 5);
}
#[test]
fn test_profile_entities() {
//async {
let profile = Profile::new();
let words = vec![
"word-one".to_string(),
"word-two".to_string(),
"word-three".to_string(),
"word-four".to_string(),
"word-five".to_string(),
];
let result = Xtest::profile_entities(profile, words);
assert!(result.is_ok());
//};
}
}