sameerc77
diff --git a/‎README.md‎
Lines changed: 5 additions & 1 deletion b/‎README.md‎
Lines changed: 5 additions & 1 deletion
diff --git a/‎bin/compile.py‎
Lines changed: 1 addition & 0 deletions b/‎bin/compile.py‎
Lines changed: 1 addition & 0 deletions
diff --git a/‎book.md‎
Lines changed: 559 additions & 169 deletions b/‎book.md‎
Lines changed: 559 additions & 169 deletions
diff --git a/‎hangman/Makefile‎
Lines changed: 4 additions & 0 deletions b/‎hangman/Makefile‎
Lines changed: 4 additions & 0 deletions
diff --git a/‎hangman/README.md‎
Lines changed: 71 additions & 35 deletions b/‎hangman/README.md‎
Lines changed: 71 additions & 35 deletions
@@ -74,7 +74,11 @@ Notebooks are great for interactive exploration of data, especially if you want
 * Hard to test
 * No way to pass in arguments
 
-As I want you to learn 
+I believe you can better learn how to create testable, **reproducible** software by writing command-line programs that always run from beginning to end and have a test suite. It's difficult to achieve that with Notebooks, but I do encourage you to explore Notebooks on your own.
+
+## Code examples, the REPL
+
+I always love when a language has a good REPL (read-evaluate-print-loop) tool. Python and Haskell both excel in this respect. For simplicity's sake, I show the standard REPL when you execute `python3` on the command-line, but you won't be able to copy and paste the same code examples there. For your own purposes, I suggest using the iPython REPL (`ipython`) instead.
 
 ## Author
 
 
@@ -93,6 +93,7 @@ def main():
             fh.write('\n\n\\newpage\n\n')
 
         fh.write('\\setcounter{tocdepth}{2}\\tableofcontents\n\n')
+        fh.write('\n\\newpage\n\n')
 
         top_readme = 'README.md'
         if os.path.isfile(top_readme):
 
@@ -0,0 +1,4 @@
+.PHONY: test
+
+test:
+	pytest -xv hangman.py test.py
@@ -2,12 +2,14 @@
 
 Write a Python program called `hangman.py` that will play a game of Hangman which is a bit like "Wheel of Fortune" where you present the user with a number of elements indicating the length of a word. For our game, use the underscore `_` to indicate a letter that has not been guessed. The program should take `-n|--minlen` minimum length (default `5`) and `-l|--maxlen` maximum length options (default `10`) to indicate the minimum and maximum lengths of the randomly chosen word taken from the `-w|--wordlist` option (default `/usr/share/dict/words`). It also needs to take `-s|--seed` to for the random seed and the `-m|--misses` number of misses to allow the player.
 
-To play, you will initiate an inifinite loop and keep track of the game state, e.g., the word to guess, the letters already guessed, the letters found, the number of misses. As this is an interactive game, I cannot write an test suite, so you can play my version and then try to write one like it. If the user guesses a letter that is in the word, replace the `_` characters with the letter. If the user guesses the same letter twice, admonish them. If the user guesses a letter that is not in the word, increment the misses and let them know they missed. If the user guesses too many times, exit the game and insult them. If they correctly guess the word, let them know and exit the game.
+The game is intended to be interactive, but I want you to additionally take an `-i|--inputs` option that is a string of letters to use as guesses so that we can write a test.
+
+When run with the `-h|--help` flags, it should present a usage statement:
 
 ````
 $ ./hangman.py -h
 usage: hangman.py [-h] [-l MAXLEN] [-n MINLEN] [-m MISSES] [-s SEED]
-                  [-w WORDLIST]
+                  [-w WORDLIST] [-i INPUTS]
 
 Hangman
 
@@ -22,42 +24,76 @@ optional arguments:
   -s SEED, --seed SEED  Random seed (default: None)
   -w WORDLIST, --wordlist WORDLIST
                         Word list (default: /usr/share/dict/words)
