sudoku_bardi 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.rvmrc
+Gemfile.lock
+doc/
+experimental/

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in sudoku_bardi.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Bardi Einarsson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,80 @@
+sudoku\_bardi
+=============
+
+## Summary
+
+Sudoku solver, validator and generator
+
+## Description
+
+sudoku\_bardi (see websudoku.com) is a set of tools for solving, validating and generating Sudoku puzzles.
+
+## Why should one the sudoku\_bardi tools?
+
+The Sudoku solution algorithm does not use recursion -- runs in limited memory and can find all solutions of incorrect puzzles.
+
+## Version
+
+v0.1.0 with comprehensive tests, was developed using ruby 1.9.3 and rspec 2.13.0. It does not have any specific Sudoku puzzle generators yet; however it provides a good foundation for any generator as it provides validation of solution uniqueness and shows the operations used in the puzzle solution(s).
+
+## Installation
+
+Get the v0.1.0 gem or clone the repository.
+
+## Usage and documentation
+
+Study the programs in the spec/ directory. See below for more information.
+
+Try the software in irb:
+
+    irb prompt> load 'lib/sudoku_bardi.rb'
+    irb prompt> load 'spec/support/sudoku_fixture.rb'
+    irb prompt> include SudokuBardi
+    irb prompt> include SudokuFixture
+    irb prompt> s = Solver.new EXAMPLE2
+    irb prompt> s.take 1
+
+After -- s.take 1 -- one will see a listing of an array of size 2. The 0 element is an array of operations made to get the solution. The 1 element is the solution.
+
+    [75, SudokuBardi::Five] means assign Five to square 75.
+    ["start"] ends the operations to construct the puzzle.
+    ["mark", 2, [SudokuBardi::Seven, SudokuBardi::Two], 1]
+      shows a backtrack mark for square 2. That type of thing
+      occurs when there is no longer any square with only one
+      possible value. The solver had to try Seven and Two to
+      get all possible solutions. The 1 points at Two as the
+      current value chosen.
+
+      0  1  2  3  4  5  6  7  8
+      9 10 11 12 13 14 15 16 17
+     18 19 20 21 22 23 24 25 26
+     27 28 29 30 31 32 33 34 35
+     36 37 38 39 40 41 42 43 44
+     45 46 47 48 49 50 51 52 53
+     54 55 56 57 58 59 60 61 62
+     63 64 65 66 67 68 69 70 71
+     72 73 74 75 76 77 78 79 80
+
+## Requirements
+
+Most likely any recent version of 1.9 ruby works.
+
+## Test with rspec ~> 2.11, rspec -fd
+
+Try the software in irb:
+
+    irb prompt> load 'spec/support/sudoku_bardi_test.rb'
+    irb prompt> load 'spec/support/sudoku_fixture.rb'
+
+Note, to find the gem installation directory:
+
+    irb prompt> require 'sudoku_bardi'
+    irb prompt> $".grep(/sudoku_bardi/)[0]
+    irb prompt> Sudoku::Solver.new.method(:each).source_location
+    irb prompt> exit
+
+## License
+
+Copyright (c) 2013 Bardi Einarsson. Released under the MIT License.  See the [LICENSE][license] file for further details.
+
+[license]: https://github.com/bardibardi/sudoku_bardi/blob/master/LICENSE.md

data/lib/sudoku_bardi.rb

