Add rust/clock exercise

This commit is contained in:
Avery Winters 2023-10-11 11:24:31 -05:00
parent 3586ece50a
commit 01407451de
Signed by: avery
SSH key fingerprint: SHA256:eesvLB5MMqHLZrAMFt6kEhqJWnASMLcET6Sgmw0FqZI
8 changed files with 564 additions and 0 deletions

View file

@ -0,0 +1,43 @@
{
"authors": [
"sacherjj"
],
"contributors": [
"attilahorvath",
"coriolinus",
"cwhakes",
"danieljl",
"eddyp",
"efx",
"ErikSchierboom",
"felix91gr",
"kunaltyagi",
"lutostag",
"nfiles",
"petertseng",
"rofrol",
"shaaraddalvi",
"stringparser",
"tmccombs",
"xakon",
"ZapAnton"
],
"files": {
"solution": [
"src/lib.rs",
"Cargo.toml"
],
"test": [
"tests/clock.rs"
],
"example": [
".meta/example.rs"
]
},
"blurb": "Implement a clock that handles times without dates.",
"source": "Pairing session with Erin Drummond",
"source_url": "https://twitter.com/ebdrummond",
"custom": {
"allowed-to-not-compile": "Stub doesn't compile because there is no to_string() implementation. This exercise is an introduction to derived and self-implemented traits, therefore adding template for a trait would reduce student learning."
}
}

View file

@ -0,0 +1 @@
{"track":"rust","exercise":"clock","id":"03afbacf8b0344d091daf16fb370c820","url":"https://exercism.org/tracks/rust/exercises/clock","handle":"averywinters","is_requester":true,"auto_approve":false}

8
rust/clock/.gitignore vendored Normal file
View file

@ -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

6
rust/clock/Cargo.toml Normal file
View file

@ -0,0 +1,6 @@
[package]
edition = "2021"
name = "clock"
version = "2.4.0"
[dependencies]

86
rust/clock/HELP.md Normal file
View file

