Merge 9f517e4eb8 into 8df66f7991

update struct name in hashmap3

.github/workflows/rust.yml

@@ -35,7 +35,10 @@ jobs:
       - name: Run cargo test
         run: cargo test --workspace
   dev-check:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macOS-latest]
     steps:
       - uses: actions/checkout@v4
       - uses: swatinem/rust-cache@v2

CHANGELOG.md

@@ -1,8 +1,10 @@
-<a name="6.1.1"></a>
+<a name="6.2.0"></a>
 
-## 6.1.1 (UNRELEASED)
+## 6.2.0 (2024-08-08)
 
 - Show a helpful error message when trying to install Rustlings with a Rust version lower than the minimum one that Rustlings supports.
+- Remove the state file and the solutions directory from the generated `.gitignore` file.
+- Add a `README.md` file to the `solutions/` directory.
 - Run the final check of all exercises in parallel.
 - Small exercise improvements.
 - `dev check`: Check that all solutions are formatted with `rustfmt`.

README.md

@@ -88,8 +88,6 @@ While working with Rustlings, please use a modern terminal for the best user exp
 The default terminal on Linux and Mac should be sufficient.
 On Windows, we recommend the [Windows Terminal](https://aka.ms/terminal).
 
-If you use VS Code, the builtin terminal should also be fine.
-
 ## Doing exercises
 
 The exercises are sorted by topic and can be found in the subdirectory `exercises/<topic>`.

dev/Cargo.toml

@@ -195,3 +195,9 @@ name = "exercises"
 edition = "2021"
 # Don't publish the exercises on crates.io!
 publish = false
+
+[profile.release]
+panic = "abort"
+
+[profile.dev]
+panic = "abort"

exercises/11_hashmaps/hashmaps3.rs

@@ -10,12 +10,12 @@ use std::collections::HashMap;
 
 // A structure to store the goal details of a team.
 #[derive(Default)]
-struct Team {
+struct TeamScores {
     goals_scored: u8,
     goals_conceded: u8,
 }
 
-fn build_scores_table(results: &str) -> HashMap<&str, Team> {
+fn build_scores_table(results: &str) -> HashMap<&str, TeamScores> {
     // The name of the team is the key and its associated struct is the value.
     let mut scores = HashMap::new();
 

exercises/13_error_handling/errors6.rs

@@ -25,7 +25,7 @@ impl ParsePosNonzeroError {
     }
 
     // TODO: Add another error conversion function here.
-    // fn from_parseint(???) -> Self { ??? }
+    // fn from_parse_int(???) -> Self { ??? }
 }
 
 #[derive(PartialEq, Debug)]

release-hook.sh

@@ -9,6 +9,5 @@ cargo upgrades
 # Similar to CI
 cargo clippy -- --deny warnings
 cargo fmt --all --check
-rustfmt --check --edition 2021 solutions/**/*.rs
 cargo test --workspace --all-targets
 cargo run -- dev check --require-solutions

rustlings-macros/info.toml

@@ -571,7 +571,7 @@ name = "hashmaps3"
 dir = "11_hashmaps"
 hint = """
 Hint 1: Use the `entry()` and `or_insert()` (or `or_insert_with()`) methods of
-        `HashMap` to insert the default value of `Team` if a team doesn't
+        `HashMap` to insert the default value of `TeamScores` if a team doesn't
         exist in the table yet.
 
 Learn more in The Book:

solutions/11_hashmaps/hashmaps3.rs

@@ -10,12 +10,12 @@ use std::collections::HashMap;
 
 // A structure to store the goal details of a team.
 #[derive(Default)]
-struct Team {
+struct TeamScores {
     goals_scored: u8,
     goals_conceded: u8,
 }
 
-fn build_scores_table(results: &str) -> HashMap<&str, Team> {
+fn build_scores_table(results: &str) -> HashMap<&str, TeamScores> {
     // The name of the team is the key and its associated struct is the value.
     let mut scores = HashMap::new();
 
@@ -28,13 +28,17 @@ fn build_scores_table(results: &str) -> HashMap<&str, Team> {
         let team_2_score: u8 = split_iterator.next().unwrap().parse().unwrap();
 
         // Insert the default with zeros if a team doesn't exist yet.
-        let team_1 = scores.entry(team_1_name).or_insert_with(Team::default);
+        let team_1 = scores
+            .entry(team_1_name)
+            .or_insert_with(TeamScores::default);
         // Update the values.
         team_1.goals_scored += team_1_score;
         team_1.goals_conceded += team_2_score;
 
         // Similarely for the second team.
-        let team_2 = scores.entry(team_2_name).or_insert_with(Team::default);
+        let team_2 = scores
+            .entry(team_2_name)
+            .or_insert_with(TeamScores::default);
         team_2.goals_scored += team_2_score;
         team_2.goals_conceded += team_1_score;
     }

solutions/13_error_handling/errors6.rs

@@ -24,7 +24,7 @@ impl ParsePosNonzeroError {
         Self::Creation(err)
     }
 
-    fn from_parseint(err: ParseIntError) -> Self {
+    fn from_parse_int(err: ParseIntError) -> Self {
         Self::ParseInt(err)
     }
 }
@@ -44,7 +44,7 @@ impl PositiveNonzeroInteger {
     fn parse(s: &str) -> Result<Self, ParsePosNonzeroError> {
         // Return an appropriate error instead of panicking when `parse()`
         // returns an error.
-        let x: i64 = s.parse().map_err(ParsePosNonzeroError::from_parseint)?;
+        let x: i64 = s.parse().map_err(ParsePosNonzeroError::from_parse_int)?;
         //                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
         Self::new(x).map_err(ParsePosNonzeroError::from_creation)
     }

solutions/README.md

@@ -0,0 +1,6 @@
+# Official Rustlings solutions
+
+Before you finish an exercise, its solution file will only contain an empty `main` function.
+The content of this file will be automatically replaced by the actual solution once you finish the exercise.
+
+Note that these solution are often only _one possibility_ to solve an exercise.

src/cmd.rs

@@ -129,13 +129,6 @@ impl<'out> CargoSubcommand<'out> {
         self
     }
 
-    /// RUSTFLAGS="-A warnings"
-    #[inline]
-    pub fn hide_warnings(&mut self) -> &mut Self {
-        self.cmd.env("RUSTFLAGS", "-A warnings");
-        self
-    }
-
     /// The boolean in the returned `Result` is true if the command's exit status is success.
     #[inline]
     pub fn run(self, description: &str) -> Result<bool> {

src/dev/check.rs

@@ -175,22 +175,21 @@ fn check_exercises_unsolved(info_file: &InfoFile, cmd_runner: &CmdRunner) -> Res
                     return None;
                 }
 
-                Some(s.spawn(|| exercise_info.run_exercise(None, cmd_runner)))
+                Some((
+                    exercise_info.name.as_str(),
+                    s.spawn(|| exercise_info.run_exercise(None, cmd_runner)),
+                ))
             })
             .collect::<Vec<_>>();
 
-        for (exercise_info, handle) in info_file.exercises.iter().zip(handles) {
+        for (exercise_name, handle) in handles {
             let Ok(result) = handle.join() else {
-                bail!(
-                    "Panic while trying to run the exericse {}",
-                    exercise_info.name,
-                );
+                bail!("Panic while trying to run the exericse {exercise_name}");
             };
 
             match result {
                 Ok(true) => bail!(
-                    "The exercise {} is already solved.\n{SKIP_CHECK_UNSOLVED_HINT}",
-                    exercise_info.name,
+                    "The exercise {exercise_name} is already solved.\n{SKIP_CHECK_UNSOLVED_HINT}",
                 ),
                 Ok(false) => (),
                 Err(e) => return Err(e),

src/dev/new.rs

@@ -76,8 +76,8 @@ pub fn new(path: &Path, no_git: bool) -> Result<()> {
 
 pub const GITIGNORE: &[u8] = b".rustlings-state.txt
 Cargo.lock
-target
-.vscode
+target/
+.vscode/
 !.vscode/extensions.json
 ";
 

src/exercise.rs

@@ -78,27 +78,40 @@ pub trait RunnableExercise {
         mut output: Option<&mut Vec<u8>>,
         cmd_runner: &CmdRunner,
     ) -> Result<bool> {
-        let output_is_none = if let Some(output) = output.as_deref_mut() {
+        if let Some(output) = output.as_deref_mut() {
             output.clear();
-            false
-        } else {
-            true
-        };
-
-        let mut build_cmd = cmd_runner.cargo("build", bin_name, output.as_deref_mut());
-        if output_is_none {
-            build_cmd.hide_warnings();
         }
-        let build_success = build_cmd.run("cargo build …")?;
+
+        let build_success = cmd_runner
+            .cargo("build", bin_name, output.as_deref_mut())
+            .run("cargo build …")?;
         if !build_success {
             return Ok(false);
         }
 
-        // Discard the output of `cargo build` because it will be shown again by Clippy.
+        // Discard the compiler output because it will be shown again by `cargo test` or Clippy.
         if let Some(output) = output.as_deref_mut() {
             output.clear();
         }
 
+        if self.test() {
+            let output_is_some = output.is_some();
+            let mut test_cmd = cmd_runner.cargo("test", bin_name, output.as_deref_mut());
+            if output_is_some {
+                test_cmd.args(["--", "--color", "always", "--show-output"]);
+            }
+            let test_success = test_cmd.run("cargo test …")?;
+            if !test_success {
+                run_bin(bin_name, output, cmd_runner)?;
+                return Ok(false);
+            }
+
+            // Discard the compiler output because it will be shown again by Clippy.
+            if let Some(output) = output.as_deref_mut() {
+                output.clear();
+            }
+        }
+
         let mut clippy_cmd = cmd_runner.cargo("clippy", bin_name, output.as_deref_mut());
 
         // `--profile test` is required to also check code with `[cfg(test)]`.
@@ -109,25 +122,9 @@ pub trait RunnableExercise {
         }
 
         let clippy_success = clippy_cmd.run("cargo clippy …")?;
-        if !clippy_success {
-            return Ok(false);
-        }
-
-        if !self.test() {
-            return run_bin(bin_name, output.as_deref_mut(), cmd_runner);
-        }
-
-        let mut test_cmd = cmd_runner.cargo("test", bin_name, output.as_deref_mut());
-        if !output_is_none {
-            test_cmd.args(["--", "--color", "always", "--show-output"]);
-        }
-        // Hide warnings because they are shown by Clippy.
-        test_cmd.hide_warnings();
-        let test_success = test_cmd.run("cargo test …")?;
-
         let run_success = run_bin(bin_name, output, cmd_runner)?;
 
-        Ok(test_success && run_success)
+        Ok(clippy_success && run_success)
     }
 
     /// Compile, check and run the exercise.

src/init.rs

@@ -3,30 +3,40 @@ use ratatui::crossterm::style::Stylize;
 use std::{
     env::set_current_dir,
     fs::{self, create_dir},
-    io::ErrorKind,
+    io::{self, Write},
     path::Path,
     process::{Command, Stdio},
 };
 
-use crate::{cargo_toml::updated_cargo_toml, embedded::EMBEDDED_FILES, info_file::InfoFile};
+use crate::{
+    cargo_toml::updated_cargo_toml, embedded::EMBEDDED_FILES, info_file::InfoFile,
+    term::press_enter_prompt,
+};
 
 pub fn init() -> Result<()> {
-    // Prevent initialization in a directory that contains the file `Cargo.toml`.
-    // This can mean that Rustlings was already initialized in this directory.
-    // Otherwise, this can cause problems with Cargo workspaces.
+    let rustlings_dir = Path::new("rustlings");
+    if rustlings_dir.exists() {
+        bail!(RUSTLINGS_DIR_ALREADY_EXISTS_ERR);
+    }
+
+    let mut stdout = io::stdout().lock();
+    let mut init_git = true;
+
     if Path::new("Cargo.toml").exists() {
-        bail!(CARGO_TOML_EXISTS_ERR);
-    }
-
-    let rustlings_path = Path::new("rustlings");
-    if let Err(e) = create_dir(rustlings_path) {
-        if e.kind() == ErrorKind::AlreadyExists {
-            bail!(RUSTLINGS_DIR_ALREADY_EXISTS_ERR);
+        if Path::new("exercises").exists() && Path::new("solutions").exists() {
+            bail!(IN_INITIALIZED_DIR_ERR);
         }
-        return Err(e.into());
+
+        stdout.write_all(CARGO_TOML_EXISTS_PROMPT_MSG)?;
+        press_enter_prompt(&mut stdout)?;
+        init_git = false;
     }
 
-    set_current_dir("rustlings")
+    stdout.write_all(b"This command will create the directory `rustlings/` which will contain the exercises.\nPress ENTER to continue ")?;
+    press_enter_prompt(&mut stdout)?;
+
+    create_dir(rustlings_dir).context("Failed to create the `rustlings/` directory")?;
+    set_current_dir(rustlings_dir)
         .context("Failed to change the current directory to `rustlings/`")?;
 
     let info_file = InfoFile::parse()?;
@@ -35,6 +45,11 @@ pub fn init() -> Result<()> {
         .context("Failed to initialize the `rustlings/exercises` directory")?;
 
     create_dir("solutions").context("Failed to create the `solutions/` directory")?;
+    fs::write(
+        "solutions/README.md",
+        include_bytes!("../solutions/README.md"),
+    )
+    .context("Failed to create the file rustlings/solutions/README.md")?;
     for dir in EMBEDDED_FILES.exercise_dirs {
         let mut dir_path = String::with_capacity(10 + dir.name.len());
         dir_path.push_str("solutions/");
@@ -70,18 +85,21 @@ pub fn init() -> Result<()> {
     fs::write(".vscode/extensions.json", VS_CODE_EXTENSIONS_JSON)
         .context("Failed to create the file `rustlings/.vscode/extensions.json`")?;
 
-    // Ignore any Git error because Git initialization is not required.
-    let _ = Command::new("git")
-        .arg("init")
-        .stdin(Stdio::null())
-        .stderr(Stdio::null())
-        .status();
+    if init_git {
+        // Ignore any Git error because Git initialization is not required.
+        let _ = Command::new("git")
+            .arg("init")
+            .stdin(Stdio::null())
+            .stderr(Stdio::null())
+            .status();
+    }
 
-    println!(
+    writeln!(
+        stdout,
         "\n{}\n\n{}",
         "Initialization done ✓".green(),
         POST_INIT_MSG.bold(),
-    );
+    )?;
 
     Ok(())
 }
@@ -92,16 +110,14 @@ const INIT_SOLUTION_FILE: &[u8] = b"fn main() {
 }
 ";
 
-const GITIGNORE: &[u8] = b".rustlings-state.txt
-solutions
-Cargo.lock
-target
-.vscode
+const GITIGNORE: &[u8] = b"Cargo.lock
+target/
+.vscode/
 ";
 
 pub const VS_CODE_EXTENSIONS_JSON: &[u8] = br#"{"recommendations":["rust-lang.rust-analyzer"]}"#;
 
-const CARGO_TOML_EXISTS_ERR: &str = "The current directory contains the file `Cargo.toml`.
+const IN_INITIALIZED_DIR_ERR: &str = "It looks like Rustlings is already initialized in this directory.
 
 If you already initialized Rustlings, run the command `rustlings` for instructions on getting started with the exercises.
 Otherwise, please run `rustlings init` again in another directory.";
@@ -112,5 +128,19 @@ You probably already initialized Rustlings.
 Run `cd rustlings`
 Then run `rustlings` again";
 
+const CARGO_TOML_EXISTS_PROMPT_MSG: &[u8] = br#"You are about to initialize Rustlings in a directory that already contains a `Cargo.toml` file!
+
+  => It is recommended to abort with CTRL+C and initialize Rustlings in another directory <=
+
+If you know what you are doing and want to initialize Rustlings in a Cargo workspace,
+then you need to add its directory to `members` in the `workspace` section of the `Cargo.toml` file:
+
+```toml
+[workspace]
+members = ["rustlings"]
+```
+
+Press ENTER if you are sure that you want to continue after reading the warning above "#;
+
 const POST_INIT_MSG: &str = "Run `cd rustlings` to go into the generated directory.
 Then run `rustlings` to get started.";

src/main.rs

@@ -2,10 +2,11 @@ use anyhow::{bail, Context, Result};
 use app_state::StateFileStatus;
 use clap::{Parser, Subcommand};
 use std::{
-    io::{self, BufRead, IsTerminal, StdoutLock, Write},
+    io::{self, IsTerminal, Write},
     path::Path,
     process::exit,
 };
+use term::{clear_terminal, press_enter_prompt};
 
 use self::{app_state::AppState, dev::DevCommands, info_file::InfoFile, watch::WatchExit};
 
@@ -20,20 +21,12 @@ mod init;
 mod list;
 mod progress_bar;
 mod run;
+mod term;
 mod terminal_link;
 mod watch;
 
 const CURRENT_FORMAT_VERSION: u8 = 1;
 
-fn clear_terminal(stdout: &mut StdoutLock) -> io::Result<()> {
-    stdout.write_all(b"\x1b[H\x1b[2J\x1b[3J")
-}
-
-fn press_enter_prompt() -> io::Result<()> {
-    io::stdin().lock().read_until(b'\n', &mut Vec::new())?;
-    Ok(())
-}
-
 /// Rustlings is a collection of small exercises to get you used to writing and reading Rust code
 #[derive(Parser)]
 #[command(version)]
@@ -79,14 +72,6 @@ fn main() -> Result<()> {
 
     match args.command {
         Some(Subcommands::Init) => {
-            {
-                let mut stdout = io::stdout().lock();
-                stdout.write_all(b"This command will create the directory `rustlings/` which will contain the exercises.\nPress ENTER to continue ")?;
-                stdout.flush()?;
-                press_enter_prompt()?;
-                stdout.write_all(b"\n")?;
-            }
-
             return init::init().context("Initialization failed");
         }
         Some(Subcommands::Dev(dev_command)) => return dev_command.run(),
@@ -118,9 +103,10 @@ fn main() -> Result<()> {
 
                 let welcome_message = welcome_message.trim_ascii();
                 write!(stdout, "{welcome_message}\n\nPress ENTER to continue ")?;
-                stdout.flush()?;
-                press_enter_prompt()?;
+                press_enter_prompt(&mut stdout)?;
                 clear_terminal(&mut stdout)?;
+                // Flush to be able to show errors occuring before printing a newline to stdout.
+                stdout.flush()?;
             }
             StateFileStatus::Read => (),
         }

src/term.rs

@@ -0,0 +1,12 @@
+use std::io::{self, BufRead, StdoutLock, Write};
+
+pub fn clear_terminal(stdout: &mut StdoutLock) -> io::Result<()> {
+    stdout.write_all(b"\x1b[H\x1b[2J\x1b[3J")
+}
+
+pub fn press_enter_prompt(stdout: &mut StdoutLock) -> io::Result<()> {
+    stdout.flush()?;
+    io::stdin().lock().read_until(b'\n', &mut Vec::new())?;
+    stdout.write_all(b"\n")?;
+    Ok(())
+}