Merge pull request #89 from bugzmanov/pre_037

Release 0.3.7 prep

Author: bugzmanov

CLAUDE.md

@@ -4,7 +4,10 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
 
 ## CRITICAL RULES FOR AI ASSISTANTS
 
+0. **Working Directory**: NEVER CHANGE WORKING DIRECTORY UNLESS SPECIFICALLY ASKED. THE CURRENT USER WORKFLOW IS BASED ON WORKTREES, BY RECKLESSLY CHANGING DIRECTORIES YOU CAN MAKE IRREVERSIBLE DAMAGE.
+
 1. **Testing**: ALWAYS use the existing SVG-based snapshot testing in `tests/svg_snapshots.rs`. NEVER introduce new testing frameworks or approaches.
+1a. **Sandbox-Safe Tests**: All tests must run in sandboxed environments (e.g., Nix builds). This means tests MUST NOT: rely on a writable home directory or system directories (`dirs::data_dir()`, `dirs::cache_dir()`, etc.); make network requests; depend on system fonts, a real TTY, or specific environment variables (`TERM`, `COLORTERM`, `TERM_PROGRAM`); assume standard tools exist in `PATH` beyond what's declared as dependencies. Use `tempfile::TempDir` for any filesystem operations, and inject/mock any external dependencies rather than relying on the host environment.
 2. **Golden Snapshots**: NEVER update golden snapshot files with `SNAPSHOTS=overwrite` unless explicitly requested by the user. This is critical for test integrity.
 3. **Test Updates**: NEVER update any test files or test expectations unless explicitly requested by the user. This includes unit tests, integration tests, and snapshot tests.
 4. **File Creation**: Prefer editing existing files over creating new ones. Only create new files when absolutely necessary.

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "bookokrat"
-version = "0.3.6"
+version = "0.3.7"
 edition = "2024"
 rust-version = "1.86"
 authors = ["Rafael Bagmanov <bugzmanov@gmail.com>"]

Cargo.toml

@@ -13,11 +13,11 @@ Hard UX:
  [ ] Rework footer command bar to be context-aware and higher-contrast, reducing clutter.
  [ ] Comments editing in pdf annotations is very non-ergonomic. Potentially need normal mode.
  --
- [ ] update & analyze tapes & tests
- [ ] Analyze the PDF impact: size wise, heap wise and make it sure that it wouldn't affect epub only readers
- [ ] update help (new stuff & inspiration links)
+ [x] update & analyze tapes & tests
+ [x] Analyze the PDF impact: size wise, heap wise and make it sure that it wouldn't affect epub only readers
+ [x] update help (new stuff & inspiration links)
     [ ] Make help context dependent
- [ ] new pictures for the site and potentially new video for the app. 
+ [x] new pictures for the site and potentially new video for the app. 
 
 ideas to implement:
  - [ ] Dimming should probably just use math instead of sticking to fixed palette
@@ -94,6 +94,35 @@ bugs:
 [ ] Effective rust - chapter 4 
    [ ] Too much visual noise. (potentially because bg highlights)
 [ ] <i>code</i> will have bg color instead of being cursive
+[ ] 
+-----
+of choosing which rule to apply to rewrite a symbol, we make that decision randomly. For example,
+consider our apple-banana grammar: Sentence → apple Sentence banana, Sentence → apple banana. If we
+start with the symbol Sentence and then flip a coin for which rule to apply, we end up defining a
+probability distribution over all sentences with some number of apples followed by the same number of
+bananas: “apple banana” appears with probability
+
+1
+─
+2
+
+, “apple apple banana banana” with probability
+
+1
+─
+4
+
+, “apple apple apple banana banana banana” with probability
+
+1
+─
+8
+
+, and so on.
+-----
+
+Simple mathml expressions should be one-liners: 1/2, 1/4 etc.
+
 
 Tools with cool ratatui UI:
 - https://github.com/erikjuhani/basalt

TODO.md

@@ -98,7 +98,11 @@
 │  Ctrl+i        Jump forward in history                                      │
 │  z (PDF)       Zoom to fit height                                           │
 │  Z (PDF)       Zoom to fit width                                            │
