kudo 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9a70a096d1feca4a8d023437c21c9964582bf5d40dde850fb1af9ca9229a4152
+  data.tar.gz: 5dfb3cfe1fb74ff04349bfe177a01650bb722d2fa379a075798e6aa4e6bb6a8a
+SHA512:
+  metadata.gz: ba48e564feb52227c126e2b51b6b472e74517b96bf88bcc8a495014e0ef5bc248750efc50e953c9cdfb2016987f9a3a5dc5db875e1bb46dbb72e1a38b861ad1d
+  data.tar.gz: af589d27f6881182d70e1b2c20f8728d4ea37f5d7510a15322612ab3ae8e1ece515c8b627565e2cd09596736bcb5858a4948fcb1685d5d07013a4952f6759879

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# rubocop
+
+.rubocop.yml
+.rubocop_todo.yml

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in kudo.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,86 @@
+PATH
+  remote: .
+  specs:
+    kudo (0.1.0)
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (2.0.0)
+      bundler (>= 1.17, < 3.0)
+      childprocess (>= 2.0, < 5.0)
+      contracts (>= 0.16.0, < 0.18.0)
+      cucumber (>= 4.0, < 8.0)
+      rspec-expectations (~> 3.4)
+      thor (~> 1.0)
+    builder (3.2.4)
+    childprocess (4.1.0)
+    contracts (0.16.1)
+    cucumber (7.0.0)
+      builder (~> 3.2, >= 3.2.4)
+      cucumber-core (~> 10.0, >= 10.0.1)
+      cucumber-create-meta (~> 6.0, >= 6.0.1)
+      cucumber-cucumber-expressions (~> 12.1, >= 12.1.1)
+      cucumber-gherkin (~> 20.0, >= 20.0.1)
+      cucumber-html-formatter (~> 16.0, >= 16.0.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+      cucumber-wire (~> 6.0, >= 6.0.1)
+      diff-lcs (~> 1.4, >= 1.4.4)
+      mime-types (~> 3.3, >= 3.3.1)
+      multi_test (~> 0.1, >= 0.1.2)
+      sys-uname (~> 1.2, >= 1.2.2)
+    cucumber-core (10.0.1)
+      cucumber-gherkin (~> 20.0, >= 20.0.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+      cucumber-tag-expressions (~> 3.0, >= 3.0.1)
+    cucumber-create-meta (6.0.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+      sys-uname (~> 1.2, >= 1.2.2)
+    cucumber-cucumber-expressions (12.1.2)
+    cucumber-gherkin (20.0.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+    cucumber-html-formatter (16.0.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+    cucumber-messages (17.0.1)
+    cucumber-tag-expressions (3.0.1)
+    cucumber-wire (6.1.0)
+      cucumber-core (~> 10.0, >= 10.0.1)
+      cucumber-cucumber-expressions (~> 12.1, >= 12.1.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+    diff-lcs (1.4.4)
+    ffi (1.15.3)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0704)
+    multi_test (0.1.2)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    sys-uname (1.2.2)
+      ffi (~> 1.1)
+    thor (1.1.0)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  aruba
+  cucumber
+  kudo!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.25

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Nguyen Viet Tuang
+
+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,37 @@
+# Kudo
+
+"Yet another sudoku solver" - *some one famous, 2021*
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kudo'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install kudo
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tuang3142/sudoku.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "kudo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/exe/kudo

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "kudo/cli"
+
+Kudo::CLI.start

data/kudo.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/kudo/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kudo"
+  spec.version       = Kudo::VERSION
+  spec.authors       = ["Tuan Nguyen"]
+  spec.email         = ["hi@tuanguyen.com"]
+
+  spec.summary       = "Yet another sudoku solver"
+  spec.description   = "A command-line interface to solve sudoku quickly."
+  spec.homepage      = "https://github.com/tuang3142/sudoku"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"]      = spec.homepage
+  spec.metadata["source_code_uri"]   = spec.homepage
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor"
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "aruba"
+end

data/lib/kudo.rb

@@ -0,0 +1,19 @@
+ # frozen_string_literal: true
+
+require_relative "kudo/version"
+require_relative "kudo/ping"
+require_relative "kudo/solver"
+require_relative "kudo/converter"
+require_relative "kudo/operator"
+require_relative "kudo/validator"
+
+module Kudo
+  module_function
+
+  def solve(sudoku_string)
+    grid = Converter.convert_to_array(sudoku_string)
+    raise "Sudoku is invalid!" unless Validator.check_valid(grid)
+
+    Converter.convert_to_string(Solver.solve(grid))
+  end
+end

data/lib/kudo/cli.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "thor"
+require "kudo"
+
+module Kudo
+  class CLI < Thor
+    desc "ping", "pong!"
+    def ping
+      puts Kudo.ping
+    end
+
+    desc "solve INPUT", "Solves the sudoku given in the input file"
+    def solve(file_name)
+      sudoku = File.read(file_name)
+
+      puts Kudo.solve(sudoku)
+    rescue StandardError => e
+      puts e
+    end
+  end
+end

data/lib/kudo/converter.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Kudo
+  class Converter
+    def self.convert_to_array(sudoku_string)
+      sudoku_string
+        .split("")
+        .select { |char| "0" <= char && char <= "9" }
+        .map(&:to_i)
+        .each_slice(9)
+        .to_a
+    end
+
+    def self.convert_to_string(sudoku_grid)
+      sudoku_grid
+        .map { |row| row.join(" ") }
+        .join("\n")
+    end
+  end
+end

data/lib/kudo/operator.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+class Kudo::Operator
+  class << self
+    def get_empty_cells(sudoku)
+      empty_cells = []
+      9.times do |i|
+        9.times do |j|
+          empty_cells.append([i, j]) if sudoku[i][j].zero?
+        end
+      end
+
+      empty_cells
+    end
+
+    def get_row(sudoku, i)
+      sudoku[i]
+    end
+
+    def get_column(sudoku, j)
+      sudoku.map { |row| row[j] }
+    end
+
+    def get_subgrid(sudoku, i, j)
+      row = i / 3 * 3
+      col = j / 3 * 3
+      subgrid = []
+      (row..row + 2).each do |r|
+        (col..col + 2).each do |c|
+          subgrid << sudoku[r][c]
+        end
+      end
+      subgrid
+    end
+  end
+end

data/lib/kudo/ping.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Kudo
+  module_function
+
+  def ping
+    "pong!"
+  end
+end

data/lib/kudo/solver.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Kudo
+  class Solver
+    class << self
+      def solve(sudoku)
+        empty_cells = Operator.get_empty_cells(sudoku)
+        try_solve(sudoku, empty_cells)
+      end
+
+      private
+
+      def try_solve(sudoku, empty_cells)
+        return sudoku if empty_cells.empty?
+
+        i, j = empty_cells.last
+        (1..9).each do |num|
+          next if Operator.get_row(sudoku, i).include?(num) ||
+                  Operator.get_column(sudoku, j).include?(num) ||
+                  Operator.get_subgrid(sudoku, i, j).include?(num)
+          sudoku[i][j] = num
+          empty_cells.pop
+          result = try_solve(sudoku, empty_cells)
+          return result if result
+          sudoku[i][j] = 0
+          empty_cells.append([i, j])
+        end
+
+        nil
+      end
+    end
+  end
+end

data/lib/kudo/validator.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "set"
+
+module Kudo
+  class Validator
+    class << self
+      def check_solved(sudoku)
+        check_complete(sudoku) && check_valid(sudoku)
+      end
+
+      def check_complete(sudoku)
+        Operator.get_empty_cells(sudoku).empty?
+      end
+
+      def check_valid(sudoku)
+        check_rows(sudoku) && check_columns(sudoku) && check_subgrids(sudoku)
+      end
+
+      private
+
+      SUDOKU_RANGE = (0..8)
+
+      def check_rows(sudoku)
+        SUDOKU_RANGE.all? { |i| check_unique(Operator.get_row(sudoku, i)) }
+      end
+
+      def check_columns(sudoku)
+        SUDOKU_RANGE.all? { |i| check_unique(Operator.get_column(sudoku, i)) }
+      end
+
+      def check_subgrids(sudoku)
+        SUDOKU_RANGE.all? do |i|
+          SUDOKU_RANGE.all? do |j|
+            check_unique(Operator.get_subgrid(sudoku, i, j))
+          end
+        end
+      end
+
+      def check_unique(array)
+        non_zero_arr = array.reject(&:zero?)
+        non_zero_arr.size == non_zero_arr.to_set.size
+      end
+    end
+  end
+end

data/lib/kudo/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Kudo
+  VERSION = "0.2.1"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: kudo
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Tuan Nguyen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A command-line interface to solve sudoku quickly.
+email:
+- hi@tuanguyen.com
+executables:
+- kudo
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/kudo
+- kudo.gemspec
+- lib/kudo.rb
+- lib/kudo/cli.rb
+- lib/kudo/converter.rb
+- lib/kudo/operator.rb
+- lib/kudo/ping.rb
+- lib/kudo/solver.rb
+- lib/kudo/validator.rb
+- lib/kudo/version.rb
+homepage: https://github.com/tuang3142/sudoku
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/tuang3142/sudoku
+  source_code_uri: https://github.com/tuang3142/sudoku
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
+specification_version: 4
+summary: Yet another sudoku solver
+test_files: []