From 4a71d99d83fb8dcd3506e8995c1e6a3d1578ddc6 Mon Sep 17 00:00:00 2001
From: Tim <70119791+journich@users.noreply.github.com>
Date: Mon, 22 Feb 2021 09:20:13 +1030
Subject: [PATCH] cleanup

---
 51 Hurkle/java/Hurkle.iml          | 11 -----------
 51 Hurkle/java/src/Hurkle.java     | 25 ++++++++++++++++---------
 51 Hurkle/java/src/HurkleGame.java |  4 ++--
 3 files changed, 18 insertions(+), 22 deletions(-)
 delete mode 100644 51 Hurkle/java/Hurkle.iml

diff --git a/51 Hurkle/java/Hurkle.iml b/51 Hurkle/java/Hurkle.iml
deleted file mode 100644
index c90834f2..00000000
--- a/51 Hurkle/java/Hurkle.iml	
+++ /dev/null
@@ -1,11 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="JAVA_MODULE" version="4">
-  <component name="NewModuleRootManager" inherit-compiler-output="true">
-    <exclude-output />
-    <content url="file://$MODULE_DIR$">
-      <sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" />
-    </content>
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>
\ No newline at end of file
diff --git a/51 Hurkle/java/src/Hurkle.java b/51 Hurkle/java/src/Hurkle.java
index 8af8732f..5d3ebcbf 100644
--- a/51 Hurkle/java/src/Hurkle.java	
+++ b/51 Hurkle/java/src/Hurkle.java	
@@ -1,6 +1,14 @@
-import java.util.ArrayList;
 import java.util.Scanner;
 
+/**
+ * Game of Hiurkle
+ * <p>
+ * Based on the Basic game of Hurkle here
+ * https://github.com/coding-horror/basic-computer-games/blob/main/51%20Hurkle/hurkle.bas
+ * <p>
+ * Note:  The idea was to create a version of 1970's Basic game in Java, without introducing
+ * new features - no additional text, error checking, etc has been added.
+ */
 public class Hurkle {
 
     public static final int GRID_SIZE = 10;
@@ -17,7 +25,7 @@ public class Hurkle {
     private GAME_STATE gameState;
 
     // Used for keyboard input
-    private Scanner kbScanner;
+    private final Scanner kbScanner;
 
     private int guesses;
 
@@ -73,7 +81,7 @@ public class Hurkle {
                     } else {
                         showDirectionOfHurkle();
                         this.guesses++;
-                        if(this.guesses > MAX_GUESSES) {
+                        if (this.guesses > MAX_GUESSES) {
                             System.out.println("SORRY, THAT'S "
                                     + MAX_GUESSES + " GUESSES.");
                             System.out.println("THE HURKLE IS AT "
@@ -98,25 +106,24 @@ public class Hurkle {
 
     private void showDirectionOfHurkle() {
         System.out.print("GO ");
-        if(this.playerGuessYPos == this.hurkleYPos) {
+        if (this.playerGuessYPos == this.hurkleYPos) {
             // don't print North or South because the player has chosen the
             // same y grid pos as the hurkle
         } else if (this.playerGuessYPos < this.hurkleYPos) {
             System.out.print("NORTH");
-        } else if(this.playerGuessYPos > this.hurkleYPos) {
+        } else if (this.playerGuessYPos > this.hurkleYPos) {
             System.out.print("SOUTH");
         }
 
-        if(this.playerGuessXPos == this.hurkleXPos) {
+        if (this.playerGuessXPos == this.hurkleXPos) {
             // don't print East or West because the player has chosen the
             // same x grid pos as the hurkle
-        } else if(this.playerGuessXPos < this.hurkleXPos) {
+        } else if (this.playerGuessXPos < this.hurkleXPos) {
             System.out.print("EAST");
-        } else if(this.playerGuessXPos > this.hurkleXPos) {
+        } else if (this.playerGuessXPos > this.hurkleXPos) {
             System.out.print("WEST");
         }
         System.out.println();
-        return;
     }
 
     private boolean foundHurkle() {
diff --git a/51 Hurkle/java/src/HurkleGame.java b/51 Hurkle/java/src/HurkleGame.java
index c582885e..1b527398 100644
--- a/51 Hurkle/java/src/HurkleGame.java	
+++ b/51 Hurkle/java/src/HurkleGame.java	
@@ -1,7 +1,7 @@
 public class HurkleGame {
 
     public static void main(String[] args) {
-	    Hurkle hurkle = new Hurkle();
-	    hurkle.play();
+        Hurkle hurkle = new Hurkle();
+        hurkle.play();
     }
 }