-$ ./hangman.py
-_ _ _ _ _ _ _ _ (Misses: 0)
+  -i INPUTS, --inputs INPUTS
+                        Input choices (default: )
+````
+
+If given a bad `--wordlist`, error out (print the problem and exit with a non-zero status) with a message like so:
+
+````
+$ ./hangman.py -w kdfkj
+usage: hangman.py [-h] [-l MAXLEN] [-n MINLEN] [-m MISSES] [-s SEED]
+                  [-w WORDLIST] [-i INPUTS]
+hangman.py: error: argument -w/--wordlist: can't open 'kdfkj': [Errno 2] \
+No such file or directory: 'kdfkj'
+````
+
+If given a value less than 1 for `--minlen`, error out:
+
+````
+$ ./hangman.py -n -4
+usage: hangman.py [-h] [-l MAXLEN] [-n MINLEN] [-m MISSES] [-s SEED]
+                  [-w WORDLIST] [-i INPUTS]
+hangman.py: error: --minlen "-4" must be positive
+````
+
+If given a `--maxlen` value greater than 20, error out:
+
+````
+$ ./hangman.py -l 30
+usage: hangman.py [-h] [-l MAXLEN] [-n MINLEN] [-m MISSES] [-s SEED]
+                  [-w WORDLIST] [-i INPUTS]
+hangman.py: error: --maxlen "30" must be < 20
+````
+
+Error out if the `--minlen` is greater than the `--maxlen`:
+
+````
+$ ./hangman.py -l 5 -n 10
+usage: hangman.py [-h] [-l MAXLEN] [-n MINLEN] [-m MISSES] [-s SEED]
+                  [-w WORDLIST] [-i INPUTS]
+hangman.py: error: --minlen "10" is greater than --maxlen "5"
+````
+
+To play, you will initiate an inifinite loop and keep track of the game state, e.g., the word to guess, the letters already guessed, the letters found, the number of misses. As this is an interactive game, you will normally use the `input` function to get a letter from the user. If given `--inputs`, bypass the `input` prompt and instead use those letters in turn.
+
+If the user guesses a letter that is in the word, replace the `_` characters with the letter. If the user guesses the same letter twice, admonish them. If the user guesses a letter that is not in the word, increment the misses and let them know they missed. If the user guesses too many times, exit the game and insult them. If they correctly guess the word, let them know and exit the game.
+
+````
+$ ./hangman.py -s 2
+_ _ _ _ _ _ _ (Misses: 0)
 Your guess? ("?" for hint, "!" to quit) a
-_ _ _ _ _ _ _ _ (Misses: 1)
+There is no "a"
+_ _ _ _ _ _ _ (Misses: 1)
 Your guess? ("?" for hint, "!" to quit) i
-_ _ _ _ _ _ i _ (Misses: 1)
+There is no "i"
+_ _ _ _ _ _ _ (Misses: 2)
 Your guess? ("?" for hint, "!" to quit) e
-_ _ _ _ _ _ i _ (Misses: 2)
+_ _ _ _ _ _ e (Misses: 2)
 Your guess? ("?" for hint, "!" to quit) o
-_ o _ _ _ _ i _ (Misses: 2)
-Your guess? ("?" for hint, "!" to quit) u
-_ o _ _ _ _ i _ (Misses: 3)
-Your guess? ("?" for hint, "!" to quit) y
-_ o _ _ _ _ i _ (Misses: 4)
-Your guess? ("?" for hint, "!" to quit) c
-_ o _ _ _ _ i _ (Misses: 5)
-Your guess? ("?" for hint, "!" to quit) d
-_ o _ _ _ _ i _ (Misses: 6)
-Your guess? ("?" for hint, "!" to quit) p
-_ o _ _ _ _ i p (Misses: 6)
-Your guess? ("?" for hint, "!" to quit) m
-_ o _ _ _ _ i p (Misses: 7)
-Your guess? ("?" for hint, "!" to quit) n
-_ o _ _ _ _ i p (Misses: 8)
-Your guess? ("?" for hint, "!" to quit) s
-_ o s _ s _ i p (Misses: 8)
+o _ o _ _ _ e (Misses: 2)
+Your guess? ("?" for hint, "!" to quit) z
+o z o _ _ _ e (Misses: 2)
 Your guess? ("?" for hint, "!" to quit) t
-_ o s t s _ i p (Misses: 8)
-Your guess? ("?" for hint, "!" to quit) h
-You win. You guessed "hostship" with "8" misses!
-$ ./hangman.py -m 2
-_ _ _ _ _ _ _ _ _ _ (Misses: 0)
-Your guess? ("?" for hint, "!" to quit) a
-_ _ _ _ _ _ a _ _ a (Misses: 0)
-Your guess? ("?" for hint, "!" to quit) b
-_ _ _ _ _ _ a _ _ a (Misses: 1)
-Your guess? ("?" for hint, "!" to quit) c
-You lose, loser!  The word was "metromania."
+o z o t _ _ e (Misses: 2)
+Your guess? ("?" for hint, "!" to quit) p
+o z o t _ p e (Misses: 2)
+Your guess? ("?" for hint, "!" to quit) y
+You win. You guessed "ozotype" with "2" misses!
 ````
+
+Play the `solution.py` a few times to get a feel for how the game should work.
+
+Hints:
+
+* Leverage `get_args` and `argparse` to validate inputs. Use `type=argparse.FileType('r')` for the `--wordlist`. Check the value of `--minlen` and `--maxlen` inside `get_args` and use `parser.error` to error out.
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +.PHONY: test
++
 +test:
 +	pytest -xv hangman.py test.py