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
/*
* Copyright © 2019-today Peter M. Stahl pemistahl@gmail.com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either expressed or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
use crate::config::RegExpConfig;
use crate::regexp::RegExp;
use itertools::Itertools;
use std::io::ErrorKind;
use std::path::PathBuf;
pub(crate) const MISSING_TEST_CASES_MESSAGE: &str =
"No test cases have been provided for regular expression generation";
pub(crate) const MINIMUM_REPETITIONS_MESSAGE: &str =
"Quantity of minimum repetitions must be greater than zero";
pub(crate) const MINIMUM_SUBSTRING_LENGTH_MESSAGE: &str =
"Minimum substring length must be greater than zero";
/// This struct builds regular expressions from user-provided test cases.
#[derive(Clone)]
#[cfg_attr(feature = "python", pyo3::prelude::pyclass)]
pub struct RegExpBuilder {
pub(crate) test_cases: Vec<String>,
pub(crate) config: RegExpConfig,
}
impl RegExpBuilder {
/// Specifies the test cases to build the regular expression from.
///
/// The test cases need not be sorted because `RegExpBuilder` sorts them internally.
///
/// ⚠ Panics if `test_cases` is empty.
pub fn from<T: Clone + Into<String>>(test_cases: &[T]) -> Self {
if test_cases.is_empty() {
panic!("{}", MISSING_TEST_CASES_MESSAGE);
}
Self {
test_cases: test_cases.iter().cloned().map(|it| it.into()).collect_vec(),
config: RegExpConfig::new(),
}
}
/// Specifies a text file containing test cases to build the regular expression from.
///
/// The test cases need not be sorted because `RegExpBuilder` sorts them internally.
///
/// Each test case needs to be on a separate line.
/// Lines may be ended with either a newline (`\n`) or
/// a carriage return with a line feed (`\r\n`).
/// The final line ending is optional.
///
/// ⚠ Panics if:
/// - the file cannot be found
/// - the file's encoding is not valid UTF-8 data
/// - the file cannot be opened because of conflicting permissions
pub fn from_file<T: Into<PathBuf>>(file_path: T) -> Self {
match std::fs::read_to_string(file_path.into()) {
Ok(file_content) => Self {
test_cases: file_content.lines().map(|it| it.to_string()).collect_vec(),
config: RegExpConfig::new(),
},
Err(error) => match error.kind() {
ErrorKind::NotFound => panic!("The specified file could not be found"),
ErrorKind::InvalidData => {
panic!("The specified file's encoding is not valid UTF-8")
}
ErrorKind::PermissionDenied => {
panic!("Permission denied: The specified file could not be opened")
}
_ => panic!("{}", error),
},
}
}
/// Converts any Unicode decimal digit to character class `\d`.
///
/// This method takes precedence over
/// [`with_conversion_of_words`](Self::with_conversion_of_words) if both are set.
/// Decimal digits are converted to `\d`, the remaining word characters to `\w`.
///
/// This method takes precedence over
/// [`with_conversion_of_non_whitespace`](Self::with_conversion_of_non_whitespace) if both are set.
/// Decimal digits are converted to `\d`, the remaining non-whitespace characters to `\S`.
pub fn with_conversion_of_digits(&mut self) -> &mut Self {
self.config.is_digit_converted = true;
self
}
/// Converts any character which is not a Unicode decimal digit to character class `\D`.
///
/// This method takes precedence over
/// [`with_conversion_of_non_words`](Self::with_conversion_of_non_words) if both are set.
/// Non-digits which are also non-word characters are converted to `\D`.
///
/// This method takes precedence over
/// [`with_conversion_of_non_whitespace`](Self::with_conversion_of_non_whitespace) if both are set.
/// Non-digits which are also non-space characters are converted to `\D`.
pub fn with_conversion_of_non_digits(&mut self) -> &mut Self {
self.config.is_non_digit_converted = true;
self
}
/// Converts any Unicode whitespace character to character class `\s`.
///
/// This method takes precedence over
/// [`with_conversion_of_non_digits`](Self::with_conversion_of_non_digits) if both are set.
/// Whitespace characters are converted to `\s`, the remaining non-digit characters to `\D`.
///
/// This method takes precedence over
/// [`with_conversion_of_non_words`](Self::with_conversion_of_non_words) if both are set.
/// Whitespace characters are converted to `\s`, the remaining non-word characters to `\W`.
pub fn with_conversion_of_whitespace(&mut self) -> &mut Self {
self.config.is_space_converted = true;
self
}
/// Converts any character which is not a Unicode whitespace character to character class `\S`.
pub fn with_conversion_of_non_whitespace(&mut self) -> &mut Self {
self.config.is_non_space_converted = true;
self
}
/// Converts any Unicode word character to character class `\w`.
///
/// This method takes precedence over
/// [`with_conversion_of_non_digits`](Self::with_conversion_of_non_digits) if both are set.
/// Word characters are converted to `\w`, the remaining non-digit characters to `\D`.
///
/// This method takes precedence over
/// [`with_conversion_of_non_whitespace`](Self::with_conversion_of_non_whitespace) if both are set.
/// Word characters are converted to `\w`, the remaining non-space characters to `\S`.
pub fn with_conversion_of_words(&mut self) -> &mut Self {
self.config.is_word_converted = true;
self
}
/// Converts any character which is not a Unicode word character to character class `\W`.
///
/// This method takes precedence over
/// [`with_conversion_of_non_whitespace`](Self::with_conversion_of_non_whitespace) if both are set.
/// Non-words which are also non-space characters are converted to `\W`.
pub fn with_conversion_of_non_words(&mut self) -> &mut Self {
self.config.is_non_word_converted = true;
self
}
/// Detects repeated non-overlapping substrings and
/// to convert them to `{min,max}` quantifier notation.
pub fn with_conversion_of_repetitions(&mut self) -> &mut Self {
self.config.is_repetition_converted = true;
self
}
/// Enables case-insensitive matching of test cases
/// so that letters match both upper and lower case.
pub fn with_case_insensitive_matching(&mut self) -> &mut Self {
self.config.is_case_insensitive_matching = true;
self
}
/// Replaces non-capturing groups with capturing ones.
pub fn with_capturing_groups(&mut self) -> &mut Self {
self.config.is_capturing_group_enabled = true;
self
}
/// Specifies the minimum quantity of substring repetitions to be converted if
/// [`with_conversion_of_repetitions`](Self::with_conversion_of_repetitions) is set.
///
/// If the quantity is not explicitly set with this method, a default value of 1 will be used.
///
/// ⚠ Panics if `quantity` is zero.
pub fn with_minimum_repetitions(&mut self, quantity: u32) -> &mut Self {
if quantity == 0 {
panic!("{}", MINIMUM_REPETITIONS_MESSAGE);
}
self.config.minimum_repetitions = quantity;
self
}
/// Specifies the minimum length a repeated substring must have in order to be converted if
/// [`with_conversion_of_repetitions`](Self::with_conversion_of_repetitions) is set.
///
/// If the length is not explicitly set with this method, a default value of 1 will be used.
///
/// ⚠ Panics if `length` is zero.
pub fn with_minimum_substring_length(&mut self, length: u32) -> &mut Self {
if length == 0 {
panic!("{}", MINIMUM_SUBSTRING_LENGTH_MESSAGE);
}
self.config.minimum_substring_length = length;
self
}
/// Converts non-ASCII characters to unicode escape sequences.
/// The parameter `use_surrogate_pairs` specifies whether to convert astral code planes
/// (range `U+010000` to `U+10FFFF`) to surrogate pairs.
pub fn with_escaping_of_non_ascii_chars(&mut self, use_surrogate_pairs: bool) -> &mut Self {
self.config.is_non_ascii_char_escaped = true;
self.config.is_astral_code_point_converted_to_surrogate = use_surrogate_pairs;
self
}
/// Produces a nicer looking regular expression in verbose mode.
pub fn with_verbose_mode(&mut self) -> &mut Self {
self.config.is_verbose_mode_enabled = true;
self
}
/// Removes the caret anchor '^' from the resulting regular
/// expression, thereby allowing to match the test cases also when they do not occur
/// at the start of a string.
pub fn without_start_anchor(&mut self) -> &mut Self {
self.config.is_start_anchor_disabled = true;
self
}
/// Removes the dollar sign anchor '$' from the resulting regular
/// expression, thereby allowing to match the test cases also when they do not occur
/// at the end of a string.
pub fn without_end_anchor(&mut self) -> &mut Self {
self.config.is_end_anchor_disabled = true;
self
}
/// Removes the caret and dollar sign anchors from the resulting
/// regular expression, thereby allowing to match the test cases also when they occur
/// within a larger string that contains other content as well.
pub fn without_anchors(&mut self) -> &mut Self {
self.config.is_start_anchor_disabled = true;
self.config.is_end_anchor_disabled = true;
self
}
/// Provides syntax highlighting for the resulting regular expression.
///
/// ⚠ This method may only be used if the resulting regular expression is meant to
/// be printed to the console. The regex string representation returned from enabling
/// this setting cannot be fed into the [*regex*](https://crates.io/crates/regex) crate.
#[cfg(feature = "cli")]
#[doc(hidden)]
pub fn with_syntax_highlighting(&mut self) -> &mut Self {
self.config.is_output_colorized = true;
self
}
/// Builds the actual regular expression using the previously given settings.
pub fn build(&mut self) -> String {
RegExp::from(&mut self.test_cases, &self.config).to_string()
}
}