doku 1.0.0

data/spec/puzzle_spec.rb

@@ -0,0 +1,147 @@
+require 'backports' unless defined? require_relative
+require_relative 'spec_helper'
+
+class TestPuzzle < Doku::Puzzle
+  has_squares [1,2,3,4]
+  has_glyphs  [true,false]
+  
+  define_group [1,2]
+  define_group [2,3]
+  define_group [3,4]
+  define_group [4,1]
+end
+
+describe "Puzzle instance" do
+  before do
+    @puzzle = TestPuzzle.new(1 => true)
+  end
+
+  it "is basically a hash of square => glyph" do
+    @puzzle[1].should == true
+    @puzzle[4].should == nil
+
+    @puzzle[1] = false
+    @puzzle[1].should == false
+
+    @puzzle[1] = nil
+    @puzzle[1].should == nil
+  end
+
+  it "has an each method that excludes nil values" do
+    TestPuzzle.new(2 => nil).each { raise }
+  end
+
+  it "only allows squares as keys" do
+    lambda { @puzzle[0] }.should raise_error IndexError
+    lambda { @puzzle[0] = false }.should raise_error IndexError
+  end
+
+  it "only allows glyphs or nil as values" do
+    lambda { @puzzle[1] = 10 }.should raise_error ArgumentError
+  end
+
+  it "can not be initialized with bad data" do
+    lambda { TestPuzzle.new(:foo => true) }.should raise_error IndexError
+    lambda { TestPuzzle.new(1 => :foo) }.should raise_error ArgumentError
+  end
+
+  describe "comparison operators say" do
+    it "A == B iff the square=>glyph pairs in A and B are the same" do
+      @puzzle.should_not == TestPuzzle.new
+      TestPuzzle.new.should_not == @puzzle.should
+
+      puzzle2 = TestPuzzle.new(1 => true)
+      @puzzle.should == puzzle2
+      puzzle2.should == @puzzle
+
+      (TestPuzzle.new(1 => true) != @puzzle).should == false
+    end
+
+    it "A eql? B is the same as A == B" do
+      @puzzle.should_not eql TestPuzzle.new
+      TestPuzzle.new.should_not eql @puzzle.should
+
+      puzzle2 = TestPuzzle.new(1 => true)
+      @puzzle.should eql puzzle2
+      puzzle2.should eql @puzzle
+    end
+
+    it "A.subset?(B) iff square=>glyph pairs in A are a subset of those in B" do
+      @puzzle.should_not be_a_subset TestPuzzle.new
+      TestPuzzle.new.should be_a_subset @puzzle
+
+      @puzzle.should be_a_subset @puzzle
+
+      @puzzle.should be_a_subset TestPuzzle.new(1 => true, 3 => false)
+    end
+  end
+
+  describe "#filled?" do
+    it "returns true iff all squares have been assigned a glyph" do
+      TestPuzzle.new(1 => true, 2=> true, 3 => false, 4 => false).should be_filled
+      @puzzle.should_not be_filled
+    end
+  end
+
+  describe "#valid?" do
+    it "returns false iff a group has the same glyph in it twice" do
+      @puzzle.should be_valid
+      TestPuzzle.new(1 => true, 2=> true).should_not be_valid      
+    end
+  end
+
+  describe "#solution?" do
+    it "returns true iff it is filled and valid" do
+      puzzle2 = TestPuzzle.new(1 => false, 2 => true, 3 => false, 4 => true)
+      puzzle2.should be_a_solution
+
+      puzzle3 = TestPuzzle.new(1 => true, 2=> true, 3 => false, 4 => false)
+      puzzle3.should_not be_a_solution
+    end
+  end
+
+  describe "#solution_for?(puzzle)" do
+    it "returns true if this puzzle is a solution and a super set of the other puzzle" do
+      puzzle4 = TestPuzzle.new(1 => false, 2 => true, 3 => false, 4 => true)
+      puzzle4.should_not be_a_solution_for @puzzle
+
+      puzzle5 = TestPuzzle.new(1 => true, 2 => false, 3 => true, 4 => false)
+      puzzle5.should be_a_solution_for @puzzle
+    end
+  end
+
+  shared_examples_for "copied puzzle" do
+    it "produces an equal puzzle" do
+      @copy.should == @puzzle
+      @copy.should_not equal @puzzle
+    end
+
+    it "produces a puzzle with a different glyph_state hash" do
+      @copy.glyph_state.should_not equal @puzzle.glyph_state
+    end
+  end
+
+  describe "dup" do
+    before do
+      @copy = @puzzle.dup
+    end
+
+    it_should_behave_like "copied puzzle"
+  end
+
+  describe "clone" do
+    before do
+      @copy = @puzzle.clone
+    end
+
+    it_should_behave_like "copied puzzle"
+  end
+
+  it "equality and hash codes are not affected by nil values" do
+    puzzle2 = TestPuzzle.new(1 => true, 3 => nil)
+    @puzzle[2] = nil
+    puzzle2.should == @puzzle
+    puzzle2.hash.should == @puzzle.hash
+  end
+
+end

