wordl-solver 1.4.0 → 2.0.0

data/lib/wordl_solver.rb

@@ -1,64 +1,38 @@
 # frozen_string_literal: true
 
-require "csv"
-require "fileutils"
-
-FILE_PATH = File.join(File.dirname(__FILE__), "5_words.csv")
-
-LETTER_WORDS = []
-
-CSV.foreach(FILE_PATH) do |row|
-  LETTER_WORDS << row[0]
-end
-
-# The Class WordlSolver is a class that contains the methods to solve the wordl puzzle.
-class WordlSolver
-  class << self
-    def find_possible_words(greys, greens, yellows)
-      @greys = greys
-      @greens = greens 
-      @yellows = yellows
-      @possible_words = @possible_words.nil? || @possible_words.empty? ? LETTER_WORDS : @possible_words
-      filter_greens
-      filter_yellows
-      filter_greys
-      @possible_words
+require_relative "wordl_solver/version"
+require_relative "wordl_solver/feedback"
+
+module WordlSolver
+  # Compute Wordle feedback for a guess against a secret.
+  # Returns an Array of 5 Symbols drawn from :green / :yellow / :grey.
+  # Two-pass algorithm so duplicate letters are scored correctly.
+  def self.score(guess, secret)
+    raise ArgumentError, "guess must be a 5-char String" unless guess.is_a?(String) && guess.length == 5
+    raise ArgumentError, "secret must be a 5-char String" unless secret.is_a?(String) && secret.length == 5
+
+    colors = Array.new(5, :grey)
+    pool = secret.chars.tally
+
+    # Pass 1: greens.
+    5.times do |i|
+      next unless guess[i] == secret[i]
+
+      colors[i] = :green
+      pool[guess[i]] -= 1
     end
 
-    def filter_greens
-      @possible_words.select! do |word|
-        put_in = true
-        @greens.each do |key, value|
-          next if value.nil?
+    # Pass 2: yellows / greys.
+    5.times do |i|
+      next if colors[i] == :green
 
-          put_in = false unless word[key] == value
-        end
-        put_in
+      letter = guess[i]
+      if pool.fetch(letter, 0) > 0
+        colors[i] = :yellow
+        pool[letter] -= 1
       end
     end
 
-    def filter_yellows
-      yellow_letters = @yellows.values.flatten.uniq
-      @possible_words.select! do |word|
-        possible = true
-        word.chars.each_with_index do |letter, index|
-          possible = false if @yellows[index].include?(letter)
-        end
-        possible = false unless yellow_letters.all? { |letter| word.include?(letter) }
-        possible
-      end
-    end
-
-    def filter_greys
-      @possible_words.reject! do |word|
-        @greys.each do |letter|
-          if @greens.values.include?(letter)
-            word.count(letter) > 1
-          else
-            word.include?(letter)
-          end
-        end
-      end
-    end
+    Feedback.new(colors)
   end
 end

metadata

@@ -1,114 +1,84 @@
 --- !ruby/object:Gem::Specification
 name: wordl-solver
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.0
 platform: ruby
 authors:
 - george kosmopoulos
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: shoulda
-  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: rdoc
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '5.20'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '5.20'
 - !ruby/object:Gem::Dependency
-  name: juwelier
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  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: This gem helps you solve wordl puzzles. It does so by asking you for
-  the letters position you know, the letters you know exists and the ones you know
-  don't exists. It then proposes words depending on how good they are by weighting
-  the letters by their frequency in the english language.
+        version: '13.0'
+description: Solves Wordle puzzles by ranking next guesses by expected information
+  gain (Shannon entropy of the feedback-pattern distribution). Ships with the real
+  Wordle word lists and a single-line interactive CLI.
 email: gkosmo1@hotmail.com
 executables:
 - wordl-solver
 extensions: []
-extra_rdoc_files:
-- LICENSE.txt
-- README.rdoc
+extra_rdoc_files: []
 files:
-- ".document"
-- Gemfile
-- Gemfile.lock
+- CHANGELOG.md
 - LICENSE.txt
-- README.rdoc
-- Rakefile
-- VERSION
+- README.md
 - bin/wordl-solver
-- lib/5_words.csv
+- lib/data/allowed_guesses.txt
+- lib/data/answers.txt
+- lib/data/opening_scores.json
 - lib/wordl_solver.rb
-- lib/wordl_solver_interface.rb
-- wordl-solver.gemspec
+- lib/wordl_solver/cli.rb
+- lib/wordl_solver/feedback.rb
+- lib/wordl_solver/filter.rb
+- lib/wordl_solver/game_state.rb
+- lib/wordl_solver/scorer.rb
+- lib/wordl_solver/version.rb
+- lib/wordl_solver/word_lists.rb
 homepage: http://github.com/gkosmo/wordl-solver
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -116,15 +86,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
-summary: This gem solves wordl puzzles.
+summary: Entropy-based Wordle solver gem.
 test_files: []

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt

data/Gemfile

