Merge branch 'rust-lang:main' into add/link-to-THIRD_PARTY-repository-for-Japanese-translations

Author: sotanengel

Cargo.lock

@@ -20,7 +20,7 @@ rust-version = "1.80"
 
 [workspace.dependencies]
 serde = { version = "1.0.210", features = ["derive"] }
-toml_edit = { version = "0.22.21", default-features = false, features = ["parse", "serde"] }
+toml_edit = { version = "0.22.22", default-features = false, features = ["parse", "serde"] }
 
 [package]
 name = "rustlings"
@@ -48,7 +48,7 @@ include = [
 [dependencies]
 ahash = { version = "0.8.11", default-features = false }
 anyhow = "1.0.89"
-clap = { version = "4.5.17", features = ["derive"] }
+clap = { version = "4.5.18", features = ["derive"] }
 crossterm = { version = "0.28.1", default-features = false, features = ["windows", "events"] }
 notify = { version = "6.1.1", default-features = false, features = ["macos_fsevent"] }
 os_pipe = "1.2.1"

Cargo.toml

@@ -1144,7 +1144,7 @@ constants, but clippy recognizes those imprecise mathematical constants as a
 source of potential error.
 
 See the suggestions of the Clippy warning in the compile output and use the
-appropriate replacement constant from `std::f32::consts`..."""
+appropriate replacement constant from `std::f32::consts`."""
 
 [[exercises]]
 name = "clippy2"

rustlings-macros/info.toml

@@ -381,7 +381,7 @@ impl AppState {
 
     // Return the exercise index of the first pending exercise found.
     fn check_all_exercises(&self, stdout: &mut StdoutLock) -> Result<Option<usize>> {
-        stdout.write_all(RERUNNING_ALL_EXERCISES_MSG)?;
+        stdout.write_all(FINAL_CHECK_MSG)?;
         let n_exercises = self.exercises.len();
 
         let status = thread::scope(|s| {
@@ -441,7 +441,10 @@ impl AppState {
     /// Mark the current exercise as done and move on to the next pending exercise if one exists.
     /// If all exercises are marked as done, run all of them to make sure that they are actually
     /// done. If an exercise which is marked as done fails, mark it as pending and continue on it.
-    pub fn done_current_exercise(&mut self, stdout: &mut StdoutLock) -> Result<ExercisesProgress> {
+    pub fn done_current_exercise<const CLEAR_BEFORE_FINAL_CHECK: bool>(
+        &mut self,
+        stdout: &mut StdoutLock,
+    ) -> Result<ExercisesProgress> {
         let exercise = &mut self.exercises[self.current_exercise_ind];
         if !exercise.done {
             exercise.done = true;
@@ -453,6 +456,12 @@ impl AppState {
             return Ok(ExercisesProgress::NewPending);
         }
 
+        if CLEAR_BEFORE_FINAL_CHECK {
+            clear_terminal(stdout)?;
+        } else {
+            stdout.write_all(b"\n")?;
+        }
+
         if let Some(pending_exercise_ind) = self.check_all_exercises(stdout)? {
             stdout.write_all(b"\n\n")?;
 
@@ -482,8 +491,7 @@ impl AppState {
 
 const BAD_INDEX_ERR: &str = "The current exercise index is higher than the number of exercises";
 const STATE_FILE_HEADER: &[u8] = b"DON'T EDIT THIS FILE!\n\n";
-const RERUNNING_ALL_EXERCISES_MSG: &[u8] = b"
-All exercises seem to be done.
+const FINAL_CHECK_MSG: &[u8] = b"All exercises seem to be done.
 Recompiling and running all exercises to make sure that all of them are actually done.
 ";
 const FENISH_LINE: &str = "+----------------------------------------------------+

src/app_state.rs

@@ -44,7 +44,7 @@ pub fn run(app_state: &mut AppState) -> Result<()> {
         stdout.write_all(b"\n")?;
     }
 
-    match app_state.done_current_exercise(&mut stdout)? {
+    match app_state.done_current_exercise::<false>(&mut stdout)? {
         ExercisesProgress::NewPending | ExercisesProgress::CurrentPending => {
             stdout.write_all(b"Next exercise: ")?;
             app_state

src/run.rs

@@ -69,11 +69,11 @@ fn run_watch(
     // Prevent dropping the guard until the end of the function.
     // Otherwise, the file watcher exits.
     let _watcher_guard = if let Some(exercise_names) = notify_exercise_names {
+        let notify_event_handler =
+            NotifyEventHandler::build(watch_event_sender.clone(), exercise_names)?;
+
         let mut watcher = RecommendedWatcher::new(
-            NotifyEventHandler {
-                sender: watch_event_sender.clone(),
-                exercise_names,
-            },
+            notify_event_handler,
             Config::default().with_poll_interval(Duration::from_secs(1)),
         )
         .inspect_err(|_| eprintln!("{NOTIFY_ERR}"))?;
@@ -100,13 +100,14 @@ fn run_watch(
                 ExercisesProgress::NewPending => watch_state.run_current_exercise(&mut stdout)?,
                 ExercisesProgress::CurrentPending => (),
             },
+            WatchEvent::Input(InputEvent::Run) => watch_state.run_current_exercise(&mut stdout)?,
             WatchEvent::Input(InputEvent::Hint) => watch_state.show_hint(&mut stdout)?,
             WatchEvent::Input(InputEvent::List) => return Ok(WatchExit::List),
+            WatchEvent::Input(InputEvent::Reset) => watch_state.reset_exercise(&mut stdout)?,
             WatchEvent::Input(InputEvent::Quit) => {
                 stdout.write_all(QUIT_MSG)?;
                 break;
             }
-            WatchEvent::Input(InputEvent::Run) => watch_state.run_current_exercise(&mut stdout)?,
             WatchEvent::FileChange { exercise_ind } => {
                 watch_state.handle_file_change(exercise_ind, &mut stdout)?;
             }

src/watch.rs

@@ -1,15 +1,71 @@
+use anyhow::{Context, Result};
 use notify::{
-    event::{MetadataKind, ModifyKind},
+    event::{AccessKind, AccessMode, MetadataKind, ModifyKind, RenameMode},
     Event, EventKind,
 };
-use std::sync::{atomic::Ordering::Relaxed, mpsc::Sender};
+use std::{
+    sync::{
+        atomic::Ordering::Relaxed,
+        mpsc::{sync_channel, RecvTimeoutError, Sender, SyncSender},
+    },
+    thread,
+    time::Duration,
+};
 
 use super::{WatchEvent, EXERCISE_RUNNING};
 
+const DEBOUNCE_DURATION: Duration = Duration::from_millis(200);
+
 pub struct NotifyEventHandler {
-    pub sender: Sender<WatchEvent>,
-    /// Used to report which exercise was modified.
-    pub exercise_names: &'static [&'static [u8]],
+    error_sender: Sender<WatchEvent>,
+    // Sends the index of the updated exercise.
+    update_sender: SyncSender<usize>,
+    // Used to report which exercise was modified.
+    exercise_names: &'static [&'static [u8]],
+}
+
+impl NotifyEventHandler {
+    pub fn build(
+        watch_event_sender: Sender<WatchEvent>,
+        exercise_names: &'static [&'static [u8]],
+    ) -> Result<Self> {
+        let (update_sender, update_receiver) = sync_channel(0);
+        let error_sender = watch_event_sender.clone();
+
+        // Debouncer
+        thread::Builder::new()
+            .spawn(move || {
+                let mut exercise_updated = vec![false; exercise_names.len()];
+
+                loop {
+                    match update_receiver.recv_timeout(DEBOUNCE_DURATION) {
+                        Ok(exercise_ind) => exercise_updated[exercise_ind] = true,
+                        Err(RecvTimeoutError::Timeout) => {
+                            for (exercise_ind, updated) in exercise_updated.iter_mut().enumerate() {
+                                if *updated {
+                                    if watch_event_sender
+                                        .send(WatchEvent::FileChange { exercise_ind })
+                                        .is_err()
+                                    {
+                                        break;
+                                    }
+
+                                    *updated = false;
+                                }
+                            }
+                        }
+                        Err(RecvTimeoutError::Disconnected) => break,
+                    }
+                }
+            })
+            .context("Failed to spawn a thread to debounce file changes")?;
+
+        Ok(Self {
+            error_sender,
+            update_sender,
+            exercise_names,
+        })
+    }
 }
 
 impl notify::EventHandler for NotifyEventHandler {
@@ -22,8 +78,8 @@ impl notify::EventHandler for NotifyEventHandler {
             Ok(v) => v,
             Err(e) => {
                 // An error occurs when the receiver is dropped.
-                // After dropping the receiver, the debouncer guard should also be dropped.
-                let _ = self.sender.send(WatchEvent::NotifyErr(e));
+                // After dropping the receiver, the watcher guard should also be dropped.
+                let _ = self.error_sender.send(WatchEvent::NotifyErr(e));
                 return;
             }
         };
@@ -32,6 +88,10 @@ impl notify::EventHandler for NotifyEventHandler {
             EventKind::Any => (),
             EventKind::Modify(modify_kind) => match modify_kind {
                 ModifyKind::Any | ModifyKind::Data(_) => (),
+                ModifyKind::Name(rename_mode) => match rename_mode {
+                    RenameMode::Any | RenameMode::To => (),
+                    RenameMode::From | RenameMode::Both | RenameMode::Other => return,
+                },
                 ModifyKind::Metadata(metadata_kind) => match metadata_kind {
                     MetadataKind::Any | MetadataKind::WriteTime => (),
                     MetadataKind::AccessTime
@@ -40,12 +100,17 @@ impl notify::EventHandler for NotifyEventHandler {
                     | MetadataKind::Extended
                     | MetadataKind::Other => return,
                 },
-                ModifyKind::Name(_) | ModifyKind::Other => return,
+                ModifyKind::Other => return,
+            },
+            EventKind::Access(access_kind) => match access_kind {
+                AccessKind::Any => (),
+                AccessKind::Close(access_mode) => match access_mode {
+                    AccessMode::Any | AccessMode::Write => (),
+                    AccessMode::Execute | AccessMode::Read | AccessMode::Other => return,
+                },
+                AccessKind::Read | AccessKind::Open(_) | AccessKind::Other => return,
             },
-            EventKind::Access(_)
-            | EventKind::Create(_)
-            | EventKind::Remove(_)
-            | EventKind::Other => return,
+            EventKind::Create(_) | EventKind::Remove(_) | EventKind::Other => return,
         }
 
         let _ = input_event
@@ -62,6 +127,6 @@ impl notify::EventHandler for NotifyEventHandler {
                     .iter()
                     .position(|exercise_name| *exercise_name == file_name_without_ext)
             })
-            .try_for_each(|exercise_ind| self.sender.send(WatchEvent::FileChange { exercise_ind }));
+            .try_for_each(|exercise_ind| self.update_sender.send(exercise_ind));
     }
 }