kira 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d54e43948bd3ab61423f7b279dbc075713d915e06760394bf235504f31f7a8bd
+  data.tar.gz: 2f902bb6a8e558c72784c1b4b7e78c27d2a1c77142ccca2974eaec001d103667
+SHA512:
+  metadata.gz: 1b672eac79678e86121d4590c076e9de542ff5c3c7d8040cb6001bb79004744e48c2992ac790a908d33132069c3966cba06a4388386fe4e321dc168865f7e3e5
+  data.tar.gz: f3fead8b59cc529f16d06fc5c4caaf4348046dcf012960a9b04bec8d8224485c2ebb6e54648347988dd18368c05fb2d51356c2a249460d70cfab78decf49bf6b

data/bin/kira

@@ -0,0 +1,148 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require 'kira'
+require 'getoptlong'
+require 'colorize'
+
+class GridDecorator
+  def initialize
+    @top_border             = ""
+    @bottom_border          = ""
+    @vertical_separator     = ""
+    @box_vertical_separator = ""
+    @row_separator          = ""
+    @box_row_separator      = ""
+  end
+
+  def decorate(grid)
+    ret = @top_border
+    row_num = 0
+    grid.each_line do |line|
+      col_num = 0
+      line.chomp.each_char do |c|
+        if col_num % 3 == 0
+          ret += @box_vertical_separator
+        else
+          ret += @vertical_separator
+        end
+        ret += "#{c} "
+        col_num += 1
+      end
+      ret += @box_vertical_separator + "\n"
+      if (row_num + 1) % 3 == 0 and row_num != 8
+        ret += @box_row_separator
+      elsif row_num != 8
+        ret += @row_separator
+      end
+      row_num += 1
+    end
+    ret += @bottom_border
+
+    ret
+  end
+end
+
+class ASCIIGridDecorator < GridDecorator
+  def initialize
+    @top_border             = "+-------" * 3 + "+\n"
+    @bottom_border          = "+-------" * 3 + "+"
+    @vertical_separator     = ""
+    @box_vertical_separator = "| "
+    @row_separator          = ""
+    @box_row_separator      = @top_border
+  end
+end
+
+class BoxGridDecorator < GridDecorator
+  def initialize
+    @top_border             = "┏━━━┯━━━┯━━━┳━━━┯━━━┯━━━┳━━━┯━━━┯━━━┓\n"
+    @bottom_border          = "┗━━━┷━━━┷━━━┻━━━┷━━━┷━━━┻━━━┷━━━┷━━━┛"
+    @vertical_separator     = "│ "
+    @box_vertical_separator = "┃ "
+    @row_separator          = "┠───┼───┼───╂───┼───┼───╂───┼───┼───┨\n"
+    @box_row_separator      = "┣━━━┿━━━┿━━━╋━━━┿━━━┿━━━╋━━━┿━━━┿━━━┫\n"
+  end
+end
+
+class Printer
+  def print(sudoku, decorator)
+    puts decorator.decorate(sudoku.to_s + "\n")
+  end
+end
+
+class ColorPrinter < Printer
+  def print(sudoku, decorator)
+    grid = decorator.decorate(sudoku.to_s + "\n")
+    colors = String.colors.shuffle
+    colors.delete_if do |item|
+      [:black, :light_black, :white, :light_white].include? item
+    end
+    output = ""
+    i = 0
+    grid.each_char do |c|
+      if c.match?(/[1-9]/)
+        group_no = sudoku.grid_of_group_idxs[i]
+        if group_no
+          group_no %= colors.size
+          output << c.colorize(colors[group_no])
+        else
+          output << c
+        end
+        i += 1
+      else
+        output << c
+      end
+    end
+
+    puts output
+  end
+end
+
+printer = Printer.new
+decorator = GridDecorator.new
+
+opts = GetoptLong.new(
+  ['--help', '-h', GetoptLong::NO_ARGUMENT],
+  ['--version', '-V', GetoptLong::NO_ARGUMENT],
+  ['--pretty', GetoptLong::OPTIONAL_ARGUMENT],
+  ['--color', GetoptLong::NO_ARGUMENT]
+)
+
+opts.each do |opt, arg|
+  case opt
+  when '--help'
+    puts <<~EOF
+      Usage: #{$0} [options]
+
+      Options:
+        -h, --help            display this help and exit
+        -V, --version         output version information and exit
+        --pretty[=<format>]   pretty-print the result in a given format
+        --color               colorize the output
+    EOF
+    exit 0
+  when '--version'
+    puts "Kira #{Kira::VERSION}"
+    exit 0
+  when '--pretty'
+    if arg == "" or arg == "ascii"
+      decorator = ASCIIGridDecorator.new
+    elsif arg == "box"
+      decorator = BoxGridDecorator.new
+    end
+  when '--color'
+    printer = ColorPrinter.new
+  end
+end
+
+begin
+  input = $stdin.read
+  sudoku = Kira::Sudoku.new(input)
+  unless sudoku.solve
+    raise StandardError.new("Over-constrained puzzle")
+  end
+  printer.print(sudoku, decorator)
+rescue StandardError => e
+  STDERR.puts "Error: " + e.message
+end