@@ -0,0 +1,272 @@
+module SudokuBardi
+
+# row, column, box
+RCB = [
+[0,0,0],[0,1,0],[0,2,0],[0,3,1],[0,4,1],[0,5,1],[0,6,2],[0,7,2],[0,8,2],
+[1,0,0],[1,1,0],[1,2,0],[1,3,1],[1,4,1],[1,5,1],[1,6,2],[1,7,2],[1,8,2],
+[2,0,0],[2,1,0],[2,2,0],[2,3,1],[2,4,1],[2,5,1],[2,6,2],[2,7,2],[2,8,2],
+[3,0,3],[3,1,3],[3,2,3],[3,3,4],[3,4,4],[3,5,4],[3,6,5],[3,7,5],[3,8,5],
+[4,0,3],[4,1,3],[4,2,3],[4,3,4],[4,4,4],[4,5,4],[4,6,5],[4,7,5],[4,8,5],
+[5,0,3],[5,1,3],[5,2,3],[5,3,4],[5,4,4],[5,5,4],[5,6,5],[5,7,5],[5,8,5],
+[6,0,6],[6,1,6],[6,2,6],[6,3,7],[6,4,7],[6,5,7],[6,6,8],[6,7,8],[6,8,8],
+[7,0,6],[7,1,6],[7,2,6],[7,3,7],[7,4,7],[7,5,7],[7,6,8],[7,7,8],[7,8,8],
+[8,0,6],[8,1,6],[8,2,6],[8,3,7],[8,4,7],[8,5,7],[8,6,8],[8,7,8],[8,8,8]
+]
+
+class Piece; end
+class One < Piece; end
+class Two < Piece; end
+class Three < Piece; end
+class Four < Piece; end
+class Five < Piece; end
+class Six < Piece; end
+class Seven < Piece; end
+class Eight < Piece; end
+class Nine < Piece; end
+
+TO_S = { nil => '.',
+  One => '1', Two => '2', Three => '3',
+  Four => '4', Five => '5', Six => '6',
+  Seven => '7', Eight => '8', Nine => '9'
+}
+
+NINE = [One, Two, Three, Four, Five, Six, Seven, Eight, Nine]
+
+class Solver
+
+  include Enumerable
+
+  def self.piece_from_char c
+    i = c.bytes.first - 49 # 49 == '0'.bytes.first + 1
+    return nil if 0 > i
+    NINE[i]
+  end
+
+  def self.constraint c
+    a = []
+    c.size.times do
+      a << c.dup
+    end
+    a
+  end
+
+  def initialize board_str = ''
+    start
+    process board_str
+    push ['start']
+  end
+
+  def start 
+    @board = [nil] * (NINE.size * NINE.size)
+    @rows = self.class.constraint NINE
+    @columns = self.class.constraint NINE
+    @boxes = self.class.constraint NINE 
+    @ops = []
+  end
+
+  def board_to_s
+    a = @board.map do |piece|
+      TO_S[piece]
+    end
+    a.join ''
+  end
+
+  def possible i
+    r, c, b = RCB[i]
+    @rows[r] & @columns[c] & @boxes[b]
+  end
+
+  def do_op op
+    i, piece = op
+    r, c, b = RCB[i]
+    @rows[r] -= [piece]
+    @columns[c] -= [piece]
+    @boxes[b] -= [piece]
+    @board[i] = piece
+    op
+  end
+
+  def undo_op op
+    i, piece = op
+    r, c, b = RCB[i]
+    @rows[r] += [piece]
+    @columns[c] += [piece]
+    @boxes[b] += [piece]
+    @board[i] = nil
+    op
+  end
+
+  def pop_start
+    @ops.pop
+  end
+
+  def push_start
+    push ['start']
+  end
+
+  def pop
+    return nil if 'start' == @ops[-1][0]
+    @ops.pop
+  end
+
+  def push op
+    @ops << op
+  end
+
+  def process_str str_as_ops
+    ops = []
+    str_as_ops.each_char.with_index do |char, i|
+      piece = self.class.piece_from_char char
+      if piece
+        ps = possible i
+        raise "impossible #{char} at #{i}" unless ps.include? piece
+        push do_op([i, piece])
+      end
+    end
+    ops
+  end
+
+  def play ops
+    ops.each do |op|
+      push do_op(op)
+    end
+  end
+
+  def process board_str
+    play process_str(board_str)
+  end
+
+  def single i
+    processed_single = false
+    backtrack = false
+    ps = possible i
+    if 0 == ps.length
+      backtrack = true
+    end
+    if 1 == ps.length
+      processed_single = true
+      push do_op([i, ps[0]])
+    end
+    [processed_single, backtrack]
+  end
+
+  def singles
+    had_singles = true
+    finished = true
+    while had_singles
+      finished = true
+      single_found = false
+      @board.each_with_index do |piece, i|
+        if !piece
+          finished = false
+          processed_single, backtrack = single i
+          single_found ||= processed_single
+          if backtrack
+            push ['backtrack', i]
+            return finished
+          end
+        end
+      end
+      had_singles = single_found
+    end
+    finished
+  end
+
+  def min_choices
+    j = nil
+    count = 10
+    @board.each_with_index do |piece, i|
+      if !piece
+        len = possible(i).size
+        if len < count
+          j = i
+          count = len
+        end
+      end
+    end
+    j
+  end
+
+  def gen_choices
+    a = []
+    @board.each_with_index do |piece, i|
+      if !piece
+        ps = possible(i)
+        if 1 < ps.size
+          a += ps.map {|e| [i, e]}
+        end
+      end
+    end
+    a
+  end
+
+  def add_mark i
+    push ['mark', i, possible(i), -1]
+  end
+
+  def try
+    mark = pop.dup
+    mark[3] += 1
+    piece = mark[2][mark[3]]
+    push mark
+    if piece
+      push do_op([mark[1], piece])
+    else
+      push ['backtrack', mark[1]]
+    end
+  end
+
+  def do_backtrack
+    pop if 'mark' == @ops[-1][0]
+    op = pop
+    if op
+      while 'mark' != op[0]
+        undo_op op if op[0].kind_of? Numeric
+        op = pop
+        return @ops unless op
+      end
+    end
+    push op if op
+  end
+
+  def solve_one
+    solved = false
+    until solved
+      if 'backtrack' == @ops[-1][0]
+        pop
+        do_backtrack
+        if 'start' == @ops[-1][0]
+          return nil
+        end
+        try
+      else
+        solved = singles
+        if !solved
+          i = min_choices
+          add_mark i
+          try
+        end
+      end
+    end
+    [@ops, board_to_s]
+  end
+
+  def each
+    first = true
+    finished = false
+    until finished
+      push ['backtrack', 81] unless first
+      first = false
+      result = solve_one
+      if result
+        yield [result[0].dup, result[1]]
+      else
+        finished = true
+      end
+    end
+  end
+
+end # Solver
+
+end # SudokuBardi
+

