ruby-wordle 0.9.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 911b41c72a106def560cc14de90dce996c354e615054d67ea3d3c150a29dad21
+  data.tar.gz: 80a2fabaa942be49066e69af631ae473b2f5b774439fb2aa626e7e6748f3498f
+SHA512:
+  metadata.gz: b363d91c62414d150ae0675ea0345253659d20e7f2202c0c2a2fa5ba516125ace8f3a3023c21878dbf29b0c0d8a990c9ed755d4ac4fc0b2ed3ab47a6998660a3
+  data.tar.gz: 77816914e691cae8ee15bd5a11d8ff1e2c06b873d88de5bbb5b7c3e2e9676a8cd87d7674c7cbdb0f996546e82c28baea718b904a70a6b6cfb506e4b1d407480e

data/.gitignore

@@ -0,0 +1,58 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+.DS_Store

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gem 'readline'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Yoichiro Hasebe
+
+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,101 @@
+# Ruby-Wordle
+
+A set of ruby scripts to generate word-lists, solve Wordle, and play Wordle on the command line
+
+⬜️⬜️⬜️⬜️⬜️ \
+⬜️⬜️⬜️🟨🟨 \
+⬜️🟩⬜️🟩⬜️ \
+🟩🟩⬜️🟩🟩 \
+🟩🟩🟩🟩🟩
+
+----
+
+### Installation
+
+```
+> gem install ruby-wordle
+```
+
+----
+
+### Play Wordle
+
+**Usage Example**
+
+```plain-text
+> ruby-worldle play
+```
+
+<img src='https://github.com/yohasebe/ruby-wordle/blob/main/img/ruby-wordle-play.png?raw=true' width='500' />
+
+You can ask for help by typing "?↵" while playing. In the suggestion list, basic words consisting of 5 different letters are printed in red 🟥 while basic words having the same letters used more than once are printed in blue 🟦
+
+----
+
+### Wordle Solver
+
+**Usage Example**
+
+```plain-text
+> ruby-worldle solver
+```
+
+<img src='https://github.com/yohasebe/ruby-wordle/blob/main/img/ruby-wordle-solver.png?raw=true' width='500' />
+
+In the result list, basic words consisting of 5 different letters are printed in red 🟥 while basic words having the same letters used more than once are printed in blue 🟦
+
+----
+
+### Word Lists
+
+#### Word List Generator Script
+
+🟢 `lib/ruby-wordle/script-filter.rb`
+
+A ruby script to generate *n*-letter word lists (`word-list.txt` and `word-list-uniq.txt`)
+
+The default *n* value is 5. Change `NUM_LETTERS` if necessary, and run the script as follows. A directory will be created automatically with the title having the number specified in the script (e.g. `word-lists/5-letters`, `word-lists/6-letters`) and resulting word lists will be stored in that directory.
+
+----
+
+#### Lists of English Words of 5 Letters (useful to solve Wordle)
+
+🟡 `word-lists/5-letters/word-list.txt`
+
+A list of five-letter words, generated from the original word list.
+
+🟡 `word-lists/5-letters/word-list-uniq-letters.txt`
+
+A list of five-letter words consisting of five different letters, generated from the original word list.
+
+🟡 `word-lists/5-letters/word-list-basic.txt`
+
+A list of five-letter words, generated from the basic word list.
+
+🟡 `word-lists/5-letters/word-list-basic-uniq-letters.txt`
+
+A list of five-letter words consisting of five different letters, generated from the basic word list.
+
+----
+
+#### Original/Basic Lists of English Words
+
+⚪️ `word-lists/word-list-original.txt`
+
+A large word list based on `words_alpha.txt` in [dwyl/english-words](https://github.com/dwyl/english-words), containing more than 370,000 items.
+
+⚪️ `word-lists/word-list-basic.txt`
+
+A smaller word list containing about 13,000 basic English words.
+
+----
+
+### Author
+
+Yoichiro HASEBE
+
+----
+
+### License
+
+MIT

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/ruby-wordle

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.join( File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH << File.join( File.dirname(__FILE__), '..', 'lib', 'ruby-wordle')
+
+require 'version'
+require 'script-play'
+require 'script-solver'
+
+if ARGV[0] == "-v" || ARGV[0] == "--version"
+  puts "Ruby Wordle #{RubyWordle::VERSION}"
+  exit
+elsif ARGV[0] == "play" || ARGV[0] == "play" || ARGV[0] == "p"
+  RubyWordlePlay::play_wordle
+elsif ARGV[0] == "solver" || ARGV[0] == "solve" || ARGV[0] == "s"
+  RubyWordleSolver::run_interactively
+else
+  puts "Ruby Wordle #{RubyWordle::VERSION}"; puts
+  puts "Usage: ruby-wordle (play|solve)"
+  puts; puts "See https://github.com/yohasebe/ruby-wordle"
+  exit
+end
+
+

data/lib/ruby-wordle/script-filter.rb

@@ -0,0 +1,48 @@
+#! /usr/bin/env ruby
+
+NUM_LETTERS = 5
+
+HOME_DIR = File.expand_path(File.join(File.dirname(__FILE__), "..", ".."))
+
+original_word_list = File.readlines("#{HOME_DIR}/word-lists/word-list-original.txt")
+basic_word_list = File.readlines("#{HOME_DIR}/word-lists/word-list-basic.txt")
+n_letter_dir = "#{HOME_DIR}/word-lists/#{NUM_LETTERS}-letters"
+
+unless Dir.exist? n_letter_dir
+  Dir.mkdir File.expand_path(n_letter_dir)
+end
+
+n_letter_word_file = File.new(File.join(n_letter_dir, "word-list.txt"), "w")
+uniq_n_letter_word_file = File.new(File.join(n_letter_dir, "word-list-uniq-letters.txt"), "w")
+basic_n_letter_word_file = File.new(File.join(n_letter_dir, "word-list-basic.txt"), "w")
+uniq_basic_n_letter_word_file = File.new(File.join(n_letter_dir, "word-list-basic-uniq-letters.txt"), "w")
+
+original_word_list.sort!.uniq!
+original_word_list.each do |line|
+  chars = line.strip.split(//)
+  if chars.size == NUM_LETTERS
+    line.downcase!
+    n_letter_word_file.write line
+    if chars.uniq.size == chars.size
+      uniq_n_letter_word_file.write line
+    end
+  end
+end
+
+basic_word_list.sort!.uniq!
+basic_word_list.each do |line|
+  chars = line.strip.split(//)
+  if chars.size == NUM_LETTERS
+    line.downcase!
+    basic_n_letter_word_file.write line
+    if chars.uniq.size == chars.size
+      uniq_basic_n_letter_word_file.write line
+    end
+  end
+end
+
+n_letter_word_file.close
+uniq_n_letter_word_file.close
+basic_n_letter_word_file.close
+uniq_basic_n_letter_word_file.close
+

data/lib/ruby-wordle/script-play.rb

@@ -0,0 +1,124 @@
+#! /usr/bin/env ruby
+
+require "readline"
+require "script-solver"
+
+module RubyWordlePlay
+  NUM_LETTERS = 5
+  NUM_ATTEMPTS = 6
+
+  LPAD = " " * 1
+  PROMPT = "〉".bold.red
+
+  @word_list_basic = File.readlines("#{HOME_DIR}/word-lists/#{NUM_LETTERS}-letters/word-list-basic.txt").map(&:strip)
+  @word_list_original = File.readlines("#{HOME_DIR}/word-lists/#{NUM_LETTERS}-letters/word-list.txt").map(&:strip)
+  @word = @word_list_basic.sample
+  @not_used = []
+  @not_used_here = {1 => [], 2 => [], 3 => [], 4 => [], 5 => []}
+  @letters_known = ".....".split(//)
+
+  def self.check_dict(attempt)
+    @word_list_original.include?(attempt)
+  end
+
+  def self.evaluate(attempt)
+    puts
+    @letters_known = attempt.split(//)
+    correct = []
+    wrong   = []
+    @word.split(//).each_with_index do |l, i|
+      if attempt[i] == l
+        correct << i
+      else
+        wrong << i
+        @letters_known[i] = '.'
+      end
+    end
+    attempt.split(//).each_with_index do |l, i|
+      if correct.include?(i)
+        print " #{@word[i]} ".upcase.bg_green
+      else
+        elsewhere = wrong.map{|i|@word[i]}.index(l)
+        if elsewhere
+          print " #{l} ".upcase.bg_brown
+          @not_used_here[i + 1] << l unless @not_used_here[i + 1].include? l
+        else
+          print "   ".bg_gray
+          @not_used << attempt[i] if /[a-z]/ =~ attempt[i]
+          @not_used.uniq!
+          @not_used.sort!
+        end
+      end
+    end
+    puts
+    correct.size == NUM_LETTERS
+  end
+
+  def self.get_help
+    letters_used = []
+    @not_used_here.each do |k, v|
+      v.each do |r|
+        letters_used << [k - 1, r]
+      end
+    end
+    RubyWordleSolver.solve_wordle(@letters_known.join, letters_used, @not_used, :basic, @word)
+  end
+
+  def self.ask_for_attempt(str)
+    puts
+    print  " #{str} ".bold.bg_cyan + " "
+    attempt = Readline.readline(LPAD + PROMPT, true).strip.downcase
+    if attempt == "quit" || attempt == "q"
+      exit
+    elsif attempt == "help" || attempt == "h" || attempt == "?"
+      get_help
+      attempt = ask_for_attempt(str)
+    end
+
+    unless /\A[a-z]{5}\z/ =~ attempt
+      puts
+      puts LPAD + "Sorry,".red + " the input format is not right"
+      puts
+      attempt = ask_for_attempt(str)
+    end
+
+    unless check_dict(attempt)
+      puts
+      puts LPAD + "Sorry,".red + " it's not listed in the dictionary"
+      puts
+      attempt = ask_for_attempt(str)
+    end
+    attempt
+  end
+
+  def self.draw_decorated_border
+    puts
+    puts (' '.bg_green * 5 + ' '.bg_gray * 3 + ' '.bg_brown  * 5 + ' '.bg_gray * 3) * 4
+    puts
+  end
+
+  def play_wordle
+    draw_decorated_border;
+    puts "Input a word of 5 letters and press \"↵\"".cyan.bold
+    puts "Type \"?↵\" for help, \"quit↵\" to exit".gray
+
+    NUM_ATTEMPTS.times do |i|
+      attempt = ask_for_attempt("#{i + 1}/#{NUM_ATTEMPTS}")
+      result = evaluate(attempt)
+      puts
+      if result
+        puts "C O R R E C T !".upcase.bg_magenta
+        exit
+      elsif i + 1 == NUM_ATTEMPTS
+        puts " ANSWER: #{@word} ".upcase.bg_red
+        exit
+      else
+        puts @not_used.uniq.map{|l| " #{l.upcase} "}.join.bg_black if !@not_used.empty?
+        puts
+      end
+    end
+    draw_decorated_border
+  end
+
+  module_function :play_wordle
+end

data/lib/ruby-wordle/script-solver.rb

@@ -0,0 +1,179 @@
+#! /usr/bin/env ruby
+
+HOME_DIR = File.expand_path(File.join(File.dirname(__FILE__), "..", ".."))
+
+require "readline"
+require "script-utils"
+
+module RubyWordleSolver
+  NUM_LETTERS = 5
+  MAX_SUGGESTIONS = 128
+
+  LPAD = " " * 7
+  PROMPT = "〉".bold.red
+
+  @word_list = File.readlines("#{HOME_DIR}/word-lists/#{NUM_LETTERS}-letters/word-list.txt").map(&:strip)
+  @word_list_basic = File.readlines("#{HOME_DIR}/word-lists/#{NUM_LETTERS}-letters/word-list-basic.txt").map(&:strip)
+
+  @basic_word_list = {}
+  File.readlines("#{HOME_DIR}/word-lists/#{NUM_LETTERS}-letters/word-list-basic.txt").map(&:strip).each do |b|
+    @basic_word_list[b] = true
+  end
+
+  @basic_word_uniq_list = {}
+  File.readlines("#{HOME_DIR}/word-lists/#{NUM_LETTERS}-letters/word-list-basic-uniq-letters.txt").map(&:strip).each do |b|
+    @basic_word_uniq_list[b] = true
+  end
+
+  @letters_known = nil
+  @letters_used  = nil
+  @letters_not_used = nil
+
+  def self.get_letters_known
+    puts
+    puts  "STEP 1".bold.bg_green + " Input " + "known letters".underline + " using alphabets and dots"
+    puts  LPAD + "Then press \"↵\" (Type \"quit↵\" to exit)"
+    if @letters_known
+      puts LPAD + "Last time: #{@letters_known.bg_green}"
+    else
+      puts LPAD + "Example: #{'s...h'.bg_green}"
+    end
+
+    letters_known = Readline.readline(LPAD + PROMPT, true).strip.downcase
+
+    exit if letters_known == "quit" || letters_known == "q"
+    unless /\A[a-z\.]{5}\z/ =~ letters_known
+      puts LPAD + "Sorry,".red + " the input format is not right"
+      letters_known = get_letters_known
+    end
+    letters_known
+  end
+
+  def self.get_letters_used
+    puts
+    puts "STEP 2".bold.bg_brown + " Input pairs of " + "a position and a letter".underline
+    puts LPAD + "Then press \"↵\" (Type \"quit↵\" to exit)"
+    if @letters_used
+      puts LPAD + "Last time: #{@letters_used.map{|p, l| (p + 1).to_s + l}.join(' ').bg_brown}"
+    else
+      puts LPAD + "Example: #{'1g 2e 5a'.bg_brown}"
+    end
+
+    letters_used = Readline.readline(LPAD + PROMPT, true).strip.downcase
+
+    exit if letters_used == "quit" || letters_used == "q"
+    if letters_used.strip == ""
+      array_letters_used = []
+    elsif /\A(?:[1-5][a-z][\s,]*)+\z/ =~ letters_used
+      array_letters_used = []
+      letters_used.gsub(/\s+/, "").split(//).each_slice(2) do |k, v|
+        array_letters_used << [k.to_i - 1, v]
+      end
+    else
+      puts LPAD + "Sorry,".red + " the input format is not right"
+      array_letters_used = get_letters_used
+    end
+    array_letters_used
+  end
+
+  def self.get_letters_not_used
+    puts
+    puts "STEP 3".bold.bg_gray + " Input " + "letters not used".underline + " in the word"
+    puts LPAD + "Then press \"↵\" (Type \"quit↵\" to exit)"
+    if @letters_not_used
+      puts LPAD + "Last time: #{@letters_not_used.join.bg_gray}"
+    else
+      puts LPAD + "Example: #{'ieagh'.bg_gray}"
+    end
+
+    letters_not_used = Readline.readline(LPAD + PROMPT, true).strip.downcase
+
+    exit if letters_not_used == "quit" || letters_not_used == "q"
+    if letters_not_used.strip == ""
+      array_letters_not_used = []
+    elsif /\A[a-z\s]+\z/ =~ letters_not_used
+      array_letters_not_used = letters_not_used.split(//)
+    else
+      puts LPAD + "Sorry,".red + " the input format is not right"
+      array_letters_not_used = get_letters_not_used
+    end
+    array_letters_not_used
+  end
+
+  def self.draw_decorated_border
+    puts; puts (' '.bg_green * 5 + ' '.bg_gray * 3 + ' '.bg_brown  * 5 + ' '.bg_gray * 3) * 4; puts
+  end
+
+  def solve_wordle(letters_known, letters_used, letters_not_used, mode = :original, answer = nil)
+    word_list = mode == :original ? @word_list : @word_list_basic
+    indices_unknown_letters = (0 ... letters_known.length).find_all { |i| letters_known[i, 1] == '.' }
+
+    word_list_a = word_list.select do |word|
+      Regexp.compile(letters_known) =~ word
+    end
+
+    word_list_b = word_list_a.select do |word|
+      word_letters = word.split(//)
+      letters_in_candidate = word_letters.values_at(*indices_unknown_letters) - letters_used.map{|l| l[1]}
+      cond1 = letters_used.all? do |position, letter|
+        word_letters[position] != letter
+      end
+      cond2 = (letters_used.map{|l| l[1]} - word_letters).empty?
+      cond3 = (letters_in_candidate - letters_not_used).size == letters_in_candidate.size
+      cond1 && cond2 && cond3
+    end
+
+    if answer
+      word_list_b.delete(answer)
+      reduced_list = word_list_b.sample(MAX_SUGGESTIONS - 1)
+      reduced_list << answer
+    else
+      reduced_list = word_list_b.sample(MAX_SUGGESTIONS)
+    end
+
+    results = reduced_list.sort.map do |word|
+      if @basic_word_uniq_list[word]
+        mode == :original ? word.red.bold : word.red
+      elsif @basic_word_list[word]
+        mode == :original ? word.blue.bold : word.blue
+      else
+        word
+      end
+    end
+    puts
+    results.each_with_index do |word, i|
+      if (i + 1) % 8 == 0 || results.size == i + 1
+        print word + "\n"
+      else
+        print word + "   "
+      end
+    end
+    word_list_b
+  end
+
+  def run_interactively
+    draw_decorated_border
+    @letters_known = get_letters_known
+    @letters_used  = get_letters_used
+    @letters_not_used = get_letters_not_used
+    results = solve_wordle(@letters_known, @letters_used, @letters_not_used)
+    draw_decorated_border
+
+    exit if results.size < 2
+
+    puts "  ？  ".bold.bg_magenta + " Press \"↵\" to continue."
+    puts LPAD + "Type \"quit↵\" to exit."
+
+    response = Readline.readline(LPAD + PROMPT, true).strip.downcase
+
+    if response == "quit" || response == "q"
+      exit
+    else
+      run_interactively
+    end
+  end
+
+  module_function :run_interactively
+  module_function :solve_wordle
+end
+

data/lib/ruby-wordle/script-utils.rb

@@ -0,0 +1,23 @@
+class String
+  def black;          "\e[30m#{self}\e[0m" end
+  def red;            "\e[31m#{self}\e[0m" end
+  def green;          "\e[32m#{self}\e[0m" end
+  def brown;          "\e[33m#{self}\e[0m" end
+  def blue;           "\e[34m#{self}\e[0m" end
+  def magenta;        "\e[35m#{self}\e[0m" end
+  def cyan;           "\e[36m#{self}\e[0m" end
+  def gray;           "\e[37m#{self}\e[0m" end
+  def bg_black;       "\e[40m#{self}\e[0m" end
+  def bg_red;         "\e[41m#{self}\e[0m" end
+  def bg_green;       "\e[42m#{self}\e[0m" end
+  def bg_brown;       "\e[43m#{self}\e[0m" end
+  def bg_blue;        "\e[44m#{self}\e[0m" end
+  def bg_magenta;     "\e[45m#{self}\e[0m" end
+  def bg_cyan;        "\e[46m#{self}\e[0m" end
+  def bg_gray;        "\e[47m#{self}\e[0m" end
+  def bold;           "\e[1m#{self}\e[22m" end
+  def italic;         "\e[3m#{self}\e[23m" end
+  def underline;      "\e[4m#{self}\e[24m" end
+  def blink;          "\e[5m#{self}\e[25m" end
+  def reverse_color;  "\e[7m#{self}\e[27m" end
+end

data/lib/ruby-wordle/version.rb

@@ -0,0 +1,3 @@
+module RubyWordle
+  VERSION = "0.9.2"
+end

data/ruby-wordle.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require "ruby-wordle/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ruby-wordle"
+  s.version     = RubyWordle::VERSION
+  s.authors     = ["Yoichiro Hasebe"]
+  s.email       = ["yohasebe@gmail.com"]
+  s.homepage    = "http://github.com/yohasebe/ruby-wordle"
+  s.summary     = %q{A set of ruby scripts to generate word-lists, solve Wordle, and play Wordle}
+  s.description = %q{A set of ruby scripts to generate word-lists, solve Wordle, and play Wordle}
+  s.licenses    = ["MIT"]
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_runtime_dependency 'readline'
+end