data/lib/kira.rb

@@ -0,0 +1,2 @@
+require 'kira/version'
+require 'kira/sudoku'

data/lib/kira/group.rb

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+
+module Kira
+
+  # Represents a group of cells, the sum of which must be equal to a certain
+  # fixed number. It is initialized with an equation having the following form
+  # (whitespaces are ignored):
+  #   (r1, c1) + (r2, c2) + ... = s
+  # where:
+  #   rn - row number
+  #   cn - column number
+  #   s - sum of the values at the given indexes 
+  class Group
+    def initialize(equation)
+      equation.delete!(" \t\n\r")
+
+      unless equation.match /(\(\d,\d\)+)*\(\d,\d\)=\d+/
+        raise ArgumentError.new("Equation has invalid format")
+      end
+
+      *str_idxs, @sum = equation.split(/[=+]/)
+      @sum = @sum.to_i
+      @indexes = []
+      str_idxs.each do |idx|
+        row, col = idx.scan(/\d+/).map(&:to_i)
+        indexes.push(row*9 + col)
+      end
+    end
+
+    attr_reader :indexes, :sum
+
+    def to_s
+      (@indexes.map { |i| "(#{i / 9}, #{i % 9})" }).join(" + ") + " = #{@sum}"
+    end
+  end
+end

data/lib/kira/puzzle.rb

@@ -0,0 +1,106 @@
+# -*- coding: utf-8 -*-
+
+module Kira
+
+  # Represents the state of a 9x9 sudoku puzzle. 
+  class Puzzle
+    def initialize(grid)
+      grid.delete!(" \t\n\r")
+
+      if grid.length != 81
+        raise ArgumentError.new("Grid has invalid size")
+      elsif not grid.match("^[0-9.]{81}$")
+        raise ArgumentError.new("Grid contains invalid characters")
+      end
+
+      @grid = []
+      grid.each_char { |c| @grid.push(c.to_i) }
+    end
+
+    attr_reader :grid
+
+    # Traverses the row, column, and box containing the 'pos' and calls the
+    # 'proc' with the current index as an argument on each step. Note that it
+    # visits some cells more than once.
+    def scan(pos, &proc)
+      # pos - (pos % 9):
+      #   index of the first cell in the row containing 'pos'.
+      #
+      # pos % 9:
+      #   index of the first cell in the column containing 'pos'.
+      #
+      # (pos - (pos % 3)):
+      #   index of the left-most cell in the box containing 'pos'.
+      #
+      # (pos - (pos % 3)) % 9:
+      #   index of the first cell in the column containing the top-left corner
+      #   of the box.
+      #
+      # (pos - (pos % 27)):
+      #   index of the first cell in the row containing the top-left corner of
+      #   the box.
+      #
+      # (pos - (pos % 3)) % 9 + (pos - (pos % 27)):
+      #   index of the top-left corner of the box containing 'pos'.
+
+      # Scan row
+      9.times do |i|
+        proc.call((pos - (pos % 9)) + i)
+      end
+
+      # Scan col
+      9.times do |i|
+        proc.call((pos % 9) + i*9)
+      end
+
+      # Scan box
+      corner_idx = (pos - (pos % 3)) % 9 + (pos - (pos % 27))
+      3.times do |i|
+        3.times do |j|
+          proc.call(corner_idx + i*9 + j)
+        end
+      end
+    end
+
+    alias :update :scan 
+
+    # Returns true if the 'val' on the given 'pos' does not repeat in a column,
+    # row or box. The 'pos' is a 1-dimensional, 0-based index.
+    def valid?(val, pos)
+      if val != 0
+        scan(pos) { |i| if val == @grid[i] then return false end }
+      end
+      true
+    end
+
+    def to_s
+      string = ""
+      0.upto(80) do |i|
+        if @grid[i] == 0
+          string << "."
+        else
+          string << @grid[i].to_s
+        end
+        if ((i + 1) % 9 == 0 and i != 80)
+          string << "\n"
+        end
+      end
+
+      string
+    end
+
+    def [](idx)
+      @grid[idx]
+    end
+
+    def []=(idx, val)
+      if idx > 80
+        raise IndexError.new("Index out of range")
+      elsif not val.between?(0, 9)
+        raise ArgumentError.new("Value out of range")
+      end
+
+      @grid[idx] = val
+    end
+  end
+end

