kudosu 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dcd5f234f4d11bf92d05c11e677f410fbbc42a8bc9fe66285a8f358ef03443cf
+  data.tar.gz: b588e3b09170e3e475a039f4312b84dcef017216a2657469460736612eaba431
+SHA512:
+  metadata.gz: adf64a762b560d2a983fc9d60fba77ddf5bd6a503f99cc9cad35fbcfb5f3e7d36bc95e6d43c9df122381e9109e3ce4f955ec30c52332fc5a279406f8fbbe59f1
+  data.tar.gz: 838032a7c1b0a5b03b1f20a271af052105055e5729084c0bad0a5024d5e6b38dee239c03c9292c05da6467c5dff9637ca6ddf2c1d66916b7e38ac00f727fa200

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in kudosu.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    kudosu (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  kudosu!
+  rake (~> 10.0)
+  rspec (~> 3.8)
+
+BUNDLED WITH
+   1.16.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Macario
+
+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,44 @@
+# Kudosu
+
+Sudoku generator and solver
+
+## Installation
+
+```
+$ gem install kudosu
+```
+
+## Usage
+
+Generate a sudoku puzzle
+
+```
+$ kudosu generate
+```
+
+Generate a JSON representation of a sudoku puzzle
+
+```
+$ kudosu generate-json
+```
+
+Solve a JSON representation of a sudoku puzzle
+
+```
+$ kudosu generate-json | kudosu solve
+```
+
+
+## TODO
+
+- optimize
+- ncurses interface
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/maca/kudosu. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kudosu"
+
+require "irb"
+IRB.start(__FILE__)

data/bin/kudosu

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kudosu"
+require "json"
+
+
+def print_usage
+  puts <<-STR
+Usage: kudosu COMMAND
+Commands:
+  generate       prints a generated sudoku board
+  generate-json  prints a json representation of a generated sudoku board
+  solve NUMBERS  solves a puzzle, number should be a json array of sudoku numbers
+STR
+
+  exit
+end
+
+command = ARGV.shift
+
+
+print_usage unless %w(generate generate-json solve).include?(command)
+
+
+case command
+when "generate"
+  print_usage unless ARGV.none?
+  Kudosu.generate.print
+
+when "generate-json"
+  print_usage unless ARGV.none?
+  puts Kudosu.generate.values.to_json
+
+when "solve"
+  numbers = JSON.parse(STDIN.tty? ? ARGV.first : $stdin.read)
+  Kudosu.solve(numbers).print
+end

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/kudosu.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kudosu/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kudosu"
+  spec.version       = Kudosu::VERSION
+  spec.authors       = ["Macario"]
+  spec.email         = ["maca@aelita.io"]
+
+  spec.summary       = %q{Sudoku solver and generator}
+  spec.description   = %q{Sudoku solver and generator}
+  spec.homepage      = "https://github.com/maca/kudosu"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = "kudosu"
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.8"
+end

data/lib/kudosu.rb

@@ -0,0 +1,17 @@
+require "kudosu/version"
+require "kudosu/markup_range_utils"
+require "kudosu/board"
+require "kudosu/cell"
+require "kudosu/printer"
+
+module Kudosu
+  module_function
+
+  def solve(values)
+    Board.new(values).solve
+  end
+
+  def generate
+    solve([[nil] * 9] * 9).shuffle
+  end
+end

data/lib/kudosu/board.rb

@@ -0,0 +1,84 @@
+module Kudosu
+  class Board
+    attr_accessor :cells
+
+    def initialize(ary)
+      self.cells = ary.flatten.map { |val| Cell.new(val) }
+    end
+
+    def solve
+      board = attempt_solution || fork_board(values) until board
+      self.cells = board.cells
+      self
+    end
+
+    def values
+      cells.map(&:value)
+    end
+
+    def print
+      Printer.new(self).print
+    end
+
+    def rows
+      cells.each_slice(9).to_a
+    end
+
+    def columns
+      rows.transpose
+    end
+
+    def boxes
+      sliced_cols = rows.map { |row| row.each_slice(3).to_a }.transpose
+      sliced_cols.flatten.each_slice(9).to_a
+    end
+
+    def shuffle
+      boxes.each { |box| box.shuffle.take(rand(5..7)).each(&:reset) }
+      self
+    end
+
+    def solved?
+      cells.all?(&:solved?)
+    end
+
+    def valid?
+      MarkupRangeUtils.ranges_valid?(markup_ranges)
+    end
+
+    protected
+
+    def unsolved_cells
+      cells.reject(&:solved?)
+    end
+
+    def attempt_solution
+      cells.each(&:reset_markup)
+
+      until solved?
+        MarkupRangeUtils.update_ranges_markup(markup_ranges)
+        return if cells.none?(&:solve)
+      end
+
+      self
+    end
+
+    private
+
+    def markup_ranges
+      @ranges ||= rows + columns + boxes
+    end
+
+    def fork_board(values)
+      board = Board.new(values)
+
+      board.unsolved_cells.each do |cell|
+        return board if board.attempt_solution
+        cell.pick_random
+        break unless board.valid?
+      end
+
+      fork_board(values)
+    end
+  end
+end

data/lib/kudosu/cell.rb

@@ -0,0 +1,34 @@
+module Kudosu
+  class Cell
+    attr_accessor :value, :markup
+
+    def initialize(value)
+      self.value = value
+    end
+
+    def solved?
+      !value.nil?
+    end
+
+    def solve
+      self.value = markup.pop if markup.one? unless solved?
+    end
+
+    def remove_from_markup(values)
+      self.markup -= values
+    end
+
+    def pick_random
+      self.value = markup.sample
+      markup.delete(value)
+    end
+
+    def reset
+      self.value = nil
+    end
+
+    def reset_markup
+      self.markup = (1..9).to_a
+    end
+  end
+end

data/lib/kudosu/markup_range_utils.rb

@@ -0,0 +1,23 @@
+module Kudosu
+  module MarkupRangeUtils
+    module_function
+
+    def range_values(range)
+      range.map(&:value).compact
+    end
+
+    def update_ranges_markup(ranges)
+      ranges.each do |range|
+        values = range_values(range)
+        range.each { |cell| cell.remove_from_markup(values) }
+      end
+    end
+
+    def ranges_valid?(ranges)
+      ranges.all? do |range|
+        values = range_values(range)
+        values.uniq == values
+      end
+    end
+  end
+end

data/lib/kudosu/printer.rb

@@ -0,0 +1,24 @@
+module Kudosu
+  class Printer
+    attr_accessor :board
+
+    def initialize(board)
+      self.board = board
+    end
+
+    def print
+      board.rows.each do |row|
+        print_separation
+        puts '| ' + row.map{ |cell| cell.value || " " }.join(' | ') + ' |'
+      end
+
+      print_separation
+    end
+
+    private
+
+    def print_separation
+      puts '+' + '---+' * 9
+    end
+  end
+end

data/lib/kudosu/version.rb

@@ -0,0 +1,3 @@
+module Kudosu
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: kudosu
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Macario
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description: Sudoku solver and generator
+email:
+- maca@aelita.io
+executables:
+- kudosu
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/kudosu
+- bin/setup
+- kudosu.gemspec
+- lib/kudosu.rb
+- lib/kudosu/board.rb
+- lib/kudosu/cell.rb
+- lib/kudosu/markup_range_utils.rb
+- lib/kudosu/printer.rb
+- lib/kudosu/version.rb
+homepage: https://github.com/maca/kudosu
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Sudoku solver and generator
+test_files: []