From b07abf43acca3dd8509c3e0aec96f12d47dd3a4e Mon Sep 17 00:00:00 2001 From: Julio Biason Date: Tue, 30 Jun 2020 20:19:32 -0300 Subject: [PATCH] Starting: Tournament --- rust/tournament/.exercism/metadata.json | 1 + rust/tournament/.gitignore | 8 ++ rust/tournament/Cargo.toml | 4 + rust/tournament/README.md | 141 ++++++++++++++++++++++ rust/tournament/src/lib.rs | 6 + rust/tournament/tests/tournament.rs | 154 ++++++++++++++++++++++++ 6 files changed, 314 insertions(+) create mode 100644 rust/tournament/.exercism/metadata.json create mode 100644 rust/tournament/.gitignore create mode 100644 rust/tournament/Cargo.toml create mode 100644 rust/tournament/README.md create mode 100644 rust/tournament/src/lib.rs create mode 100644 rust/tournament/tests/tournament.rs diff --git a/rust/tournament/.exercism/metadata.json b/rust/tournament/.exercism/metadata.json new file mode 100644 index 0000000..a56ad79 --- /dev/null +++ b/rust/tournament/.exercism/metadata.json @@ -0,0 +1 @@ +{"track":"rust","exercise":"tournament","id":"f5184e4d92c242ddb44634b9fc33f39b","url":"https://exercism.io/my/solutions/f5184e4d92c242ddb44634b9fc33f39b","handle":"JBiason","is_requester":true,"auto_approve":false} \ No newline at end of file diff --git a/rust/tournament/.gitignore b/rust/tournament/.gitignore new file mode 100644 index 0000000..db7f315 --- /dev/null +++ b/rust/tournament/.gitignore @@ -0,0 +1,8 @@ +# Generated by Cargo +# will have compiled files and executables +/target/ +**/*.rs.bk + +# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries +# More information here http://doc.crates.io/guide.html#cargotoml-vs-cargolock +Cargo.lock diff --git a/rust/tournament/Cargo.toml b/rust/tournament/Cargo.toml new file mode 100644 index 0000000..b1e61ce --- /dev/null +++ b/rust/tournament/Cargo.toml @@ -0,0 +1,4 @@ +[package] +edition = "2018" +name = "tournament" +version = "1.4.0" diff --git a/rust/tournament/README.md b/rust/tournament/README.md new file mode 100644 index 0000000..e2558c0 --- /dev/null +++ b/rust/tournament/README.md @@ -0,0 +1,141 @@ +# Tournament + +Tally the results of a small football competition. + +Based on an input file containing which team played against which and what the +outcome was, create a file with a table like this: + +```text +Team | MP | W | D | L | P +Devastating Donkeys | 3 | 2 | 1 | 0 | 7 +Allegoric Alaskans | 3 | 2 | 0 | 1 | 6 +Blithering Badgers | 3 | 1 | 0 | 2 | 3 +Courageous Californians | 3 | 0 | 1 | 2 | 1 +``` + +What do those abbreviations mean? + +- MP: Matches Played +- W: Matches Won +- D: Matches Drawn (Tied) +- L: Matches Lost +- P: Points + +A win earns a team 3 points. A draw earns 1. A loss earns 0. + +The outcome should be ordered by points, descending. In case of a tie, teams are ordered alphabetically. + +### + +Input + +Your tallying program will receive input that looks like: + +```text +Allegoric Alaskans;Blithering Badgers;win +Devastating Donkeys;Courageous Californians;draw +Devastating Donkeys;Allegoric Alaskans;win +Courageous Californians;Blithering Badgers;loss +Blithering Badgers;Devastating Donkeys;loss +Allegoric Alaskans;Courageous Californians;win +``` + +The result of the match refers to the first team listed. So this line + +```text +Allegoric Alaskans;Blithering Badgers;win +``` + +Means that the Allegoric Alaskans beat the Blithering Badgers. + +This line: + +```text +Courageous Californians;Blithering Badgers;loss +``` + +Means that the Blithering Badgers beat the Courageous Californians. + +And this line: + +```text +Devastating Donkeys;Courageous Californians;draw +``` + +Means that the Devastating Donkeys and Courageous Californians tied. + +## Rust Installation + +Refer to the [exercism help page][help-page] for Rust installation and learning +resources. + +## Writing the Code + +Execute the tests with: + +```bash +$ cargo test +``` + +All but the first test have been ignored. After you get the first test to +pass, open the tests source file which is located in the `tests` directory +and remove the `#[ignore]` flag from the next test and get the tests to pass +again. Each separate test is a function with `#[test]` flag above it. +Continue, until you pass every test. + +If you wish to run all ignored tests without editing the tests source file, use: + +```bash +$ cargo test -- --ignored +``` + +To run a specific test, for example `some_test`, you can use: + +```bash +$ cargo test some_test +``` + +If the specific test is ignored use: + +```bash +$ cargo test some_test -- --ignored +``` + +To learn more about Rust tests refer to the [online test documentation][rust-tests] + +Make sure to read the [Modules][modules] chapter if you +haven't already, it will help you with organizing your files. + +## Further improvements + +After you have solved the exercise, please consider using the additional utilities, described in the [installation guide](https://exercism.io/tracks/rust/installation), to further refine your final solution. + +To format your solution, inside the solution directory use + +```bash +cargo fmt +``` + +To see, if your solution contains some common ineffective use cases, inside the solution directory use + +```bash +cargo clippy --all-targets +``` + +## Submitting the solution + +Generally you should submit all files in which you implemented your solution (`src/lib.rs` in most cases). If you are using any external crates, please consider submitting the `Cargo.toml` file. This will make the review process faster and clearer. + +## Feedback, Issues, Pull Requests + +The [exercism/rust](https://github.com/exercism/rust) repository on GitHub is the home for all of the Rust exercises. If you have feedback about an exercise, or want to help implement new exercises, head over there and create an issue. Members of the rust track team are happy to help! + +If you want to know more about Exercism, take a look at the [contribution guide](https://github.com/exercism/docs/blob/master/contributing-to-language-tracks/README.md). + +[help-page]: https://exercism.io/tracks/rust/learning +[modules]: https://doc.rust-lang.org/book/ch07-02-defining-modules-to-control-scope-and-privacy.html +[cargo]: https://doc.rust-lang.org/book/ch14-00-more-about-cargo.html +[rust-tests]: https://doc.rust-lang.org/book/ch11-02-running-tests.html + +## Submitting Incomplete Solutions +It's possible to submit an incomplete solution so you can see how others have completed the exercise. diff --git a/rust/tournament/src/lib.rs b/rust/tournament/src/lib.rs new file mode 100644 index 0000000..880dabd --- /dev/null +++ b/rust/tournament/src/lib.rs @@ -0,0 +1,6 @@ +pub fn tally(match_results: &str) -> String { + unimplemented!( + "Given the result of the played matches '{}' return a properly formatted tally table string.", + match_results + ); +} diff --git a/rust/tournament/tests/tournament.rs b/rust/tournament/tests/tournament.rs new file mode 100644 index 0000000..57be243 --- /dev/null +++ b/rust/tournament/tests/tournament.rs @@ -0,0 +1,154 @@ +use tournament; + +#[test] +fn just_the_header_if_no_input() { + let input = ""; + let expected = "Team | MP | W | D | L | P"; + + assert_eq!(tournament::tally(&input), expected); +} + +#[test] +#[ignore] +fn a_win_is_three_points_a_loss_is_zero_points() { + let input = "Allegoric Alaskans;Blithering Badgers;win"; + let expected = "".to_string() + + "Team | MP | W | D | L | P\n" + + "Allegoric Alaskans | 1 | 1 | 0 | 0 | 3\n" + + "Blithering Badgers | 1 | 0 | 0 | 1 | 0"; + + assert_eq!(tournament::tally(&input), expected); +} + +#[test] +#[ignore] +fn a_win_can_also_be_expressed_as_a_loss() { + let input = "Blithering Badgers;Allegoric Alaskans;loss"; + let expected = "".to_string() + + "Team | MP | W | D | L | P\n" + + "Allegoric Alaskans | 1 | 1 | 0 | 0 | 3\n" + + "Blithering Badgers | 1 | 0 | 0 | 1 | 0"; + + assert_eq!(tournament::tally(&input), expected); +} + +#[test] +#[ignore] +fn a_different_team_can_win() { + let input = "Blithering Badgers;Allegoric Alaskans;win"; + let expected = "".to_string() + + "Team | MP | W | D | L | P\n" + + "Blithering Badgers | 1 | 1 | 0 | 0 | 3\n" + + "Allegoric Alaskans | 1 | 0 | 0 | 1 | 0"; + + assert_eq!(tournament::tally(&input), expected); +} + +#[test] +#[ignore] +fn there_can_be_more_than_one_match() { + let input = "Allegoric Alaskans;Blithering Badgers;win\n".to_string() + + "Allegoric Alaskans;Blithering Badgers;win"; + let expected = "".to_string() + + "Team | MP | W | D | L | P\n" + + "Allegoric Alaskans | 2 | 2 | 0 | 0 | 6\n" + + "Blithering Badgers | 2 | 0 | 0 | 2 | 0"; + + assert_eq!(tournament::tally(&input), expected); +} + +#[test] +#[ignore] +fn a_draw_is_one_point_each() { + let input = "Allegoric Alaskans;Blithering Badgers;draw\n".to_string() + + "Allegoric Alaskans;Blithering Badgers;win"; + let expected = "".to_string() + + "Team | MP | W | D | L | P\n" + + "Allegoric Alaskans | 2 | 1 | 1 | 0 | 4\n" + + "Blithering Badgers | 2 | 0 | 1 | 1 | 1"; + + assert_eq!(tournament::tally(&input), expected); +} + +#[test] +#[ignore] +fn there_can_be_more_than_one_winner() { + let input = "Allegoric Alaskans;Blithering Badgers;loss\n".to_string() + + "Allegoric Alaskans;Blithering Badgers;win"; + let expected = "".to_string() + + "Team | MP | W | D | L | P\n" + + "Allegoric Alaskans | 2 | 1 | 0 | 1 | 3\n" + + "Blithering Badgers | 2 | 1 | 0 | 1 | 3"; + + assert_eq!(tournament::tally(&input), expected); +} + +#[test] +#[ignore] +fn there_can_be_more_than_two_teams() { + let input = "Allegoric Alaskans;Blithering Badgers;win\n".to_string() + + "Blithering Badgers;Courageous Californians;win\n" + + "Courageous Californians;Allegoric Alaskans;loss"; + let expected = "".to_string() + + "Team | MP | W | D | L | P\n" + + "Allegoric Alaskans | 2 | 2 | 0 | 0 | 6\n" + + "Blithering Badgers | 2 | 1 | 0 | 1 | 3\n" + + "Courageous Californians | 2 | 0 | 0 | 2 | 0"; + + assert_eq!(tournament::tally(&input), expected); +} + +#[test] +#[ignore] +fn typical_input() { + let input = "Allegoric Alaskans;Blithering Badgers;win\n".to_string() + + "Devastating Donkeys;Courageous Californians;draw\n" + + "Devastating Donkeys;Allegoric Alaskans;win\n" + + "Courageous Californians;Blithering Badgers;loss\n" + + "Blithering Badgers;Devastating Donkeys;loss\n" + + "Allegoric Alaskans;Courageous Californians;win"; + let expected = "".to_string() + + "Team | MP | W | D | L | P\n" + + "Devastating Donkeys | 3 | 2 | 1 | 0 | 7\n" + + "Allegoric Alaskans | 3 | 2 | 0 | 1 | 6\n" + + "Blithering Badgers | 3 | 1 | 0 | 2 | 3\n" + + "Courageous Californians | 3 | 0 | 1 | 2 | 1"; + + assert_eq!(tournament::tally(&input), expected); +} + +#[test] +#[ignore] +fn incomplete_competition_not_all_pairs_have_played() { + let input = "Allegoric Alaskans;Blithering Badgers;loss\n".to_string() + + "Devastating Donkeys;Allegoric Alaskans;loss\n" + + "Courageous Californians;Blithering Badgers;draw\n" + + "Allegoric Alaskans;Courageous Californians;win"; + let expected = "".to_string() + + "Team | MP | W | D | L | P\n" + + "Allegoric Alaskans | 3 | 2 | 0 | 1 | 6\n" + + "Blithering Badgers | 2 | 1 | 1 | 0 | 4\n" + + "Courageous Californians | 2 | 0 | 1 | 1 | 1\n" + + "Devastating Donkeys | 1 | 0 | 0 | 1 | 0"; + + assert_eq!(tournament::tally(&input), expected); +} + +#[test] +#[ignore] +fn ties_broken_alphabetically() { + let input = "Courageous Californians;Devastating Donkeys;win\n".to_string() + + "Allegoric Alaskans;Blithering Badgers;win\n" + + "Devastating Donkeys;Allegoric Alaskans;loss\n" + + "Courageous Californians;Blithering Badgers;win\n" + + "Blithering Badgers;Devastating Donkeys;draw\n" + + "Allegoric Alaskans;Courageous Californians;draw"; + let expected = "".to_string() + + "Team | MP | W | D | L | P\n" + + "Allegoric Alaskans | 3 | 2 | 1 | 0 | 7\n" + + "Courageous Californians | 3 | 2 | 1 | 0 | 7\n" + + "Blithering Badgers | 3 | 0 | 1 | 2 | 1\n" + + "Devastating Donkeys | 3 | 0 | 1 | 2 | 1"; + + assert_eq!(tournament::tally(&input), expected); +}