data/spec/solution_spec.rb

@@ -0,0 +1,278 @@
+require 'backports' unless defined? require_relative
+require_relative 'spec_helper'
+
+describe "Puzzle#solve" do
+  context 'given the sudoku puzzle' do
+    before do
+      @puzzle = Doku::Sudoku.new <<END
+...|..8|...
+..7|.35|..9
+5..|4.6|8..
+---+---+---
+...|..4|2..
+4..|...|.37
+8..|...|5..
+---+---+---
+.9.|.67|...
+..3|...|1.5
+...|...|..3
+END
+
+      @solution = @puzzle.solve
+    end
+
+    it 'solves the puzzle' do
+      @solution.solution_for?(@puzzle).should == true
+    end
+
+    it 'is the correct solution' do
+      @solution.to_grid_string.strip.should == <<END.strip
+964|278|351
+287|135|649
+531|496|872
+---+---+---
+319|754|286
+452|681|937
+876|923|514
+---+---+---
+195|367|428
+723|849|165
+648|512|793
+END
+    end
+
+    it "can also find the solution using Donald Knuth's recursive DLX" do
+      sm = @puzzle.to_link_matrix
+      exact_cover = sm.find_exact_cover_recursive
+      solution = @puzzle.exact_cover_to_solution exact_cover
+      solution.should == @solution
+    end
+  end
+
+  context 'given a sudoku puzzle with two solutions' do
+    before do
+      @puzzle = Doku::Sudoku.new <<END
+...|..8|...
+..7|.3.|..9
+5..|4.6|8..
+---+---+---
+...|..4|2..
+4..|...|.37
+8..|...|5..
+---+---+---
+.9.|.67|...
+..3|...|1.5
+...|...|..3
+END
+    end
+
+    it 'finds two solutions' do
+      solutions = @puzzle.solutions.to_a
+      solutions.size.should == 2
+
+      solutions.should include Doku::Sudoku.new <<END
+964|278|351
+287|135|649
+531|496|872
+---+---+---
+319|754|286
+452|681|937
+876|923|514
+---+---+---
+195|367|428
+723|849|165
+648|512|793
+END
+
+      solutions.should include Doku::Sudoku.new <<END
+964|278|351
+287|531|649
+531|496|872
+---+---+---
+359|714|286
+412|685|937
+876|923|514
+---+---+---
+195|367|428
+723|849|165
+648|152|793
+END
+
+      solutions[0].should be_a_solution_for @puzzle
+      solutions[1].should be_a_solution_for @puzzle
+    end
+
+  end
+
+  context 'given a sudoku puzzle with NO solutions' do
+    before do
+      @puzzle = Doku::Sudoku.new <<END
+123|...|...
+456|...|...
+78.|...|...
+---+---+---
+..1|...|...
+...|9..|...
+..2|...|...
+---+---+---
+..4|...|...
+...|9..|...
+..5|...|...
+END
+    end
+
+    it 'finds no solutions' do
+      @puzzle.solve.should == nil
+    end
+
+    it 'can not tell instantly there is no solution, in this case' do
+      sm = @puzzle.to_link_matrix
+      sc = sm.columns.min_by(&:size)
+      sc.size.should > 0
+    end
+
+    it 'finds no solutions using the recursive algorithm' do
+      sm = @puzzle.to_link_matrix
+      sm.find_exact_cover_recursive.should == nil
+    end
+  end
+
+  context 'given a hexadoku puzzle' do
+    before do
+      # Elektor Hexadoku 2011
+      @puzzle = Doku::Hexadoku.new <<END
+2A.7|.C..|9D64|8...
+..3.|A..D|7...|.2F.
+.1..|..0.|8...|.4AB
+....|.7.2|..BC|.0.3
+----+----+----+----
+C2.8|.D3.|..4E|....
+..FA|7.2.|B.3.|1C04
+....|4..F|..1.|...E
+9..B|1...|....|23..
+----+----+----+----
+..8C|....|...0|3..D
+6...|.F..|1..A|....
+D37E|.0.1|.9.8|AF..
+....|3B..|.2D.|C.80
+----+----+----+----
+F.B.|51..|2.A.|....
+3CA.|...7|.E..|..6.
+.E4.|...9|3..5|.D..
+...1|F3A4|..9.|5.E2
+END
+
+      @solution = @puzzle.solve
+    end
+
+    it 'finds the correct solution' do
+      @solution.to_grid_string.should == <<END.strip
+2A07|BCF3|9D64|8E15
+B839|A54D|70E1|62FC
+51CD|E906|8F23|74AB
+46EF|8712|A5BC|D093
+----+----+----+----
+C218|6D3B|074E|9A5F
+EDFA|7825|B639|1C04
+0753|4A9F|C812|B6DE
+946B|1EC0|DA5F|2378
+----+----+----+----
+158C|946A|EBF0|372D
+6B20|CFD8|137A|E549
+D37E|2051|49C8|AFB6
+AF94|3B7E|52D6|C180
+----+----+----+----
+F9B6|51EC|24AD|0837
+3CA5|D287|FE0B|4961
+7E42|06B9|3185|FDCA
+80D1|F3A4|6C97|5BE2
+END
+    end
+  end
+
+  context "given a Hexamurai puzzle" do
+    before do
+      # From Elektor 2011-07 (with extra hints so it can be solved quickly).
+      @puzzle = Doku::Hexamurai.new <<END
+        |39DEA62B|80C1745F|
+        |..213...|5.B4....|
+        |..0.....|......2.|
+        |.....4.5|..9A1.E.|
+        |..3C....|.1654.0.|
+        |.1..2...|3......6|
+        |...90...|BD4.25..|
+        |2.57....|ACE03.D1|
+--------+--------+--------+--------
+52.0..3.|A.....B.|0.....3.|78A....6
+4.8.1...|..9.....|...E..4.|2.063...
+.7......|.4F.50.9|.7.2..8E|.1..4...
+..6...0.|.....C3.|...6.7.0|5..3..21
+A1D24E6B|9083C.5F|E62BAD14|.....8..
+E0347.28|CFA5BD96|14830E72|.9....5A
+8B96FC50|ED.2134A|950CB6F8|.2.1.4.3
+7.FC3A9D|1B64E2.0|FA7..9C3|0..E.2..
+--------+--------+--------+--------
+.3.1..7.|B.5F2.E4|31......|B.6....4
+C.......|4..7..0D|..6...B.|9.40.178
+..28....|.C.A..73|...49..1|..3.5.0.
+047.5...|.6.1....|...045..|1....3..
+..036.4.|.1.C.EA.|60473..9|........
+1......2|8.4D.96.|A3EF..2.|4.5.0...
+..4..51.|.7.E3...|B291..5.|....C637
+6.5...8.|...9...1|8DC5..0.|........
+--------+--------+--------+--------
+        |...B..39|..0..2..|
+        |5.804..2|.6.3.E7.|
+        |...6....|....5.3.|
+        |...2.7..|C4.....0|
+        |..685340|.729A1..|
+        |7..51...|.....6.3|
+        |...4....|.B..0...|
+        |...3....|0......2|
+END
+    end
+
+    it "can be solved correctly" do
+      solution = @puzzle.solve
+      solution.should be_solution_for @puzzle
+      solution.to_s.should == <<END.chomp
+        |39DEA62B|80C1745F|
+        |87213FDC|5EB4906A|
+        |450A79E1|63DF8B2C|
+        |6CBF8405|729A13ED|
+        |BA3CFE7D|21654809|
+        |014D25A8|39F7ECB6|
+        |F6E901C3|BD4825A7|
+        |28579B64|ACE03FD1|
+--------+--------+--------+--------
+52109D3F|AEC648B7|0F19D235|78A4BEC6
+4E8D1BC5|73906AF2|D85EC14B|2F0637A9
+37CA82E6|D4FB5019|C7326A8E|D19B40F5
+B96FA704|5218DC3E|4BA6F790|5CE38D21
+A1D24E6B|9083C75F|E62BAD14|C3F57890
+E0347128|CFA5BD96|14830E72|69BDFC5A
+8B96FC50|ED72134A|950CB6F8|A271E4D3
+75FC3A9D|1B64E280|FA7D59C3|048E126B
+--------+--------+--------+--------
+D3A1087C|B95F26E4|31D870AC|B5629FE4
+CFB526A3|48E7910D|5C6A23BF|9E40D178
+9628E4B1|0CDAF573|2EB49861|FD375A0C
+047E5FD9|3621ABC8|79F045ED|1AC863B2
+FD036947|21BC8EA5|60473FD9|8B2CA51E
+1AE7C3F2|854D096B|A3EF1C27|46590B8D
+2849B51A|670E3FDC|B291845A|E0DFC637
+6C5BD08E|FA397421|8DC5EB06|371A294F
+--------+--------+--------+--------
+        |AF7BC839|E50D6214|
+        |5D804AF2|9613CE7B|
+        |94C6B01E|FA725D38|
+        |E312D756|C48BFA90|
+        |CB685340|D729A1FE|
+        |709512BF|48AED6C3|
+        |D2F4EC9A|1B360785|
+        |1EA36D87|0F5CB942|
+END
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift File.join File.dirname(__FILE__), '..', 'lib'
+require 'rspec'
+require 'doku'
+
+# Change this to true if a test is failing and you want more clues about why.
+EXTRA_ASSERTS = false
+
+if EXTRA_ASSERTS
+  # Add any patches here that help check the validity of the algorithm but are
+  # not necessary to have in the production code.
+
+  class Doku::DancingLinks::LinkMatrix::Column
+    def size=(num)
+      raise "bad class" unless Fixnum === num
+      raise "negative value #{num}" if num < 0
+      @size = num
+    end
+  end
+end

