diff --git a/.all-contributorsrc b/.all-contributorsrc
index f2446f1f..be95fe9f 100644
--- a/.all-contributorsrc
+++ b/.all-contributorsrc
@@ -2685,6 +2685,42 @@
"contributions": [
"code"
]
+ },
+ {
+ "login": "paul-leydier",
+ "name": "Paul Leydier",
+ "avatar_url": "https://avatars.githubusercontent.com/u/75126792?v=4",
+ "profile": "https://github.com/paul-leydier",
+ "contributions": [
+ "doc"
+ ]
+ },
+ {
+ "login": "wznmickey",
+ "name": "wznmickey",
+ "avatar_url": "https://avatars.githubusercontent.com/u/44784663?v=4",
+ "profile": "http://wznmickey.com",
+ "contributions": [
+ "doc"
+ ]
+ },
+ {
+ "login": "NicolasRoelandt",
+ "name": "NicolasRoelandt",
+ "avatar_url": "https://avatars.githubusercontent.com/u/8594193?v=4",
+ "profile": "https://github.com/NicolasRoelandt",
+ "contributions": [
+ "doc"
+ ]
+ },
+ {
+ "login": "jbouganim-parallel",
+ "name": "Josh Bouganim",
+ "avatar_url": "https://avatars.githubusercontent.com/u/150748285?v=4",
+ "profile": "https://github.com/jbouganim-parallel",
+ "contributions": [
+ "code"
+ ]
}
],
"contributorsPerLine": 8,
diff --git a/AUTHORS.md b/AUTHORS.md
index 00122e07..42c7dbfe 100644
--- a/AUTHORS.md
+++ b/AUTHORS.md
@@ -378,6 +378,12 @@ authors.
0Ahmed-0
๐ |
guizo792
๐ |
Kazuki Matsuo
๐ป |
+ 
Paul Leydier
๐ |
+
+
+ 
wznmickey
๐ |
+ 
NicolasRoelandt
๐ |
+ 
Josh Bouganim
๐ป |
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index cc8ac923..4fc7fb79 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -21,7 +21,6 @@ _implement a new feature! โก๏ธ [open an Issue to discuss it first, then a Pull
`rustlings` is basically a glorified `rustc` wrapper. Therefore the source code
isn't really that complicated since the bulk of the work is done by `rustc`.
-`src/main.rs` contains a simple `argh` CLI that connects to most of the other source files.
### Adding an exercise
@@ -66,7 +65,7 @@ changes. There's a couple of things to watch out for:
#### Write correct commit messages
-We follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/)
+We follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
specification.
This means that you have to format your commit messages in a specific way. Say
you're working on adding a new exercise called `foobar1.rs`. You could write
diff --git a/Cargo.lock b/Cargo.lock
index 3950c476..f4853d0c 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -4,9 +4,9 @@ version = 3
[[package]]
name = "aho-corasick"
-version = "1.1.2"
+version = "1.1.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b2969dcb958b36655471fc61f7e416fa76033bdd4bfed0678d8fee1e2d07a1f0"
+checksum = "8e60d3430d3a69478ad0993f19238d2df97c507009a52b3c10addcd7f6bcb916"
dependencies = [
"memchr",
]
@@ -59,6 +59,12 @@ dependencies = [
"windows-sys 0.52.0",
]
+[[package]]
+name = "anyhow"
+version = "1.0.81"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0952808a6c2afd1aa8947271f3a60f1a6763c7b912d210184c5149b5cf147247"
+
[[package]]
name = "assert_cmd"
version = "2.0.14"
@@ -76,9 +82,9 @@ dependencies = [
[[package]]
name = "autocfg"
-version = "1.1.0"
+version = "1.2.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa"
+checksum = "f1fdabc7756949593fe60f30ec81974b613357de856987752631dea1e3394c80"
[[package]]
name = "bitflags"
@@ -88,9 +94,9 @@ checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a"
[[package]]
name = "bitflags"
-version = "2.4.2"
+version = "2.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ed570934406eb16438a4e976b1b4500774099c13b8cb96eec99f620f05090ddf"
+checksum = "cf4b9d6a944f767f8e5e0db018570623c85f3d925ac718db4e06d0187adb21c1"
[[package]]
name = "bstr"
@@ -111,9 +117,9 @@ checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
[[package]]
name = "clap"
-version = "4.5.2"
+version = "4.5.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b230ab84b0ffdf890d5a10abdbc8b83ae1c4918275daea1ab8801f71536b2651"
+checksum = "90bc066a67923782aa8515dbaea16946c5bcc5addbd668bb80af688e53e548a0"
dependencies = [
"clap_builder",
"clap_derive",
@@ -133,9 +139,9 @@ dependencies = [
[[package]]
name = "clap_derive"
-version = "4.5.0"
+version = "4.5.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "307bc0538d5f0f83b8248db3087aa92fe504e4691294d0c96c0eabc33f47ba47"
+checksum = "528131438037fd55894f62d6e9f068b8f45ac57ffa77517819645d10aed04f64"
dependencies = [
"heck",
"proc-macro2",
@@ -195,6 +201,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 +219,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"
@@ -251,9 +273,9 @@ checksum = "290f1a1d9242c78d09ce40a5e87e7554ee637af1351968159f4952f028f75604"
[[package]]
name = "heck"
-version = "0.4.1"
+version = "0.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "95505c38b4572b2d910cecb0281560f54b440a19336cbbcb27bf6ce6adc6f5a8"
+checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
[[package]]
name = "home"
@@ -266,9 +288,9 @@ dependencies = [
[[package]]
name = "indexmap"
-version = "2.2.5"
+version = "2.2.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7b0b929d511467233429c45a44ac1dcaa21ba0f5ba11e4879e6ed28ddb4f9df4"
+checksum = "168fb715dda47215e360912c096649d23d58bf392ac62f73919e831745e40f26"
dependencies = [
"equivalent",
"hashbrown",
@@ -318,9 +340,9 @@ dependencies = [
[[package]]
name = "itoa"
-version = "1.0.10"
+version = "1.0.11"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b1a46d1a171d865aa5f83f92695765caa047a9b4cbae2cbf37dbd613a793fd4c"
+checksum = "49f1f14873335454500d59611f1cf4a4b0f786f9ac11f4312a78e4cf2566695b"
[[package]]
name = "kqueue"
@@ -354,6 +376,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"
@@ -390,7 +418,7 @@ version = "6.1.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "6205bd8bb1e454ad2e27422015fb5e4f2bcc7e08fa8f27058670d208324a4d2d"
dependencies = [
- "bitflags 2.4.2",
+ "bitflags 2.5.0",
"crossbeam-channel",
"filetime",
"fsevent-sys",
@@ -467,9 +495,9 @@ dependencies = [
[[package]]
name = "proc-macro2"
-version = "1.0.78"
+version = "1.0.79"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e2422ad645d89c99f8f3e6b88a9fdeca7fabeac836b1002371c4367c8f984aae"
+checksum = "e835ff2298f5721608eb1a980ecaee1aef2c132bf95ecc026a11b7bf3c01c02e"
dependencies = [
"unicode-ident",
]
@@ -494,9 +522,9 @@ dependencies = [
[[package]]
name = "regex"
-version = "1.10.3"
+version = "1.10.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b62dbe01f0b06f9d8dc7d49e05a0785f153b00b2c227856282f671e0318c9b15"
+checksum = "c117dbdfde9c8308975b6a18d71f3f385c89461f7b3fb054288ecf2a2058ba4c"
dependencies = [
"aho-corasick",
"memchr",
@@ -517,26 +545,41 @@ dependencies = [
[[package]]
name = "regex-syntax"
-version = "0.8.2"
+version = "0.8.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c08c74e62047bb2de4ff487b251e4a92e24f48745648451635cec7d591162d9f"
+checksum = "adad44e29e4c806119491a7f06f03de4d1af22c3a680dd47f1e6e179439d1f56"
+
+[[package]]
+name = "rustix"
+version = "0.38.32"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "65e04861e65f21776e67888bfbea442b3642beaa0138fdb1dd7a84a52dffdb89"
+dependencies = [
+ "bitflags 2.5.0",
+ "errno",
+ "libc",
+ "linux-raw-sys",
+ "windows-sys 0.52.0",
+]
[[package]]
name = "rustlings"
version = "5.6.1"
dependencies = [
+ "anyhow",
"assert_cmd",
"clap",
"console",
"glob",
- "home",
"indicatif",
"notify-debouncer-mini",
"predicates",
- "regex",
"serde",
"serde_json",
- "toml",
+ "shlex",
+ "toml_edit",
+ "which",
+ "winnow",
]
[[package]]
@@ -576,9 +619,9 @@ dependencies = [
[[package]]
name = "serde_json"
-version = "1.0.114"
+version = "1.0.115"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c5f09b1bd632ef549eaa9f60a1f8de742bdbc698e6cee2095fc84dde5f549ae0"
+checksum = "12dc5c46daa8e9fdf4f5e71b6cf9a53f2487da0e86e55808e2d35539666497dd"
dependencies = [
"itoa",
"ryu",
@@ -594,6 +637,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"
@@ -602,9 +651,9 @@ checksum = "5ee073c9e4cd00e28217186dbe12796d692868f432bf2e97ee73bed0c56dfa01"
[[package]]
name = "syn"
-version = "2.0.52"
+version = "2.0.55"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b699d15b36d1f02c3e7c69f8ffef53de37aefae075d8488d4ba1a7788d574a07"
+checksum = "002a1b3dbf967edfafc32655d0f377ab0bb7b994aa1d32c8cc7e9b8bf3ebb8f0"
dependencies = [
"proc-macro2",
"quote",
@@ -617,18 +666,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 +677,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",
@@ -694,6 +731,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 +914,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 218b7990..2d152cfc 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -9,16 +9,17 @@ authors = [
edition = "2021"
[dependencies]
-clap = { version = "4.5.2", features = ["derive"] }
+anyhow = "1.0.81"
+clap = { version = "4.5.4", 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"
-serde_json = "1.0.114"
+serde_json = "1.0.115"
serde = { version = "1.0.197", features = ["derive"] }
-toml = "0.8.10"
+shlex = "1.3.0"
+toml_edit = { version = "0.22.9", default-features = false, features = ["parse", "serde"] }
+which = "6.0.1"
+winnow = "0.6.5"
[[bin]]
name = "rustlings"
diff --git a/exercises/23_conversions/from_str.rs b/exercises/23_conversions/from_str.rs
index 34472c32..e2093474 100644
--- a/exercises/23_conversions/from_str.rs
+++ b/exercises/23_conversions/from_str.rs
@@ -44,10 +44,6 @@ enum ParsePersonError {
// 6. If while extracting the name and the age something goes wrong, an error
// should be returned
// If everything goes well, then return a Result of a Person object
-//
-// As an aside: `Box` implements `From<&'_ str>`. This means that if
-// you want to return a string error message, you can do so via just using
-// return `Err("my error message".into())`.
impl FromStr for Person {
type Err = ParsePersonError;
diff --git a/exercises/README.md b/exercises/README.md
index c7effa95..237f2f1e 100644
--- a/exercises/README.md
+++ b/exercises/README.md
@@ -17,11 +17,11 @@
| error_handling | ยง9 |
| generics | ยง10 |
| traits | ยง10.2 |
-| tests | ยง11.1 |
| lifetimes | ยง10.3 |
+| tests | ยง11.1 |
| iterators | ยง13.2-4 |
-| threads | ยง16.1-3 |
| smart_pointers | ยง15, ยง16.3 |
-| macros | ยง19.6 |
+| threads | ยง16.1-3 |
+| macros | ยง19.5 |
| clippy | ยง21.4 |
| conversions | n/a |
diff --git a/src/exercise.rs b/src/exercise.rs
index 664b362b..19f528a8 100644
--- a/src/exercise.rs
+++ b/src/exercise.rs
@@ -1,19 +1,33 @@
-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::process::{self, exit, Command, Stdio};
+use std::{array, env, mem};
+use winnow::ascii::{space0, Caseless};
+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"(?m)^\s*///?\s*I\s+AM\s+NOT\s+DONE";
const CONTEXT: usize = 2;
const CLIPPY_CARGO_TOML_PATH: &str = "./exercises/22_clippy/Cargo.toml";
+// Checks if the line contains the "I AM NOT DONE" comment.
+fn contains_not_done_comment(input: &str) -> bool {
+ (
+ space0::<_, ()>,
+ "//",
+ opt('/'),
+ space0,
+ Caseless("I AM NOT DONE"),
+ )
+ .parse_next(&mut &*input)
+ .is_ok()
+}
+
// Get a temporary file name that is hopefully unique
#[inline]
fn temp_file() -> String {
@@ -58,7 +72,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 +81,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,
@@ -148,7 +162,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 +174,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])
@@ -205,51 +225,101 @@ path = "{}.rs""#,
}
pub fn state(&self) -> State {
- let mut 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_file = File::open(&self.path).unwrap_or_else(|e| {
+ println!(
+ "Failed to open the exercise file {}: {e}",
+ self.path.display(),
+ );
+ exit(1);
});
+ let mut source_reader = BufReader::new(source_file);
- 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
+ // 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') {
+ buf.pop();
+ if buf.ends_with('\r') {
+ buf.pop();
+ }
+ }
+ Ok(n)
};
- let re = Regex::new(I_AM_DONE_REGEX).unwrap();
+ 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);
- if !re.is_match(&source) {
- return State::Done;
+ loop {
+ let n = read_line(&mut line).unwrap_or_else(|e| {
+ println!(
+ "Failed to read the exercise file {}: {e}",
+ self.path.display(),
+ );
+ exit(1);
+ });
+
+ // Reached the end of the file and didn't find the comment.
+ if n == 0 {
+ return State::Done;
+ }
+
+ 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)
+ .enumerate()
+ .rev()
+ {
+ context.push(ContextLine {
+ line: prev_line,
+ number: current_line_number - 1 - ind,
+ important: false,
+ });
+ }
+
+ // 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;
+ }
+
+ context.push(ContextLine {
+ line: next_line,
+ number: current_line_number + 1 + ind,
+ important: false,
+ });
+ }
+
+ return State::Pending(context);
+ }
+
+ current_line_number += 1;
+ // 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();
}
-
- 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)
}
// Check that the exercise looks to be solved using self.state()
@@ -375,4 +445,20 @@ mod test {
let out = exercise.compile().unwrap().run().unwrap();
assert!(out.stdout.contains("THIS TEST TOO SHALL PASS"));
}
+
+ #[test]
+ fn test_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!(!contains_not_done_comment("I AM NOT DONE"));
+ assert!(!contains_not_done_comment("// NOT DONE"));
+ assert!(!contains_not_done_comment("DONE"));
+ }
}
diff --git a/src/main.rs b/src/main.rs
index a06f0c56..8f73dbba 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -1,16 +1,18 @@
use crate::exercise::{Exercise, ExerciseList};
-use crate::project::RustAnalyzerProject;
+use crate::project::write_project_json;
use crate::run::{reset, run};
use crate::verify::verify;
+use anyhow::Result;
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::*};
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};
@@ -84,31 +86,32 @@ enum Subcommands {
Lsp,
}
-fn main() {
+fn main() -> Result<()> {
let args = Args::parse();
if args.command.is_none() {
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() {
+ 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.");
std::process::exit(1);
}
- let toml_str = &fs::read_to_string("info.toml").unwrap();
- let exercises = toml::from_str::(toml_str).unwrap().exercises;
+ 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::(&info_file)
+ .unwrap()
+ .exercises;
let verbose = args.nocapture;
let command = args.command.unwrap_or_else(|| {
@@ -128,31 +131,43 @@ 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::>();
+
+ for exercise in &exercises {
+ let fname = exercise.path.to_string_lossy();
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 looks_done = exercise.looks_done();
+ let status = if looks_done {
exercises_done += 1;
"Done"
} else {
"Pending"
};
- let solve_cond = {
- (e.looks_done() && solved)
- || (!e.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")
} 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 +183,8 @@ fn main() {
});
}
}
- });
+ }
+
let percentage_progress = exercises_done as f32 / exercises.len() as f32 * 100.0;
println!(
"Progress: You completed {} / {} exercises ({:.1} %).",
@@ -203,30 +219,17 @@ fn main() {
}
Subcommands::Lsp => {
- let mut project = RustAnalyzerProject::new();
- project
- .get_sysroot_src()
- .expect("Couldn't find toolchain path, do you have `rustc` installed?");
- project
- .exercises_to_json()
- .expect("Couldn't parse rustlings exercises files");
-
- if project.crates.is_empty() {
- println!("Failed find any exercises, make sure you're in the `rustlings` folder");
- } else if project.write_to_disk().is_err() {
- println!("Failed to write rust-project.json to disk for rust-analyzer");
+ if let Err(e) = write_project_json(exercises) {
+ println!("Failed to write rust-project.json to disk for rust-analyzer: {e}");
} 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");
}
}
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);
}
@@ -243,56 +246,60 @@ fn main() {
}
},
}
+
+ Ok(())
}
fn spawn_watch_shell(
- failed_exercise_hint: &Arc>>,
+ failed_exercise_hint: Arc>>,
should_quit: Arc,
) {
- 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 {
- 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!(" ! - 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}");
- }
+
+ thread::spawn(move || {
+ let mut input = String::with_capacity(32);
+ 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}"),
}
});
}
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())
@@ -338,7 +345,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()),
@@ -346,9 +352,9 @@ 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));
+ 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 {
@@ -383,7 +389,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());
}
}
}
@@ -403,19 +409,7 @@ 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!
+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
@@ -441,7 +435,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! |
@@ -477,3 +471,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
+ ! - 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.";
diff --git a/src/project.rs b/src/project.rs
index 00fc304d..0f56de96 100644
--- a/src/project.rs
+++ b/src/project.rs
@@ -1,102 +1,83 @@
-use glob::glob;
-use serde::{Deserialize, Serialize};
+use anyhow::{Context, Result};
+use serde::Serialize;
use std::env;
-use std::error::Error;
-use std::path::{Path, PathBuf};
-use std::process::Command;
+use std::path::PathBuf;
+use std::process::{Command, Stdio};
+
+use crate::exercise::Exercise;
/// Contains the structure of resulting rust-project.json file
/// and functions to build the data required to create the file
-#[derive(Serialize, Deserialize)]
-pub struct RustAnalyzerProject {
- sysroot_src: String,
- pub crates: Vec,
+#[derive(Serialize)]
+struct RustAnalyzerProject {
+ sysroot_src: PathBuf,
+ crates: Vec,
}
-#[derive(Serialize, Deserialize)]
-pub struct Crate {
- root_module: String,
- edition: String,
- deps: Vec,
- cfg: Vec,
+#[derive(Serialize)]
+struct Crate {
+ root_module: PathBuf,
+ edition: &'static str,
+ // Not used, but required in the JSON file.
+ deps: Vec<()>,
+ // Only `test` is used for all crates.
+ // Therefore, an array is used instead of a `Vec`.
+ cfg: [&'static str; 1],
}
impl RustAnalyzerProject {
- pub fn new() -> RustAnalyzerProject {
- RustAnalyzerProject {
- sysroot_src: String::new(),
- crates: Vec::new(),
- }
- }
+ fn build(exercises: Vec) -> Result {
+ let crates = exercises
+ .into_iter()
+ .map(|exercise| Crate {
+ root_module: exercise.path,
+ edition: "2021",
+ deps: Vec::new(),
+ // This allows rust_analyzer to work inside `#[test]` blocks
+ cfg: ["test"],
+ })
+ .collect();
- /// Write rust-project.json to disk
- pub fn write_to_disk(&self) -> Result<(), std::io::Error> {
- std::fs::write(
- "./rust-project.json",
- serde_json::to_vec(&self).expect("Failed to serialize to JSON"),
- )?;
- Ok(())
- }
-
- /// If path contains .rs extension, add a crate to `rust-project.json`
- fn path_to_json(&mut self, path: PathBuf) -> Result<(), Box> {
- if let Some(ext) = path.extension() {
- if ext == "rs" {
- self.crates.push(Crate {
- root_module: path.display().to_string(),
- edition: "2021".to_string(),
- deps: Vec::new(),
- // This allows rust_analyzer to work inside #[test] blocks
- cfg: vec!["test".to_string()],
- })
- }
- }
-
- Ok(())
- }
-
- /// Parse the exercises folder for .rs files, any matches will create
- /// a new `crate` in rust-project.json which allows rust-analyzer to
- /// treat it like a normal binary
- pub fn exercises_to_json(&mut self) -> Result<(), Box> {
- for path in glob("./exercises/**/*")? {
- self.path_to_json(path?)?;
- }
- Ok(())
- }
-
- /// Use `rustc` to determine the default toolchain
- pub fn get_sysroot_src(&mut self) -> Result<(), Box> {
- // check if RUST_SRC_PATH is set
- if let Ok(path) = env::var("RUST_SRC_PATH") {
- self.sysroot_src = path;
- return Ok(());
+ if let Some(path) = env::var_os("RUST_SRC_PATH") {
+ return Ok(Self {
+ sysroot_src: PathBuf::from(path),
+ crates,
+ });
}
let toolchain = Command::new("rustc")
.arg("--print")
.arg("sysroot")
- .output()?
+ .stderr(Stdio::inherit())
+ .output()
+ .context("Failed to get the sysroot from `rustc`. Do you have `rustc` installed?")?
.stdout;
- let toolchain = String::from_utf8(toolchain)?;
+ let toolchain =
+ String::from_utf8(toolchain).context("The toolchain path is invalid UTF8")?;
let toolchain = toolchain.trim_end();
-
println!("Determined toolchain: {toolchain}\n");
- let Ok(path) = Path::new(toolchain)
- .join("lib")
- .join("rustlib")
- .join("src")
- .join("rust")
- .join("library")
- .into_os_string()
- .into_string()
- else {
- return Err("The sysroot path is invalid UTF8".into());
- };
- self.sysroot_src = path;
+ let mut sysroot_src = PathBuf::with_capacity(256);
+ sysroot_src.extend([toolchain, "lib", "rustlib", "src", "rust", "library"]);
- Ok(())
+ Ok(Self {
+ sysroot_src,
+ crates,
+ })
}
}
+
+/// Write `rust-project.json` to disk.
+pub fn write_project_json(exercises: Vec) -> Result<()> {
+ let content = RustAnalyzerProject::build(exercises)?;
+
+ // Using the capacity 2^14 since the file length in bytes is higher than 2^13.
+ // The final length is not known exactly because it depends on the user's sysroot path,
+ // the current number of exercises etc.
+ let mut buf = Vec::with_capacity(1 << 14);
+ serde_json::to_writer(&mut buf, &content)?;
+ std::fs::write("rust-project.json", buf)?;
+
+ Ok(())
+}
diff --git a/src/run.rs b/src/run.rs
index e0ada4c5..6dd0388f 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();
diff --git a/src/ui.rs b/src/ui.rs
index 74835e13..d8177b9f 100644
--- a/src/ui.rs
+++ b/src/ui.rs
@@ -1,5 +1,5 @@
macro_rules! print_emoji {
- ($emoji:expr, $sign:expr, $color: ident ,$fmt:literal, $ex:expr) => {{
+ ($emoji:expr, $sign:expr, $color: ident, $fmt:literal, $ex:expr) => {{
use console::{style, Emoji};
use std::env;
let formatstr = format!($fmt, $ex);
diff --git a/src/verify.rs b/src/verify.rs
index cafecab0..dac25626 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} %).",
@@ -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)
@@ -191,27 +192,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,");
@@ -224,14 +223,14 @@ 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!(
"{:>2} {} {}",
style(context_line.number).blue().bold(),
style("|").blue(),
- formatted_line
+ formatted_line,
);
}