Exercism: Rust version of the 'Proverb' exercise.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

97 lines
3.5 KiB

  1. # Proverb
  2. For want of a horseshoe nail, a kingdom was lost, or so the saying goes.
  3. Given a list of inputs, generate the relevant proverb. For example, given the list `["nail", "shoe", "horse", "rider", "message", "battle", "kingdom"]`, you will output the full text of this proverbial rhyme:
  4. ```text
  5. For want of a nail the shoe was lost.
  6. For want of a shoe the horse was lost.
  7. For want of a horse the rider was lost.
  8. For want of a rider the message was lost.
  9. For want of a message the battle was lost.
  10. For want of a battle the kingdom was lost.
  11. And all for the want of a nail.
  12. ```
  13. Note that the list of inputs may vary; your solution should be able to handle lists of arbitrary length and content. No line of the output text should be a static, unchanging string; all should vary according to the input given.
  14. ## Rust Installation
  15. Refer to the [exercism help page][help-page] for Rust installation and learning
  16. resources.
  17. ## Writing the Code
  18. Execute the tests with:
  19. ```bash
  20. $ cargo test
  21. ```
  22. All but the first test have been ignored. After you get the first test to
  23. pass, open the tests source file which is located in the `tests` directory
  24. and remove the `#[ignore]` flag from the next test and get the tests to pass
  25. again. Each separate test is a function with `#[test]` flag above it.
  26. Continue, until you pass every test.
  27. If you wish to run all ignored tests without editing the tests source file, use:
  28. ```bash
  29. $ cargo test -- --ignored
  30. ```
  31. To run a specific test, for example `some_test`, you can use:
  32. ```bash
  33. $ cargo test some_test
  34. ```
  35. If the specific test is ignored use:
  36. ```bash
  37. $ cargo test some_test -- --ignored
  38. ```
  39. To learn more about Rust tests refer to the [online test documentation][rust-tests]
  40. Make sure to read the [Modules][modules] chapter if you
  41. haven't already, it will help you with organizing your files.
  42. ## Further improvements
  43. 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.
  44. To format your solution, inside the solution directory use
  45. ```bash
  46. cargo fmt
  47. ```
  48. To see, if your solution contains some common ineffective use cases, inside the solution directory use
  49. ```bash
  50. cargo clippy --all-targets
  51. ```
  52. ## Submitting the solution
  53. 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.
  54. ## Feedback, Issues, Pull Requests
  55. 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!
  56. If you want to know more about Exercism, take a look at the [contribution guide](https://github.com/exercism/docs/blob/main/contributing-to-language-tracks/README.md).
  57. [help-page]: https://exercism.io/tracks/rust/learning
  58. [modules]: https://doc.rust-lang.org/book/ch07-02-defining-modules-to-control-scope-and-privacy.html
  59. [cargo]: https://doc.rust-lang.org/book/ch14-00-more-about-cargo.html
  60. [rust-tests]: https://doc.rust-lang.org/book/ch11-02-running-tests.html
  61. ## Source
  62. Wikipedia [http://en.wikipedia.org/wiki/For_Want_of_a_Nail](http://en.wikipedia.org/wiki/For_Want_of_a_Nail)
  63. ## Submitting Incomplete Solutions
  64. It's possible to submit an incomplete solution so you can see how others have completed the exercise.