Add a script to extract the solutions, and put them at the end of the book

marijnh · marijnh · commit 6872682dd843 · 2014-07-22T16:36:07.000+02:00
Also fix up some problems with hyperrefs Closes marijnh#85
diff --git a/01_values.txt b/01_values.txt
@@ -1,8 +1,8 @@
 :chap_num: 1
 :prev_link: 00_intro
 :next_link: 02_program_structure
+:docid: values
 
-[[values]]
 = Values, Types, and Operators =
 
 [quote, Master Yuan-Ma, The Book of Programming]
diff --git a/02_program_structure.txt b/02_program_structure.txt
@@ -2,7 +2,6 @@
 :prev_link: 01_values
 :next_link: 03_functions
 
-[[program_structure]]
 = Program Structure =
 
 [chapterquote="true"]
@@ -864,8 +863,9 @@ end of the introduction.
 
 Each exercise starts with a problem description. Read that and try to
 solve the exercise. If you run into problems, consider reading the
-hints after the exercise. Full solutions to the exercises are not
-included in this book, but you can find them online at
+hints (!html after the exercise!)(!tex at the link:solutions[end of the book]!).
+Full solutions to the exercises are not included in this
+book, but you can find them online at
 http://eloquentjavascript.net/exercises.html[_eloquentjavascript.net/exercises.html_].
 If you want to learn something from the exercises, I recommend looking
 at the solutions only after you've solved the exercise, or at least
diff --git a/03_functions.txt b/03_functions.txt
@@ -2,7 +2,6 @@
 :prev_link: 02_program_structure
 :next_link: 04_data
 
-[[functions]]
 = Functions =
 
 [chapterquote="true"]
@@ -415,7 +414,6 @@ one will tell you about it.
 indexsee:[optional argument,argument optional]
 
 [[power]]
-
 (((power example)))(((argument,optional)))(((optional arguments)))The
 upside is that this behavior can be used to have a function take
 “optional” arguments. For example, the following version of `power`
diff --git a/04_data.txt b/04_data.txt
@@ -3,7 +3,6 @@
 :next_link: 05_higher_order
 :load_files: ["code/jacques_journal.js", "code/chapter/04_data.js"]
 
-[[data]]
 = Data Structures: Objects and Arrays =
 
 [chapterquote="true"]
@@ -106,7 +105,6 @@ the element in the left-hand expression that corresponds to the _index_
 given by the expression in the brackets.
 
 [[array_indexing]]
-
 The first index of an array is zero, not one. So the first element can be read
 with `listOfNumbers[0]`. If you don't have a programming background,
 this convention might take some getting used to. But zero-based counting has a long
@@ -190,7 +188,7 @@ is also `toLowerCase`. You can guess what that does.
 Interestingly, even though the call to `toUpperCase` does not pass any
 arguments, the function somehow has access to the string
 `"Doh"`, the value whose property we called. How this works
-is described in link:06_object.html#methods[Chapter 6].
+is described in link:06_object.html#obj_methods[Chapter 6].
 
 Properties that contain functions are generally called _methods_ of
 the value they belong to. As in, “`toUpperCase` is a method of a
diff --git a/05_higher_order.txt b/05_higher_order.txt
@@ -3,7 +3,6 @@
 :next_link: 06_object
 :load_files: ["code/ancestry.js", "code/chapter/05_higher_order.js", "js/intro.js"]
 
-[[higher_order]]
 = Higher-Order Functions =
 
 ifdef::html_target[]
diff --git a/06_object.txt b/06_object.txt
@@ -65,7 +65,7 @@ has popularized. These are worth studying.
 This chapter describes JavaScript's rather eccentric take on objects,
 and the way they relate to some classical object-oriented techniques.
 
-[[methods]]
+[[obj_methods]]
 == Methods ==
 
 (((rabbit example)))(((method)))(((property)))Methods are simply
diff --git a/07_elife.txt b/07_elife.txt
@@ -3,7 +3,6 @@
 :next_link: 08_error
 :load_files: ["code/chapter/07_elife.js", "js/animateworld.js"]
 
-[[elife]]
 = Project: Electronic Life =
 
 [chapterquote="true"]
diff --git a/10_modules.txt b/10_modules.txt
@@ -3,7 +3,6 @@
 :next_link: 11_language
 :load_files: ["code/chapter/10_modules.js", "js/loadfile.js"]
 
-[[modules]]
 = Modules =
 
 ifdef::html_target[]
diff --git a/13_dom.txt b/13_dom.txt
@@ -3,7 +3,6 @@
 :next_link: 14_event
 :load_files: ["code/mountains.js", "code/chapter/13_dom.js"]
 
-[[dom]]
 = The Document Object Model =
 
 When you open a web page in your browser, it will retrieve the page's
diff --git a/15_game.txt b/15_game.txt
@@ -3,7 +3,6 @@
 :next_link: 16_canvas
 :load_files: ["code/chapter/15_game.js", "code/game_levels.js"]
 