@ -0,0 +1,86 @@
# Help
## Running the tests
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 _only ignored_ tests without editing the tests source file, use:
```bash
$ cargo test -- --ignored
```
If you are using Rust 1.51 or later, you can run _all_ tests with
```bash
$ cargo test -- --include-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].
[rust-tests]: https://doc.rust-lang.org/book/ch11-02-running-tests.html
## Submitting your solution
You can submit your solution using the `exercism submit src/lib.rs Cargo.toml` command.
This command will upload your solution to the Exercism website and print the solution page's URL.
It's possible to submit an incomplete solution which allows you to:
- See how others have completed the exercise
- Request help from a mentor
## Need to get help?
If you'd like help solving the exercise, check the following pages:
- The [Rust track's documentation](https://exercism.org/docs/tracks/rust)
- The [Rust track's programming category on the forum](https://forum.exercism.org/c/programming/rust)
- [Exercism's programming category on the forum](https://forum.exercism.org/c/programming/5)
- The [Frequently Asked Questions](https://exercism.org/docs/using/faqs)
Should those resources not suffice, you could submit your (incomplete) solution to request mentoring.
## Rust Installation
Refer to the [exercism help page][help-page] for Rust installation and learning
resources.
## 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 GitHub [track repository][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].
## Submitting Incomplete Solutions
It's possible to submit an incomplete solution so you can see how others have completed the exercise.
[help-page]: https://exercism.org/tracks/rust/learning
[github]: https://github.com/exercism/rust
[contribution guide]: https://exercism.org/docs/community/contributors

57
rust/clock/README.md Normal file
View file

@ -0,0 +1,57 @@
# Clock
Welcome to Clock on Exercism's Rust Track.
If you need help running the tests or submitting your code, check out `HELP.md`.
## Instructions
Implement a clock that handles times without dates.
You should be able to add and subtract minutes to it.
Two clocks that represent the same time should be equal to each other.
You will also need to implement `.to_string()` for the `Clock` struct. We will be using this to display the Clock's state. You can either do it via implementing it directly or using the [Display trait](https://doc.rust-lang.org/std/fmt/trait.Display.html).
Did you implement `.to_string()` for the `Clock` struct?
If so, try implementing the
[Display trait](https://doc.rust-lang.org/std/fmt/trait.Display.html) for `Clock` instead.
Traits allow for a common way to implement functionality for various types.
For additional learning, consider how you might implement `String::from` for the `Clock` type.
You don't have to actually implement this—it's redundant with `Display`, which is generally the
better choice when the destination type is `String`—but it's useful to have a few type-conversion
traits in your toolkit.
## Source
### Created by
- @sacherjj
### Contributed to by
- @attilahorvath
- @coriolinus
- @cwhakes
- @danieljl
- @eddyp
- @efx
- @ErikSchierboom
- @felix91gr
- @kunaltyagi
- @lutostag
- @nfiles
- @petertseng
- @rofrol
- @shaaraddalvi
- @stringparser
- @tmccombs
- @xakon
- @ZapAnton
### Based on
Pairing session with Erin Drummond - https://twitter.com/ebdrummond

11
rust/clock/src/lib.rs Normal file
View file

@ -0,0 +1,11 @@
pub struct Clock;
impl Clock {
pub fn new(hours: i32, minutes: i32) -> Self {
todo!("Construct a new Clock from {hours} hours and {minutes} minutes");
}
pub fn add_minutes(&self, minutes: i32) -> Self {
todo!("Add {minutes} minutes to existing Clock time");
}
}

352
rust/clock/tests/clock.rs Normal file
View file

@ -0,0 +1,352 @@
use clock::Clock;
//
// Clock Creation
//
#[test]
fn on_the_hour() {
assert_eq!(Clock::new(8, 0).to_string(), "08:00");
}
#[test]
#[ignore]
fn past_the_hour() {
assert_eq!(Clock::new(11, 9).to_string(), "11:09");
}
#[test]
#[ignore]
fn midnight_is_zero_hours() {
assert_eq!(Clock::new(24, 0).to_string(), "00:00");
}
#[test]
#[ignore]
fn hour_rolls_over() {
assert_eq!(Clock::new(25, 0).to_string(), "01:00");
}
#[test]
#[ignore]
fn hour_rolls_over_continuously() {
assert_eq!(Clock::new(100, 0).to_string(), "04:00");
}
#[test]
#[ignore]
fn sixty_minutes_is_next_hour() {
assert_eq!(Clock::new(1, 60).to_string(), "02:00");
}
#[test]
#[ignore]
fn minutes_roll_over() {
assert_eq!(Clock::new(0, 160).to_string(), "02:40");
}
#[test]
#[ignore]
fn minutes_roll_over_continuously() {
assert_eq!(Clock::new(0, 1723).to_string(), "04:43");
}
#[test]
#[ignore]
fn hours_and_minutes_roll_over() {
assert_eq!(Clock::new(25, 160).to_string(), "03:40");
}
#[test]
#[ignore]
fn hours_and_minutes_roll_over_continuously() {
assert_eq!(Clock::new(201, 3001).to_string(), "11:01");
}
#[test]
#[ignore]
fn hours_and_minutes_roll_over_to_exactly_midnight() {
assert_eq!(Clock::new(72, 8640).to_string(), "00:00");
}
#[test]
#[ignore]
fn negative_hour() {
assert_eq!(Clock::new(-1, 15).to_string(), "23:15");
}
#[test]
#[ignore]
fn negative_hour_roll_over() {
assert_eq!(Clock::new(-25, 00).to_string(), "23:00");
}
#[test]
#[ignore]
fn negative_hour_roll_over_continuously() {
assert_eq!(Clock::new(-91, 00).to_string(), "05:00");
}
#[test]
#[ignore]
fn negative_minutes() {
assert_eq!(Clock::new(1, -40).to_string(), "00:20");
}
#[test]
#[ignore]
fn negative_minutes_roll_over() {
assert_eq!(Clock::new(1, -160).to_string(), "22:20");
}
#[test]
#[ignore]
fn negative_minutes_roll_over_continuously() {
assert_eq!(Clock::new(1, -4820).to_string(), "16:40");
}
#[test]
#[ignore]
fn negative_sixty_minutes_is_prev_hour() {
assert_eq!(Clock::new(2, -60).to_string(), "01:00");
}
#[test]
#[ignore]
fn negative_one_twenty_minutes_is_two_prev_hours() {
assert_eq!(Clock::new(1, -120).to_string(), "23:00");
}
#[test]
#[ignore]
fn negative_hour_and_minutes_both_roll_over() {
assert_eq!(Clock::new(-25, -160).to_string(), "20:20");
}
#[test]
#[ignore]
fn negative_hour_and_minutes_both_roll_over_continuously() {
assert_eq!(Clock::new(-121, -5810).to_string(), "22:10");
}
#[test]
#[ignore]
fn zero_hour_and_negative_minutes() {
assert_eq!(Clock::new(0, -22).to_string(), "23:38");
}
//
// Clock Math
//
#[test]
#[ignore]
fn add_minutes() {
let clock = Clock::new(10, 0).add_minutes(3);
assert_eq!(clock.to_string(), "10:03");
}
#[test]
#[ignore]
fn add_no_minutes() {
let clock = Clock::new(6, 41).add_minutes(0);
assert_eq!(clock.to_string(), "06:41");
}
#[test]
#[ignore]
fn add_to_next_hour() {
let clock = Clock::new(0, 45).add_minutes(40);
assert_eq!(clock.to_string(), "01:25");
}
#[test]
#[ignore]
fn add_more_than_one_hour() {
let clock = Clock::new(10, 0).add_minutes(61);
assert_eq!(clock.to_string(), "11:01");
}
#[test]
#[ignore]
fn add_more_than_two_hours_with_carry() {
let clock = Clock::new(0, 45).add_minutes(160);
assert_eq!(clock.to_string(), "03:25");
}
#[test]
#[ignore]
fn add_across_midnight() {
let clock = Clock::new(23, 59).add_minutes(2);
assert_eq!(clock.to_string(), "00:01");
}
#[test]
#[ignore]
fn add_more_than_one_day() {
let clock = Clock::new(5, 32).add_minutes(1500);
assert_eq!(clock.to_string(), "06:32");
}
#[test]
#[ignore]
fn add_more_than_two_days() {
let clock = Clock::new(1, 1).add_minutes(3500);
assert_eq!(clock.to_string(), "11:21");
}
#[test]
#[ignore]
fn subtract_minutes() {
let clock = Clock::new(10, 3).add_minutes(-3);
assert_eq!(clock.to_string(), "10:00");
}
#[test]
#[ignore]
fn subtract_to_previous_hour() {
let clock = Clock::new(10, 3).add_minutes(-30);
assert_eq!(clock.to_string(), "09:33");
}
#[test]
#[ignore]
fn subtract_more_than_an_hour() {
let clock = Clock::new(10, 3).add_minutes(-70);
assert_eq!(clock.to_string(), "08:53");
}
#[test]
#[ignore]
fn subtract_across_midnight() {
let clock = Clock::new(0, 3).add_minutes(-4);
assert_eq!(clock.to_string(), "23:59");
}
#[test]
#[ignore]
fn subtract_more_than_two_hours() {
let clock = Clock::new(0, 0).add_minutes(-160);
assert_eq!(clock.to_string(), "21:20");
}
#[test]
#[ignore]
fn subtract_more_than_two_hours_with_borrow() {
let clock = Clock::new(6, 15).add_minutes(-160);
assert_eq!(clock.to_string(), "03:35");
}
#[test]
#[ignore]
fn subtract_more_than_one_day() {
let clock = Clock::new(5, 32).add_minutes(-1500);
assert_eq!(clock.to_string(), "04:32");
}
#[test]
#[ignore]
fn subtract_more_than_two_days() {
let clock = Clock::new(2, 20).add_minutes(-3000);
assert_eq!(clock.to_string(), "00:20");
}
//
// Test Equality
//
#[test]
#[ignore]
fn compare_clocks_for_equality() {
assert_eq!(Clock::new(15, 37), Clock::new(15, 37));
}
#[test]
#[ignore]
fn compare_clocks_a_minute_apart() {
assert_ne!(Clock::new(15, 36), Clock::new(15, 37));
}
#[test]
#[ignore]
fn compare_clocks_an_hour_apart() {
assert_ne!(Clock::new(14, 37), Clock::new(15, 37));
}
#[test]
#[ignore]
fn compare_clocks_with_hour_overflow() {
assert_eq!(Clock::new(10, 37), Clock::new(34, 37));
}
#[test]
#[ignore]
fn compare_clocks_with_hour_overflow_by_several_days() {
assert_eq!(Clock::new(99, 11), Clock::new(3, 11));
}
#[test]
#[ignore]
fn compare_clocks_with_negative_hour() {
assert_eq!(Clock::new(-2, 40), Clock::new(22, 40));
}
#[test]
#[ignore]
fn compare_clocks_with_negative_hour_that_wraps() {
assert_eq!(Clock::new(-31, 3), Clock::new(17, 3));
}
#[test]
#[ignore]
fn compare_clocks_with_negative_hour_that_wraps_multiple_times() {
assert_eq!(Clock::new(-83, 49), Clock::new(13, 49));
}
#[test]
#[ignore]
fn compare_clocks_with_minutes_overflow() {
assert_eq!(Clock::new(0, 1441), Clock::new(0, 1));
}
#[test]
#[ignore]
fn compare_clocks_with_minutes_overflow_by_several_days() {
assert_eq!(Clock::new(2, 4322), Clock::new(2, 2));
}
#[test]
#[ignore]
fn compare_clocks_with_negative_minute() {
assert_eq!(Clock::new(3, -20), Clock::new(2, 40));
}
#[test]
#[ignore]
fn compare_clocks_with_negative_minute_that_wraps() {
assert_eq!(Clock::new(5, -1490), Clock::new(4, 10));
}
#[test]
#[ignore]
fn compare_clocks_with_negative_minute_that_wraps_multiple() {
assert_eq!(Clock::new(6, -4305), Clock::new(6, 15));
}
#[test]
#[ignore]
fn compare_clocks_with_negative_hours_and_minutes() {
assert_eq!(Clock::new(-12, -268), Clock::new(7, 32));
}
#[test]
#[ignore]
fn compare_clocks_with_negative_hours_and_minutes_that_wrap() {
assert_eq!(Clock::new(-54, -11_513), Clock::new(18, 7));
}
#[test]
#[ignore]
fn compare_full_clock_and_zeroed_clock() {
assert_eq!(Clock::new(24, 0), Clock::new(0, 0));
}