From 3dce7e56961a40748f428d10c50540a075839f8d Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Sat, 23 Mar 2024 18:51:25 +0100
Subject: [PATCH 01/25] Improvements to watch mode
---
Cargo.lock | 7 +++++
Cargo.toml | 1 +
src/main.rs | 87 ++++++++++++++++++++++++++++++-----------------------
3 files changed, 58 insertions(+), 37 deletions(-)
diff --git a/Cargo.lock b/Cargo.lock
index 3950c47..e86f9fa 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -536,6 +536,7 @@ dependencies = [
"regex",
"serde",
"serde_json",
+ "shlex",
"toml",
]
@@ -594,6 +595,12 @@ dependencies = [
"serde",
]
+[[package]]
+name = "shlex"
+version = "1.3.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64"
+
[[package]]
name = "strsim"
version = "0.11.0"
diff --git a/Cargo.toml b/Cargo.toml
index 218b799..2cf8bc3 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -18,6 +18,7 @@ notify-debouncer-mini = "0.4.1"
regex = "1.10.3"
serde_json = "1.0.114"
serde = { version = "1.0.197", features = ["derive"] }
+shlex = "1.3.0"
toml = "0.8.10"
[[bin]]
diff --git a/src/main.rs b/src/main.rs
index a06f0c5..7c469d5 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -6,6 +6,7 @@ use clap::{Parser, Subcommand};
use console::Emoji;
use notify_debouncer_mini::notify::{self, RecursiveMode};
use notify_debouncer_mini::{new_debouncer, DebouncedEventKind};
+use shlex::Shlex;
use std::ffi::OsStr;
use std::fs;
use std::io::{self, prelude::*};
@@ -25,6 +26,16 @@ mod project;
mod run;
mod verify;
+const WATCH_MODE_HELP_MESSAGE: &str = "Commands available to you in watch mode:
+ hint - prints the current exercise's hint
+ clear - clears the screen
+ quit - quits watch mode
+ !<cmd> - executes a command, like `!rustc --explain E0381`
+ help - displays this help message
+
+Watch mode automatically re-evaluates the current exercise
+when you edit a file's contents.";
+
/// Rustlings is a collection of small exercises to get you used to writing and reading Rust code
#[derive(Parser)]
#[command(version)]
@@ -246,47 +257,49 @@ fn main() {
}
fn spawn_watch_shell(
- failed_exercise_hint: &Arc<Mutex<Option<String>>>,
+ failed_exercise_hint: Arc<Mutex<Option<String>>>,
should_quit: Arc<AtomicBool>,
) {
- let failed_exercise_hint = Arc::clone(failed_exercise_hint);
println!("Welcome to watch mode! You can type 'help' to get an overview of the commands you can use here.");
- thread::spawn(move || loop {
+
+ thread::spawn(move || {
let mut input = String::new();
- match io::stdin().read_line(&mut input) {
- Ok(_) => {
- let input = input.trim();
- if input == "hint" {
- if let Some(hint) = &*failed_exercise_hint.lock().unwrap() {
- println!("{hint}");
- }
- } else if input == "clear" {
- println!("\x1B[2J\x1B[1;1H");
- } else if input.eq("quit") {
- should_quit.store(true, Ordering::SeqCst);
- println!("Bye!");
- } else if input.eq("help") {
- println!("Commands available to you in watch mode:");
- println!(" hint - prints the current exercise's hint");
- println!(" clear - clears the screen");
- println!(" quit - quits watch mode");
- println!(" !<cmd> - executes a command, like `!rustc --explain E0381`");
- println!(" help - displays this help message");
- println!();
- println!("Watch mode automatically re-evaluates the current exercise");
- println!("when you edit a file's contents.")
- } else if let Some(cmd) = input.strip_prefix('!') {
- let parts: Vec<&str> = cmd.split_whitespace().collect();
- if parts.is_empty() {
- println!("no command provided");
- } else if let Err(e) = Command::new(parts[0]).args(&parts[1..]).status() {
- println!("failed to execute command `{}`: {}", cmd, e);
- }
- } else {
- println!("unknown command: {input}");
- }
+ let mut stdin = io::stdin().lock();
+
+ loop {
+ // Recycle input buffer.
+ input.clear();
+
+ if let Err(e) = stdin.read_line(&mut input) {
+ println!("error reading command: {e}");
+ }
+
+ let input = input.trim();
+ if input == "hint" {
+ if let Some(hint) = &*failed_exercise_hint.lock().unwrap() {
+ println!("{hint}");
+ }
+ } else if input == "clear" {
+ println!("\x1B[2J\x1B[1;1H");
+ } else if input == "quit" {
+ should_quit.store(true, Ordering::SeqCst);
+ println!("Bye!");
+ } else if input == "help" {
+ println!("{WATCH_MODE_HELP_MESSAGE}");
+ } else if let Some(cmd) = input.strip_prefix('!') {
+ let mut parts = Shlex::new(cmd);
+
+ let Some(program) = parts.next() else {
+ println!("no command provided");
+ continue;
+ };
+
+ if let Err(e) = Command::new(program).args(parts).status() {
+ println!("failed to execute command `{cmd}`: {e}");
+ }
+ } else {
+ println!("unknown command: {input}\n{WATCH_MODE_HELP_MESSAGE}");
}
- Err(error) => println!("error reading command: {error}"),
}
});
}
@@ -348,7 +361,7 @@ fn watch(
Ok(_) => return Ok(WatchStatus::Finished),
Err(exercise) => Arc::new(Mutex::new(Some(to_owned_hint(exercise)))),
};
- spawn_watch_shell(&failed_exercise_hint, Arc::clone(&should_quit));
+ spawn_watch_shell(Arc::clone(&failed_exercise_hint), Arc::clone(&should_quit));
loop {
match rx.recv_timeout(Duration::from_secs(1)) {
Ok(event) => match event {
From 0d93266462f56d28501f068a764405a0cd0bf41a Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Sat, 23 Mar 2024 18:56:30 +0100
Subject: [PATCH 02/25] Initialize the input buffer with some capacity
---
src/main.rs | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main.rs b/src/main.rs
index 7c469d5..2b6a48c 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -263,7 +263,7 @@ fn spawn_watch_shell(
println!("Welcome to watch mode! You can type 'help' to get an overview of the commands you can use here.");
thread::spawn(move || {
- let mut input = String::new();
+ let mut input = String::with_capacity(32);
let mut stdin = io::stdin().lock();
loop {
From 27fa7c3e4a5bb58b21359e9d6246f66b5f20a978 Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Sat, 23 Mar 2024 19:00:15 +0100
Subject: [PATCH 03/25] Move the const string to the bottom like others
---
src/main.rs | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/src/main.rs b/src/main.rs
index 2b6a48c..d2614df 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -26,16 +26,6 @@ mod project;
mod run;
mod verify;
-const WATCH_MODE_HELP_MESSAGE: &str = "Commands available to you in watch mode:
- hint - prints the current exercise's hint
- clear - clears the screen
- quit - quits watch mode
- !<cmd> - executes a command, like `!rustc --explain E0381`
- help - displays this help message
-
-Watch mode automatically re-evaluates the current exercise
-when you edit a file's contents.";
-
/// Rustlings is a collection of small exercises to get you used to writing and reading Rust code
#[derive(Parser)]
#[command(version)]
@@ -490,3 +480,13 @@ const WELCOME: &str = r" welcome to...
| | | |_| \__ \ |_| | | | | | (_| \__ \
|_| \__,_|___/\__|_|_|_| |_|\__, |___/
|___/";
+
+const WATCH_MODE_HELP_MESSAGE: &str = "Commands available to you in watch mode:
+ hint - prints the current exercise's hint
+ clear - clears the screen
+ quit - quits watch mode
+ !<cmd> - executes a command, like `!rustc --explain E0381`
+ help - displays this help message
+
+Watch mode automatically re-evaluates the current exercise
+when you edit a file's contents.";
From a325df55d1077c8613905bb82709cd8c80341641 Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Sat, 23 Mar 2024 21:56:40 +0100
Subject: [PATCH 04/25] Cache filters
---
src/main.rs | 39 +++++++++++++++++++++++++++------------
1 file changed, 27 insertions(+), 12 deletions(-)
diff --git a/src/main.rs b/src/main.rs
index a06f0c5..9bf5866 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -128,31 +128,45 @@ fn main() {
println!("{:<17}\t{:<46}\t{:<7}", "Name", "Path", "Status");
}
let mut exercises_done: u16 = 0;
- let filters = filter.clone().unwrap_or_default().to_lowercase();
- exercises.iter().for_each(|e| {
- let fname = format!("{}", e.path.display());
+ let lowercase_filter = filter
+ .as_ref()
+ .map(|s| s.to_lowercase())
+ .unwrap_or_default();
+ let filters = lowercase_filter
+ .split(',')
+ .filter_map(|f| {
+ let f = f.trim();
+ if f.is_empty() {
+ None
+ } else {
+ Some(f)
+ }
+ })
+ .collect::<Vec<_>>();
+
+ for exercise in &exercises {
+ let fname = format!("{}", exercise.path.display());
let filter_cond = filters
- .split(',')
- .filter(|f| !f.trim().is_empty())
- .any(|f| e.name.contains(f) || fname.contains(f));
- let status = if e.looks_done() {
+ .iter()
+ .any(|f| exercise.name.contains(f) || fname.contains(f));
+ let status = if exercise.looks_done() {
exercises_done += 1;
"Done"
} else {
"Pending"
};
let solve_cond = {
- (e.looks_done() && solved)
- || (!e.looks_done() && unsolved)
+ (exercise.looks_done() && solved)
+ || (!exercise.looks_done() && unsolved)
|| (!solved && !unsolved)
};
if solve_cond && (filter_cond || filter.is_none()) {
let line = if paths {
format!("{fname}\n")
} else if names {
- format!("{}\n", e.name)
+ format!("{}\n", exercise.name)
} else {
- format!("{:<17}\t{fname:<46}\t{status:<7}\n", e.name)
+ format!("{:<17}\t{fname:<46}\t{status:<7}\n", exercise.name)
};
// Somehow using println! leads to the binary panicking
// when its output is piped.
@@ -168,7 +182,8 @@ fn main() {
});
}
}
- });
+ }
+
let percentage_progress = exercises_done as f32 / exercises.len() as f32 * 100.0;
println!(
"Progress: You completed {} / {} exercises ({:.1} %).",
From 01b7d6334c44d55f11d7f09c45e76b2db7fef948 Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Sat, 23 Mar 2024 22:08:25 +0100
Subject: [PATCH 05/25] Remove unneeded to_string call
---
src/verify.rs | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/verify.rs b/src/verify.rs
index aee2afa..e3a8e88 100644
--- a/src/verify.rs
+++ b/src/verify.rs
@@ -224,7 +224,7 @@ fn prompt_for_completion(
let formatted_line = if context_line.important {
format!("{}", style(context_line.line).bold())
} else {
- context_line.line.to_string()
+ context_line.line
};
println!(
From 0aeaccc3a50b5b60b6005161847641bade75effa Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Sun, 24 Mar 2024 18:34:46 +0100
Subject: [PATCH 06/25] Optimize state
---
src/exercise.rs | 112 ++++++++++++++++++++++++++++++++----------------
1 file changed, 75 insertions(+), 37 deletions(-)
diff --git a/src/exercise.rs b/src/exercise.rs
index 664b362..b112fe8 100644
--- a/src/exercise.rs
+++ b/src/exercise.rs
@@ -1,16 +1,16 @@
use regex::Regex;
use serde::Deserialize;
-use std::env;
use std::fmt::{self, Display, Formatter};
use std::fs::{self, remove_file, File};
-use std::io::Read;
+use std::io::{self, BufRead, BufReader};
use std::path::PathBuf;
use std::process::{self, Command};
+use std::{array, env, mem};
const RUSTC_COLOR_ARGS: &[&str] = &["--color", "always"];
const RUSTC_EDITION_ARGS: &[&str] = &["--edition", "2021"];
const RUSTC_NO_DEBUG_ARGS: &[&str] = &["-C", "strip=debuginfo"];
-const I_AM_DONE_REGEX: &str = r"(?m)^\s*///?\s*I\s+AM\s+NOT\s+DONE";
+const I_AM_DONE_REGEX: &str = r"^\s*///?\s*I\s+AM\s+NOT\s+DONE";
const CONTEXT: usize = 2;
const CLIPPY_CARGO_TOML_PATH: &str = "./exercises/22_clippy/Cargo.toml";
@@ -205,51 +205,89 @@ path = "{}.rs""#,
}
pub fn state(&self) -> State {
- let mut source_file = File::open(&self.path).unwrap_or_else(|e| {
+ let source_file = File::open(&self.path).unwrap_or_else(|e| {
panic!(
"We were unable to open the exercise file {}! {e}",
self.path.display()
)
});
-
- let source = {
- let mut s = String::new();
- source_file.read_to_string(&mut s).unwrap_or_else(|e| {
- panic!(
- "We were unable to read the exercise file {}! {e}",
- self.path.display()
- )
- });
- s
+ let mut source_reader = BufReader::new(source_file);
+ let mut read_line = |buf: &mut String| -> io::Result<_> {
+ let n = source_reader.read_line(buf)?;
+ if buf.ends_with('\n') {
+ buf.pop();
+ if buf.ends_with('\r') {
+ buf.pop();
+ }
+ }
+ Ok(n)
};
let re = Regex::new(I_AM_DONE_REGEX).unwrap();
+ let mut matched_line_ind: usize = 0;
+ let mut prev_lines: [_; CONTEXT] = array::from_fn(|_| String::with_capacity(256));
+ let mut line = String::with_capacity(256);
- if !re.is_match(&source) {
- return State::Done;
+ loop {
+ match read_line(&mut line) {
+ Ok(0) => break,
+ Ok(_) => {
+ if re.is_match(&line) {
+ let mut context = Vec::with_capacity(2 * CONTEXT + 1);
+ for (ind, prev_line) in prev_lines
+ .into_iter()
+ .rev()
+ .take(matched_line_ind)
+ .enumerate()
+ {
+ context.push(ContextLine {
+ line: prev_line,
+ // TODO
+ number: matched_line_ind - CONTEXT + ind + 1,
+ important: false,
+ });
+ }
+
+ context.push(ContextLine {
+ line,
+ number: matched_line_ind + 1,
+ important: true,
+ });
+
+ for ind in 0..CONTEXT {
+ let mut next_line = String::with_capacity(256);
+ let Ok(n) = read_line(&mut next_line) else {
+ break;
+ };
+
+ if n == 0 {
+ break;
+ }
+
+ context.push(ContextLine {
+ line: next_line,
+ number: matched_line_ind + ind + 2,
+ important: false,
+ });
+ }
+
+ return State::Pending(context);
+ }
+
+ matched_line_ind += 1;
+ for prev_line in &mut prev_lines {
+ mem::swap(&mut line, prev_line);
+ }
+ line.clear();
+ }
+ Err(e) => panic!(
+ "We were unable to read the exercise file {}! {e}",
+ self.path.display()
+ ),
+ }
}
- let matched_line_index = source
- .lines()
- .enumerate()
- .find_map(|(i, line)| if re.is_match(line) { Some(i) } else { None })
- .expect("This should not happen at all");
-
- let min_line = ((matched_line_index as i32) - (CONTEXT as i32)).max(0) as usize;
- let max_line = matched_line_index + CONTEXT;
-
- let context = source
- .lines()
- .enumerate()
- .filter(|&(i, _)| i >= min_line && i <= max_line)
- .map(|(i, line)| ContextLine {
- line: line.to_string(),
- number: i + 1,
- important: i == matched_line_index,
- })
- .collect();
-
- State::Pending(context)
+ State::Done
}
// Check that the exercise looks to be solved using self.state()
From e1375ef4319641749611124ae495346d32e04e2d Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Sun, 24 Mar 2024 18:47:27 +0100
Subject: [PATCH 07/25] Use to_string_lossy
---
src/main.rs | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main.rs b/src/main.rs
index 9bf5866..067c810 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -145,7 +145,7 @@ fn main() {
.collect::<Vec<_>>();
for exercise in &exercises {
- let fname = format!("{}", exercise.path.display());
+ let fname = exercise.path.to_string_lossy();
let filter_cond = filters
.iter()
.any(|f| exercise.name.contains(f) || fname.contains(f));
From f205ee3d4c6f259c82e4f1226acc6a5ae5e70031 Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Sun, 24 Mar 2024 18:50:46 +0100
Subject: [PATCH 08/25] Call looks_done only once
---
src/main.rs | 10 ++++------
1 file changed, 4 insertions(+), 6 deletions(-)
diff --git a/src/main.rs b/src/main.rs
index 067c810..f646fdc 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -149,17 +149,15 @@ fn main() {
let filter_cond = filters
.iter()
.any(|f| exercise.name.contains(f) || fname.contains(f));
- let status = if exercise.looks_done() {
+ let looks_done = exercise.looks_done();
+ let status = if looks_done {
exercises_done += 1;
"Done"
} else {
"Pending"
};
- let solve_cond = {
- (exercise.looks_done() && solved)
- || (!exercise.looks_done() && unsolved)
- || (!solved && !unsolved)
- };
+ let solve_cond =
+ (looks_done && solved) || (!looks_done && unsolved) || (!solved && !unsolved);
if solve_cond && (filter_cond || filter.is_none()) {
let line = if paths {
format!("{fname}\n")
From c0c112985b531bbcf503a2b1a8c2764030a16c99 Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Sun, 24 Mar 2024 19:18:19 +0100
Subject: [PATCH 09/25] Replace regex with winnow
---
Cargo.lock | 2 +-
Cargo.toml | 2 +-
src/exercise.rs | 44 ++++++++++++++++++++++++++++++++++++++++----
3 files changed, 42 insertions(+), 6 deletions(-)
diff --git a/Cargo.lock b/Cargo.lock
index 3950c47..e42b8f4 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -533,10 +533,10 @@ dependencies = [
"indicatif",
"notify-debouncer-mini",
"predicates",
- "regex",
"serde",
"serde_json",
"toml",
+ "winnow",
]
[[package]]
diff --git a/Cargo.toml b/Cargo.toml
index 218b799..dd4c0c3 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -15,10 +15,10 @@ glob = "0.3.0"
home = "0.5.9"
indicatif = "0.17.8"
notify-debouncer-mini = "0.4.1"
-regex = "1.10.3"
serde_json = "1.0.114"
serde = { version = "1.0.197", features = ["derive"] }
toml = "0.8.10"
+winnow = "0.6.5"
[[bin]]
name = "rustlings"
diff --git a/src/exercise.rs b/src/exercise.rs
index b112fe8..8f580d3 100644
--- a/src/exercise.rs
+++ b/src/exercise.rs
@@ -1,4 +1,3 @@
-use regex::Regex;
use serde::Deserialize;
use std::fmt::{self, Display, Formatter};
use std::fs::{self, remove_file, File};
@@ -6,14 +5,34 @@ use std::io::{self, BufRead, BufReader};
use std::path::PathBuf;
use std::process::{self, Command};
use std::{array, env, mem};
+use winnow::ascii::{space0, space1};
+use winnow::combinator::opt;
+use winnow::Parser;
const RUSTC_COLOR_ARGS: &[&str] = &["--color", "always"];
const RUSTC_EDITION_ARGS: &[&str] = &["--edition", "2021"];
const RUSTC_NO_DEBUG_ARGS: &[&str] = &["-C", "strip=debuginfo"];
-const I_AM_DONE_REGEX: &str = r"^\s*///?\s*I\s+AM\s+NOT\s+DONE";
const CONTEXT: usize = 2;
const CLIPPY_CARGO_TOML_PATH: &str = "./exercises/22_clippy/Cargo.toml";
+fn not_done(input: &str) -> bool {
+ (
+ space0::<_, ()>,
+ "//",
+ opt('/'),
+ space0,
+ 'I',
+ space1,
+ "AM",
+ space1,
+ "NOT",
+ space1,
+ "DONE",
+ )
+ .parse_next(&mut &*input)
+ .is_ok()
+}
+
// Get a temporary file name that is hopefully unique
#[inline]
fn temp_file() -> String {
@@ -223,7 +242,6 @@ path = "{}.rs""#,
Ok(n)
};
- let re = Regex::new(I_AM_DONE_REGEX).unwrap();
let mut matched_line_ind: usize = 0;
let mut prev_lines: [_; CONTEXT] = array::from_fn(|_| String::with_capacity(256));
let mut line = String::with_capacity(256);
@@ -232,7 +250,7 @@ path = "{}.rs""#,
match read_line(&mut line) {
Ok(0) => break,
Ok(_) => {
- if re.is_match(&line) {
+ if not_done(&line) {
let mut context = Vec::with_capacity(2 * CONTEXT + 1);
for (ind, prev_line) in prev_lines
.into_iter()
@@ -413,4 +431,22 @@ mod test {
let out = exercise.compile().unwrap().run().unwrap();
assert!(out.stdout.contains("THIS TEST TOO SHALL PASS"));
}
+
+ #[test]
+ fn test_not_done() {
+ assert!(not_done("// I AM NOT DONE"));
+ assert!(not_done("/// I AM NOT DONE"));
+ assert!(not_done("// I AM NOT DONE"));
+ assert!(not_done("/// I AM NOT DONE"));
+ assert!(not_done("// I AM NOT DONE"));
+ assert!(not_done("// I AM NOT DONE"));
+ assert!(not_done("// I AM NOT DONE"));
+ assert!(not_done("// I AM NOT DONE "));
+ assert!(not_done("// I AM NOT DONE!"));
+
+ assert!(!not_done("I AM NOT DONE"));
+ assert!(!not_done("// NOT DONE"));
+ assert!(!not_done("DONE"));
+ assert!(!not_done("// i am not done"));
+ }
}
From bdf826a026cfe7f89c31433cfd2b9a32cbe66d2c Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Sun, 24 Mar 2024 22:22:55 +0100
Subject: [PATCH 10/25] Make "I AM NOT DONE" caseless
---
src/exercise.rs | 16 ++++------------
1 file changed, 4 insertions(+), 12 deletions(-)
diff --git a/src/exercise.rs b/src/exercise.rs
index 8f580d3..136e943 100644
--- a/src/exercise.rs
+++ b/src/exercise.rs
@@ -5,7 +5,7 @@ use std::io::{self, BufRead, BufReader};
use std::path::PathBuf;
use std::process::{self, Command};
use std::{array, env, mem};
-use winnow::ascii::{space0, space1};
+use winnow::ascii::{space0, Caseless};
use winnow::combinator::opt;
use winnow::Parser;
@@ -21,13 +21,7 @@ fn not_done(input: &str) -> bool {
"//",
opt('/'),
space0,
- 'I',
- space1,
- "AM",
- space1,
- "NOT",
- space1,
- "DONE",
+ Caseless("I AM NOT DONE"),
)
.parse_next(&mut &*input)
.is_ok()
@@ -438,15 +432,13 @@ mod test {
assert!(not_done("/// I AM NOT DONE"));
assert!(not_done("// I AM NOT DONE"));
assert!(not_done("/// I AM NOT DONE"));
- assert!(not_done("// I AM NOT DONE"));
- assert!(not_done("// I AM NOT DONE"));
- assert!(not_done("// I AM NOT DONE"));
assert!(not_done("// I AM NOT DONE "));
assert!(not_done("// I AM NOT DONE!"));
+ assert!(not_done("// I am not done"));
+ assert!(not_done("// i am NOT done"));
assert!(!not_done("I AM NOT DONE"));
assert!(!not_done("// NOT DONE"));
assert!(!not_done("DONE"));
- assert!(!not_done("// i am not done"));
}
}
From 51b4c240ed006a8279bd94e9b7ed5df67086c86e Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Mon, 25 Mar 2024 00:30:01 +0100
Subject: [PATCH 11/25] Use `which` instead of running `rustc --version`
---
Cargo.lock | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++++
Cargo.toml | 1 +
src/main.rs | 16 ++--------------
3 files changed, 57 insertions(+), 14 deletions(-)
diff --git a/Cargo.lock b/Cargo.lock
index 3950c47..1bfd301 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -195,6 +195,12 @@ version = "0.3.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "fea41bba32d969b513997752735605054bc0dfa92b4c56bf1189f2e174be7a10"
+[[package]]
+name = "either"
+version = "1.10.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "11157ac094ffbdde99aa67b23417ebdd801842852b500e395a45a9c0aac03e4a"
+
[[package]]
name = "encode_unicode"
version = "0.3.6"
@@ -207,6 +213,16 @@ version = "1.0.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5443807d6dff69373d433ab9ef5378ad8df50ca6298caf15de6e52e24aaf54d5"
+[[package]]
+name = "errno"
+version = "0.3.8"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a258e46cdc063eb8519c00b9fc845fc47bcfca4130e2f08e88665ceda8474245"
+dependencies = [
+ "libc",
+ "windows-sys 0.52.0",
+]
+
[[package]]
name = "filetime"
version = "0.2.23"
@@ -354,6 +370,12 @@ version = "0.2.153"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9c198f91728a82281a64e1f4f9eeb25d82cb32a5de251c6bd1b5154d63a8e7bd"
+[[package]]
+name = "linux-raw-sys"
+version = "0.4.13"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "01cda141df6706de531b6c46c3a33ecca755538219bd484262fa09410c13539c"
+
[[package]]
name = "log"
version = "0.4.21"
@@ -521,6 +543,19 @@ version = "0.8.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c08c74e62047bb2de4ff487b251e4a92e24f48745648451635cec7d591162d9f"
+[[package]]
+name = "rustix"
+version = "0.38.32"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "65e04861e65f21776e67888bfbea442b3642beaa0138fdb1dd7a84a52dffdb89"
+dependencies = [
+ "bitflags 2.4.2",
+ "errno",
+ "libc",
+ "linux-raw-sys",
+ "windows-sys 0.52.0",
+]
+
[[package]]
name = "rustlings"
version = "5.6.1"
@@ -537,6 +572,7 @@ dependencies = [
"serde",
"serde_json",
"toml",
+ "which",
]
[[package]]
@@ -694,6 +730,18 @@ version = "0.11.0+wasi-snapshot-preview1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9c8d87e72b64a3b4db28d11ce29237c246188f4f51057d65a7eab63b7987e423"
+[[package]]
+name = "which"
+version = "6.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8211e4f58a2b2805adfbefbc07bab82958fc91e3836339b1ab7ae32465dce0d7"
+dependencies = [
+ "either",
+ "home",
+ "rustix",
+ "winsafe",
+]
+
[[package]]
name = "winapi"
version = "0.3.9"
@@ -865,3 +913,9 @@ checksum = "dffa400e67ed5a4dd237983829e66475f0a4a26938c4b04c21baede6262215b8"
dependencies = [
"memchr",
]
+
+[[package]]
+name = "winsafe"
+version = "0.0.19"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d135d17ab770252ad95e9a872d365cf3090e3be864a34ab46f48555993efc904"
diff --git a/Cargo.toml b/Cargo.toml
index 218b799..de65fc6 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -19,6 +19,7 @@ regex = "1.10.3"
serde_json = "1.0.114"
serde = { version = "1.0.197", features = ["derive"] }
toml = "0.8.10"
+which = "6.0.1"
[[bin]]
name = "rustlings"
diff --git a/src/main.rs b/src/main.rs
index a06f0c5..f932631 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -10,7 +10,7 @@ use std::ffi::OsStr;
use std::fs;
use std::io::{self, prelude::*};
use std::path::Path;
-use std::process::{Command, Stdio};
+use std::process::Command;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::mpsc::{channel, RecvTimeoutError};
use std::sync::{Arc, Mutex};
@@ -100,7 +100,7 @@ fn main() {
std::process::exit(1);
}
- if !rustc_exists() {
+ if which::which("rustc").is_err() {
println!("We cannot find `rustc`.");
println!("Try running `rustc --version` to diagnose your problem.");
println!("For instructions on how to install Rust, check the README.");
@@ -403,18 +403,6 @@ fn watch(
}
}
-fn rustc_exists() -> bool {
- Command::new("rustc")
- .args(["--version"])
- .stdout(Stdio::null())
- .stderr(Stdio::null())
- .stdin(Stdio::null())
- .spawn()
- .and_then(|mut child| child.wait())
- .map(|status| status.success())
- .unwrap_or(false)
-}
-
const DEFAULT_OUT: &str = r#"Thanks for installing Rustlings!
Is this your first time? Don't worry, Rustlings was made for beginners! We are
From 83cd91ccca22e36ed94e03cc622a88ef45e6da10 Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Mon, 25 Mar 2024 02:35:51 +0100
Subject: [PATCH 12/25] Replace toml with toml_edit
---
Cargo.lock | 18 +++---------------
Cargo.toml | 2 +-
src/main.rs | 6 ++++--
3 files changed, 8 insertions(+), 18 deletions(-)
diff --git a/Cargo.lock b/Cargo.lock
index 3950c47..52b2725 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -536,7 +536,7 @@ dependencies = [
"regex",
"serde",
"serde_json",
- "toml",
+ "toml_edit",
]
[[package]]
@@ -617,18 +617,6 @@ version = "0.4.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "3369f5ac52d5eb6ab48c6b4ffdc8efbcad6b89c765749064ba298f2c68a16a76"
-[[package]]
-name = "toml"
-version = "0.8.10"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9a9aad4a3066010876e8dcf5a8a06e70a558751117a145c6ce2b82c2e2054290"
-dependencies = [
- "serde",
- "serde_spanned",
- "toml_datetime",
- "toml_edit",
-]
-
[[package]]
name = "toml_datetime"
version = "0.6.5"
@@ -640,9 +628,9 @@ dependencies = [
[[package]]
name = "toml_edit"
-version = "0.22.6"
+version = "0.22.9"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2c1b5fd4128cc8d3e0cb74d4ed9a9cc7c7284becd4df68f5f940e1ad123606f6"
+checksum = "8e40bb779c5187258fd7aad0eb68cb8706a0a81fa712fbea808ab43c4b8374c4"
dependencies = [
"indexmap",
"serde",
diff --git a/Cargo.toml b/Cargo.toml
index 218b799..2861459 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -18,7 +18,7 @@ notify-debouncer-mini = "0.4.1"
regex = "1.10.3"
serde_json = "1.0.114"
serde = { version = "1.0.197", features = ["derive"] }
-toml = "0.8.10"
+toml_edit = { version = "0.22.9", default-features = false, features = ["parse", "serde"] }
[[bin]]
name = "rustlings"
diff --git a/src/main.rs b/src/main.rs
index a06f0c5..8e0029d 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -107,8 +107,10 @@ fn main() {
std::process::exit(1);
}
- let toml_str = &fs::read_to_string("info.toml").unwrap();
- let exercises = toml::from_str::<ExerciseList>(toml_str).unwrap().exercises;
+ let info_file = fs::read_to_string("info.toml").unwrap();
+ let exercises = toml_edit::de::from_str::<ExerciseList>(&info_file)
+ .unwrap()
+ .exercises;
let verbose = args.nocapture;
let command = args.command.unwrap_or_else(|| {
From e4520602f52935ff310534afc65160bcc5796a97 Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Mon, 25 Mar 2024 02:41:45 +0100
Subject: [PATCH 13/25] Use the NotFound variant of the IO error
---
src/main.rs | 19 +++++++++----------
1 file changed, 9 insertions(+), 10 deletions(-)
diff --git a/src/main.rs b/src/main.rs
index 8e0029d..d6542aa 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -91,15 +91,6 @@ fn main() {
println!("\n{WELCOME}\n");
}
- if !Path::new("info.toml").exists() {
- println!(
- "{} must be run from the rustlings directory",
- std::env::current_exe().unwrap().to_str().unwrap()
- );
- println!("Try `cd rustlings/`!");
- std::process::exit(1);
- }
-
if !rustc_exists() {
println!("We cannot find `rustc`.");
println!("Try running `rustc --version` to diagnose your problem.");
@@ -107,7 +98,15 @@ fn main() {
std::process::exit(1);
}
- let info_file = fs::read_to_string("info.toml").unwrap();
+ let info_file = fs::read_to_string("info.toml").unwrap_or_else(|e| {
+ match e.kind() {
+ io::ErrorKind::NotFound => println!(
+ "The program must be run from the rustlings directory\nTry `cd rustlings/`!",
+ ),
+ _ => println!("Failed to read the info.toml file: {e}"),
+ }
+ std::process::exit(1);
+ });
let exercises = toml_edit::de::from_str::<ExerciseList>(&info_file)
.unwrap()
.exercises;
From dca3ea355ea1809318ea545f23f396405d86aa0a Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Mon, 25 Mar 2024 14:10:51 +0100
Subject: [PATCH 14/25] Remove the home dependency since it is not used
---
Cargo.lock | 10 ----------
Cargo.toml | 1 -
2 files changed, 11 deletions(-)
diff --git a/Cargo.lock b/Cargo.lock
index 3950c47..9d8606a 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -255,15 +255,6 @@ version = "0.4.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "95505c38b4572b2d910cecb0281560f54b440a19336cbbcb27bf6ce6adc6f5a8"
-[[package]]
-name = "home"
-version = "0.5.9"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e3d1354bf6b7235cb4a0576c2619fd4ed18183f689b12b006a0ee7329eeff9a5"
-dependencies = [
- "windows-sys 0.52.0",
-]
-
[[package]]
name = "indexmap"
version = "2.2.5"
@@ -529,7 +520,6 @@ dependencies = [
"clap",
"console",
"glob",
- "home",
"indicatif",
"notify-debouncer-mini",
"predicates",
diff --git a/Cargo.toml b/Cargo.toml
index 218b799..2e6ab3b 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -12,7 +12,6 @@ edition = "2021"
clap = { version = "4.5.2", features = ["derive"] }
console = "0.15.8"
glob = "0.3.0"
-home = "0.5.9"
indicatif = "0.17.8"
notify-debouncer-mini = "0.4.1"
regex = "1.10.3"
From d911586788ad411be92e43cdc2f7e88fee7e78a4 Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Mon, 25 Mar 2024 17:21:54 +0100
Subject: [PATCH 15/25] Pipe the output to null instead of capturing and
ignoring it
---
src/exercise.rs | 12 +++++++++---
1 file changed, 9 insertions(+), 3 deletions(-)
diff --git a/src/exercise.rs b/src/exercise.rs
index 664b362..e6a9222 100644
--- a/src/exercise.rs
+++ b/src/exercise.rs
@@ -5,7 +5,7 @@ use std::fmt::{self, Display, Formatter};
use std::fs::{self, remove_file, File};
use std::io::Read;
use std::path::PathBuf;
-use std::process::{self, Command};
+use std::process::{self, Command, Stdio};
const RUSTC_COLOR_ARGS: &[&str] = &["--color", "always"];
const RUSTC_EDITION_ARGS: &[&str] = &["--edition", "2021"];
@@ -148,7 +148,10 @@ path = "{}.rs""#,
.args(RUSTC_COLOR_ARGS)
.args(RUSTC_EDITION_ARGS)
.args(RUSTC_NO_DEBUG_ARGS)
- .output()
+ .stdin(Stdio::null())
+ .stdout(Stdio::null())
+ .stderr(Stdio::null())
+ .status()
.expect("Failed to compile!");
// Due to an issue with Clippy, a cargo clean is required to catch all lints.
// See https://github.com/rust-lang/rust-clippy/issues/2604
@@ -157,7 +160,10 @@ path = "{}.rs""#,
Command::new("cargo")
.args(["clean", "--manifest-path", CLIPPY_CARGO_TOML_PATH])
.args(RUSTC_COLOR_ARGS)
- .output()
+ .stdin(Stdio::null())
+ .stdout(Stdio::null())
+ .stderr(Stdio::null())
+ .status()
.expect("Failed to run 'cargo clean'");
Command::new("cargo")
.args(["clippy", "--manifest-path", CLIPPY_CARGO_TOML_PATH])
From 7a6f71f09092e8a521d53456491e7d9d8a159602 Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Tue, 26 Mar 2024 02:14:25 +0100
Subject: [PATCH 16/25] Fix context of previous lines and improve readability
---
src/exercise.rs | 154 +++++++++++++++++++++++++-----------------------
1 file changed, 80 insertions(+), 74 deletions(-)
diff --git a/src/exercise.rs b/src/exercise.rs
index 136e943..e841aed 100644
--- a/src/exercise.rs
+++ b/src/exercise.rs
@@ -3,7 +3,7 @@ use std::fmt::{self, Display, Formatter};
use std::fs::{self, remove_file, File};
use std::io::{self, BufRead, BufReader};
use std::path::PathBuf;
-use std::process::{self, Command};
+use std::process::{self, exit, Command};
use std::{array, env, mem};
use winnow::ascii::{space0, Caseless};
use winnow::combinator::opt;
@@ -15,7 +15,8 @@ const RUSTC_NO_DEBUG_ARGS: &[&str] = &["-C", "strip=debuginfo"];
const CONTEXT: usize = 2;
const CLIPPY_CARGO_TOML_PATH: &str = "./exercises/22_clippy/Cargo.toml";
-fn not_done(input: &str) -> bool {
+// Checks if the line contains the "I AM NOT DONE" comment.
+fn contains_not_done_comment(input: &str) -> bool {
(
space0::<_, ()>,
"//",
@@ -219,12 +220,15 @@ path = "{}.rs""#,
pub fn state(&self) -> State {
let source_file = File::open(&self.path).unwrap_or_else(|e| {
- panic!(
- "We were unable to open the exercise file {}! {e}",
- self.path.display()
- )
+ println!(
+ "Failed to open the exercise file {}: {e}",
+ self.path.display(),
+ );
+ exit(1);
});
let mut source_reader = BufReader::new(source_file);
+
+ // Read the next line into `buf` without the newline at the end.
let mut read_line = |buf: &mut String| -> io::Result<_> {
let n = source_reader.read_line(buf)?;
if buf.ends_with('\n') {
@@ -236,70 +240,72 @@ path = "{}.rs""#,
Ok(n)
};
- let mut matched_line_ind: usize = 0;
+ let mut current_line_number: usize = 1;
let mut prev_lines: [_; CONTEXT] = array::from_fn(|_| String::with_capacity(256));
let mut line = String::with_capacity(256);
loop {
- match read_line(&mut line) {
- Ok(0) => break,
- Ok(_) => {
- if not_done(&line) {
- let mut context = Vec::with_capacity(2 * CONTEXT + 1);
- for (ind, prev_line) in prev_lines
- .into_iter()
- .rev()
- .take(matched_line_ind)
- .enumerate()
- {
- context.push(ContextLine {
- line: prev_line,
- // TODO
- number: matched_line_ind - CONTEXT + ind + 1,
- important: false,
- });
- }
+ let n = read_line(&mut line).unwrap_or_else(|e| {
+ println!(
+ "Failed to read the exercise file {}: {e}",
+ self.path.display(),
+ );
+ exit(1);
+ });
- context.push(ContextLine {
- line,
- number: matched_line_ind + 1,
- important: true,
- });
-
- for ind in 0..CONTEXT {
- let mut next_line = String::with_capacity(256);
- let Ok(n) = read_line(&mut next_line) else {
- break;
- };
-
- if n == 0 {
- break;
- }
-
- context.push(ContextLine {
- line: next_line,
- number: matched_line_ind + ind + 2,
- important: false,
- });
- }
-
- return State::Pending(context);
- }
-
- matched_line_ind += 1;
- for prev_line in &mut prev_lines {
- mem::swap(&mut line, prev_line);
- }
- line.clear();
- }
- Err(e) => panic!(
- "We were unable to read the exercise file {}! {e}",
- self.path.display()
- ),
+ // Reached the end of the file and didn't find the comment.
+ if n == 0 {
+ return State::Done;
}
- }
- State::Done
+ if contains_not_done_comment(&line) {
+ let mut context = Vec::with_capacity(2 * CONTEXT + 1);
+ for (ind, prev_line) in prev_lines
+ .into_iter()
+ .take(current_line_number - 1)
+ .enumerate()
+ .rev()
+ {
+ context.push(ContextLine {
+ line: prev_line,
+ number: current_line_number - 1 - ind,
+ important: false,
+ });
+ }
+
+ context.push(ContextLine {
+ line,
+ number: current_line_number,
+ important: true,
+ });
+
+ for ind in 0..CONTEXT {
+ let mut next_line = String::with_capacity(256);
+ let Ok(n) = read_line(&mut next_line) else {
+ break;
+ };
+
+ if n == 0 {
+ break;
+ }
+
+ context.push(ContextLine {
+ line: next_line,
+ number: current_line_number + 1 + ind,
+ important: false,
+ });
+ }
+
+ return State::Pending(context);
+ }
+
+ current_line_number += 1;
+ // Recycle the buffers.
+ for prev_line in &mut prev_lines {
+ mem::swap(&mut line, prev_line);
+ }
+ line.clear();
+ }
}
// Check that the exercise looks to be solved using self.state()
@@ -428,17 +434,17 @@ mod test {
#[test]
fn test_not_done() {
- assert!(not_done("// I AM NOT DONE"));
- assert!(not_done("/// I AM NOT DONE"));
- assert!(not_done("// I AM NOT DONE"));
- assert!(not_done("/// I AM NOT DONE"));
- assert!(not_done("// I AM NOT DONE "));
- assert!(not_done("// I AM NOT DONE!"));
- assert!(not_done("// I am not done"));
- assert!(not_done("// i am NOT done"));
+ assert!(contains_not_done_comment("// I AM NOT DONE"));
+ assert!(contains_not_done_comment("/// I AM NOT DONE"));
+ assert!(contains_not_done_comment("// I AM NOT DONE"));
+ assert!(contains_not_done_comment("/// I AM NOT DONE"));
+ assert!(contains_not_done_comment("// I AM NOT DONE "));
+ assert!(contains_not_done_comment("// I AM NOT DONE!"));
+ assert!(contains_not_done_comment("// I am not done"));
+ assert!(contains_not_done_comment("// i am NOT done"));
- assert!(!not_done("I AM NOT DONE"));
- assert!(!not_done("// NOT DONE"));
- assert!(!not_done("DONE"));
+ assert!(!contains_not_done_comment("I AM NOT DONE"));
+ assert!(!contains_not_done_comment("// NOT DONE"));
+ assert!(!contains_not_done_comment("DONE"));
}
}
From 078f6ffc1cf18546079d03bee99f0903c9e14703 Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Tue, 26 Mar 2024 02:26:26 +0100
Subject: [PATCH 17/25] Add comments
---
src/exercise.rs | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/src/exercise.rs b/src/exercise.rs
index e841aed..cdf8d20 100644
--- a/src/exercise.rs
+++ b/src/exercise.rs
@@ -241,6 +241,7 @@ path = "{}.rs""#,
};
let mut current_line_number: usize = 1;
+ // Keep the last `CONTEXT` lines while iterating over the file lines.
let mut prev_lines: [_; CONTEXT] = array::from_fn(|_| String::with_capacity(256));
let mut line = String::with_capacity(256);
@@ -260,6 +261,7 @@ path = "{}.rs""#,
if contains_not_done_comment(&line) {
let mut context = Vec::with_capacity(2 * CONTEXT + 1);
+ // Previous lines.
for (ind, prev_line) in prev_lines
.into_iter()
.take(current_line_number - 1)
@@ -273,18 +275,22 @@ path = "{}.rs""#,
});
}
+ // Current line.
context.push(ContextLine {
line,
number: current_line_number,
important: true,
});
+ // Next lines.
for ind in 0..CONTEXT {
let mut next_line = String::with_capacity(256);
let Ok(n) = read_line(&mut next_line) else {
+ // If an error occurs, just ignore the next lines.
break;
};
+ // Reached the end of the file.
if n == 0 {
break;
}
@@ -300,10 +306,12 @@ path = "{}.rs""#,
}
current_line_number += 1;
- // Recycle the buffers.
+ // Add the current line as a previous line and shift the older lines by one.
for prev_line in &mut prev_lines {
mem::swap(&mut line, prev_line);
}
+ // The current line now contains the oldest previous line.
+ // Recycle it for reading the next line.
line.clear();
}
}
From 853d0593d061119b042a45b602ff52af229dad83 Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Tue, 26 Mar 2024 17:47:33 +0100
Subject: [PATCH 18/25] Derive Eq when PartialEq is derived
---
src/exercise.rs | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/exercise.rs b/src/exercise.rs
index 664b362..a13ed2c 100644
--- a/src/exercise.rs
+++ b/src/exercise.rs
@@ -58,7 +58,7 @@ pub struct Exercise {
// An enum to track of the state of an Exercise.
// An Exercise can be either Done or Pending
-#[derive(PartialEq, Debug)]
+#[derive(PartialEq, Eq, Debug)]
pub enum State {
// The state of the exercise once it's been completed
Done,
@@ -67,7 +67,7 @@ pub enum State {
}
// The context information of a pending exercise
-#[derive(PartialEq, Debug)]
+#[derive(PartialEq, Eq, Debug)]
pub struct ContextLine {
// The source code that is still pending completion
pub line: String,
From f36efae25deee03cb6f98ce7fc1e59efb7e72985 Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Tue, 26 Mar 2024 17:48:06 +0100
Subject: [PATCH 19/25] Only use arg instead of args AND arg
---
src/run.rs | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/src/run.rs b/src/run.rs
index e0ada4c..6dd0388 100644
--- a/src/run.rs
+++ b/src/run.rs
@@ -21,7 +21,8 @@ pub fn run(exercise: &Exercise, verbose: bool) -> Result<(), ()> {
// Resets the exercise by stashing the changes.
pub fn reset(exercise: &Exercise) -> Result<(), ()> {
let command = Command::new("git")
- .args(["stash", "--"])
+ .arg("stash")
+ .arg("--")
.arg(&exercise.path)
.spawn();
From ed0fcf8e3d05f5420b55370d4ff4ad8e0ded127b Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Tue, 26 Mar 2024 17:49:05 +0100
Subject: [PATCH 20/25] Formatting
---
src/main.rs | 7 ++-----
src/verify.rs | 32 +++++++++++++++-----------------
2 files changed, 17 insertions(+), 22 deletions(-)
diff --git a/src/main.rs b/src/main.rs
index a06f0c5..a0b3af2 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -223,10 +223,7 @@ fn main() {
Subcommands::Watch { success_hints } => match watch(&exercises, verbose, success_hints) {
Err(e) => {
- println!(
- "Error: Could not watch your progress. Error message was {:?}.",
- e
- );
+ println!("Error: Could not watch your progress. Error message was {e:?}.");
println!("Most likely you've run out of disk space or your 'inotify limit' has been reached.");
std::process::exit(1);
}
@@ -280,7 +277,7 @@ fn spawn_watch_shell(
if parts.is_empty() {
println!("no command provided");
} else if let Err(e) = Command::new(parts[0]).args(&parts[1..]).status() {
- println!("failed to execute command `{}`: {}", cmd, e);
+ println!("failed to execute command `{cmd}`: {e}");
}
} else {
println!("unknown command: {input}");
diff --git a/src/verify.rs b/src/verify.rs
index aee2afa..3123e45 100644
--- a/src/verify.rs
+++ b/src/verify.rs
@@ -24,7 +24,7 @@ pub fn verify<'a>(
.progress_chars("#>-"),
);
bar.set_position(num_done as u64);
- bar.set_message(format!("({:.1} %)", percentage));
+ bar.set_message(format!("({percentage:.1} %)"));
for exercise in exercises {
let compile_result = match exercise.mode {
@@ -37,7 +37,7 @@ pub fn verify<'a>(
}
percentage += 100.0 / total as f32;
bar.inc(1);
- bar.set_message(format!("({:.1} %)", percentage));
+ bar.set_message(format!("({percentage:.1} %)"));
if bar.position() == total as u64 {
println!(
"Progress: You completed {} / {} exercises ({:.1} %).",
@@ -191,27 +191,25 @@ fn prompt_for_completion(
Mode::Test => "The code is compiling, and the tests pass!",
Mode::Clippy => clippy_success_msg,
};
- println!();
+
if no_emoji {
- println!("~*~ {success_msg} ~*~")
+ println!("\n~*~ {success_msg} ~*~\n");
} else {
- println!("š š {success_msg} š š")
+ println!("\nš š {success_msg} š š\n");
}
- println!();
if let Some(output) = prompt_output {
- println!("Output:");
- println!("{}", separator());
- println!("{output}");
- println!("{}", separator());
- println!();
+ println!(
+ "Output:\n{separator}\n{output}\n{separator}\n",
+ separator = separator(),
+ );
}
if success_hints {
- println!("Hints:");
- println!("{}", separator());
- println!("{}", exercise.hint);
- println!("{}", separator());
- println!();
+ println!(
+ "Hints:\n{separator}\n{}\n{separator}\n",
+ exercise.hint,
+ separator = separator(),
+ );
}
println!("You can keep working on this exercise,");
@@ -231,7 +229,7 @@ fn prompt_for_completion(
"{:>2} {} {}",
style(context_line.number).blue().bold(),
style("|").blue(),
- formatted_line
+ formatted_line,
);
}
From 1f2029ae5503024f71203893fe1eab7b90aa80af Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Tue, 26 Mar 2024 17:49:25 +0100
Subject: [PATCH 21/25] Add missing semicolon
---
src/main.rs | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main.rs b/src/main.rs
index a0b3af2..6884a0e 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -217,7 +217,7 @@ fn main() {
println!("Failed to write rust-project.json to disk for rust-analyzer");
} else {
println!("Successfully generated rust-project.json");
- println!("rust-analyzer will now parse exercises, restart your language server or editor")
+ println!("rust-analyzer will now parse exercises, restart your language server or editor");
}
}
From 980ffa2a2bb791992ef05ca9b05aadba62ec6abc Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Tue, 26 Mar 2024 17:49:48 +0100
Subject: [PATCH 22/25] Use == on simple enums
---
src/verify.rs | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/src/verify.rs b/src/verify.rs
index 3123e45..e2fa98f 100644
--- a/src/verify.rs
+++ b/src/verify.rs
@@ -51,6 +51,7 @@ pub fn verify<'a>(
Ok(())
}
+#[derive(PartialEq, Eq)]
enum RunMode {
Interactive,
NonInteractive,
@@ -124,7 +125,7 @@ fn compile_and_test(
if verbose {
println!("{}", output.stdout);
}
- if let RunMode::Interactive = run_mode {
+ if run_mode == RunMode::Interactive {
Ok(prompt_for_completion(exercise, None, success_hints))
} else {
Ok(true)
From e89028581cd03c02cb0971a2772fa382667019a3 Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Tue, 26 Mar 2024 17:49:55 +0100
Subject: [PATCH 23/25] Use == instead of eq
---
src/main.rs | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main.rs b/src/main.rs
index 6884a0e..559be69 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -289,7 +289,7 @@ fn spawn_watch_shell(
}
fn find_exercise<'a>(name: &str, exercises: &'a [Exercise]) -> &'a Exercise {
- if name.eq("next") {
+ if name == "next" {
exercises
.iter()
.find(|e| !e.looks_done())
From a610fc1bc21a04017542208ef70a8010ee00c04c Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Tue, 26 Mar 2024 17:50:10 +0100
Subject: [PATCH 24/25] Remove unneeded closure
---
src/main.rs | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/src/main.rs b/src/main.rs
index 559be69..eca73fa 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -335,7 +335,6 @@ fn watch(
clear_screen();
- let to_owned_hint = |t: &Exercise| t.hint.to_owned();
let failed_exercise_hint = match verify(
exercises.iter(),
(0, exercises.len()),
@@ -343,7 +342,7 @@ fn watch(
success_hints,
) {
Ok(_) => return Ok(WatchStatus::Finished),
- Err(exercise) => Arc::new(Mutex::new(Some(to_owned_hint(exercise)))),
+ Err(exercise) => Arc::new(Mutex::new(Some(exercise.hint.clone()))),
};
spawn_watch_shell(&failed_exercise_hint, Arc::clone(&should_quit));
loop {
@@ -380,7 +379,7 @@ fn watch(
Err(exercise) => {
let mut failed_exercise_hint =
failed_exercise_hint.lock().unwrap();
- *failed_exercise_hint = Some(to_owned_hint(exercise));
+ *failed_exercise_hint = Some(exercise.hint.clone());
}
}
}
From 87001a68c0cc6b3498a253d0923e9c609355c4ee Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Tue, 26 Mar 2024 17:50:29 +0100
Subject: [PATCH 25/25] The string doesn't have to be a raw string
---
src/main.rs | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/main.rs b/src/main.rs
index eca73fa..141549c 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -411,7 +411,7 @@ fn rustc_exists() -> bool {
.unwrap_or(false)
}
-const DEFAULT_OUT: &str = r#"Thanks for installing Rustlings!
+const DEFAULT_OUT: &str = "Thanks for installing Rustlings!
Is this your first time? Don't worry, Rustlings was made for beginners! We are
going to teach you a lot of things about Rust, but before we can get
@@ -437,7 +437,7 @@ started, here's a couple of notes about how Rustlings operates:
autocompletion, run the command `rustlings lsp`.
Got all that? Great! To get started, run `rustlings watch` in order to get the first
-exercise. Make sure to have your editor open!"#;
+exercise. Make sure to have your editor open!";
const FENISH_LINE: &str = "+----------------------------------------------------+
| You made it to the Fe-nish line! |