Merge pull request #1021 from petertseng/fmt

GitHub Actions: Enforce exercises' formatting; format exercises

Author: petertseng

.github/workflows/tests.yml

@@ -109,6 +109,33 @@ jobs:
         run: sh ./_test/check-exercise-crate.sh
         continue-on-error: ${{ matrix.rust == 'beta' && matrix.deny_warnings == '1' }}
 
+  rustformat:
+    name: Check Rust Formatting
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          default: true
+
+      - name: Rust Format Version
+        run: rustfmt --version
+
+      - name: Format
+        run: sh bin/format_exercises
+
+      - name: Diff
+        run: |
+          if ! git diff --color --exit-code; then
+            echo "Please run cargo fmt, or see the diff above:"
+            exit 1
+          fi
+
   clippy:
     name: Clippy
     runs-on: ubuntu-latest

bin/format_exercises

@@ -1,33 +1,17 @@
-#!/bin/bash
+#!/bin/sh
 # Format existing exercises using rustfmt
 
 RUST_TRACK_REPO_PATH=$(cd "$(dirname "$0")/.." && pwd)
 
 EXERCISES_PATH="${RUST_TRACK_REPO_PATH}/exercises/"
 
-# Some exercises use custom formatting for illustration purpose and should not be formatted. 
-IGNORED_EXERCISES=(
-	"diamond" 
-	"minesweeper" 
-	"rectangles"
-)
-
-# Iterate over every exercise directory and if it is not ignored - format it
 for exercise_dir in ${EXERCISES_PATH}/*; do
-	exercise_name=${exercise_dir##*/}
-
-	if [[ " ${IGNORED_EXERCISES[*]} " == *"$exercise_name"* ]]; then
-		echo "$exercise_name - Ignored"
-	else
-		(
-			echo "$exercise_name - Formatting"
-
-			cd "$exercise_dir"
-
-			cargo fmt
-
-			[ -f example.rs ] && rustfmt example.rs
-		)
-	fi
-
+  exercise_name=$(basename $exercise_dir)
+  (
+    cd "$exercise_dir"
+    cargo fmt
+    if [ -f example.rs ]; then
+      rustfmt example.rs
+    fi
+  )
 done

exercises/acronym/tests/acronym.rs