-│  i (PDF)       Toggle image inversion                                       │
+│  i (PDF)       Toggle image inversion (themed mode only; saved per book)    │
+│  I (PDF)       Switch between original PDF rendering and themed style        │
+│                (saved per book).                                             │
+│                Themed style is the default.                                  │
+│                In original rendering mode, i has no visual effect.          │
 │  n             Toggle normal mode                                           │
 └─────────────────────────────────────────────────────────────────────────────┘
 

readme.txt

@@ -30,6 +30,10 @@ pub struct Bookmark {
     #[cfg(feature = "pdf")]
     #[serde(skip_serializing_if = "Option::is_none", default)]
     pub pdf_invert_images: Option<bool>,
+
+    #[cfg(feature = "pdf")]
+    #[serde(skip_serializing_if = "Option::is_none", default)]
+    pub pdf_themed_rendering: Option<bool>,
 }
 
 #[derive(Debug, Serialize, Deserialize)]
@@ -188,6 +192,7 @@ impl Bookmarks {
             pdf_zoom,
             pdf_pan,
             None,
+            None,
         );
     }
 
@@ -204,6 +209,7 @@ impl Bookmarks {
         pdf_zoom: Option<f32>,
         pdf_pan: Option<u16>,
         pdf_invert_images: Option<bool>,
+        pdf_themed_rendering: Option<bool>,
     ) {
         self.update_bookmark_internal(
             path,
@@ -215,6 +221,7 @@ impl Bookmarks {
             pdf_zoom,
             pdf_pan,
             pdf_invert_images,
+            pdf_themed_rendering,
         );
     }
 
@@ -230,7 +237,9 @@ impl Bookmarks {
         pdf_zoom: Option<f32>,
         pdf_pan: Option<u16>,
         #[cfg(feature = "pdf")] pdf_invert_images: Option<bool>,
+        #[cfg(feature = "pdf")] pdf_themed_rendering: Option<bool>,
         #[cfg(not(feature = "pdf"))] _pdf_invert_images: Option<bool>,
+        #[cfg(not(feature = "pdf"))] _pdf_themed_rendering: Option<bool>,
     ) {
         let key = self
             .resolve_existing_key(path)
@@ -248,6 +257,8 @@ impl Bookmarks {
                 pdf_pan,
                 #[cfg(feature = "pdf")]
                 pdf_invert_images,
+                #[cfg(feature = "pdf")]
+                pdf_themed_rendering,
             },
         );
 

src/bookmarks.rs

@@ -98,61 +98,59 @@ impl ImagePopup {
             loading_duration.as_millis()
         );
 
-        // Time the protocol creation (which includes resize)
-        let start = Instant::now();
-        let protocol = self
-            .picker
-            .new_protocol(
+        let needs_protocol_rebuild = self
+            .protocol
+            .as_ref()
+            .is_none_or(|existing| existing.area() != inner_area);
+
+        if needs_protocol_rebuild {
+            let start = Instant::now();
+            match self.picker.new_protocol(
                 self.image.as_ref().clone(),
-                self.calculate_optimal_popup_area(terminal_size),
+                inner_area,
                 Resize::Viewport(ViewportOptions {
                     y_offset: 0,
                     x_offset: 0,
                 }),
-            )
-            .unwrap();
-        let duration = start.elapsed();
-
-        self.protocol = Some(protocol);
-        self.is_loading = false;
-
-        // Log the timing information
-        let total_time = self.load_start.map(|s| s.elapsed()).unwrap_or(duration);
-        debug!(
-            "--Image popup stats for '{}': protocol creation: {}ms, total time: {}ms",
-            self.src_path,
-            duration.as_millis(),
-            total_time.as_millis()
-        );
+            ) {
+                Ok(protocol) => {
+                    let duration = start.elapsed();
+                    self.protocol = Some(protocol);
+                    self.is_loading = false;
+
+                    let total_time = self.load_start.map(|s| s.elapsed()).unwrap_or(duration);
+                    debug!(
+                        "--Image popup stats for '{}': protocol creation: {}ms, total time: {}ms",
+                        self.src_path,
+                        duration.as_millis(),
+                        total_time.as_millis()
+                    );
+                }
+                Err(e) => {
+                    debug!(
+                        "Failed to create image popup protocol for '{}': {e}",
+                        self.src_path
+                    );
+                    self.popup_area = Some(popup_area);
+                    return;
+                }
+            }
+        }
 
         let image_area = inner_area;
-        let image_widget = Image::new(self.protocol.as_ref().unwrap());
-
-        let total_time = self.load_start.map(|s| s.elapsed()).unwrap_or(duration);
-        let duration = start.elapsed();
-        debug!(
-            "--Image creation stats for '{}': protocol creation: {}ms, total time: {}ms",
-            self.src_path,
-            duration.as_millis(),
-            total_time.as_millis()
-        );
-
-        let render_start = Instant::now();
-        f.render_widget(image_widget, image_area);
-        let render_duration = render_start.elapsed();
-
-        debug!(
-            "--Image widget render time for '{}': {}ms",
-            self.src_path,
-            render_duration.as_millis()
-        );
-
-        let total_render_time = render_start.elapsed();
-        debug!(
-            "TOTAL render() time for '{}': {}ms",
-            self.src_path,
-            total_render_time.as_millis()
-        );
+        if let Some(ref protocol) = self.protocol {
+            let image_widget = Image::new(protocol);
+
+            let image_render_start = Instant::now();
+            f.render_widget(image_widget, image_area);
+            let render_duration = image_render_start.elapsed();
+
+            debug!(
+                "--Image widget render time for '{}': {}ms",
+                self.src_path,
+                render_duration.as_millis()
+            );
+        }
 
         // Return the popup area so the main app knows where the image is displayed
         self.popup_area = Some(popup_area)

src/images/image_popup.rs

@@ -39,20 +39,29 @@ impl ImageStorage {
         let epub_path_str = epub_path.to_string_lossy().to_string();
         info!("Starting image extraction for: {epub_path_str}");
 
-        if self.book_dirs.lock().unwrap().contains_key(&epub_path_str) {
-            info!("Images already extracted for this book");
-            return Ok(());
-        }
-
         let book_name = epub_path
             .file_stem()
             .and_then(|s| s.to_str())
             .unwrap_or("unknown");
         let safe_book_name = sanitize_filename(book_name);
         let book_dir = self.base_dir.join(&safe_book_name);
+        let cache_is_stale = is_cache_stale(epub_path, &book_dir);
+
+        if cache_is_stale {
+            info!("EPUB is newer than cached images; forcing re-extraction");
+            self.book_dirs.lock().unwrap().remove(&epub_path_str);
+            if let Err(e) = fs::remove_dir_all(&book_dir)
+                && book_dir.exists()
+            {
+                warn!("Failed to remove stale image cache {book_dir:?}: {e}");
+            }
+        } else if self.book_dirs.lock().unwrap().contains_key(&epub_path_str) {
+            info!("Images already extracted for this book");
+            return Ok(());
+        }
 
         // Check if directory exists and already contains images
-        if book_dir.exists() {
+        if book_dir.exists() && !cache_is_stale {
             let mut has_images = false;
             if let Ok(entries) = fs::read_dir(&book_dir) {
                 for entry in entries.flatten() {
@@ -460,9 +469,17 @@ fn collect_images_recursive(dir: &Path, images: &mut Vec<PathBuf>) -> Result<()>
     Ok(())
 }
 
+fn is_cache_stale(epub_path: &Path, book_dir: &Path) -> bool {
+    let epub_modified = epub_path.metadata().and_then(|m| m.modified()).ok();
+    let cache_modified = book_dir.metadata().and_then(|m| m.modified()).ok();
+    matches!((epub_modified, cache_modified), (Some(epub_t), Some(cache_t)) if epub_t > cache_t)
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;
+    use std::thread::sleep;
+    use std::time::Duration;
     use tempfile::TempDir;
     use walkdir::WalkDir;
 
@@ -583,4 +600,18 @@ mod tests {
 
         assert!(found, "expected extracted .jpg in image storage");
     }
+
+    #[test]
+    fn cache_stale_when_epub_newer_than_cache_dir() {
+        let root = TempDir::new().unwrap();
+        let epub = root.path().join("book.epub");
+        let cache = root.path().join("book");
+
+        fs::create_dir_all(&cache).unwrap();
+        fs::write(cache.join("cover.webp"), b"old").unwrap();
+        sleep(Duration::from_millis(1100));
+        fs::write(&epub, b"newer epub").unwrap();
+
+        assert!(is_cache_stale(&epub, &cache));
+    }
 }