sudokusolver 1.0

data/COPYING

@@ -0,0 +1 @@
+See the file called LICENSE

data/Changes.rdoc

@@ -0,0 +1 @@
+2007-04-09 Version 0.1 => initial release

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2007
+
+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.rdoc

@@ -0,0 +1,20 @@
+This sofware was translated from the python source code 
+obtained from Peter Norvig's website:
+
+http://www.norvig.com/sudoku.html
+http://www.norvig.com/sudo.py
+
+Thank you to Peter Norvig for the original python source code, 
+algorithms and exceptionally clear explanations.
+
+example:
+========
+
+require 'sudoku_solver'
+
+# The puzzle representation is simply the 9 rows of the Sudoku grid stringed together
+# from top to bottom (periods representing blank squares)
+
+puzzle = "4.....8.5.3..........7......2.....6.....8.4......1.......6.3.7.5..2.....1.4......"
+s = SudokuSolver.new
+s.print_grid(s.search(s.parse_grid(puzzle)))

data/Rakefile

@@ -0,0 +1,256 @@
+# Rakefile
+require "rake/testtask"
+require "rake/clean"
+require "rake/rdoctask"
+require "rake/gempackagetask"
+
+#---
+# The name of your project
+PROJECT = "SudokuSolver"
+
+# Your name, used in packaging.
+MY_NAME = "Martin-Louis Bright"
+
+# Your email address, used in packaging.
+MY_EMAIL = "mlbright@gmail.com"
+
+# Short summary of your project, used in packaging.
+PROJECT_SUMMARY = "Commandline program and library for solving Sudoku puzzles"
+
+# The project's package name (as opposed to its display name). Used for
+# RubyForge connectivity and packaging.
+UNIX_NAME = "sudokusolver"
+
+# Your RubyForge user name.
+RUBYFORGE_USER = ENV["RUBYFORGE_USER"] || "mlbright"
+
+# Directory on RubyForge where your website's files should be uploaded.
+WEBSITE_DIR = "sudokusolver"
+
+# Output directory for the rdoc html files.
+# If you don't have a custom homepage, and want to use the RDoc
+# index.html as homepage, just set it to WEBSITE_DIR.
+RDOC_HTML_DIR = "#{WEBSITE_DIR}/rdoc"
+
+#---
+# Variable settings for extension support.
+EXT_DIR = "ext"
+HAVE_EXT = File.directory?(EXT_DIR)
+EXTCONF_FILES = FileList["#{EXT_DIR}/**/extconf.rb"]
+EXT_SOURCES = FileList["#{EXT_DIR}/**/*.{c,h}"]
+# Eventually add other files from EXT_DIR, like "MANIFEST"
+EXT_DIST_FILES = EXT_SOURCES + EXTCONF_FILES
+
+#---
+REQUIRE_PATHS = ["lib"]
+REQUIRE_PATHS << EXT_DIR if HAVE_EXT
+$LOAD_PATH.concat(REQUIRE_PATHS)
+# This library file defines the MyProject::VERSION constant.
+require "#{UNIX_NAME}"
+PROJECT_VERSION = eval("#{PROJECT}::VERSION") # e.g. "1.0.2"
+
+#---
+# Clobber object files and Makefiles generated by extconf.rb.
+CLOBBER.include("#{EXT_DIR}/**/*.{so,dll,o}", "#{EXT_DIR}/**/Makefile")
+# Clobber .config generated by setup.rb.
+CLOBBER.include(".config")
+
+#---
+# Options common to RDocTask AND Gem::Specification.
+#   The --main argument specifies which file appears on the index.html page
+GENERAL_RDOC_OPTS = {
+  "--title" => "#{PROJECT} API documentation",
+  "--main" => "README.rdoc"
+}
+
+# Additional RDoc formatted files, besides the Ruby source files.
+RDOC_FILES = FileList["README.rdoc", "Changes.rdoc"]
+# Remove the following line if you don't want to extract RDoc from
+# the extension C sources.
+RDOC_FILES.include(EXT_SOURCES)
+
+# Ruby library code.
+LIB_FILES = FileList["lib/**/*.rb"]
+
+# Filelist with Test::Unit test cases.
+TEST_FILES = FileList["test/**/tc_*.rb"]
+
+# Executable scripts, all non-garbage files under bin/.
+BIN_FILES = FileList["bin/*"]
+
+# This filelist is used to create source packages.
+# Include all Ruby and RDoc files.
+DIST_FILES = FileList["**/*.rb", "**/*.rdoc"]
+DIST_FILES.include("Rakefile", "COPYING", "LICENSE")
+DIST_FILES.include(BIN_FILES)
+DIST_FILES.include("data/**/*", "test/data/**/*")
+DIST_FILES.include("#{WEBSITE_DIR}/**/*.{html,css}", "man/*.[0-9]")
+# Don't package files which are autogenerated by RDocTask
+DIST_FILES.exclude(/^(\.\/)?#{RDOC_HTML_DIR}(\/|$)/)
+# Include extension source files.
+DIST_FILES.include(EXT_DIST_FILES)
+# Don't package temporary files, perhaps created by tests.
+DIST_FILES.exclude("**/temp_*", "**/*.tmp")
+# Don't get into recursion...
+DIST_FILES.exclude(/^(\.\/)?pkg(\/|$)/)
+
+#---
+# Run the tests if rake is invoked without arguments.
+task "default" => ["test"]
+
+test_task_name = HAVE_EXT ? "run-tests" : "test"
+Rake::TestTask.new(test_task_name) do |t|
+  t.test_files = TEST_FILES
+  t.libs = REQUIRE_PATHS
+end
+
+#---
+# Set an environment variable with any configuration options you want to
+# be passed through to "setup.rb config".
+CONFIG_OPTS = ENV["CONFIG"]
+if HAVE_EXT
+  file_create ".config" do
+    ruby "setup.rb config #{CONFIG_OPTS}"
+  end
+  
+  desc "Configure and make extension. " +
+    "The CONFIG variable is passed to `setup.rb config'"
+  task "make-ext" => ".config" do
+    # The -q option suppresses messages from setup.rb.
+    ruby "setup.rb -q setup"
+  end
+  
+  desc "Run tests after making the extension."
+  task "test" do
+    Rake::Task["make-ext"].invoke
+    Rake::Task["run-tests"].invoke
+  end
+end
+
+#---
+# The "rdoc" task generates API documentation.
+Rake::RDocTask.new("rdoc") do |t|
+  t.rdoc_files = RDOC_FILES + LIB_FILES
+  t.title = GENERAL_RDOC_OPTS["--title"]
+  t.main = GENERAL_RDOC_OPTS["--main"]
+  t.rdoc_dir = RDOC_HTML_DIR
+end
+
+#---
+GEM_SPEC = Gem::Specification.new do |s|
+  s.name = UNIX_NAME
+  s.version = PROJECT_VERSION
+  s.summary = PROJECT_SUMMARY
+  s.rubyforge_project = UNIX_NAME
+  s.homepage = "http://#{UNIX_NAME}.rubyforge.org/"
+  s.author = MY_NAME
+  s.email = MY_EMAIL
+  s.files = DIST_FILES
+  s.test_files = TEST_FILES
+  s.executables = BIN_FILES.map { |fn| File.basename(fn) }
+  s.has_rdoc = true
+  s.extra_rdoc_files = RDOC_FILES
+  s.rdoc_options = GENERAL_RDOC_OPTS.to_a.flatten
+  if HAVE_EXT
+    s.extensions = EXTCONF_FILES
+    s.require_paths << EXT_DIR
+  end
+end
+
+# Now we can generate the package-related tasks.
+Rake::GemPackageTask.new(GEM_SPEC) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+
+#---
+desc "Upload website to RubyForge. " +
+  "scp will prompt for your RubyForge password."
+task "publish-website" => ["rdoc"] do
+  rubyforge_path = "/var/www/gforge-projects/#{UNIX_NAME}/"
+  sh "scp -r #{WEBSITE_DIR}/* " +
+    "#{RUBYFORGE_USER}@rubyforge.org:#{rubyforge_path}",
+    :verbose => true
+end
+
+#---
+task "rubyforge-setup" do
+  unless File.exist?(File.join(ENV["HOME"], ".rubyforge"))
+    puts "rubyforge will ask you to edit its config.yml now."
+    puts "Please set the `username' and `password' entries"
+    puts "to your RubyForge username and RubyForge password!"
+    puts "Press ENTER to continue."
+    $stdin.gets
+    sh "rubyforge setup", :verbose => true
+  end
+end
+
+task "rubyforge-login" => ["rubyforge-setup"] do
+  # Note: We assume that username and password were set in
+  # rubyforge's config.yml.
+  sh "rubyforge login", :verbose => true
+end
+
+task "publish-packages" => ["package", "rubyforge-login"] do
+  # Upload packages under pkg/ to RubyForge
+  # This task makes some assumptions:
+  # * You have already created a package on the "Files" tab on the
+  #   RubyForge project page. See pkg_name variable below.
+  # * You made entries under package_ids and group_ids for this
+  #   project in rubyforge's config.yml.  If not, eventually read
+  #   "rubyforge --help" and then run "rubyforge setup".
+  pkg_name = ENV["PKG_NAME"] || UNIX_NAME
+  cmd = "rubyforge add_release #{UNIX_NAME} #{pkg_name} " +
+        "#{PROJECT_VERSION} #{UNIX_NAME}-#{PROJECT_VERSION}"
+  cd "pkg" do
+  sh(cmd + ".gem", :verbose => true)
+    sh(cmd + ".tgz", :verbose => true)
+    sh(cmd + ".zip", :verbose => true)
+  end
+end
+
+#---
+# The "prepare-release" task makes sure your tests run, and then generates
+# files for a new release.
+desc "Run tests, generate RDoc and create packages."
+task "prepare-release" => ["clobber"] do
+  puts "Preparing release of #{PROJECT} version #{VERSION}"
+  Rake::Task["test"].invoke
+  Rake::Task["rdoc"].invoke
+  Rake::Task["package"].invoke
+end
+
+# The "publish" task is the overarching task for the whole project. It
+# builds a release and then publishes it to RubyForge.
+desc "Publish new release of #{PROJECT}"
+task "publish" => ["prepare-release"] do
+  puts "Uploading documentation..."
+  Rake::Task["publish-website"].invoke
+  puts "Checking for rubyforge command..."
+  `rubyforge --help`
+  if $? == 0
+    puts "Uploading packages..."
+    Rake::Task["publish-packages"].invoke
+    puts "Release done!"
+  else
+    puts "Can't invoke rubyforge command."
+    puts "Either install rubyforge with 'gem install rubyforge'"
+    puts "and retry or upload the package files manually!"
+  end
+end
+
+#---
+# $ rake -T
+# rake clean            # Remove any temporary products.
+# rake clobber          # Remove any generated file.
+# rake clobber_package  # Remove package products
+# rake clobber_rdoc     # Remove rdoc products
+# rake package          # Build all the packages
+# rake prepare-release  # Run tests, generate RDoc and create packages.
+# rake publish # Publish new release of MyProject
+# rake publish-website  # Upload website to RubyForge. scp will prompt for your RubyForge password.
+# rake rdoc             # Build the rdoc HTML Files
+# rake repackage        # Force a rebuild of the package files
+# rake rerdoc           # Force a rebuild of the RDOC files
+# rake test             # Run tests for test
+#---

data/lib/sudokusolver.rb

@@ -0,0 +1,197 @@
+#!/usr/bin/env ruby
+#
+#  Translated into ruby from python by Martin-Louis Bright
+#  Algorithm, overall structure and original python source code by Peter Norvig
+#  See http://norvig.com/sudoku.html
+
+## Throughout this program:
+##   r is a row,    e.g. 'A'
+##   c is a column, e.g. '3'
+##   s is a square, e.g. 'A3'
+##   d is a digit,  e.g. '9'
+##   u is a unit,   e.g. ['A1','B1','C1','D1','E1','F1','G1','H1','I1']
+##   g is a grid,   e.g. 81 non-blank chars, e.g. starting with '.18...7...
+##   values is a hash of possible values, e.g. {'A1':'123489', 'A2':'8', ...}
+
+class SudokuSolver
+	VERSION = "1.0"
+  attr_reader :rows, :cols, :squares, :unitlist, :peers, :units
+  
+  def cross(a, b)
+    cp = Array.new # cross product
+    a.each do |x|
+      b.each do |y|
+        cp << x+y
+      end
+    end
+    return cp
+  end
+
+  def initialize() 
+    @rows = ('A'..'I').to_a
+    @cols = ('1'..'9').to_a 
+    @squares = cross(@rows, @cols)  
+    @unitlist = Array.new
+    cols.each { |c| @unitlist.push(cross(rows, c)) }
+    rows.each { |r| @unitlist.push(cross(r, cols)) }    
+    for rb in ['ABC','DEF','GHI'] do
+      for cb in ['123','456','789'] do
+        @unitlist << cross(rb.split(''),cb.split(''))
+      end
+    end
+
+    @units = Hash.new
+    squares.each do |s|
+      @units[s] = Array.new
+      unitlist.each do |u| 
+        u.each do |x| 
+          @units[s].push(u) if s == x
+        end
+      end
+    end
+
+    @peers = Hash.new
+    squares.each do |s|
+      @peers[s] = Array.new
+      units[s].each do |u|
+        u.each { |s2| @peers[s] << s2 if s2 != s }
+      end
+    end
+    
+  end
+  
+  def parse_grid(g)
+    g = g.chomp
+    g = g.split('')
+    values = Hash.new
+    # Initially any square can be anything.
+    squares.each { |s| values[s] = "123456789" }
+    for s,d in squares.zip(g)
+      return false unless assign(values, s, d) if d =~ /\d/
+    end
+    return values
+  end
+  
+  def assign(values, s, d)
+    values[s].split('').each do |d2|
+      unless d2 == d
+        return false if eliminate(values, s, d2) == false
+      end
+    end
+    return values
+  end
+  
+  def eliminate(values, s, d)
+    return values unless values[s].include?(d) ## Already eliminated.
+
+    values[s] = values[s].sub(d,'') ## Remove the digit from the string of possibilities
+    ##  values[s].sub!(d,'') => why doesn't sub!() work?
+
+    return false if values[s].length == 0 ## Contradiction: no more values (no more digits can be assigned)
+
+    ## Remove digit from all peers
+    peers[s].each { |s2| return false unless eliminate(values, s2, values[s]) } if values[s].length == 1
+
+    ## Assign digit if, by elimination, there is only one square left 
+    ## in the units for this square that can hold the digit 
+    units[s].each do |u|
+      dplaces = Array.new
+      u.each { |s2| dplaces << s2 if values[s2].include?(d) }
+      return false if dplaces.length == 0 # bad
+      return false if assign(values, dplaces[0], d) == false if dplaces.length == 1
+    end
+    return values
+  end
+
+  def search(values)
+    return false if values == false
+
+    solved = true ## assumption 
+    squares.each do |s|
+      unless values[s].length == 1
+        solved = false
+        break
+      end
+    end
+    return values if solved == true  ## Solved!
+      
+    min = 10 
+    start = nil
+    squares.each do |s| ## Chose the undetermined square s with the fewest possibilities
+      l = values[s].length
+      if l > 1 && l < min
+        min = l
+        start = s
+      end
+    end
+
+    values[start].split('').each do |d| 
+      solution = search(assign(values.clone,start,d))
+      return solution unless solution == false
+    end
+    return false
+  end
+    
+  def print_grid(values)
+    return if values == false
+    max = 0
+    squares.each { |s| max = values[s].length if values[s].length > max }
+    width = 1 + max
+    a = Array.new
+    3.times do |c|
+      tmp = ""
+      (3*width).times do
+        tmp = tmp + '-'
+      end
+      tmp += "-" if c == 1 
+      a.push(tmp)
+    end
+    line  = "\n" + a.join('+')
+    
+    tmp = ""
+    for r in rows
+      for c in cols
+        tmp = tmp + values[r+c].center(width)
+        if c == '3' or c == '6'
+          tmp = tmp + '| '
+        end
+      end
+      tmp = tmp + line if r == 'C' or r == 'F' 
+      tmp = tmp + "\n"
+    end
+    puts tmp + "\n"
+    return values
+  end
+  
+  def string_solution(values)
+    solution = ""
+    squares.each do |s|
+      solution += values[s]
+    end
+    return solution
+  end
+  
+  def check_solution(solution)
+    values = Hash.new
+    for s,d in squares.zip(solution.split(''))
+      values[s] = d
+    end
+    
+    unitlist.each do |u|
+      tmp = Hash.new
+      u.each do |s|
+        tmp[values[s]] = true
+      end
+      return false unless tmp.keys.length == 9
+    end
+    return true  
+  end
+  
+end
+
+## Algorithm by Peter Norvig @ http://www.norvig.com/sudoku.html
+
+## More constraints:
+## http://www.scanraid.com/BasicStrategies.htm
+## http://www.krazydad.com/blog/2005/09/29/an-index-of-sudoku-strategies/
+## http://www2.warwick.ac.uk/fac/sci/moac/currentstudents/peter_cock/python/sudoku/

data/test/driver.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+#
+#  Created by Martin-Louis Bright on 2007-04-10.
+#  Copyright (c) 2007. All rights reserved.
+
+require 'sudokusolver'
+
+puzzle = "4.....8.5.3..........7......2.....6.....8.4......1.......6.3.7.5..2.....1.4......"
+s  = SudokuSolver.new
+s.print_grid(s.search(s.parse_grid(puzzle)))

data/test/tc_sudoku.rb

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+#
+#  Created by Martin-Louis Bright on 2007-03-21.
+#  Copyright (c) 2007. All rights reserved.
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'sudokusolver')
+require 'test/unit'
+
+class SudokuTest < Test::Unit::TestCase
+  
+  def setup
+    @path = File.join(File.dirname(__FILE__), '..')
+    @easy = File.read(@path + '/test/easy_puzzles.txt').split("\n")
+    @hard = File.read(@path + '/test/top95.txt').split("\n")
+    @s = SudokuSolver.new
+  end
+  
+  def test_empty_puzzle
+    e = "................................................................................."
+    sol = @s.string_solution(@s.search(@s.parse_grid(e)))
+    puts sol
+    assert(@s.check_solution(sol))
+  end
+  
+  def test_sanity
+    puts "Easy puzzle (constraint satisfaction only): "
+    puts
+    @s.print_grid(@s.search(@s.parse_grid(@easy[0])))
+    puts "Hard puzzle (constraint satisfaction + search): "
+    puts
+    @s.print_grid(@s.search(@s.parse_grid(@hard[0])))
+  end
+  
+  def test_easy
+    multiple(@easy)
+  end
+  
+  def test_hard
+    multiple(@hard)
+  end
+
+  def test_bmark_hard
+    @hard.each do |g|
+      puts @s.string_solution(@s.search(@s.parse_grid(g)))
+    end
+  end
+  
+  def multiple(puzzles)
+    puzzles.each do |g|
+      assert(@s.check_solution(@s.string_solution(@s.search(@s.parse_grid(g)))))
+    end
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.2
+specification_version: 1
+name: sudokusolver
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+date: 2007-04-15 00:00:00 -04:00
+summary: Commandline program and library for solving Sudoku puzzles
+require_paths: 
+- lib
+email: mlbright@gmail.com
+homepage: http://sudokusolver.rubyforge.org/
+rubyforge_project: sudokusolver
+description: 
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Martin-Louis Bright
+files: 
+- lib/sudokusolver.rb
+- test/driver.rb
+- test/tc_sudoku.rb
+- Changes.rdoc
+- README.rdoc
+- Rakefile
+- COPYING
+- LICENSE
+test_files: 
+- test/tc_sudoku.rb
+rdoc_options: 
+- --title
+- SudokuSolver API documentation
+- --main
+- README.rdoc
+extra_rdoc_files: 
+- README.rdoc
+- Changes.rdoc
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+