data/spec/sudoku_spec.rb

@@ -0,0 +1,52 @@
+require 'backports' unless defined? require_relative
+require_relative 'spec_helper'
+
+describe Doku::Sudoku do
+  before do
+    @puzzle = Doku::Sudoku.new
+  end
+
+  it 'has 81 squares' do
+    Doku::Sudoku.squares.size.should == 81
+  end
+
+  it 'has 9 squares in the first row' do
+    first_row = Doku::Sudoku.squares.select { |s| s.matches?(:y => 0) }
+    first_row.size.should == 9
+  end
+
+  it 'has the right number of groups' do
+    Doku::Sudoku.groups.size.should == 3*9
+  end
+
+  it 'has methods for getting and setting glyphs by coordinates' do
+    # (just like any puzzle class that includes the PuzzleOnGrid module)
+
+    @puzzle.get(0, 1).should == nil
+    @puzzle.set(0, 1, 4)
+    @puzzle.set(5, 7, 9)
+    @puzzle.set(6, 6, 1)
+    @puzzle.set(6, 6, nil)
+    @puzzle.get(0, 1).should == 4
+    @puzzle.to_s.should == <<END.strip
+...|...|...
+4..|...|...
+...|...|...
+---+---+---
+...|...|...
+...|...|...
+...|...|...
+---+---+---
+...|...|...
+...|..9|...
+...|...|...
+END
+  end
+
+  it "the get method has a good error message" do
+    msg = "Square not found in Doku::Sudoku: Square(19, david)."
+    lambda { @puzzle.get(19, 'david') }.should raise_error IndexError, msg
+    lambda { @puzzle.set(19, 'david', 10) }.should raise_error IndexError, msg
+  end
+end
+