@@ -1,14 +0,0 @@
-source "https://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
-
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "shoulda", ">= 0"
-  gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.0"
-  gem "juwelier", "~> 2.1.0"
-  gem "simplecov", ">= 0"
-end

data/Gemfile.lock

@@ -1,113 +0,0 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (7.0.2.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    builder (3.2.4)
-    concurrent-ruby (1.1.10)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
-    docile (1.4.0)
-    faraday (1.10.0)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0)
-      faraday-multipart (~> 1.0)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.0)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      faraday-retry (~> 1.0)
-      ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.3)
-      multipart-post (>= 1.2, < 3)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    faraday-retry (1.0.3)
-    git (1.10.2)
-      rchardet (~> 1.8)
-    github_api (0.19.0)
-      addressable (~> 2.4)
-      descendants_tracker (~> 0.0.4)
-      faraday (>= 0.8, < 2)
-      hashie (~> 3.5, >= 3.5.2)
-      oauth2 (~> 1.0)
-    hashie (3.6.0)
-    highline (2.0.3)
-    i18n (1.10.0)
-      concurrent-ruby (~> 1.0)
-    json (1.8.6)
-    juwelier (2.1.3)
-      builder
-      bundler (>= 1.13)
-      git (>= 1.2.5)
-      github_api
-      highline (>= 1.6.15)
-      nokogiri (>= 1.5.10)
-      rake
-      rdoc
-      semver
-    jwt (2.3.0)
-    mini_portile2 (2.8.0)
-    minitest (5.15.0)
-    multi_json (1.15.0)
-    multi_xml (0.6.0)
-    multipart-post (2.1.1)
-    nokogiri (1.13.3)
-      mini_portile2 (~> 2.8.0)
-      racc (~> 1.4)
-    oauth2 (1.4.9)
-      faraday (>= 0.17.3, < 3.0)
-      jwt (>= 1.0, < 3.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (>= 1.2, < 3)
-    public_suffix (4.0.6)
-    racc (1.6.0)
-    rack (2.2.3)
-    rake (13.0.6)
-    rchardet (1.8.0)
-    rdoc (3.12.2)
-      json (~> 1.4)
-    ruby2_keywords (0.0.5)
-    semver (1.0.1)
-    shoulda (4.0.0)
-      shoulda-context (~> 2.0)
-      shoulda-matchers (~> 4.0)
-    shoulda-context (2.0.0)
-    shoulda-matchers (4.5.1)
-      activesupport (>= 4.2.0)
-    simplecov (0.21.2)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.4)
-    thread_safe (0.3.6)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.0)
-  juwelier (~> 2.1.0)
-  rdoc (~> 3.12)
-  shoulda
-  simplecov
-
-BUNDLED WITH
-   1.17.3

data/README.rdoc

@@ -1,28 +0,0 @@
-= wordl-solver
-
-Description goes here.
-
-This is a tool I've built to help me solve wordle. 
-It does so by providing all the 5 letter words, ordering them by the frequency of the letters and filter them depending on the the colours. 
- 
-
-** Still To DO
-
-- have the logic for when a letter appear twice or not
-- allow to correct the inputs
-- clean the code a bit more 
-
-== Contributing to wordl-solver
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2022 george kosmopoulos. See LICENSE.txt for
-further details.

data/Rakefile

@@ -1,49 +0,0 @@
-require "rubygems"
-require "bundler"
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  warn e.message
-  warn "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require "rake"
-require "juwelier"
-Juwelier::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
-  gem.name = "wordl-solver"
-  gem.homepage = "http://github.com/gkosmo/wordl-solver"
-  gem.license = "MIT"
-  gem.summary = "This gem solves wordl puzzles."
-  gem.description = "This gem helps you solve wordl puzzles. It does so by asking you for the letters position you know, the letters you know exists and the ones you know don't exists. It then proposes words depending on how good they are by weighting the letters by their frequency in the english language."
-  gem.email = "gkosmo1@hotmail.com"
-  gem.authors = ["george kosmopoulos"]
-  gem.files.include "lib/*"
-  # dependencies defined in Gemfile
-  gem.executables = ["wordl-solver"]
-end
-Juwelier::RubygemsDotOrgTasks.new
-require "rake/testtask"
-Rake::TestTask.new(:test) do |test|
-  test.libs << "lib" << "test"
-  test.pattern = "test/**/test_*.rb"
-  test.verbose = true
-end
-
-desc "Code coverage detail"
-task :simplecov do
-  ENV["COVERAGE"] = "true"
-  Rake::Task["test"].execute
-end
-
-task default: :test
-
-require "rdoc/task"
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?("VERSION") ? File.read("VERSION") : ""
-
-  rdoc.rdoc_dir = "rdoc"
-  rdoc.title = "wordl-solver #{version}"
-  rdoc.rdoc_files.include("README*")
-  rdoc.rdoc_files.include("lib/**/*.rb")
-end

data/VERSION

@@ -1 +0,0 @@
-1.4.0