-[[game]]
 = Project: A Platform Game =
 
 My initial fascination with computers, like that of many kids,
diff --git a/16_canvas.txt b/16_canvas.txt
@@ -3,7 +3,6 @@
 :next_link: 17_http
 :load_files: ["code/chapter/15_game.js", "code/game_levels.js", "code/chapter/16_canvas.js"]
 
-[[canvas]]
 = Drawing on Canvas =
 
 [chapterquote="true"]
diff --git a/17_http.txt b/17_http.txt
@@ -3,7 +3,6 @@
 :next_link: 18_forms
 :load_files: ["code/chapter/17_http.js", "js/promise.js"]
 
-[[http]]
 = HTTP =
 
 [chapterquote="true"]
diff --git a/18_forms.txt b/18_forms.txt
@@ -3,7 +3,6 @@
 :next_link: 19_paint
 :load_files: ["js/promise.js"]
 
-[[forms]]
 = Forms and Form Fields =
 
 [chapterquote="true"]
diff --git a/19_paint.txt b/19_paint.txt
@@ -3,7 +3,6 @@
 :next_link: 20_node
 :load_files: ["code/chapter/19_paint.js"]
 
-[[paint]]
 = Project: A Paint Program =
 
 The material from the previous chapters gives you all the elements you
diff --git a/20_node.txt b/20_node.txt
@@ -2,7 +2,6 @@
 :prev_link: 19_paint
 :next_link: 21_echo_chamber
 
-[[node]]
 = Node.js =
 
 [chapterquote="true"]