data/lib/kira/sudoku.rb

@@ -0,0 +1,114 @@
+# -*- coding: utf-8 -*-
+
+require 'kira/group'
+require 'kira/puzzle'
+
+module Kira
+
+  # A Killer Sudoku solver. It is initialized with an optional string
+  # containing a grid followed by any number of equations. The grid consists
+  # of digits from 1 to 9 and dots representing an empty cell. Each equation
+  # has to be on its own line.
+  class Sudoku
+    def initialize(string)
+      grid = ""
+      @groups = []
+      string.each_line do |line|
+        if line.match("^[1-9\. \t\n\r]*$")
+          grid << line
+        else
+          @groups.push(Group.new(line))
+        end
+      end
+
+      if grid == ""
+        grid << '.' * 81
+      end
+
+      @puzzle = Puzzle.new(grid)
+
+      # '@grid_of_group_idxs' maps the cell's index to the index of the group
+      # to which the cell belongs.
+      @grid_of_group_idxs = Array.new(81)
+      0.upto(@groups.size - 1) do |i|
+        @groups[i].indexes.each { |j| @grid_of_group_idxs[j] = i }
+      end
+    end
+
+    attr_reader :puzzle, :groups, :grid_of_group_idxs
+
+    def to_s
+      @puzzle.to_s
+    end
+
+    def solve(start = 0)
+      # Find next empty cell.
+      until @puzzle[start] == 0 or @puzzle[start] == nil
+        start += 1
+      end
+
+      if @puzzle[start] == nil
+        return true
+      end
+
+      possibilities = []
+      1.upto(9) do |v|
+        if valid?(v, start)
+          possibilities.push(v)
+        end
+      end
+
+      possibilities.each do |p|
+        @puzzle[start] = p
+
+        if solve(start + 1)
+          return true
+        end
+      end
+
+      @puzzle[start] = 0
+      false
+    end
+
+    # Returns true if the 'val' on the given 'pos' does not repeat in a column,
+    # row, box or group and all the equations are satisfied.
+    def valid?(val, pos)
+      unless @puzzle.valid?(val, pos)
+        return false
+      end
+
+      group_idx = @grid_of_group_idxs[pos]
+      if group_idx == nil
+        return true
+      end
+
+      g = @groups[group_idx]
+      sum = val
+
+      # Set to true when the group contains an empty cell at position other
+      # than 'pos'.
+      empty = false
+
+      g.indexes.each do |idx|
+        v = @puzzle.grid[idx]
+
+        if idx != pos
+          if v == val
+            return false
+          end
+          if v == 0
+            empty = true
+          end
+        end
+
+        sum += v
+      end
+
+      unless (sum == g.sum and not empty) or (empty and sum < g.sum)
+        return false
+      end
+
+      true
+    end
+  end
+end

data/lib/kira/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Kira
+  VERSION = '0.2.0'
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: kira
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Wadim X. Janikowski
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-25 00:00:00.000000000 Z
+dependencies: []
+description:
+email: wadim.janikowski@gmail.com
+executables:
+- kira
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/kira
+- lib/kira.rb
+- lib/kira/group.rb
+- lib/kira/puzzle.rb
+- lib/kira/sudoku.rb
+- lib/kira/version.rb
+homepage: https://github.com/wadiim/kira
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: A (killer) sudoku solver.
+test_files: []