Skip to content

LapoElisacci/italian_round_robin

Repository files navigation

ItalianRoundRobin

The Gem allows you to generate Round Robin tournament pairings based on Berger tables.

Wikipedia

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add italian_round_robin

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install italian_round_robin

Usage

Passing a list of any item to the generate method will return all rounds based on Berger tables:

members = [1, 2, 3, 4] # This can be a list of anything (Integer, String, Object, ...)
rounds = ItalianRoundRobin.generate(members)

# [
#     [[1, 4], [2, 3]],
#     [[4, 3], [1, 2]],
#     [[2, 4], [3, 1]]
# ]

The gem supports odd numbers of players as well, a nil value will stand for BYE

members = [1, 2, 3, 4, 5] # This can be a list of anything (Integer, String, Object, ...)
rounds = ItalianRoundRobin.generate(members)

# [
#     [[1, nil], [2, 5], [3, 4]],
#     [[nil, 4], [5, 3], [1, 2]],
#     [[2, nil], [3, 1], [4, 5]],
#     [[nil, 5], [1, 4], [2, 3]],
#     [[3, nil], [4, 2], [5, 1]]
# ]

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/LapoElisacci/italian_round_robin. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the ItalianRoundRobin project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

About

Italian Round Robin Tournament pairings generator - Ruby

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published