diff --git a/Makefile b/Makefile
@@ -23,18 +23,21 @@ code/solutions/20_4_a_public_space_on_the_web.zip: $(wildcard code/solutions/20_
 	rm -f $@
 	cd code/solutions; zip 20_4_a_public_space_on_the_web.zip 20_4_a_public_space_on_the_web/*
 
-tex: $(foreach CHAP,$(CHAPTERS),tex/$(CHAP).tex)
+tex: $(foreach CHAP,$(CHAPTERS),tex/$(CHAP).tex) tex/solutions.tex
 
-tex/%.tex: %.txt asciidoc_latex.conf
-	cat $< | node bin/pre_latex.js | asciidoc -f asciidoc_latex.conf --backend=latex -o - - | node bin/clean_latex.js > $@
+tex/solutions.tex: $(foreach CHAP,$(CHAPTERS),$(CHAP).txt) bin/extract_solutions.js
+	node bin/extract_solutions.js | node bin/pre_latex.js - | asciidoc -f asciidoc_latex.conf --backend=latex -o - - | node bin/clean_latex.js > $@
+
+tex/%.tex: %.txt asciidoc_latex.conf bin/pre_latex.js bin/clean_latex.js
+	node bin/pre_latex.js $< | asciidoc -f asciidoc_latex.conf --backend=latex -o - - | node bin/clean_latex.js > $@
 
 test: html
 	@for F in $(CHAPTERS); do echo Testing $$F:; node bin/run_tests.js $$F.txt; done
 	@! grep '[a-zA-Z0-9]_[—“”‘’]\|[—“”‘’]_[a-zA-Z0-9]\|[a-zA-Z0-9]`—\|[a-zA-Z0-9]`[a-zA-Z0-9]' *.txt
 	@node bin/check_links.js
 	@echo Done.
 
-book.pdf: tex/book/book.tex $(foreach CHAP,$(CHAPTERS),tex/$(CHAP).tex)
+book.pdf: tex/book/book.tex $(foreach CHAP,$(CHAPTERS),tex/$(CHAP).tex) tex/solutions.tex
 	cd tex/book && xelatex book.tex
 	cd tex/book && xelatex book.tex
 	makeindex -s tex/book/nostarch.ist -o tex/book/book.ind tex/book/book.idx
diff --git a/asciidoc_latex.conf b/asciidoc_latex.conf
@@ -38,17 +38,9 @@ subscript=_!..braceleft..!|!..braceright..!
 [http-inlinemacro]
 !..backslash..!href!..braceleft..!http:{target}!..braceright..!!..braceleft..!{0}!..braceright..!
 
-[blockdef-solution]
-delimiter=^!!solution!!$
-template=solution
-options=sectionbody
-
 [blockdef-listing]
 source-style=template="codeblock"
 
-[solution]
-{empty}
-
 [htmlonly-inlinemacro]
 {empty}
 
@@ -77,6 +69,7 @@ template::[openblock]
 {newline}
 
 [codeblock]
+\label\{{id}\}
 \begin\{Code\}{newline}
 |{newline}
 \end\{Code\}
@@ -89,6 +82,7 @@ template::[openblock]
 {newline}
 
 [paragraph]
+\label\{{id}\}
 |
 {newline}
 
diff --git a/bin/clean_latex.js b/bin/clean_latex.js
@@ -18,16 +18,16 @@ process.stdin.on("data", function(chunk) {
 });
 process.stdin.on("end", function() {
   checkUnicode(input);
-  input = input.replace(/(\n\n\\end{Code})|(\n{3,})|(_why,)|(\\chapter\{Introduction\})|\\hyperref\[((?:[^\]]|\\_\{\})+)\]|\\index\{([^|}]+?)\\textbar\{\}see\{([^}]+)}}/g,
-                        function(all, codeSpace, manyBlanks, why, intro, link, seeFrom, seeTo) {
+  input = input.replace(/(\n\n\\end{Code})|(\n{3,})|(_why,)|\\chapter\{(Introduction|Solutions to the Exercises)\}|\\hyperref\[((?:[^\]]|\\_\{\})+)\]|\\index\{([^|}]+?)\\textbar\{\}see\{([^}]+)}}/g,
+                        function(all, codeSpace, manyBlanks, why, simplechapter, link, seeFrom, seeTo) {
     if (codeSpace)
       return codeSpace.slice(1);
     if (manyBlanks)
       return "\n\n";
     if (why)
       return "\\_why,";
-    if (intro)
-      return "\\chapter*{Introduction}";
+    if (simplechapter)
+      return "\\chapter*{" + simplechapter + "}";
     if (link)
       return "\\hyperref[" + link.replace(/\\_\{\}/g, "_") + "]";
     if (seeFrom)
diff --git a/bin/extract_solutions.js b/bin/extract_solutions.js
@@ -0,0 +1,25 @@
+var fs = require("fs");
+
+process.stdout.write(":docid: solutions\n\n= Solutions to the Exercises =\n\nThe hints below might help when you are stuck with one of the exercises in this book. They don't ive away the entire solution, but rather try to help you find it yourself.\n\n");
+
+fs.readdirSync(".").forEach(function(name) {
+  var m = /^(\d\d.*)\.txt$/.exec(name);
+  if (!m) return;
+
+  var file = fs.readFileSync(name, "utf8");
+  var title = file.match(/\n= (.*?) =\n/)[1], titleWritten = false;
+
+  var curSubsection;
+  var re = /\n=== (.*?) ===|!!solution!!([^]+?)!!solution!!/g;
+  while (m = re.exec(file)) {
+    if (m[1]) {
+      curSubsection = m[1];
+    } else {
+      if (!titleWritten) {
+        process.stdout.write("== " + title + " ==\n\n");
+        titleWritten = true;
+      }
+      process.stdout.write("=== " + curSubsection + " ===\n\n" + m[2] + "\n");
+    }
+  }
+});
diff --git a/bin/pre_latex.js b/bin/pre_latex.js
@@ -4,16 +4,25 @@
 
 var fs = require("fs"), child = require("child_process");
 
+var infile = process.argv[2], instream;
+if (infile == "-") {
+  instream = process.stdin;
+  instream.resume();
+} else {
+  instream = fs.createReadStream(infile);
+}
+
 var titleCaseSmallWords = "a an the at by for in of on to up and as but it or nor if console.log".split(" ");
 
 var input = "";
-process.stdin.on("data", function(chunk) {
+instream.on("data", function(chunk) {
   input += chunk;
 });
-process.stdin.on("end", function() {
-  var docid = /($|\n)\[\[(.*?)\]\]\n= /.exec(input);
-  if (docid) input = ":docid: " + docid[2] + "\n" + input;
-  process.stdout.write(input.replace(/\n===? (.*?) ===?|”([.,:;])|\nimage::img\/(.+?)\.(svg)|link:[^\.]+\.html#(.*?)\[/g, function(match, title, quoted, imgName, imgType, link) {
+instream.on("end", function() {
+  if (infile != "-")
+    input = ":docid: " + infile.match(/^\d{2}_(.*?)\.txt/)[1] + "\n" + input;
+  process.stdout.write(input.replace(/\n===? (.*?) ===?|”([.,:;])|\nimage::img\/(.+?)\.(svg)|link:[^\.]+\.html#(.*?)\[|!!(solution)!![^]+?!!solution!!(?:\n|$)/g,
+                                     function(match, title, quoted, imgName, imgType, link, solution) {
     if (title) { // Section title, must be converted to title case
       var kind = /^\n(=*)/.exec(match)[1];
       return "\n" + kind + " " + title.split(" ").map(function(word) {
@@ -28,10 +37,11 @@ process.stdin.on("end", function() {
       return "\nimage::" + convertImage(imgName, imgType);
     } else if (link) {
       return "link:" + link + "[";
+    } else if (solution) {
+      return "";
     }
   }));
 });
-process.stdin.resume();
 
 function convertImage(name, type) {
   if (type == "svg") {
diff --git a/tex/book/book.tex b/tex/book/book.tex
@@ -128,6 +128,8 @@
 
 \input{../21_skillsharing.tex}
 
+\input{../solutions.tex}
+
 \backmatter
 
 \printindex
