Sudoku

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/sudoku. To experiment with that code, run bin/console for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

Installation

Add this line to your application's Gemfile:

gem 'sudoku'

And then execute:

$ bundle

Or install it yourself as:

$ gem install sudoku

Usage

To create a new puzzle:

Sudoku.new

This will return a Sudoku::Builder object that looks like this:

```ruby
#<Sudoku::Builder:0x007fdc729373e8 @sud={0=>[6], 1=>[8], 2=>[9], 3=>[5], 4=>[7], 5=>[2], 6=>[3], ...
```

On the builder object you can call a handful of different methods:

  • valid? checks if the sudoku is valid.
  • to_hash turns it into a regular hash.
  • poke(number, poke_with) pokes holes in the puzzle. (to create a solvable sudoku)
  • medium, easy and hard poke a set number of holes in the puzzle.
  • pretty_print makes it print out nice on the command line.

To solve an existing puzzle, call:

`Sudoku::Solver.new(my_puzzle)`

my_puzzle must be equal to a hash with keys from 0 to 80 and values equal to an integer for already given squares, and an array for empty squares. ie:

```
{0=>6, 1=>8, 2=>[], 3=>[], 4=>[], 5=>[], 6=>[3] ...
```

Development

After checking out the repo, run bin/setup to install dependencies. Then, 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 to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( https://github.com/[my-github-username]/sudoku/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request