data/spec/sudoku_bardi_spec.rb

@@ -0,0 +1,18 @@
+require 'support/no_should_rspec'
+require 'support/sudoku_bardi_test'
+require 'support/sudoku_fixture'
+include SudokuFixture
+
+describe SudokuBardi::Solver do
+
+  it "should solve puzzles with unique solutions" do
+    expect(SudokuBardi.unique_solution?(EXAMPLE, SOLUTION)).to be_true
+    expect(SudokuBardi.unique_solution?(EXAMPLE2, SOLUTION2)).to be_true
+    expect(SudokuBardi.unique_solution?(EXAMPLE3, SOLUTION3)).to be_true
+  end
+
+  it "should solve puzzles with multiple solutions" do
+    expect(SudokuBardi.empty_puzzle_has_at_least_100_solutions?).to be_true
+  end
+
+end

data/spec/support/no_should_rspec.rb

@@ -0,0 +1,9 @@
+RSpec.configure do |config|
+
+  # rspec 2.11 turn off should monkey patching
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+end
+

data/spec/support/sudoku_bardi_test.rb

@@ -0,0 +1,19 @@
+require_relative '../../lib/sudoku_bardi'
+
+module SudokuBardi
+
+  def self.unique_solution? puzzle_board, solution_board
+    s = Solver.new puzzle_board
+    solutions = s.take 2
+    return nil unless 1 == solutions.size
+    solutions[0][1] == solution_board
+  end
+
+  def self.empty_puzzle_has_at_least_100_solutions?
+    s = Solver.new
+    solutions = s.take 100
+    100 == solutions.size
+  end
+
+end # SudokuBardi
+

data/spec/support/sudoku_fixture.rb

@@ -0,0 +1,76 @@
+module SudokuFixture
+
+EXAMPLE = %w(
+...3...1.
+8...167.2
+1....93..
+7.3...645
+5.68.49.7
+294...8.1
+..17....8
+3.792...4
+.6...1...
+).join ''
+
+SOLUTION = %w(
+672385419
+839416752
+145279386
+783192645
+516834927
+294657831
+421763598
+357928164
+968541273
+).join ''
+
+EXAMPLE2 = %w(
+.....8..6
+9.17.53.4
+.....4.1.
+1..94..5.
+49..5..67
+.2..71..3
+.3.4.....
+2.53.97.1
+7..5.....
+).join ''
+
+SOLUTION2 = %w(
+342198576
+961725384
+857634912
+173946258
+498253167
+526871493
+639417825
+285369741
+714582639
+).join ''
+
+EXAMPLE3 = %w(
+68.35....
+....1..2.
+..7.6.9..
+1........
+3.5.9.1.2
+........9
+..3.2.8..
+.6..7....
+....45.31
+).join ''
+
+SOLUTION3 = %w(
+689352417
+534917628
+217468953
+192584376
+345796182
+876231549
+753129864
+461873295
+928645731
+).join ''
+
+end
+

data/sudoku_bardi.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name = 'sudoku_bardi'
+  s.version = '0.1.0'
+  s.date = '2013-05-23'
+  s.summary = "Sudoku solver, validator and generator"
+  s.description = "sudoku_bardi (see websudoku.com) is a set of tools for solving, validating and generating Sudoku puzzles."
+
+  s.authors = ['Bardi Einarsson']
+  s.email = ['bardi@hotmail.com']
+  s.homepage = 'https://github.com/bardibardi/sudoku_bardi'
+  s.required_ruby_version = '>= 1.9.2'
+  s.add_development_dependency('rspec', '~> 2.11')
+
+  s.files = %w(
+.gitignore
+Gemfile
+LICENSE.md
+README.md
+sudoku_bardi.gemspec
+lib/sudoku_bardi.rb
+spec/sudoku_bardi_spec.rb
+spec/support/no_should_rspec.rb
+spec/support/sudoku_bardi_test.rb
+spec/support/sudoku_fixture.rb
+)
+end
+

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: sudoku_bardi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Bardi Einarsson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+description: sudoku_bardi (see websudoku.com) is a set of tools for solving, validating
+  and generating Sudoku puzzles.
+email:
+- bardi@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.md
+- README.md
+- sudoku_bardi.gemspec
+- lib/sudoku_bardi.rb
+- spec/sudoku_bardi_spec.rb
+- spec/support/no_should_rspec.rb
+- spec/support/sudoku_bardi_test.rb
+- spec/support/sudoku_fixture.rb
+homepage: https://github.com/bardibardi/sudoku_bardi
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Sudoku solver, validator and generator
+test_files: []