Merge 59e8f70e55 into e6cb104294

CHANGELOG.md

@@ -1,3 +1,34 @@
+<a name="6.4.0"></a>
+
+## 6.4.0 (2024-11-11)
+
+### Added
+
+- The list of exercises is now searchable by pressing `s` or `/` 🔍️ (thanks to [@frroossst](https://github.com/frroossst))
+- New option `c` in the prompt to manually check all exercises ✅ (thanks to [@Nahor](https://github.com/Nahor))
+- New command `check-all` to manually check all exercises ✅ (thanks to [@Nahor](https://github.com/Nahor))
+- Addictive animation for showing the progress of checking all exercises. A nice showcase of parallelism in Rust ✨
+- New option `x` in the prompt to reset the file of the current exercise 🔄
+- Allow `dead_code` for all exercises and solutions ⚰️ (thanks to [@huss4in](https://github.com/huss4in))
+- Pause input while running an exercise to avoid unexpected prompt interactions ⏸️
+- Limit the maximum number of exercises to 999. Any third-party exercises willing to reach that limit? 🔝
+
+### Changed
+
+- `enums3`: Remove redundant enum definition task (thanks to [@senekor](https://github.com/senekor))
+- `if2`: Make the exercise less confusing by avoiding "fizz", "fuzz", "foo", "bar" and "baz" (thanks to [@senekor](https://github.com/senekor))
+- `hashmap3`: Use the method `Entry::or_default`.
+- Update the state of all exercises when checking all of them (thanks to [@Nahor](https://github.com/Nahor))
+- The main prompt doesn't need a confirmation with ENTER on Unix-like systems anymore.
+- No more jumping back to a previous exercise when its file is changed. Use the list to jump between exercises.
+- Dump the solution file after an exercise is done even if the solution's directory doesn't exist.
+- Rework the footer in the list.
+- Optimize the file watcher.
+
+### Fixed
+
+- Fix bad contrast in the list on terminals with a light theme.
+
 <a name="6.3.0"></a>
 
 ## 6.3.0 (2024-08-29)
@@ -113,7 +144,7 @@ You can read about the motivations of this change in [this issue](https://github
 
 ### List mode
 
-A list mode was added using [Ratatui](https://ratatui.rs).
+A new list mode was added!
 You can enter it by entering `l` in the watch mode.
 It offers the following features:
 
@@ -814,7 +845,7 @@ Then follow the link to the guide about [third-party exercises](THIRD_PARTY_EXER
 
 #### Bug Fixes
 
-- Update deps to version compatable with aarch64-pc-windows (#263) ([19a93428](https://github.com/rust-lang/rustlings/commit/19a93428b3c73d994292671f829bdc8e5b7b3401))
+- Update deps to version compatible with aarch64-pc-windows (#263) ([19a93428](https://github.com/rust-lang/rustlings/commit/19a93428b3c73d994292671f829bdc8e5b7b3401))
 - **docs:**
   - Added a necessary step to Windows installation process (#242) ([3906efcd](https://github.com/rust-lang/rustlings/commit/3906efcd52a004047b460ed548037093de3f523f))
   - Fixed mangled sentence from book; edited for clarity (#266) ([ade52ff](https://github.com/rust-lang/rustlings/commit/ade52ffb739987287ddd5705944c8777705faed9))

Cargo.lock

@@ -4,9 +4,9 @@ version = 3
 
 [[package]]
 name = "anstream"
-version = "0.6.17"
+version = "0.6.18"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "23a1e53f0f5d86382dafe1cf314783b2044280f406e7e1506368220ad11b1338"
+checksum = "8acc5369981196006228e28809f761875c0327210a891e941f4c683b3a99529b"
 dependencies = [
  "anstyle",
  "anstyle-parse",
@@ -19,9 +19,9 @@ dependencies = [
 
 [[package]]
 name = "anstyle"
-version = "1.0.9"
+version = "1.0.10"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8365de52b16c035ff4fcafe0092ba9390540e3e352870ac09933bebcaa2c8c56"
+checksum = "55cc3b69f167a1ef2e161439aa98aed94e6028e5f9a59be9a6ffb47aef1651f9"
 
 [[package]]
 name = "anstyle-parse"
@@ -53,9 +53,9 @@ dependencies = [
 
 [[package]]
 name = "anyhow"
-version = "1.0.91"
+version = "1.0.93"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c042108f3ed77fd83760a5fd79b53be043192bb3b9dba91d8c574c0ada7850c8"
+checksum = "4c95c10ba0b00a02636238b814946408b1322d5ac4760326e6fb8ec956d85775"
 
 [[package]]
 name = "autocfg"
@@ -170,9 +170,9 @@ dependencies = [
 
 [[package]]
 name = "fastrand"
-version = "2.1.1"
+version = "2.2.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e8c02a5121d4ea3eb16a80748c74f5549a5665e4c21333c6098f283870fbdea6"
+checksum = "486f806e73c5707928240ddc295403b1b93c96a02038563881c4a2fd84b81ac4"
 
 [[package]]
 name = "filetime"
@@ -197,9 +197,9 @@ dependencies = [
 
 [[package]]
 name = "hashbrown"
-version = "0.15.0"
+version = "0.15.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1e087f84d4f86bf4b218b927129862374b72199ae7d8657835f1e89000eea4fb"
+checksum = "3a9bfc1af68b1726ea47d3d5109de126281def866b33970e10fbab11b5dafab3"
 
 [[package]]
 name = "heck"
@@ -286,9 +286,9 @@ dependencies = [
 
 [[package]]
 name = "libc"
-version = "0.2.161"
+version = "0.2.162"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8e9489c2807c139ffd9c1794f4af0ebe86a828db53ecdc7fea2111d0fed085d1"
+checksum = "18d287de67fe55fd7e1581fe933d965a5a9477b38e949cfa9f8574ef01506398"
 
 [[package]]
 name = "libredox"
@@ -438,9 +438,9 @@ dependencies = [
 
 [[package]]
 name = "rustix"
-version = "0.38.38"
+version = "0.38.40"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "aa260229e6538e52293eeb577aabd09945a09d6d9cc0fc550ed7529056c2e32a"
+checksum = "99e4ea3e1cdc4b559b8e5650f9c8e5998e3e5c1343b4eaf034565f32318d63c0"
 dependencies = [
  "bitflags 2.6.0",
  "errno",
@@ -451,7 +451,7 @@ dependencies = [
 
 [[package]]
 name = "rustlings"
-version = "6.3.0"
+version = "6.4.0"
 dependencies = [
  "anyhow",
  "clap",
@@ -468,7 +468,7 @@ dependencies = [
 
 [[package]]
 name = "rustlings-macros"
-version = "6.3.0"
+version = "6.4.0"
 dependencies = [
  "quote",
  "serde",
@@ -581,9 +581,9 @@ checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f"
 
 [[package]]
 name = "syn"
-version = "2.0.85"
+version = "2.0.87"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5023162dfcd14ef8f32034d8bcd4cc5ddc61ef7a247c024a33e24e1f24d21b56"
+checksum = "25aa4ce346d03a6dcd68dd8b4010bcb74e54e62c90c573f394c46eae99aba32d"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -592,9 +592,9 @@ dependencies = [
 
 [[package]]
 name = "tempfile"
-version = "3.13.0"
+version = "3.14.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f0f2c9fc62d0beef6951ccffd757e241266a2c833136efbe35af6cd2567dca5b"
+checksum = "28cce251fcbc87fac86a866eeb0d6c2d536fc16d06f184bb61aeae11aa4cee0c"
 dependencies = [
  "cfg-if",
  "fastrand",

Cargo.toml

@@ -6,7 +6,7 @@ exclude = [
 ]
 
 [workspace.package]
-version = "6.3.0"
+version = "6.4.0"
 authors = [
   "Mo Bitar <mo8it@proton.me>", # https://github.com/mo8it
   "Liv <mokou@fastmail.com>", # https://github.com/shadows-withal
@@ -46,12 +46,12 @@ include = [
 ]
 
 [dependencies]
-anyhow = "1.0.91"
+anyhow = "1.0.93"
 clap = { version = "4.5.20", features = ["derive"] }
 crossterm = { version = "0.28.1", default-features = false, features = ["windows", "events"] }
 notify = "7.0.0"
 os_pipe = "1.2.1"
-rustlings-macros = { path = "rustlings-macros", version = "=6.3.0" }
+rustlings-macros = { path = "rustlings-macros", version = "=6.4.0" }
 serde_json = "1.0.132"
 serde.workspace = true
 toml_edit.workspace = true
@@ -60,7 +60,7 @@ toml_edit.workspace = true
 rustix = { version = "0.38.38", default-features = false, features = ["std", "stdio", "termios"] }
 
 [dev-dependencies]
-tempfile = "3.13.0"
+tempfile = "3.14.0"
 
 [profile.release]
 panic = "abort"
@@ -70,6 +70,7 @@ panic = "abort"
 
 [package.metadata.release]
 pre-release-hook = ["./release-hook.sh"]
+pre-release-commit-message = "Release 🎉"
 
 [workspace.lints.rust]
 unsafe_code = "forbid"

dev/Cargo.toml

@@ -116,6 +116,8 @@ bin = [
   { name = "generics1_sol", path = "../solutions/14_generics/generics1.rs" },
   { name = "generics2", path = "../exercises/14_generics/generics2.rs" },
   { name = "generics2_sol", path = "../solutions/14_generics/generics2.rs" },
+  { name = "generics3", path = "../exercises/14_generics/generics3.rs" },
+  { name = "generics3_sol", path = "../solutions/14_generics/generics3.rs" },
   { name = "traits1", path = "../exercises/15_traits/traits1.rs" },
   { name = "traits1_sol", path = "../solutions/15_traits/traits1.rs" },
   { name = "traits2", path = "../exercises/15_traits/traits2.rs" },

exercises/14_generics/generics3.rs

@@ -0,0 +1,54 @@
+// generics3.rs
+// Execute `rustlings hint generics3` or use the `hint` watch subcommand for a hint.
+
+// This function should take an array of `Option` elements and returns array of not None elements
+// TODO fix this function signature
+fn into_dispose_nulls(list: Vec<Option<&str>>) -> Vec<&str> {
+    list.into_iter().flatten().collect()
+}
+
+fn main() {
+    // You can optionally experiment here.
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn store_str_on_list() {
+        let names_list = vec![Some("maria"), Some("jacob"), None, Some("kacper"), None];
+        let only_values = into_dispose_nulls(names_list);
+        assert_eq!(only_values.len(), 3);
+    }
+
+    #[test]
+    fn store_numbers_on_list() {
+        let numbers_list = vec![Some(1), Some(2), None, Some(3)];
+        let only_values = into_dispose_nulls(numbers_list);
+        assert_eq!(only_values.len(), 3);
+    }
+
+    #[test]
+    fn store_custom_type_on_list() {
+        #[allow(dead_code)]
+        struct Rectangle {
+            width: i32,
+            height: i32,
+        }
+        impl Rectangle {
+            fn new(width: i32, height: i32) -> Self {
+                Self { width, height }
+            }
+        }
+
+        let custom_list = vec![
+            Some(Rectangle::new(1, 2)),
+            None,
+            None,
+            Some(Rectangle::new(3, 4)),
+        ];
+        let only_values = into_dispose_nulls(custom_list);
+        assert_eq!(only_values.len(), 2);
+    }
+}

release-hook.sh

@@ -11,3 +11,6 @@ cargo clippy -- --deny warnings
 cargo fmt --all --check
 cargo test --workspace --all-targets
 cargo run -- dev check --require-solutions
+
+# MSRV
+cargo +1.80 run -- dev check --require-solutions

rustlings-macros/info.toml

@@ -745,6 +745,17 @@ hint = """
 Related section in The Book:
 https://doc.rust-lang.org/book/ch10-01-syntax.html#in-method-definitions"""
 
+[[exercises]]
+name = "generics3"
+dir = "14_generics"
+hint = """
+Vectors in Rust use generics to create dynamically-sized arrays of any type.
+The `into_dispose_nulls` function takes a vector as an argument, but only accepts vectors that store the &str type.
+To allow the function to accept vectors that store any type, you can leverage your knowledge about generics.
+If you're unsure how to proceed, please refer to the Rust Book at:
+https://doc.rust-lang.org/book/ch10-01-syntax.html#in-function-definitions.
+"""
+
 # TRAITS
 
 [[exercises]]

solutions/14_generics/generics3.rs

@@ -0,0 +1,53 @@
+// generics3.rs
+// Execute `rustlings hint generics3` or use the `hint` watch subcommand for a hint.
+
+// Here we added generic type `T` to function signature
+// Now this function can be used with vector of any
+fn into_dispose_nulls<T>(list: Vec<Option<T>>) -> Vec<T> {
+    list.into_iter().flatten().collect()
+}
+
+fn main() {
+    // You can optionally experiment here.
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn store_str_on_list() {
+        let names_list = vec![Some("maria"), Some("jacob"), None, Some("kacper"), None];
+        let only_values = into_dispose_nulls(names_list);
+        assert_eq!(only_values.len(), 3);
+    }
+
+    #[test]
+    fn store_numbers_on_list() {
+        let numbers_list = vec![Some(1), Some(2), None, Some(3)];
+        let only_values = into_dispose_nulls(numbers_list);
+        assert_eq!(only_values.len(), 3);
+    }
+
+    #[test]
+    fn store_custom_type_on_list() {
+        struct Rectangle {
+            width: i32,
+            height: i32,
+        }
+        impl Rectangle {
+            fn new(width: i32, height: i32) -> Self {
+                Self { width, height }
+            }
+        }
+
+        let custom_list = vec![
+            Some(Rectangle::new(1, 2)),
+            None,
+            None,
+            Some(Rectangle::new(3, 4)),
+        ];
+        let only_values = into_dispose_nulls(custom_list);
+        assert_eq!(only_values.len(), 2);
+    }
+}

src/list/state.rs

@@ -1,7 +1,9 @@
 use anyhow::{Context, Result};
 use crossterm::{
     cursor::{MoveTo, MoveToNextLine},
-    style::{Attribute, Color, ResetColor, SetAttribute, SetBackgroundColor, SetForegroundColor},
+    style::{
+        Attribute, Attributes, Color, ResetColor, SetAttribute, SetAttributes, SetForegroundColor,
+    },
     terminal::{self, BeginSynchronizedUpdate, Clear, ClearType, EndSynchronizedUpdate},
     QueueableCommand,
 };
@@ -19,6 +21,9 @@ use crate::{
 use super::scroll_state::ScrollState;
 
 const COL_SPACING: usize = 2;
+const SELECTED_ROW_ATTRIBUTES: Attributes = Attributes::none()
+    .with(Attribute::Reverse)
+    .with(Attribute::Bold);
 
 fn next_ln(stdout: &mut StdoutLock) -> io::Result<()> {
     stdout
@@ -41,6 +46,7 @@ pub struct ListState<'a> {
     app_state: &'a mut AppState,
     scroll_state: ScrollState,
     name_col_padding: Vec<u8>,
+    path_col_padding: Vec<u8>,
     filter: Filter,
     term_width: u16,
     term_height: u16,
@@ -52,13 +58,18 @@ impl<'a> ListState<'a> {
         stdout.queue(Clear(ClearType::All))?;
 
         let name_col_title_len = 4;
-        let name_col_width = app_state
-            .exercises()
-            .iter()
-            .map(|exercise| exercise.name.len())
-            .max()
-            .map_or(name_col_title_len, |max| max.max(name_col_title_len));
+        let path_col_title_len = 4;
+        let (name_col_width, path_col_width) = app_state.exercises().iter().fold(
+            (name_col_title_len, path_col_title_len),
+            |(name_col_width, path_col_width), exercise| {
+                (
+                    name_col_width.max(exercise.name.len()),
+                    path_col_width.max(exercise.path.len()),
+                )
+            },
+        );
         let name_col_padding = vec![b' '; name_col_width + COL_SPACING];
+        let path_col_padding = vec![b' '; path_col_width];
 
         let filter = Filter::None;
         let n_rows_with_filter = app_state.exercises().len();
@@ -73,6 +84,7 @@ impl<'a> ListState<'a> {
             app_state,
             scroll_state,
             name_col_padding,
+            path_col_padding,
             filter,
             // Set by `set_term_size`
             term_width: 0,
@@ -105,7 +117,7 @@ impl<'a> ListState<'a> {
         );
     }
 
-    fn draw_exericse_name(&self, writer: &mut MaxLenWriter, exercise: &Exercise) -> io::Result<()> {
+    fn draw_exercise_name(&self, writer: &mut MaxLenWriter, exercise: &Exercise) -> io::Result<()> {
         if !self.search_query.is_empty() {
             if let Some((pre_highlight, highlight, post_highlight)) = exercise
                 .name
@@ -119,7 +131,7 @@ impl<'a> ListState<'a> {
                 writer.write_str(pre_highlight)?;
                 writer.stdout.queue(SetForegroundColor(Color::Magenta))?;
                 writer.write_str(highlight)?;
-                writer.stdout.queue(ResetColor)?;
+                writer.stdout.queue(SetForegroundColor(Color::Reset))?;
                 return writer.write_str(post_highlight);
             }
         }
@@ -143,14 +155,12 @@ impl<'a> ListState<'a> {
             let mut writer = MaxLenWriter::new(stdout, self.term_width as usize);
 
             if self.scroll_state.selected() == Some(row_offset + n_displayed_rows) {
-                writer.stdout.queue(SetBackgroundColor(Color::Rgb {
-                    r: 40,
-                    g: 40,
-                    b: 40,
-                }))?;
                 // The crab emoji has the width of two ascii chars.
                 writer.add_to_len(2);
                 writer.stdout.write_all("🦀".as_bytes())?;
+                writer
+                    .stdout
+                    .queue(SetAttributes(SELECTED_ROW_ATTRIBUTES))?;
             } else {
                 writer.write_ascii(b"  ")?;
             }
@@ -164,14 +174,15 @@ impl<'a> ListState<'a> {
 
             if exercise.done {
                 writer.stdout.queue(SetForegroundColor(Color::Green))?;
-                writer.write_ascii(b"DONE     ")?;
+                writer.write_ascii(b"DONE   ")?;
             } else {
                 writer.stdout.queue(SetForegroundColor(Color::Yellow))?;
-                writer.write_ascii(b"PENDING  ")?;
+                writer.write_ascii(b"PENDING")?;
             }
             writer.stdout.queue(SetForegroundColor(Color::Reset))?;
+            writer.write_ascii(b"  ")?;
 
-            self.draw_exericse_name(&mut writer, exercise)?;
+            self.draw_exercise_name(&mut writer, exercise)?;
 
             writer.write_ascii(&self.name_col_padding[exercise.name.len()..])?;
 
@@ -183,6 +194,8 @@ impl<'a> ListState<'a> {
                 exercise.terminal_file_link(&mut writer)?;
             }
 
+            writer.write_ascii(&self.path_col_padding[exercise.path.len()..])?;
+
             next_ln(stdout)?;
             stdout.queue(ResetColor)?;
             n_displayed_rows += 1;

src/watch/state.rs

@@ -20,6 +20,10 @@ use crate::{
 
 use super::{terminal_event::terminal_event_handler, InputPauseGuard, WatchEvent};
 
+const HEADING_ATTRIBUTES: Attributes = Attributes::none()
+    .with(Attribute::Bold)
+    .with(Attribute::Underlined);
+
 #[derive(PartialEq, Eq)]
 enum DoneStatus {
     DoneWithSolution(String),
@@ -209,9 +213,7 @@ impl<'a> WatchState<'a> {
 
         if self.show_hint {
             stdout
-                .queue(SetAttributes(
-                    Attributes::from(Attribute::Bold).with(Attribute::Underlined),
-                ))?
+                .queue(SetAttributes(HEADING_ATTRIBUTES))?
                 .queue(SetForegroundColor(Color::Cyan))?;
             stdout.write_all(b"Hint")?;
             stdout.queue(ResetColor)?;
@@ -267,6 +269,9 @@ impl<'a> WatchState<'a> {
     }
 
     pub fn check_all_exercises(&mut self, stdout: &mut StdoutLock) -> Result<ExercisesProgress> {
+        // Ignore any input until checking all exercises is done.
+        let _input_pause_guard = InputPauseGuard::scoped_pause();
+
         if let Some(first_pending_exercise_ind) = self.app_state.check_all_exercises(stdout)? {
             // Only change exercise if the current one is done.
             if self.app_state.current_exercise().done {