Merge PR josueBarretogit#189 feat/save_filters_used_mangadex

Feat/save filters used mangadex

Author: josueBarretogit

src/backend.rs

@@ -6,7 +6,7 @@ use once_cell::sync::Lazy;
 use strum::{Display, EnumIter, IntoEnumIterator};
 
 use self::error_log::create_error_logs_files;
-use crate::config::{MangaTuiConfig, build_config_file};
+use crate::config::build_config_file;
 use crate::logger::ILogger;
 
 pub mod cache;

src/backend/cache.rs

@@ -1,6 +1,5 @@
 use std::error::Error;
-use std::fmt::{Debug, Display};
-use std::time::Duration;
+use std::fmt::Debug;
 
 pub mod in_memory;
 

src/backend/cache/in_memory.rs

@@ -139,13 +139,12 @@ impl Cacher for InMemoryCache {
 #[cfg(test)]
 mod tests {
     use std::error::Error;
-    use std::thread::sleep;
     use std::time::{Duration, Instant};
 
     use pretty_assertions::assert_eq;
 
     use super::*;
-    use crate::backend::cache::{self, Entry, InsertEntry};
+    use crate::backend::cache::{Entry, InsertEntry};
 
     #[test]
     fn it_saves_and_retrieves_data() -> Result<(), Box<dyn Error>> {

src/backend/manga_downloader/pdf_downloader.rs

@@ -4,8 +4,8 @@ use std::path::Path;
 
 use flate2::Compression;
 use flate2::write::ZlibEncoder;
-use image::{DynamicImage, GenericImageView, ImageFormat};
-use lopdf::{Document, Object, Stream, dictionary};
+use image::{GenericImageView, ImageFormat};
+use lopdf::{Document, Stream, dictionary};
 
 use super::MangaDownloader;
 
@@ -28,14 +28,15 @@ impl MangaDownloader for PdfDownloader {
 
         let pdf_path = base_directory.join(format!("{}.pdf", self.make_chapter_name(&chapter).display()));
 
+        let file = File::create(pdf_path)?;
         let mut doc = Document::with_version("1.7");
         let mut pages = Vec::new();
         let page_width = 595.0;
 
-        for (index, page) in chapter.pages.iter().enumerate() {
+        for page in chapter.pages.iter() {
             let img = image::load_from_memory(&page.bytes)?;
             let (img_width, img_height) = img.dimensions();
-            let mut img_data = Vec::new();
+            let mut img_data = Vec::with_capacity(page.bytes.len());
             let filter;
             let color_space = if img.color().has_color() { "DeviceRGB" } else { "DeviceGray" };
 
@@ -105,7 +106,6 @@ impl MangaDownloader for PdfDownloader {
 
         doc.trailer.set("Root", catalog_id);
 
-        let mut file = File::create(pdf_path)?;
         doc.save_to(&mut BufWriter::new(file))?;
 
         Ok(())
@@ -115,12 +115,9 @@ impl MangaDownloader for PdfDownloader {
 #[cfg(test)]
 mod tests {
     use std::error::Error;
-    use std::fs;
-    use std::path::PathBuf;
 
     use fake::Fake;
     use fake::faker::name::en::Name;
-    use lopdf::Document;
     use uuid::Uuid;
 
     use super::*;

src/backend/manga_provider.rs

@@ -21,6 +21,7 @@ use crate::config::ImageQuality;
 use crate::global::PREFERRED_LANGUAGE;
 use crate::view::widgets::StatefulWidgetFrame;
 
+pub mod filters;
 pub mod mangadex;
 pub mod weebcentral;
 
@@ -203,6 +204,11 @@ impl Languages {
         }
     }
 
+    /// Returns an iterator which discards the 'Unknown' variant
+    pub fn iterate() -> std::iter::Filter<LanguagesIter, impl FnMut(&Languages) -> bool> {
+        Self::iter().filter(|lan| *lan != Self::Unkown)
+    }
+
     pub fn get_preferred_lang() -> &'static Languages {
         PREFERRED_LANGUAGE.get_or_init(Self::default)
     }

src/backend/manga_provider/filters.rs

@@ -0,0 +1,252 @@
+//! This module provides the `FiltersCache` struct, which is responsible for caching and retrieving filter data used in manga search
+//! operations.
+//!
+//! The `FiltersCache` allows you to serialize filter configurations (such as languages, publication status, sort order, tags,
+//! authors, and more) into TOML files for persistent storage, and deserialize them back when needed. This is useful for persisting
+//! user-selected filters or default filter sets between application runs.
+//!
+//! The cache is stored in a specified directory and file, and the module provides methods to write filter data to the cache and
+//! read it back. The filter data must implement `serde::Serialize` and `serde::de::DeserializeOwned`, making it flexible for
+//! various filter types.
+//!
+//! Example use cases include caching search filters for manga providers like MangaDex, where filters may include fields such as
+//! languages, publication status, sort order, tags, magazine demographics, authors, and artists.
+use std::error::Error;
+use std::fs::{File, create_dir_all};
+use std::io::{Read, Write};
+use std::path::PathBuf;
+
+use serde::Serialize;
+use serde::de::DeserializeOwned;
+
+/// A cache handler for serializing and deserializing filter data to and from TOML files.
+///
+/// `FiltersCache` is designed to persist filter configurations used in manga search operations, such as those for MangaDex.
+/// It stores filter data (implementing `serde::Serialize` and `serde::de::DeserializeOwned`) in a specified directory and file.
+///
+/// # Example Usage
+///
+/// The struct is typically used to cache filters like the following (see tests for more details):
+///
+/// ```rust
+/// # use crate::backend::manga_provider::mangadex::filters::api_parameter::{Filters, ContentRating, PublicationStatus, SortBy, Tags, TagData, TagSelection, MagazineDemographic, User, AuthorFilterState};
+/// # use crate::backend::manga_provider::Languages;
+/// let filters = Filters {
+///     content_rating: vec![ContentRating::Suggestive, ContentRating::Erotic],
+///     publication_status: vec![PublicationStatus::Completed, PublicationStatus::Ongoing],
+///     sort_by: SortBy::HighestRating,
+///     tags: Tags::new(vec![TagData::new("id_tag".to_string(), TagSelection::Included, "fantasy".to_string())]),
+///     magazine_demographic: vec![MagazineDemographic::Shoujo, MagazineDemographic::Seinen],
+///     authors: User::new(vec![AuthorFilterState::new("user_id".to_string(), "".to_string())]),
+///     artists: User::default(),
+///     languages: vec![Languages::English, Languages::Spanish],
+/// };
+/// ```
+///
+/// You can then write these filters to a cache file and retrieve them later:
+///
+/// ```rust
+/// # use std::path::Path;
+/// # let filters_cache = FiltersCache::new(Path::new("./cache_dir"), "filters.toml");
+/// filters_cache.write_to_cache(&filters).unwrap();
+/// let cached: Option<Filters> = filters_cache.get_cached_filters();
+/// ```
+///
+/// This enables persistent storage and retrieval of user or default filter sets between application runs.
+pub struct FiltersCache {
+    base_directory: PathBuf,
+    cache_filename: &'static str,
+}
+
+impl FiltersCache {
+    pub fn new<T: Into<PathBuf>>(base_directory: T, cache_filename: &'static str) -> Self {
+        let path: PathBuf = base_directory.into();
+        Self {
+            base_directory: path,
+            cache_filename,
+        }
+    }
+
+    fn save_filters<T: Write, I: Serialize>(&self, filters: &I, file: &mut T) -> Result<(), Box<dyn Error>> {
+        let filters_as_toml = toml::to_string(filters)?;
+
+        file.write_all(filters_as_toml.as_bytes())?;
+
+        file.flush()?;
+
+        Ok(())
+    }
+
+    #[inline]
+    fn get_cache_file_path(&self) -> PathBuf {
+        self.base_directory.join(self.cache_filename)
+    }
+
+    fn parse_cache<T: Read, I: DeserializeOwned>(&self, file: &mut T) -> Result<I, Box<dyn Error>> {
+        let mut contents = String::new();
+
+        file.read_to_string(&mut contents)?;
+
+        let filters: I = toml::from_str(&contents)?;
+
+        Ok(filters)
+    }
+
+    fn ensure_cache_directory_exists(&self) -> Result<(), std::io::Error> {
+        if !self.base_directory.exists() {
+            create_dir_all(&self.base_directory)?
+        }
+
+        Ok(())
+    }
+
+    /// Reads the cache directory, and returns:
+    /// Some(filters) if there is already a cache filters file,
+    /// None if the file doesnt exist
+    pub fn get_cached_filters<I: DeserializeOwned>(&self) -> Option<I> {
+        let file_path = self.get_cache_file_path();
+
+        let maybe_filters = File::open(file_path)
+            .inspect_err(|e| match e.kind() {
+                std::io::ErrorKind::NotFound => {},
+                _ => {
+                    #[cfg(not(test))]
+                    {
+                        use crate::backend::error_log::{ErrorType, write_to_error_log};
+
+                        write_to_error_log(ErrorType::String(&e.to_string()))
+                    }
+                },
+            })
+            .and_then(|mut file| self.parse_cache(&mut file).map_err(|e| std::io::Error::other(e.to_string())))
+            .ok();
+
+        maybe_filters
+    }
+
+    /// Writes the "Filters" to the cache file which is created if it
+    /// doesnt exist in toml format
+    pub fn write_to_cache<I: Serialize>(&self, filters: &I) -> Result<(), Box<dyn Error>> {
+        let file_path = self.get_cache_file_path();
+
+        self.ensure_cache_directory_exists()?;
+
+        let mut file = File::create(file_path)?;
+
+        self.save_filters(filters, &mut file)?;
+
+        Ok(())
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use std::error::Error;
+    use std::fs::create_dir_all;
+    use std::io::Cursor;
+    use std::path::Path;
+
+    use pretty_assertions::assert_eq;
+
+    use super::*;
+    use crate::backend::manga_provider::Languages;
+    use crate::backend::manga_provider::mangadex::filters::api_parameter::{
+        AuthorFilterState, ContentRating, Filters, MagazineDemographic, PublicationStatus, SortBy, TagData, TagSelection, Tags,
+        User,
+    };
+
+    const CACHE_TEST_DIRECTORY_PATH: &str = "./test_results/cache_test/";
+
+    #[test]
+    fn it_writes_mangadex_filters_to_cache_file() -> Result<(), Box<dyn Error>> {
+        let filters: Filters = Filters {
+            content_rating: vec![ContentRating::Suggestive, ContentRating::Erotic],
+            publication_status: vec![PublicationStatus::Completed, PublicationStatus::Ongoing],
+            sort_by: SortBy::HighestRating,
+            tags: Tags::new(vec![TagData::new("id_tag".to_string(), TagSelection::Included, "fantasy".to_string())]),
+            magazine_demographic: vec![MagazineDemographic::Shoujo, MagazineDemographic::Seinen],
+            authors: User::new(vec![AuthorFilterState::new("user_id".to_string(), "".to_string())]),
+            artists: User::default(),
+            languages: vec![Languages::English, Languages::Spanish],
+        };
+
+        let mut test_file = Cursor::new(Vec::new());
+
+        let filters_cache = FiltersCache::new(Path::new(""), "");
+
+        filters_cache.save_filters(&filters, &mut test_file)?;
+
+        let contents = String::from_utf8(test_file.into_inner())?;
+
+        let result: Filters = toml::from_str(&contents)?;
+
+        assert_eq!(filters, result);
+
+        Ok(())
+    }
+
+    #[test]
+    fn it_parses_mangadex_filters_from_the_cache_from_file() -> Result<(), Box<dyn Error>> {
+        let filters: Filters = Filters {
+            content_rating: vec![ContentRating::Suggestive, ContentRating::Erotic],
+            publication_status: vec![PublicationStatus::Completed, PublicationStatus::Ongoing],
+            sort_by: SortBy::HighestRating,
+            tags: Tags::new(vec![TagData::new("id_tag".to_string(), TagSelection::Included, "fantasy".to_string())]),
+            magazine_demographic: vec![MagazineDemographic::Shoujo, MagazineDemographic::Seinen],
+            authors: User::new(vec![AuthorFilterState::new("user_id".to_string(), "".to_string())]),
+            artists: User::default(),
+            languages: vec![Languages::English, Languages::Spanish],
+        };
+
+        let mut test_file = Cursor::new(toml::to_string(&filters)?);
+
+        let filters_cache = FiltersCache::new(Path::new(""), "");
+
+        let cached = filters_cache.parse_cache(&mut test_file)?;
+
+        assert_eq!(filters, cached);
+
+        Ok(())
+    }
+
+    fn delete_cached_file_if_already_exists(path: &Path) {
+        if path.exists() {
+            std::fs::remove_file(path).unwrap()
+        }
+    }
+
+    #[ignore]
+    #[test]
+    fn it_check_if_cache_file_exists_and_returns_none() -> Result<(), Box<dyn Error>> {
+        let filters: Filters = Filters {
+            content_rating: vec![ContentRating::Suggestive, ContentRating::Erotic],
+            publication_status: vec![PublicationStatus::Completed, PublicationStatus::Ongoing],
+            sort_by: SortBy::HighestRating,
+            tags: Tags::new(vec![TagData::new("id_tag".to_string(), TagSelection::Included, "fantasy".to_string())]),
+            magazine_demographic: vec![MagazineDemographic::Shoujo, MagazineDemographic::Seinen],
+            authors: User::new(vec![AuthorFilterState::new("user_id".to_string(), "".to_string())]),
+            artists: User::default(),
+            languages: vec![Languages::English, Languages::Spanish],
+        };
+
+        create_dir_all(CACHE_TEST_DIRECTORY_PATH)?;
+
+        let file_cache = FiltersCache::new(CACHE_TEST_DIRECTORY_PATH, "mangadex_filters.toml");
+
+        delete_cached_file_if_already_exists(&file_cache.get_cache_file_path());
+
+        let first_check: Option<Filters> = file_cache.get_cached_filters();
+
+        assert!(first_check.is_none());
+
+        file_cache.write_to_cache(&filters).expect("failed to create cache file");
+
+        let second_check: Option<Filters> = file_cache.get_cached_filters();
+
+        assert!(second_check.is_some());
+
+        dbg!(second_check);
+
+        Ok(())
+    }
+}