wordle 0.4.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a6fde063384b381fd26d3bf8dd318e23ed68a76f2389bfe9ae5a25f6868106a
-  data.tar.gz: dc16f5b1a5ad0e9e4d40f7cbb7bcb29fe9224ed9e39cd715e4fe42199cc6bd81
+  metadata.gz: 5fa86fa80e845caca00f5128d21a4c569996441d57b9367862a1a634067052d3
+  data.tar.gz: a3965aea2dba04cf9abfd4a8bc1e1760980630200f576d60bf7b14319aace3a3
 SHA512:
-  metadata.gz: 63745922fe29a07bb57f3313328c5afb1ce1190cafec5b1d91a129075eaa7ee69de4799df60800711d76df2aeb364e5b7b46f94749ac6b1b72f8891c0e37aa8c
-  data.tar.gz: 78b0c4fd62495d09a623815f8aa6410c65db0ac6d63ac8bfc8851d8932afffd2b87883716daa93c95b7482c56a2e3ec86cf5f4b9d39f68ecb5b206bd67380dbb
+  metadata.gz: 9f1772bbf2e003583cf25ee27af46f2911ff584dfa4c4e2533aafeaa411ba877db690d4f4789242a50e9c54a070beea66e3db966ed4aa0a84075b431977be10c
+  data.tar.gz: 87f7b5e53311ee0e15f1cacf56f2eaae014ea1a78ce0363f590ee9a4c273b4717bf13f748864dbe67ab567d0862c881fe69f62b2adec8a1c579921b451d9aa74

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.1.1

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [0.7.0] - 2022-04-15
+
+- Adds high color contrast mode.
+
+## [0.6.0] - 2022-04-14
+
+- Adds hard mode.
+
+## [0.5.0] - 2022-02-02
+
+- Prints outs squares for sharing at the end of a game.
+- Sharing prints out unique hash for word that was played, which can be passed
+to -i option so you can play the same word as a friend.
+
 ## [0.4.0] - 2022-01-14
 
 - Fixes bug where too many letters would get marked as yellow. Resolves

data/Gemfile

@@ -5,8 +5,8 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in wordle.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+gem "rake"
 
-gem "rspec", "~> 3.0"
+gem "rspec"
 
-gem "standard", "~> 1.3"
+gem "standard"

data/Gemfile.lock

@@ -1,71 +1,70 @@
 PATH
   remote: .
   specs:
-    wordle (0.4.0)
+    wordle (0.7.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    debug (1.4.0)
+    debug (1.5.0)
       irb (>= 1.3.6)
       reline (>= 0.2.7)
     diff-lcs (1.5.0)
     io-console (0.5.11)
     irb (1.4.1)
       reline (>= 0.3.0)
-    parallel (1.21.0)
-    parser (3.1.0.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.0)
+    regexp_parser (2.3.0)
     reline (0.3.1)
       io-console (~> 0.5)
     rexml (3.2.5)
-    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)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    rubocop (1.24.1)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.27.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.15.1, < 2.0)
+      rubocop-ast (>= 1.16.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.15.1)
-      parser (>= 3.0.1.1)
-    rubocop-performance (1.13.1)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.3)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
-    standard (1.6.0)
-      rubocop (= 1.24.1)
-      rubocop-performance (= 1.13.1)
+    standard (1.10.0)
+      rubocop (= 1.27.0)
+      rubocop-performance (= 1.13.3)
     unicode-display_width (2.1.0)
 
 PLATFORMS
   x86_64-darwin-21
-  x86_64-linux
 
 DEPENDENCIES
   debug (>= 1.0.0)
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  standard (~> 1.3)
+  rake
+  rspec
+  standard
   wordle!
 
 BUNDLED WITH
-   2.3.4
+   2.3.7

data/README.md

