glimmer_wordle 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 18a1772cb458e49ced9e103096f736c307ae5b4e100457ea5e19ba04e4f4d28a
+  data.tar.gz: 9e341e855c03fb9a587f0b537988b60fe8771e9e4d3ba19d38a9678f98bee849
+SHA512:
+  metadata.gz: 370bc2a11daa444256e6dcd7fb43129d3f09fe17fdd0f6db4b972ce2455e1437ad3473682ac54c71cbf208c81f6490a93a6d1978d3b0fe4ede55b6ab7ae39e3d
+  data.tar.gz: 53ee100edcbacaa594ed6adf5b97a8041d44f1a25f281722093c1c9159df445c8bb4deb5b292186dfa5910e22e70665668378a4a514e8a3e587ba92f820cc564

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2022 Andy Maleh
+
+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,74 @@
+# <img src='https://raw.githubusercontent.com/AndyObtiva/glimmer_wordle/master/icons/linux/Glimmer Wordle.png' height=85 /> Wordle
+## Word Game
+[![Gem Version](https://badge.fury.io/rb/glimmer_wordle.svg)](http://badge.fury.io/rb/glimmer_wordle)
+
+[Wordle](https://en.wikipedia.org/wiki/Wordle) word game desktop GUI app written [test-first](https://github.com/AndyObtiva/wordle/blob/master/spec/app/model/five_letter_word_spec.rb) using [Glimmer DSL for SWT](https://github.com/AndyObtiva/glimmer-dsl-swt) (JRuby Desktop Development GUI Framework) as inspiration by [Kevin Newton's blog post](https://kddnewton.com/2022/01/29/solving-wordle-in-ruby.html).
+
+![Wordle Screenshot](screenshots/glimmer-wordle.png)
+
+## Demo
+
+![Wordle Screenshot](screenshots/glimmer-wordle.gif)
+
+## Setup
+
+### Download
+
+[<img src='https://raw.githubusercontent.com/AndyObtiva/glimmer_wordle/master/icons/linux/Glimmer Wordle.png' height=40 /> Download Glimmer Wordle DMG for Mac ARM64 Monterey and Older](https://www.dropbox.com/s/t77si617tsaxe0c/Glimmer%20Wordle-arm64-1.0.0.dmg?dl=1)
+
+[<img src='https://raw.githubusercontent.com/AndyObtiva/glimmer_wordle/master/icons/linux/Glimmer Wordle.png' height=40 /> Download Glimmer Wordle DMG for Mac x86_64 Catalina and Older](https://www.dropbox.com/s/amlrm4nufdlzlb1/Glimmer%20Wordle-1.0.0.dmg?dl=1)
+
+### Install Ruby Gem
+
+If you are a software engineer and would rather install this game as a Ruby gem, please follow these instructions.
+
+First, make sure you have all the [prerequisites of Glimmer DSL for SWT](https://github.com/AndyObtiva/glimmer-dsl-swt#pre-requisites) setup on your machine like Java and JRuby.
+
+Run:
+
+```
+gem install glimmer_wordle
+```
+
+Afterwards, run:
+
+```
+glimmer_wordle
+```
+
+## Contributing
+
+-   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.
+
+## TODO
+
+[TODO.md](TODO.md)
+
+## Change Log
+
+[CHANGELOG.md](CHANGELOG.md)
+
+## Copyright
+
+[MIT](LICENSE.txt)
+
+Copyright (c) 2022 Andy Maleh. See
+[LICENSE.txt](LICENSE.txt) for further details.
+
+--
+
+[<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=40 />](https://github.com/AndyObtiva/glimmer) Built with [Glimmer DSL for SWT](https://github.com/AndyObtiva/glimmer-dsl-swt) (JRuby Desktop Development GUI Framework)
+
+Glimmer Wordle icon made by <a href="https://www.flaticon.com/authors/freepik" title="Freepik">Freepik</a> from <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a>

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/app/wordle/launch.rb

@@ -0,0 +1,3 @@
+require_relative '../wordle'
+
+Wordle::View::AppView.launch

data/app/wordle/model/five_letter_word.rb

@@ -0,0 +1,69 @@
+class Wordle
+  module Model
+    class FiveLetterWord
+      class << self
+        def random_word
+          WORLD_ANSWERS_ALPHABETICAL.sample
+        end
+      end
+      
+      WORLD_ANSWERS_ALPHABETICAL_FILE = File.join(APP_ROOT, 'config', 'wordle-answers-alphabetical.txt')
+      WORLD_ALLOWED_GUESSES_FILE = File.join(APP_ROOT, 'config', 'wordle-allowed-guesses.txt')
+      WORLD_ANSWERS_ALPHABETICAL = File.read(WORLD_ANSWERS_ALPHABETICAL_FILE).lines(chomp: true).sort
+      WORLD_ALLOWED_GUESSES = (WORLD_ANSWERS_ALPHABETICAL + File.read(WORLD_ALLOWED_GUESSES_FILE).lines(chomp: true)).sort
+      COLORS = [:green, :yellow, :gray]
+      STATUSES = [:in_progress, :win, :loss]
+      
+      attr_accessor :guesses, :guess_results, :status, :answer, :colored_alphabets
+      
+      def initialize
+        refresh
+      end
+      
+      def refresh
+        self.guesses = []
+        self.guess_results = []
+        self.status = :in_progress
+        self.answer = self.class.random_word
+        self.colored_alphabets = (97..122).map {|n| n.chr}.reduce({}) {|hash, letter| hash.merge(letter => nil) }
+      end
+      
+      def guess(word_guess)
+        word_guess = word_guess.downcase
+        return [] if status == :win || status == :loss
+        guesses << word_guess
+        guess_results << guess_result_for(word_guess)
+        update_colored_alphabets(word_guess, guess_results.last)
+        self.status = :win if guesses.last == answer
+        self.status = :loss if guesses.last != answer && guesses.count == 6
+        guess_results.last
+      end
+      
+      private
+      
+      def guess_result_for(word_guess)
+        5.times.map do |i|
+          if answer[i] == word_guess[i]
+            :green
+          elsif answer.include?(word_guess[i])
+            :yellow
+          else
+            :gray
+          end
+        end
+      end
+      
+      def update_colored_alphabets(word_guess, guess_result)
+        5.times do |i|
+          if guess_result[i] == :green
+            self.colored_alphabets[word_guess[i]] = :green
+          elsif guess_result[i] == :yellow
+            self.colored_alphabets[word_guess[i]] = :yellow if self.colored_alphabets[word_guess[i]] != :green
+          elsif guess_result[i] == :gray
+            self.colored_alphabets[word_guess[i]] = :gray if self.colored_alphabets[word_guess[i]].nil?
+          end
+        end
+      end
+    end
+  end
+end

data/app/wordle/view/app_view.rb

@@ -0,0 +1,361 @@
+class Wordle
+  module View
+    class AppView
+      include Glimmer::UI::CustomShell
+      
+      COLOR_TO_BACKGROUND_COLOR_MAP = {
+        green:  :dark_green,
+        yellow: :dark_yellow,
+        gray:   :dark_gray,
+      }
+      
+      COLOR_TO_TEXT_COLOR_MAP = {
+        green:  :white,
+        yellow: :white,
+        gray:   :white,
+      }
+      
+      ALPHABET_ROW1 = %w[Q W E R T Y U I O P]
+      ALPHABET_ROW2 = %w[A S D F G H J K L]
+      ALPHABET_ROW3 = %w[Z X C V B N M]
+
+    
+      before_body do
+        @display = display {
+          on_about {
+            display_about_dialog
+          }
+          on_preferences {
+            display_about_dialog
+          }
+          on_swt_keydown do |key_event|
+            if key_event.keyCode == 8
+              do_backspace
+            elsif key_event.keyCode == swt(:cr)
+              if @five_letter_word.status == :in_progress
+                do_guess
+              else
+                do_restart
+              end
+            elsif valid_character?((key_event.keyCode.chr rescue ''))
+              do_type(key_event.keyCode.chr)
+            end
+          end
+        }
+        @five_letter_word = Model::FiveLetterWord.new
+      end
+  
+      ## Add widget content inside custom shell body
+      ## Top-most widget must be a shell or another custom shell
+      #
+      body {
+        shell(:no_resize) {
+          grid_layout {
+            margin_width 10
+            margin_height 10
+            vertical_spacing 0
+          }
+          
+          # Replace example content below with custom shell content
+          minimum_size 420, 540
+          image File.join(APP_ROOT, 'icons', 'windows', "Glimmer Wordle.ico") if OS.windows?
+          image File.join(APP_ROOT, 'icons', 'linux', "Glimmer Wordle.png") unless OS.windows?
+          text "Glimmer Wordle"
+          background :white
+          
+          app_menu_bar
+          
+          alphabets
+          
+          label {
+            layout_data :center, :center, true, false
+            text 'You have 6 tries to guess a 5-letter word'
+          }
+          
+          word_guesser
+          
+          guess_button
+        }
+      }
+      
+      def app_menu_bar
+        menu_bar {
+          menu {
+            text '&Game'
+            
+            menu_item {
+              text '&Restart'
+              
+              on_widget_selected {
+                do_restart
+              }
+            }
+            
+            menu_item {
+              text 'E&xit'
+              
+              on_widget_selected {
+                exit(0)
+              }
+            }
+          }
+          
+          menu {
+            text '&Help'
+            
+            menu_item {
+              text '&About...'
+              
+              on_widget_selected {
+                display_about_dialog
+              }
+            }
+          }
+        }
+      end
+  
+      def display_about_dialog
+        message_box(body_root) {
+          text 'About'
+          message "Glimmer Wordle #{VERSION}\n\n#{LICENSE}"
+        }.open
+      end
+      
+      def alphabets
+        alphabet_row(ALPHABET_ROW1) {
+          layout_data(:center, :center, true, false) {
+            width_hint 318
+            height_hint 50
+          }
+        }
+        
+        alphabet_row(ALPHABET_ROW2) {
+          layout_data(:center, :center, true, false) {
+            width_hint 288
+            height_hint 50
+          }
+        }
+        
+        alphabet_row(ALPHABET_ROW3) {
+          layout_data(:center, :center, true, false) {
+            width_hint 222
+            height_hint 50
+          }
+        }
+      end
+      
+      def alphabet_row(alphabet_characters, &block)
+        canvas {
+          block.call
+          background :white
+          
+          @alphabet_rectangles ||= []
+          @alphabet_borders ||= []
+          @alphabet_letters ||= []
+          alphabet_characters.each_with_index do |alphabet_character, i|
+            @alphabet_rectangles << rectangle(1 + i*32, @alphabet_row_offset_y, 28, 28) {
+              background :transparent
+              
+              @alphabet_borders << rectangle {
+                foreground :gray
+                line_width 2
+              }
+              
+              @alphabet_letters << text(alphabet_character) {
+                font style: :bold, height: 28
+              }
+            }
+          end
+        }
+      end
+      
+      def word_guesser
+        @canvasses ||= []
+        margin_x = 5
+        margin_y = 5
+        @canvasses << canvas {
+          layout_data(:center, :center, true, false) {
+            width_hint 230
+            height_hint 50
+          }
+          background :white
+          focus true
+          
+          @rectangles = []
+          @borders = []
+          @letters = []
+          5.times do |i|
+            @rectangles << rectangle(margin_x + i*45, margin_y, 40, 40) {
+              background :transparent
+              
+              @borders << rectangle {
+                foreground i == 0 ? :title_background : :gray
+                line_width 2
+              }
+              
+              @letters << text('') {
+                font style: :bold, height: 40
+              }
+            }
+          end
+        }
+      end
+      
+      def guess_button
+        @guess_button = button {
+          layout_data :center, :center, true, false
+          text 'Guess'
+          
+          on_widget_selected do
+            do_guess
+          end
+        }
+      end
+      
+      def do_backspace
+        @letter = @letters.find {|letter| letter.string == ''}
+        index = @letter ? @letters.index(@letter) - 1 : 4
+        @letter = @letters[index]
+        @letter.string = ''
+        if index > 0
+          @borders.each { |caret| caret.foreground = :gray}
+          @borders[index - 1].foreground = :title_background
+        end
+      end
+      
+      def do_guess
+        return if !word_filled_up?
+        word = @letters.map(&:string).join
+        if invalid_word?(word)
+          message_box {
+            text 'Invalid Word'
+            message "The word you entered is not an allowed guess!\n\nPlease try another word!"
+          }.open
+          return
+        end
+        guess_result = @five_letter_word.guess(word)
+        update_guess_word_background_colors(guess_result)
+        update_alphabet_background_colors
+        if @five_letter_word.status == :in_progress
+          @guess_button.dispose
+          body_root.content {
+            word_guesser
+            guess_button
+          }
+        else
+          @guess_button.dispose
+          body_root.content {
+            @restart_button = button {
+              layout_data :center, :center, true, false
+              text 'Restart'
+              focus true
+              
+              on_widget_selected do
+                do_restart
+              end
+            }
+          }
+          display_share_text_dialog
+        end
+        body_root.layout(true, true)
+        body_root.pack(true)
+      end
+      
+      def do_type(character)
+        @letter = @letters.find {|letter| letter.string == ''}
+        index = @letters.index(@letter)
+        if @letter
+          @borders.each { |caret| caret.foreground = :gray}
+          @borders[index == 4 ? 4 : index + 1].foreground = :title_background
+          @letter.string = character.upcase
+        end
+      end
+      
+      def do_restart
+        (ALPHABET_ROW1 + ALPHABET_ROW2 + ALPHABET_ROW3).each_with_index do |alphabet_character, i|
+          @alphabet_borders[i].foreground = :gray
+          @alphabet_rectangles[i].background = :white
+          @alphabet_letters[i].foreground = :black
+        end
+        @restart_button.dispose
+        @canvasses.dup.each(&:dispose)
+        @canvasses.clear
+        body_root.content { word_guesser }
+        body_root.layout(true, true)
+        body_root.pack(true)
+        @five_letter_word.refresh
+      end
+      
+      def update_guess_word_background_colors(guess_result)
+        guess_result.each_with_index do |result_color, i|
+          background_color = COLOR_TO_BACKGROUND_COLOR_MAP[result_color]
+          @borders[i].foreground = background_color
+          @rectangles[i].background = background_color
+          @letters[i].foreground = COLOR_TO_TEXT_COLOR_MAP[result_color]
+          async_exec { @canvasses.last.redraw }
+        end
+      end
+      
+      def update_alphabet_background_colors
+        (ALPHABET_ROW1 + ALPHABET_ROW2 + ALPHABET_ROW3).each_with_index do |alphabet_character, i|
+          result_color = @five_letter_word.colored_alphabets[alphabet_character.downcase]
+          if result_color
+            background_color = COLOR_TO_BACKGROUND_COLOR_MAP[result_color]
+            @alphabet_borders[i].foreground = background_color
+            @alphabet_rectangles[i].background = background_color
+            @alphabet_letters[i].foreground = COLOR_TO_TEXT_COLOR_MAP[result_color]
+          end
+        end
+      end
+      
+      def word_filled_up?
+        @letters.find {|letter| letter.string == ''}.nil?
+      end
+      
+      def invalid_word?(word)
+        !Model::FiveLetterWord::WORLD_ALLOWED_GUESSES.include?(word.downcase)
+      end
+      
+      def valid_character?(character)
+        ((65..90).to_a + (97..122).to_a).map {|n| n.chr}.include?(character)
+      end
+      
+      def display_share_text_dialog
+        result = ''
+        @five_letter_word.guess_results.each do |row|
+          row.each do |result_color|
+            case result_color
+            when :green
+              result << "🟩"
+            when :yellow
+              result << "🟨"
+            when :gray
+              result << "⬜"
+            end
+          end
+          result << "\n"
+        end
+  
+        Clipboard.copy(result)
+
+        dialog(body_root) {
+          grid_layout
+          text 'Share Result'
+          
+          label {
+            layout_data :center, :center, true, false
+            text 'Result is copied to clipboard!'
+          }
+          
+          styled_text {
+            layout_data :fill, :fill, true, true
+            editable false
+            caret nil
+            alignment :center
+            text result
+          }
+        }.open
+      end
+    end
+  end
+end

data/app/wordle.rb

@@ -0,0 +1,27 @@
+$LOAD_PATH.unshift(File.expand_path('..', __FILE__))
+
+begin
+  require 'bundler/setup'
+  Bundler.require(:default)
+rescue
+  # this runs when packaged as a gem (no bundler)
+  require 'glimmer-dsl-swt'
+  # add more gems if needed
+end
+
+Clipboard.implementation = Clipboard::Java
+Clipboard.copy(Clipboard.paste) # pre-initialize library to avoid slowdown during use
+
+class Wordle
+  include Glimmer
+  
+  APP_ROOT = File.expand_path('../..', __FILE__)
+  VERSION = File.read(File.join(APP_ROOT, 'VERSION'))
+  LICENSE = File.read(File.join(APP_ROOT, 'LICENSE.txt'))
+  
+  Display.app_name = 'Glimmer Wordle'
+  Display.app_version = VERSION
+end
+
+require 'wordle/model/five_letter_word'
+require 'wordle/view/app_view'

data/bin/glimmer_wordle

@@ -0,0 +1,13 @@
+#!/usr/bin/env jruby
+
+runner = File.expand_path('../../app/wordle/launch.rb', __FILE__)
+
+# Detect if inside a JAR file or not
+if runner.include?('uri:classloader')
+  require runner
+else
+  require 'glimmer/launcher'
+  
+  launcher = Glimmer::Launcher.new([runner] + ARGV)
+  launcher.launch
+end