xRuby

Exercism Exercises in Ruby

Setup

You'll need a recent (1.9.3+) version of Ruby, but that's it. Minitest ships with the language, so you're all set.

Working on Problems

Each problem should have a test suite and an example solution. The example solution should be named example.rb.

Run the test with ruby path/to/the_test.rb.

At the moment the Ruby problems skip all but the first test, in order to not overwhelm people with errors.

If you want to temporarily disable the skips while working on a problem, you can define an empty skip method in the test suite:

def skip
end

Just remember to delete it before submitting the problem.

Pull Requests

We welcome pull requests that provide fixes to existing problems (missing tests, interesting edge cases, improved APIs), as well as new problems.

If you're unsure, then go ahead and open a GitHub issue, and we'll discuss the change.

Please submit changes to a single problem per pull request unless you're submitting a general change across many of the problems (e.g. formatting).

Thank you so much for contributing! ✨

Style Guide

We have created a minimal set of guidelines for the testing files, which you can take advantage of by installing the rubocop gem. It will use the configuration file located in the root folder, .rubocop.yml. When you edit your code, you can simply run rubocop -D. It will ignore your example.rb, but will gently suggest style for your test code.

The -D option that is suggested is provided to give you the ability to easily ignore the Cops that you think should be ignored. This is easily done by doing # rubocop:disable CopName, where the CopName is replaced appropriately.

For more complete information, see Rubocop.

READMEs

Please do not add a README or README.md file to the problem directory. The READMEs are constructed using shared metadata, which lives in the exercism/x-common repository.

Minitest vs MiniTest

Minitest v4.x (MiniTest::Unit::TestCase) ships with the language, whereas Minitest v5.x (Minitest::Test) does not. This means that people who have installed v5.x will get deprecation warnings.

There's no really good way around this at the moment. We can't upgrade without forcing people to install an extra dependency.

Contributing Guide

For an in-depth discussion of how exercism language tracks and problem sets work, please see the contributing guide

License

The MIT License (MIT)

bjmllr / xruby