Merge branch 'master' of https://github.com/sjmann/rustlings into generics-exercises

sjmann · sjmann · commit 29b30ec946b8 · 2020-02-28T00:19:45.000Z
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,6 @@
 target/
 **/*.rs.bk
 .DS_Store
+*.pdb
+exercises/clippy/Cargo.toml
+exercises/clippy/Cargo.lock
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,44 @@
+<a name="2.2.1"></a>
+### 2.2.1 (2020-02-27)
+
+#### Bug Fixes
+
+*   Re-add cloning the repo to install scripts ([3d9b03c5](https://github.com/rust-lang/rustlings/commit/3d9b03c52b8dc51b140757f6fd25ad87b5782ef5))
+
+#### Features
+
+*   Add clippy lints (#269) ([1e2fd9c9](https://github.com/rust-lang/rustlings/commit/1e2fd9c92f8cd6e389525ca1a999fca4c90b5921))
+
+<a name="2.2.0"></a>
+## 2.2.0 (2020-02-25)
+
+
+#### Bug Fixes
+
+*   Update deps to version compatable with aarch64-pc-windows (#263) ([19a93428](https://github.com/rust-lang/rustlings/commit/19a93428b3c73d994292671f829bdc8e5b7b3401))
+* **docs:**
+  * Added a necessary step to Windows installation process (#242) ([3906efcd](https://github.com/rust-lang/rustlings/commit/3906efcd52a004047b460ed548037093de3f523f))
+  * Fixed mangled sentence from book; edited for clarity (#266) ([ade52ff](https://github.com/rust-lang/rustlings/commit/ade52ffb739987287ddd5705944c8777705faed9)) 
+  * Updated iterators readme to account for iterators4 exercise (#273) ([bec8e3a](https://github.com/rust-lang/rustlings/commit/bec8e3a644cbd88db1c73ea5f1d8a364f4a34016))
+* **installation:**  make fatal errors more obvious (#272) ([17d0951e](https://github.com/rust-lang/rustlings/commit/17d0951e66fda8e11b204d5c4c41a0d5e22e78f7))
+* **iterators2:**
+  *  Remove reference to missing iterators2.rs (#245) ([419f7797](https://github.com/rust-lang/rustlings/commit/419f7797f294e4ce6a2b883199731b5bde77d262))
+* **as_ref_mut:** Enable a test and improve per clippy's suggestion (#256) ([dfdf809](https://github.com/rust-lang/rustlings/commit/dfdf8093ebbd4145864995627b812780de52f902))
+* **tests1:**
+  * Change test command ([fe10e06c](https://github.com/rust-lang/rustlings/commit/fe10e06c3733ddb4a21e90d09bf79bfe618e97ce) 
+  * Correct test command in tests1.rs comment (#263) ([39fa7ae](https://github.com/rust-lang/rustlings/commit/39fa7ae8b70ad468da49b06f11b2383135a63bcf))
+
+#### Features
+
+*   Add variables5.rs exercise (#264) ([0c73609e](https://github.com/rust-lang/rustlings/commit/0c73609e6f2311295e95d6f96f8c747cfc4cba03))
+*   Show a completion message when watching (#253) ([d25ee55a](https://github.com/rust-lang/rustlings/commit/d25ee55a3205882d35782e370af855051b39c58c))
+*   Add type conversion and parsing exercises (#249) ([0c85dc11](https://github.com/rust-lang/rustlings/commit/0c85dc1193978b5165491b99cc4922caf8d14a65))
+*   Created consistent money unit (#258) ([fd57f8f](https://github.com/rust-lang/rustlings/commit/fd57f8f2c1da2af8ddbebbccec214e6f40f4dbab))
+*   Enable test for exercise test4 (#276) ([8b971ff](https://github.com/rust-lang/rustlings/commit/8b971ffab6079a706ac925f5917f987932b55c07))
+*   Added traits exercises (#274 but specifically #216, which originally added
+    this :heart:) ([b559cdd](https://github.com/rust-lang/rustlings/commit/b559cdd73f32c0d0cfc1feda39f82b3e3583df17))
+
+
 <a name="2.1.0"></a>
 ## 2.1.0 (2019-11-27)
 
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "rustlings"
-version = "2.1.0"
+version = "2.2.1"
 authors = ["Marisa <mokou@posteo.de>", "Carol (Nichols || Goulding) <carol.nichols@gmail.com"]
 edition = "2018"
 
diff --git a/README.md b/README.md
@@ -54,7 +54,7 @@ Basically: Clone the repository, checkout to the latest tag, run `cargo install`
 ```bash
 git clone https://github.com/rust-lang/rustlings
 cd rustlings
-git checkout tags/2.1.0 # or whatever the latest version is (find out at https://github.com/rust-lang/rustlings/releases/latest)
+git checkout tags/2.2.1 # or whatever the latest version is (find out at https://github.com/rust-lang/rustlings/releases/latest)
 cargo install --force --path .
 ```
 
diff --git a/exercises/clippy/README.md b/exercises/clippy/README.md
@@ -0,0 +1,8 @@
+### Clippy
+
+The Clippy tool is a collection of lints to analyze your code so you can catch common mistakes and improve your Rust code.
+
+If you used the installation script for Rustlings, Clippy should be already installed.
+If not you can install it manually via `rustup component add clippy`.
+
+For more information about Clippy lints, please see [their documentation page](https://rust-lang.github.io/rust-clippy/master/).
diff --git a/exercises/clippy/clippy1.rs b/exercises/clippy/clippy1.rs
@@ -0,0 +1,15 @@
+// clippy1.rs
+// The Clippy tool is a collection of lints to analyze your code
+// so you can catch common mistakes and improve your Rust code.
+//
+// Execute `rustlings hint clippy1` for hints :)
+
+// I AM NOT DONE
+
+fn main() {
+    let x = 1.2331f64;
+    let y = 1.2332f64;
+    if y != x {
+        println!("Success!");
+    }
+}
diff --git a/exercises/clippy/clippy2.rs b/exercises/clippy/clippy2.rs
@@ -0,0 +1,13 @@
+// clippy2.rs
+// Make me compile! Execute `rustlings hint clippy2` for hints :)
+
+// I AM NOT DONE
+
+fn main() {
+    let mut res = 42;
+    let option = Some(12);
+    for x in option {
+        res += x;
+    }
+    println!("{}", res);
+}
diff --git a/exercises/test4.rs b/exercises/test4.rs
@@ -7,8 +7,17 @@
 
 // I AM NOT DONE
 
-fn main() {
-    if my_macro!("world!") != "Hello world!" {
-        panic!("Oh no! Wrong output!");
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_my_macro_world() {
+        assert_eq!(my_macro!("world!"), "Hello world!");
+    }
+
+    #[test]
+    fn test_my_macro_goodbye() {
+        assert_eq!(my_macro!("goodbye!"), "Hello goodbye!");
     }
 }
diff --git a/info.toml b/info.toml
@@ -369,7 +369,7 @@ The way macros are written, it wants to see something between each
 [[exercises]]
 name = "test4"
 path = "exercises/test4.rs"
-mode = "compile"
+mode = "test"
 hint = "No hints this time ;)"
 
 # MOVE SEMANTICS
@@ -529,6 +529,22 @@ hint = """
 It should be doing some checking, returning an `Err` result if those checks fail, and only
 returning an `Ok` result if those checks determine that everything is... okay :)"""
 
+#  CLIPPY
+
+[[exercises]]
+name = "clippy1"
+path = "exercises/clippy/clippy1.rs"
+mode = "clippy"
+hint = """
+Floating point calculations are usually imprecise, so asking if two values are exactly equal is asking for trouble"""
+
+[[exercises]]
+name = "clippy2"
+path = "exercises/clippy/clippy2.rs"
+mode = "clippy"
+hint = """
+`for` loops over Option values are more clearly expressed as an `if let`"""
+
 # STANDARD LIBRARY TYPES
 
 [[exercises]]
diff --git a/install.ps1 b/install.ps1
@@ -72,6 +72,7 @@ if (!($LASTEXITCODE -eq 0)) {
 # but anyone running pwsh 5 will have to pass the argument.
 $version = Invoke-WebRequest -UseBasicParsing https://api.github.com/repos/rust-lang/rustlings/releases/latest `
     | ConvertFrom-Json | Select-Object -ExpandProperty tag_name
+
 Write-Host "Checking out version $version..."
 Set-Location $path
 git checkout -q tags/$version
@@ -82,4 +83,12 @@ if (!(Get-Command rustlings -ErrorAction SilentlyContinue)) {
     Write-Host "WARNING: Please check that you have '~/.cargo/bin' in your PATH environment variable!"
 }
 
+# Checking whether Clippy is installed.
+# Due to a bug in Cargo, this must be done with Rustup: https://github.com/rust-lang/rustup/issues/1514
+$clippy = (rustup component list | Select-String "clippy" | Select-String "installed") | Out-String
+if (!$clippy) {
+    Write-Host "Installing the 'cargo-clippy' executable..."
+    rustup component add clippy
+}
+
 Write-Host "All done! Run 'rustlings' to get started."
diff --git a/install.sh b/install.sh
@@ -87,6 +87,8 @@ echo "Cloning Rustlings at $Path..."
 git clone -q https://github.com/rust-lang/rustlings $Path
 
 Version=$(curl -s https://api.github.com/repos/rust-lang/rustlings/releases/latest | python -c "import json,sys;obj=json.load(sys.stdin);print(obj['tag_name']);")
+CargoBin="${CARGO_HOME:-$HOME/.cargo}/bin"
+
 echo "Checking out version $Version..."
 cd $Path
 git checkout -q tags/$Version
@@ -96,7 +98,16 @@ cargo install --force --path .
 
 if ! [ -x "$(command -v rustlings)" ]
 then
-    echo "WARNING: Please check that you have '~/.cargo/bin' in your PATH environment variable!"
+    echo "WARNING: Please check that you have '$CargoBin' in your PATH environment variable!"
+fi
+
+# Checking whether Clippy is installed.
+# Due to a bug in Cargo, this must be done with Rustup: https://github.com/rust-lang/rustup/issues/1514
+Clippy=$(rustup component list | grep "clippy" | grep "installed")
+if [ -z "$Clippy" ]
+then
+    echo "Installing the 'cargo-clippy' executable..."
+    rustup component add clippy
 fi
 
 echo "All done! Run 'rustlings' to get started."
diff --git a/src/exercise.rs b/src/exercise.rs
@@ -1,14 +1,15 @@
 use regex::Regex;
 use serde::Deserialize;
 use std::fmt::{self, Display, Formatter};
-use std::fs::{remove_file, File};
+use std::fs::{self, remove_file, File};
 use std::io::Read;
 use std::path::PathBuf;
-use std::process::{self, Command, Output};
+use std::process::{self, Command};
 
 const RUSTC_COLOR_ARGS: &[&str] = &["--color", "always"];
 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/clippy/Cargo.toml";
 
 fn temp_file() -> String {
     format!("./temp_{}", process::id())
@@ -19,6 +20,7 @@ fn temp_file() -> String {
 pub enum Mode {
     Compile,
     Test,
+    Clippy,
 }
 
 #[derive(Deserialize)]
@@ -47,9 +49,34 @@ pub struct ContextLine {
     pub important: bool,
 }
 
+pub struct CompiledExercise<'a> {
+    exercise: &'a Exercise,
+    _handle: FileHandle,
+}
+
+impl<'a> CompiledExercise<'a> {
+    pub fn run(&self) -> Result<ExerciseOutput, ExerciseOutput> {
+        self.exercise.run()
+    }
+}
+
+#[derive(Debug)]
+pub struct ExerciseOutput {
+    pub stdout: String,
+    pub stderr: String,
+}
+
+struct FileHandle;
+
+impl Drop for FileHandle {
+    fn drop(&mut self) {
+        clean();
+    }
+}
+
 impl Exercise {
-    pub fn compile(&self) -> Output {
-        match self.mode {
+    pub fn compile(&self) -> Result<CompiledExercise, ExerciseOutput> {
+        let cmd = match self.mode {
             Mode::Compile => Command::new("rustc")
                 .args(&[self.path.to_str().unwrap(), "-o", &temp_file()])
                 .args(RUSTC_COLOR_ARGS)
@@ -58,18 +85,66 @@ impl Exercise {
                 .args(&["--test", self.path.to_str().unwrap(), "-o", &temp_file()])
                 .args(RUSTC_COLOR_ARGS)
                 .output(),
+            Mode::Clippy => {
+                let cargo_toml = format!(
+                    r#"[package]
+name = "{}"
+version = "0.0.1"
+edition = "2018"
+[[bin]]
+name = "{}"
+path = "{}.rs""#,
+                    self.name, self.name, self.name
+                );
+                fs::write(CLIPPY_CARGO_TOML_PATH, cargo_toml)
+                    .expect("Failed to write 📎 Clippy 📎 Cargo.toml file.");
+                // 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
+                // This is already fixed on master branch. See this issue to track merging into Cargo:
+                // https://github.com/rust-lang/rust-clippy/issues/3837
+                Command::new("cargo")
+                    .args(&["clean", "--manifest-path", CLIPPY_CARGO_TOML_PATH])
+                    .args(RUSTC_COLOR_ARGS)
+                    .output()
+                    .expect("Failed to run 'cargo clean'");
+                Command::new("cargo")
+                    .args(&["clippy", "--manifest-path", CLIPPY_CARGO_TOML_PATH])
+                    .args(RUSTC_COLOR_ARGS)
+                    .args(&["--", "-D", "warnings"])
+                    .output()
+            }
+        }
+        .expect("Failed to run 'compile' command.");
+
+        if cmd.status.success() {
+            Ok(CompiledExercise {
+                exercise: &self,
+                _handle: FileHandle,
+            })
+        } else {
+            clean();
+            Err(ExerciseOutput {
+                stdout: String::from_utf8_lossy(&cmd.stdout).to_string(),
+                stderr: String::from_utf8_lossy(&cmd.stderr).to_string(),
+            })
         }
-        .expect("Failed to run 'compile' command.")
     }
 
-    pub fn run(&self) -> Output {
-        Command::new(&temp_file())
+    fn run(&self) -> Result<ExerciseOutput, ExerciseOutput> {
+        let cmd = Command::new(&temp_file())
             .output()
-            .expect("Failed to run 'run' command")
-    }
+            .expect("Failed to run 'run' command");
+
+        let output = ExerciseOutput {
+            stdout: String::from_utf8_lossy(&cmd.stdout).to_string(),
+            stderr: String::from_utf8_lossy(&cmd.stderr).to_string(),
+        };
 
-    pub fn clean(&self) {
-        let _ignored = remove_file(&temp_file());
+        if cmd.status.success() {
+            Ok(output)
+        } else {
+            Err(output)
+        }
     }
 
     pub fn state(&self) -> State {
@@ -121,6 +196,10 @@ impl Display for Exercise {
     }
 }
 
+fn clean() {
+    let _ignored = remove_file(&temp_file());
+}
+
 #[cfg(test)]
 mod test {
     use super::*;
@@ -131,11 +210,12 @@ mod test {
         File::create(&temp_file()).unwrap();
         let exercise = Exercise {
             name: String::from("example"),
-            path: PathBuf::from("example.rs"),
-            mode: Mode::Test,
+            path: PathBuf::from("tests/fixture/state/pending_exercise.rs"),
+            mode: Mode::Compile,
             hint: String::from(""),
         };
-        exercise.clean();
+        let compiled = exercise.compile().unwrap();
+        drop(compiled);
         assert!(!Path::new(&temp_file()).exists());
     }
 
diff --git a/src/main.rs b/src/main.rs
@@ -15,6 +15,9 @@ use std::sync::{Arc, Mutex};
 use std::thread;
 use std::time::Duration;
 
+#[macro_use]
+mod ui;
+
 mod exercise;
 mod run;
 mod verify;
diff --git a/src/run.rs b/src/run.rs
diff --git a/src/ui.rs b/src/ui.rs
diff --git a/src/verify.rs b/src/verify.rs