@@ -30,7 +30,10 @@ fn punctuation() {
 #[test]
 #[ignore]
 fn all_caps_word() {
-    assert_eq!(acronym::abbreviate("GNU Image Manipulation Program"), "GIMP");
+    assert_eq!(
+        acronym::abbreviate("GNU Image Manipulation Program"),
+        "GIMP"
+    );
 }
 
 #[test]
@@ -52,7 +55,9 @@ fn punctuation_without_whitespace() {
 #[ignore]
 fn very_long_abbreviation() {
     assert_eq!(
-        acronym::abbreviate("Rolling On The Floor Laughing So Hard That My Dogs Came Over And Licked Me"),
+        acronym::abbreviate(
+            "Rolling On The Floor Laughing So Hard That My Dogs Came Over And Licked Me"
+        ),
         "ROTFLSHTMDCOALM"
     );
 }
@@ -69,17 +74,11 @@ fn consecutive_delimiters() {
 #[test]
 #[ignore]
 fn apostrophes() {
-    assert_eq!(
-        acronym::abbreviate("Halley's Comet"),
-        "HC"
-    );
+    assert_eq!(acronym::abbreviate("Halley's Comet"), "HC");
 }
 
 #[test]
 #[ignore]
 fn underscore_emphasis() {
-    assert_eq!(
-        acronym::abbreviate("The Road _Not_ Taken"),
-        "TRNT"
-    );
+    assert_eq!(acronym::abbreviate("The Road _Not_ Taken"), "TRNT");
 }

exercises/all-your-base/example.rs

@@ -55,7 +55,7 @@ pub fn convert<P: AsRef<[Digit]>>(
     if let Some(&invalid) = digits.as_ref().iter().find(|&num| *num >= from_base) {
         return Err(Error::InvalidDigit(invalid));
     }
-    
+
     // convert all digits into a single large number
     let mut immediate: Digit = digits
         .as_ref()
@@ -75,6 +75,6 @@ pub fn convert<P: AsRef<[Digit]>>(
     res.reverse();
     if res.is_empty() {
         res.push(0);
-    } 
+    }
     Ok(res)
 }

exercises/bob/tests/bob.rs

@@ -8,196 +8,183 @@ fn test_stating_something() {
     process_response_case("Tom-ay-to, tom-aaaah-to.", "Whatever.");
 }
 
-
 #[test]
 #[ignore]
 /// ending with whitespace
 fn test_ending_with_whitespace() {
     process_response_case("Okay if like my  spacebar  quite a bit?   ", "Sure.");
 }
 
-
 #[test]
 #[ignore]
 /// shouting numbers
 fn test_shouting_numbers() {
     process_response_case("1, 2, 3 GO!", "Whoa, chill out!");
 }
 
-
 #[test]
 #[ignore]
 /// other whitespace
 fn test_other_whitespace() {
     process_response_case("\r\r 	", "Fine. Be that way!");
 }
 
-
 #[test]
 #[ignore]
 /// shouting with special characters
 fn test_shouting_with_special_characters() {
-    process_response_case("ZOMG THE %^*@#$(*^ ZOMBIES ARE COMING!!11!!1!", "Whoa, chill out!");
+    process_response_case(
+        "ZOMG THE %^*@#$(*^ ZOMBIES ARE COMING!!11!!1!",
+        "Whoa, chill out!",
+    );
 }
 
-
 #[test]
 #[ignore]
 /// talking forcefully
 fn test_talking_forcefully() {
     process_response_case("Hi there!", "Whatever.");
 }
 
-
 #[test]
 #[ignore]
 /// prattling on
 fn test_prattling_on() {
     process_response_case("Wait! Hang on. Are you going to be OK?", "Sure.");
 }
 
-
 #[test]
 #[ignore]
 /// forceful question
 fn test_forceful_question() {
-   process_response_case("WHAT'S GOING ON?", "Calm down, I know what I'm doing!");
+    process_response_case("WHAT'S GOING ON?", "Calm down, I know what I'm doing!");
 }
 
-
 #[test]
 #[ignore]
 /// shouting with no exclamation mark
 fn test_shouting_with_no_exclamation_mark() {
     process_response_case("I HATE THE DENTIST", "Whoa, chill out!");
 }
 
-
 #[test]
 #[ignore]
 /// asking gibberish
 fn test_asking_gibberish() {
     process_response_case("fffbbcbeab?", "Sure.");
 }
 
-
 #[test]
 #[ignore]
 /// question with no letters
 fn test_question_with_no_letters() {
     process_response_case("4?", "Sure.");
 }
 
-
 #[test]
 #[ignore]
 /// no letters
 fn test_no_letters() {
     process_response_case("1, 2, 3", "Whatever.");
 }
 
-
 #[test]
 #[ignore]
 /// statement containing question mark
 fn test_statement_containing_question_mark() {
     process_response_case("Ending with ? means a question.", "Whatever.");
 }
 
-
 //NEW
 #[test]
 #[ignore]
 /// multiple line question
 fn test_multiple_line_question() {
-    process_response_case("\rDoes this cryogenic chamber make me look fat?\rNo.", "Whatever.");
+    process_response_case(
+        "\rDoes this cryogenic chamber make me look fat?\rNo.",
+        "Whatever.",
+    );
 }
 
-
 #[test]
 #[ignore]
 /// non-question ending with whitespace
 fn test_nonquestion_ending_with_whitespace() {
-    process_response_case("This is a statement ending with whitespace      ", "Whatever.");
+    process_response_case(
+        "This is a statement ending with whitespace      ",
+        "Whatever.",
+    );
 }
 
-
 #[test]
 #[ignore]
 /// shouting
 fn test_shouting() {
     process_response_case("WATCH OUT!", "Whoa, chill out!");
 }
 
-
 #[test]
 #[ignore]
 /// non-letters with question
 fn test_nonletters_with_question() {
     process_response_case(":) ?", "Sure.");
 }
 
-
 #[test]
 #[ignore]
 /// shouting gibberish
 fn test_shouting_gibberish() {
     process_response_case("FCECDFCAAB", "Whoa, chill out!");
 }
 
-
 #[test]
 #[ignore]
 /// asking a question
 fn test_asking_a_question() {
     process_response_case("Does this cryogenic chamber make me look fat?", "Sure.");
 }
 
-
 #[test]
 #[ignore]
 /// asking a numeric question
 fn test_asking_a_numeric_question() {
     process_response_case("You are, what, like 15?", "Sure.");
 }
 
-
 #[test]
 #[ignore]
 /// silence
 fn test_silence() {
     process_response_case("", "Fine. Be that way!");
 }
 
-
 #[test]
 #[ignore]
 /// starting with whitespace
 fn test_starting_with_whitespace() {
     process_response_case("         hmmmmmmm...", "Whatever.");
 }
 
-
 #[test]
 #[ignore]
 /// using acronyms in regular speech
 fn test_using_acronyms_in_regular_speech() {
-    process_response_case("It's OK if you don't want to go work for NASA.", "Whatever.");
+    process_response_case(
+        "It's OK if you don't want to go work for NASA.",
+        "Whatever.",
+    );
 }
 
-
 #[test]
 #[ignore]
 /// alternate silence
 fn test_alternate_silence() {
     process_response_case("										", "Fine. Be that way!");
 }
 
-
 #[test]
 #[ignore]
 /// prolonged silence
 fn test_prolonged_silence() {
     process_response_case("          ", "Fine. Be that way!");
 }
-

exercises/bowling/tests/bowling.rs

@@ -432,7 +432,6 @@ fn cannot_roll_after_bonus_roll_for_strike() {
     assert_eq!(game.roll(2), Err(Error::GameComplete));
 }
 
-
 #[test]
 #[ignore]
 fn last_two_strikes_followed_by_only_last_bonus_with_non_strike_points() {

exercises/decimal/example.rs

@@ -76,7 +76,7 @@ impl Decimal {
             lower_precision.decimal_index += precision_difference;
         }
         match one.decimal_index.cmp(&two.decimal_index) {
-            std::cmp::Ordering::Equal => {},
+            std::cmp::Ordering::Equal => {}
             std::cmp::Ordering::Less => expand(&mut one, &two),
             std::cmp::Ordering::Greater => expand(&mut two, &one),
         }
@@ -118,7 +118,13 @@ macro_rules! auto_impl_decimal_ops {
 
 auto_impl_decimal_ops!(Add, add, |s, o| s + o, |s, _| s);
 auto_impl_decimal_ops!(Sub, sub, |s, o| s - o, |s, _| s);
-auto_impl_decimal_ops!(#[allow(clippy::suspicious_arithmetic_impl)] Mul, mul, |s, o| s * o, |s, o| s + o);
+auto_impl_decimal_ops!(
+    #[allow(clippy::suspicious_arithmetic_impl)]
+    Mul,
+    mul,
+    |s, o| s * o,
+    |s, o| s + o
+);
 
 macro_rules! auto_impl_decimal_cow {
     ($trait:ident, $func_name:ident, $digits_operation:expr, $return_type:ty) => {