@@ -2,7 +2,9 @@
 
 Ruby implementation of [Wordle](https://www.powerlanguage.co.uk/wordle/).
 
-<img width="794" alt="Screen Shot 2022-01-10 at 9 18 19 PM" src="https://user-images.githubusercontent.com/22665228/148885575-39805830-274e-40e6-be14-4c6bc6db37ec.png">
+<img width="869" alt="Screen Shot 2022-02-02 at 10 32 02 PM" src="https://user-images.githubusercontent.com/22665228/152292863-33743039-d9f4-4afa-a321-684d7b67cdb3.png">
+
+[![Build](https://github.com/JonathanWThom/wordle/actions/workflows/build.yml/badge.svg)](https://github.com/JonathanWThom/wordle/actions/workflows/build.yml)
 
 ## Installation
 
@@ -12,6 +14,15 @@ Ruby implementation of [Wordle](https://www.powerlanguage.co.uk/wordle/).
 
 Just run `wordle` from the command line.
 
+This version will pull a new word at random every time you run it from a very weird and long list. It's much more difficult than the original due to some of the words being a bit uncommon.
+
+```
+Usage: wordle [options]
+    -i, --identifier=IDENTIFIER      Pass word identifer to target a specific word that someone else has played. Identifier gets printed at the end of the game to share with a friend.
+    -d, --difficult                  Hard mode. Any revealed hints must be used in subsequent guesses.
+    -c, --contrast                   High contrast mode. Matched letters will be orange. Included letters will be blue.
+```
+
 ## 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.
@@ -24,7 +35,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/Jonath
 
 ## Acknowledgements
 
-I cribbed my word list from the Wordle site itself. I have no association with the site or its creator, I'm just a fan!
+I cribbed my word list from the Wordle site itself. I have no association with the site, its creator, or the New York Times - I'm just a fan!
 
 ## License
 

data/lib/integer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class Integer
+  def ordinalize
+    {
+      1 => "1st",
+      2 => "2nd",
+      3 => "3rd",
+      4 => "4th",
+      5 => "5th"
+    }[self]
+  end
+end

data/lib/string.rb

@@ -14,4 +14,12 @@ class String
   def gray
     colorize(47)
   end
+
+  def blue
+    colorize(46)
+  end
+
+  def orange
+    "\033[48:2:255:165:0m#{self}\033[m"
+  end
 end

data/lib/wordle/game.rb

@@ -2,57 +2,78 @@
 
 module Wordle
   class Game
-    def self.play
-      new.play
+    def self.play(*args)
+      new(*args).play
     end
 
-    def initialize
+    def initialize(options_reader = Options.new)
       @list = List.new
+      @options = options_reader.read
       @target_word = generate_word
+      @result_builder = ResultBuilder.new(@options[:contrast])
     end
 
-    # print letters that have already been used?
-    # compare to real words
-
     def play
       winner = false
-      attempts = 0
 
-      Legend.print
+      Legend.print(@result_builder)
       puts "Guess a 5 letter word: "
+      guesses = []
+      must_include = []
+      must_match = Array.new(5)
 
-      while attempts < 6 && !winner
+      while guesses.length < 6 && !winner
         guess = gets.chomp
 
-        validator = GuessValidator.new(guess, @list)
+        validator = GuessValidator.new(
+          guess,
+          @list,
+          @options[:difficult],
+          must_include,
+          must_match
+        )
         if validator.invalid?
           puts validator.error
           next
         end
 
-        analyzer = GuessAnalyzer.new(@target_word, guess)
+        analyzer = GuessAnalyzer.new(
+          @target_word,
+          guess,
+          @result_builder
+        )
         puts analyzer.colors
+        guesses << analyzer.squares
+        if @options[:difficult]
+          must_include = analyzer.must_include(must_include)
+          must_match = analyzer.must_match(must_match)
+        end
 
         if analyzer.match?
           winner = true
           break
         end
-
-        attempts += 1
       end
 
+      hash = Digest::SHA2.hexdigest(@target_word)[..5]
       if winner
-        puts "Winner!"
+        puts "\nWordle Gem #{hash} #{guesses.length}/6\n\n"
       else
-        puts "Word was: #{@target_word}"
-        puts "Better luck next time!"
+        puts "\nWord was: #{@target_word}\n"
+        puts "\nWordle Gem #{hash} X/6*\n\n"
       end
+
+      puts guesses
     end
 
     private
 
     def generate_word
-      @list.random
+      if @options[:identifier]
+        @list.by_hash(@options[:identifier])
+      else
+        @list.random
+      end
     end
   end
 end

data/lib/wordle/guess_analyzer.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
-require_relative "../string"
-
 module Wordle
   class GuessAnalyzer
-    def initialize(target_word, guess)
+    def initialize(target_word, guess, result_builder = ResultBuilder.new)
       @target_word = target_word
       @guess = guess
+      @result_builder = result_builder
     end
 
     def match?
@@ -14,28 +13,67 @@ module Wordle
     end
 
     def colors
-      target_letters = @target_word.chars
-      guess_letters = @guess.chars
-      colored_letters = []
-
-      guess_letters.each_with_index do |letter, i|
-        if letter == target_letters[i]
-          colored_letters[i] = letter.green
-          target_letters[i] = nil
+      raw_results.each_with_index.map do |result, i|
+        guess_letters[i].send(@result_builder.text_color(result))
+      end.join("")
+    end
+
+    def squares
+      raw_results.each_with_index.map do |result, i|
+        @result_builder.square(result)
+      end.join("")
+    end
+
+    def must_include(prev_must_include)
+      raw_results.each_with_index do |result, i|
+        if @result_builder.included?(result) && !prev_must_include.include?(guess_letters[i])
+          prev_must_include << guess_letters[i]
         end
       end
 
-      guess_letters.each_with_index do |letter, i|
-        if colored_letters[i].nil?
-          colored_letters[i] = if target_letters.include?(letter)
-            letter.yellow
-          else
-            letter.gray
-          end
+      prev_must_include
+    end
+
+    def must_match(prev_must_match)
+      raw_results.each_with_index do |result, i|
+        if @result_builder.match?(result)
+          prev_must_match[i] = guess_letters[i]
         end
       end
 
-      colored_letters.join("")
+      prev_must_match
+    end
+
+    private
+
+    def guess_letters
+      @_guess_letters ||= @guess.chars
+    end
+
+    def raw_results
+      @_raw_results ||= begin
+        target_letters = @target_word.chars
+        results = []
+
+        guess_letters.each_with_index do |letter, i|
+          if letter == target_letters[i]
+            results[i] = @result_builder.match
+            target_letters[i] = nil
+          end
+        end
+
+        guess_letters.each_with_index do |letter, i|
+          if results[i].nil?
+            results[i] = if target_letters.include?(letter)
+              @result_builder.included
+            else
+              @result_builder.miss
+            end
+          end
+        end
+
+        results
+      end
     end
   end
 end

data/lib/wordle/guess_validator.rb

@@ -2,23 +2,62 @@
 
 module Wordle
   class GuessValidator
-    attr_reader :error
-
-    def initialize(guess, list)
+    def initialize(
+      guess,
+      list,
+      difficult,
+      must_include,
+      must_match
+    )
       @guess = guess
       @list = list
+      @difficult = difficult
+      @must_include = must_include
+      @must_match = must_match
+      @validated = false
     end
 
     def invalid?
+      !error.nil?
+    end
+
+    def error
+      validate if !@validated
+
+      @error
+    end
+
+    private
+
+    def validate
+      validate_normal_mode
+      validate_hard_mode if @difficult
+      @validated = true
+    end
+
+    def validate_normal_mode
       if @guess.length != 5
         @error = "Guess must be 5 letters long"
-        return true
       elsif @list.invalid?(@guess)
-        @error = "Guess must be a real word"
-        return true
+        @error = "Guess not in word list"
+      end
+    end
+
+    def validate_hard_mode
+      @must_include.each do |letter|
+        if !@guess.include?(letter)
+          @error = "Guess must include #{letter}"
+          break
+        end
       end
 
-      false
+      @guess.each_char.with_index do |letter, i|
+        match = @must_match[i]
+        if match && match != letter
+          @error = "#{(i + 1).ordinalize} letter must be #{match}"
+          break
+        end
+      end
     end
   end
 end

data/lib/wordle/legend.rb

@@ -2,27 +2,41 @@
 
 module Wordle
   class Legend
-    def self.print
-      new.print
+    def self.print(*args)
+      new(*args).print
+    end
+
+    def initialize(result_builder = ResultBuilder.new)
+      @result_builder = result_builder
     end
 
     def print
-      puts green_example
-      puts yellow_example
-      puts gray_example
+      puts match_example
+      puts included_example
+      puts miss_example
+      puts "\nRestart and add -i flag to target a specific word by hash, for example:"
+      puts "$ wordle -i ed541a\n\n"
     end
 
     private
 
-    def green_example
-      "#{"w".green}eary - The letter w is in the word and in the correct spot."
+    def match_color
+      @result_builder.match_text_color
+    end
+
+    def included_color
+      @result_builder.included_text_color
+    end
+
+    def match_example
+      "#{"w".send(match_color)}eary - The letter w is in the word and in the correct spot."
     end
 
-    def yellow_example
-      "p#{"i".yellow}lls - The letter i is in the word but in the wrong spot."
+    def included_example
+      "p#{"i".send(included_color)}lls - The letter i is in the word but in the wrong spot."
     end
 
-    def gray_example
+    def miss_example
       "vag#{"u".gray}e - The letter u is not in the word in any spot."
     end
   end

data/lib/wordle/list.rb

@@ -2,14 +2,20 @@
 
 module Wordle
   class List
-    def initialize(length = 5)
-      @length = length
-    end
-
     def random
       list.sample.downcase.strip
     end
 
+    def by_hash(hash)
+      word = list.detect do |word|
+        Digest::SHA2.hexdigest(word.downcase.strip)[..5] == hash
+      end
+
+      raise Wordle::Error, "Invalid word identifier, are you sure you copied it correctly?" if word.nil?
+
+      word
+    end
+
     def invalid?(word)
       !list.include?(word)
     end

data/lib/wordle/options.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Wordle
+  class Options
+    def read
+      options = {}
+
+      parser = OptionParser.new do |opts|
+        opts.banner = "Usage: wordle [options]"
+
+        opts.on("-iIDENTIFIER", "--identifier=IDENTIFIER", "Pass word identifer to target a specific word that someone else has played. Identifier gets printed at the end of the game to share with a friend.") do |i|
+          options[:identifier] = i
+        end
+
+        opts.on("-d", "--difficult", "Hard mode. Any revealed hints must be used in subsequent guesses.") do |d|
+          options[:difficult] = d
+        end
+
+        opts.on("-c", "--contrast", "High contrast mode. Matched letters will be orange. Included letters will be blue.") do |c|
+          options[:contrast] = c
+        end
+      end
+
+      begin
+        parser.parse!
+      rescue OptionParser::InvalidOption
+        puts "Option not recognized"
+      end
+
+      options
+    end
+  end
+end

data/lib/wordle/result_builder.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Wordle
+  class ResultBuilder
+    MATCH = :match
+    INCLUDED = :included
+    MISS = :miss
+
+    DEFAULT_OPTIONS = {
+      MATCH => {text: :green, square: "🟩"},
+      INCLUDED => {text: :yellow, square: "🟨"},
+      MISS => {text: :gray, square: "⬛️"}
+    }.freeze
+
+    CONTRAST_OPTIONS = {
+      MATCH => {text: :orange, square: "🟧"},
+      INCLUDED => {text: :blue, square: "🟦"},
+      MISS => {text: :gray, square: "⬛️"}
+    }.freeze
+
+    def initialize(contrast = false)
+      @contrast = contrast
+    end
+
+    def match?(result)
+      result == MATCH
+    end
+
+    def included?(result)
+      result == INCLUDED
+    end
+
+    def match
+      MATCH
+    end
+
+    def included
+      INCLUDED
+    end
+
+    def miss
+      MISS
+    end
+
+    def match_text_color
+      options[match][:text]
+    end
+
+    def included_text_color
+      options[included][:text]
+    end
+
+    def text_color(result)
+      options[result][:text]
+    end
+
+    def square(result)
+      options[result][:square]
+    end
+
+    private
+
+    def options
+      return DEFAULT_OPTIONS if !@contrast
+      @_options ||= CONTRAST_OPTIONS
+    end
+  end
+end

data/lib/wordle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Wordle
-  VERSION = "0.4.0"
+  VERSION = "0.7.0"
 end

data/lib/wordle.rb

@@ -1,13 +1,18 @@
 # frozen_string_literal: true
 
+require "digest"
+require "optparse"
+require_relative "integer"
 require_relative "string"
-require_relative "wordle/version"
-require_relative "wordle/source"
-require_relative "wordle/list"
-require_relative "wordle/guess_validator"
+require_relative "wordle/game"
 require_relative "wordle/guess_analyzer"
+require_relative "wordle/guess_validator"
 require_relative "wordle/legend"
-require_relative "wordle/game"
+require_relative "wordle/list"
+require_relative "wordle/options"
+require_relative "wordle/result_builder"
+require_relative "wordle/source"
+require_relative "wordle/version"
 
 module Wordle
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wordle
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Jonathan Thom
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-15 00:00:00.000000000 Z
+date: 2022-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debug
@@ -34,6 +34,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".standard.yml"
+- ".tool-versions"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -44,6 +45,7 @@ files:
 - bin/console
 - bin/setup
 - exe/wordle
+- lib/integer.rb
 - lib/string.rb
 - lib/wordle.rb
 - lib/wordle/game.rb
@@ -51,6 +53,8 @@ files:
 - lib/wordle/guess_validator.rb
 - lib/wordle/legend.rb
 - lib/wordle/list.rb
+- lib/wordle/options.rb
+- lib/wordle/result_builder.rb
 - lib/wordle/source.rb
 - lib/wordle/version.rb
 - wordle.gemspec
@@ -77,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Wordle CLI in Ruby