Merge PR #194 feat/introducing-benchmarks

feat(Benchmarks): introduce benchmarks

Author: josueBarretogit

Cargo.lock

@@ -60,11 +60,17 @@ rusty-hook = "0.11.2"
 fake = "4.3.0"
 uuid = { version = "1.16.0", features = ["v4", "fast-rng"] }
 http = "1.3"
+criterion = { version = "0.5", features = ["html_reports"] }
 
+[[bench]]
+name = "utils"
+harness = false
 
 [target.'cfg(windows)'.dependencies]
 windows-sys = { version = "0.59.0", features = ["Win32_Foundation", "Win32_System_Console", "Win32_UI_HiDpi"]}
 
 [profile.release]
 codegen-units = 1
 lto = "fat"
+opt-level = "z"
+strip = "debuginfo"

Cargo.toml

@@ -0,0 +1,13 @@
+use criterion::{BenchmarkId, Criterion, criterion_group, criterion_main};
+use manga_tui::SanitizedFilename;
+
+fn sanitize_filename(c: &mut Criterion) {
+    let example = "some / title :";
+
+    c.bench_with_input(BenchmarkId::new("sanitized string parsing", example), &example, |b, &ex| {
+        b.iter(|| SanitizedFilename::new(ex));
+    });
+}
+
+criterion_group!(benches, sanitize_filename);
+criterion_main!(benches);

benches/utils.rs

@@ -40,11 +40,10 @@ impl SearchTerm {
 }
 
 /// Remove special characteres that may cause errors when creating directories or files
-fn remove_conflicting_characteres<T: AsRef<Path>>(title: T) -> PathBuf {
+fn remove_conflicting_characteres<T: AsRef<str>>(title: T) -> PathBuf {
     let invalid_chars = ['\\', '/', ':', '*', '?', '"', '<', '>', '|'];
 
-    let title: &Path = title.as_ref();
-    let title = title.to_str().unwrap().trim();
+    let title: &str = title.as_ref().trim();
 
     let sanitized_title: String = title.chars().map(|c| if invalid_chars.contains(&c) { '_' } else { c }).collect();
 
@@ -63,7 +62,7 @@ impl Display for SanitizedFilename {
 }
 
 impl SanitizedFilename {
-    pub fn new<T: AsRef<Path>>(name: T) -> Self {
+    pub fn new<T: AsRef<str>>(name: T) -> Self {
         Self(remove_conflicting_characteres(name))
     }
 
@@ -72,7 +71,7 @@ impl SanitizedFilename {
     }
 }
 
-impl<T: AsRef<Path>> From<T> for SanitizedFilename {
+impl<T: AsRef<str>> From<T> for SanitizedFilename {
     fn from(value: T) -> Self {
         Self::new(value)
     }
@@ -161,7 +160,7 @@ mod test {
 
         assert_eq!(Path::new("some name which contains _"), file_name.as_path());
 
-        let file_name = SanitizedFilename::new("some / name / which contains ");
+        let file_name = SanitizedFilename::new("  some / name / which contains ");
 
         assert_eq!(Path::new("some _ name _ which contains"), file_name.as_path())
     }