DO NOT MERGE: Examples for #386

.travis.yml

@@ -6,6 +6,7 @@ script:
 - "sh ./_test/ensure-stubs-compile.sh"
 - "sh ./_test/count-ignores.sh"
 - "./bin/fetch-configlet"
+- "sh ./_test/ensure-readmes-are-updated.sh"
 - "./bin/configlet lint ."
 sudo: false
 rust:

_test/ensure-readmes-are-updated.sh

@@ -0,0 +1,40 @@
+if [ ! -x bin/configlet ]; then
+   echo "Improper configuration; configlet should exist in bin/ when this script is run"
+   echo "Ping a Rust track maintainer to fix this"
+   exit 1
+fi
+
+if [ ! -d "problem-specifications" ]; then
+   git clone https://github.com/exercism/problem-specifications.git problem-specifications
+fi
+
+newline=$'\n  '
+
+missing_readmes=""
+wrong_readmes=""
+for exercise in $(git diff --name-only master..$(git rev-parse --abbrev-ref HEAD) | grep exercises/ | cut -d'/' -f2 -s | sort -fu); do
+   echo "Checking readme for $exercise"
+   readme_path="exercises/${exercise}/README.md"
+   if [ ! -f $readme_path ]; then
+      missing_readmes="$missing_readmes$newline$exercise"
+   else
+      existing_readme_checksum=$(md5sum $readme_path | cut -d' ' -f1)
+      # generate the new README
+      bin/configlet generate . --only "$exercise" --spec-path "problem-specifications"
+      generated_readme_checksum=$(md5sum $readme_path | cut -d' ' -f1)
+
+      if [ $existing_readme_checksum != $generated_readme_checksum ]; then
+         wrong_readmes="$wrong_readmes$newline$exercise"
+      fi
+   fi
+done
+
+if [ -n "$missing_readmes" ]; then
+  echo "Exercises missing README.md:$missing_readmes"
+fi
+if [ -n "$wrong_readmes" ]; then
+  echo "Exercises with out-of-date README.md:$wrong_readmes"
+fi
+if [ -n "$missing_readmes" -o -n "$wrong_readmes" ]; then
+   exit 1
+fi

exercises/crypto-square/README.md

@@ -107,3 +107,4 @@ J Dalbey's Programming Practice problems [http://users.csc.calpoly.edu/~jdalbey/
 
 ## Submitting Incomplete Solutions
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
+bogus line

exercises/hello-world/README.md

@@ -52,3 +52,4 @@ This is an exercise to introduce users to using Exercism [http://en.wikipedia.or
 
 ## Submitting Incomplete Solutions
 It's possible to submit an incomplete solution so you can see how others have completed the exercise.
+another bogus line

exercises/rectangles/README.md

@@ -37,27 +37,27 @@ The above diagram contains 6 rectangles:
 ```
 
 ```text
-       
-       
+
+
    +--+
    |  |
    +--+
 ```
 
 ```text
-       
-       
+
+
 +--+
 |  |
 +--+
 ```
 
 ```text
-       
-  ++   
-  ++   
-       
-       
+
+  ++
+  ++
+
+
 ```
 
 You may assume that the input is always a proper rectangle (i.e. the length of

exercises/two-bucket/README.md

@@ -7,15 +7,15 @@ Since this mathematical problem is fairly subject to interpretation / individual
 To help, the tests provide you with which bucket to fill first. That means, when starting with the larger bucket full, you are NOT allowed at any point to have the smaller bucket full and the larger bucket empty (aka, the opposite starting point); that would defeat the purpose of comparing both approaches!
 
 Your program will take as input:
-- the size of bucket one, passed as a numeric value
-- the size of bucket two, passed as a numeric value
-- the desired number of liters to reach, passed as a numeric value
-- which bucket to fill first, passed as a Bucket (either Bucket::One or Bucket::Two)
+- the size of bucket one
+- the size of bucket two
+- the desired number of liters to reach
+- which bucket to fill first, either bucket one or bucket two
 
 Your program should determine:
-- the total number of "moves" it should take to reach the desired number of liters, including the first fill - expects a numeric value
-- which bucket should end up with the desired number of liters (let's say this is bucket A) - expects a Bucket (either Bucket::One or Bucket::Two)
-- how many liters are left in the other bucket (bucket B) - expects a numeric value
+- the total number of "moves" it should take to reach the desired number of liters, including the first fill
+- which bucket should end up with the desired number of liters (let's say this is bucket A) - either bucket one or bucket two
+- how many liters are left in the other bucket (bucket B)
 
 Note: any time a change is made to either or both buckets counts as one (1) move.