Fix hole in CI README check (#2132)

* generate READMEs with a hints file to verify up-to-date

* regenerate READMEs that have hints.md

Author: cmccandless

bin/check-readmes.sh

@@ -1,5 +1,7 @@
 #!/bin/bash
 
+SPEC="${1:-spec}"
+
 get_timestamp()
 {
     path="$1"
@@ -8,15 +10,19 @@ get_timestamp()
 
 ret=0
 for exercise in $(ls -d exercises/*/); do
-    meta_dir="${exercise}.meta"
-    hints_file="${meta_dir}/HINTS.md"
+    exercise="${exercise%/}"
+    slug="$(basename "$exercise")"
+    meta_dir="${exercise}/.meta"
+    hints_file="${meta_dir}/hints.md"
+    readme="${exercise}/README.md"
     if [ -f "$hints_file" ]; then
-        hints_timestamp="$(get_timestamp "$hints_file")"
-        readme_timestamp="$(get_timestamp "${exercise}README.md")"
-        if [ "$hints_timestamp" -gt "$readme_timestamp" ]; then
-            ret=1
-            echo "$(basename "$exercise"): .meta/HINTS.md contents newer than README. Please regenerate README with configlet."
+        bin/configlet generate -p "$SPEC" -o "${slug}" .
+        if ! git diff --quiet "${readme}"; then
+            echo "$slug: README is out-of-date. Please regenerate README with configlet."
+        else
+            echo "$slug ok"
         fi
+        git checkout -- "${readme}"
     fi
 done
 

exercises/collatz-conjecture/README.md

@@ -31,7 +31,6 @@ Resulting in 9 steps. So for input n = 12, the return value would be 9.
 The Collatz Conjecture is only concerned with strictly positive integers, so your solution should raise a `ValueError` with a meaningful message if given 0 or a negative integer.
 
 
-
 ## Exception messages
 
 Sometimes it is necessary to raise an exception. When you do this, you should include a meaningful error message to

exercises/complex-numbers/README.md

@@ -33,7 +33,6 @@ Assume the programming language you are using does not have an implementation of
 See [Emulating numeric types](https://docs.python.org/2/reference/datamodel.html#emulating-numeric-types) for help on operator overloading.
 
 
-
 ## Exception messages
 
 Sometimes it is necessary to raise an exception. When you do this, you should include a meaningful error message to

exercises/diffie-hellman/README.md

@@ -54,7 +54,6 @@ cryptographically strong random numbers that provide the greater security requir
 Since this is only an exercise, `random` is fine to use, but note that **it would be
 very insecure if actually used for cryptography.**
 
-
 ## Exception messages
 
 Sometimes it is necessary to raise an exception. When you do this, you should include a meaningful error message to

exercises/dot-dsl/README.md

@@ -2,8 +2,8 @@
 
 A [Domain Specific Language
 (DSL)](https://en.wikipedia.org/wiki/Domain-specific_language) is a
-small language optimized for a specific domain. Since a DSL is
-targeted, it can greatly impact productivity/understanding by allowing the
+small language optimized for a specific domain. Since a DSL is 
+targeted, it can greatly impact productivity/understanding by allowing the 
 writer to declare *what* they want rather than *how*.
 
 One problem area where they are applied are complex customizations/configurations.
@@ -27,14 +27,14 @@ Write a Domain Specific Language similar to the Graphviz dot language.
 
 Our DSL is similar to the Graphviz dot language in that our DSL will be used
 to create graph data structures. However, unlike the DOT Language, our DSL will
-be an internal DSL for use only in our language.
+be an internal DSL for use only in our language. 
 
 More information about the difference between internal and external DSLs can be
 found [here](https://martinfowler.com/bliki/DomainSpecificLanguage.html).
 
 ## Description of DSL
 
-A graph, in this DSL, is an object of type `Graph`, taking a list of one
+A graph, in this DSL, is an object of type `Graph`, taking a list of one 
 or more
 
 + attributes
@@ -48,7 +48,6 @@ The implementations of `Node` and `Edge` provided in `dot_dsl.py`.
 Observe the test cases in `dot_dsl_test.py` to understand the DSL's design.
 
 
-
 ## Exception messages
 
 Sometimes it is necessary to raise an exception. When you do this, you should include a meaningful error message to

exercises/error-handling/README.md

@@ -19,7 +19,6 @@ class implements the following methods:
 - `do_something`, which may or may not throw an `Exception`.
 
 
-
 ## Exception messages
 
 Sometimes it is necessary to raise an exception. When you do this, you should include a meaningful error message to

exercises/matrix/README.md

@@ -40,10 +40,10 @@ And its columns:
 - 8, 3, 6
 - 7, 2, 7
 
-In this exercise you're going to create a **class**.  _Don't worry, it's not as complicated as you think!_
+In this exercise you're going to create a **class**.  _Don't worry, it's not as complicated as you think!_ 
 
--   [**A First Look at Classes**](https://docs.python.org/3/tutorial/classes.html#a-first-look-at-classes) from the Python 3 documentation.
--   [**How to Define a Class in Python**](https://realpython.com/python3-object-oriented-programming/#how-to-define-a-class-in-python) from the Real Python website.
+-   [**A First Look at Classes**](https://docs.python.org/3/tutorial/classes.html#a-first-look-at-classes) from the Python 3 documentation. 
+-   [**How to Define a Class in Python**](https://realpython.com/python3-object-oriented-programming/#how-to-define-a-class-in-python) from the Real Python website.  
 -   [**Data Structures in Python**](https://docs.python.org/3/tutorial/datastructures.html) from the Python 3 documentation.
 
 

exercises/minesweeper/README.md

@@ -10,7 +10,7 @@ In this exercise you have to create some code that counts the number of
 mines adjacent to a given empty square and replaces that square with the
 count.
 
-The board is a rectangle composed of blank space (' ') characters. A mine
+The board is a rectangle composed of blank space (' ') characters. A mine 
 is represented by an asterisk ('\*') character.
 
 If a given space has no adjacent mines at all, leave that square blank.
@@ -42,7 +42,6 @@ ValueError with a *meaningful* error message if the
 input turns out to be malformed.
 
 
-
 ## Exception messages
 
 Sometimes it is necessary to raise an exception. When you do this, you should include a meaningful error message to

exercises/ocr-numbers/README.md

@@ -80,7 +80,7 @@ Is converted to "123,456,789"
 
 ## Hints
 
-ocr.convert should validate its input and raise ValueErrors with meaningful error messages if necessary.
+Your converter should validate its input and raise a ValueError with a meaningful message if it receives a string that isn't a valid OCR number.
 
 
 ## Exception messages

exercises/simple-cipher/README.md

@@ -96,7 +96,6 @@ Since this is only an exercise, `random` is fine to use, but note that **it woul
 very insecure if actually used for cryptography.**
 
 
-
 ## Exception messages
 
 Sometimes it is necessary to raise an exception. When you do this, you should include a meaningful error message to