move h2 out of source files

meta/chapters.txt

@@ -1,84 +1,84 @@
-hello-world
+Hello World
-# values
+# Values
-# variables
+# Variables
-# inline-assignment
+# Short Declarations
-# constants
+# Constants
-# for
+# For
-# if-else
+# If/Else
-# switch
+# Switch
-# arrays
+# Arrays
-# slices
+# Slices
-# maps
+# Maps
-# range
+# Range
-# functions
+# Functions
-# multiple-return-values
+# Multiple Return Values
-# varadic-functions
+# Varadic Functions
-# closures
+# Closures
-# recursion
+# Recursion
-# defer
+# Defer
-# panic
+# Panic
-# pointers
+# Pointers
-# new
+# New
-# structs
+# Structs
-# methods
+# Methods
-# embedding
+# Embedding
-# interfaces
+# Interfaces
-# errors
+# Errors
-# ok-guards
+# OK Guards
-# goroutines
+# Goroutines
-# concurrent-goroutines
+# Concurrent Goroutines
-# channels
+# Channels
-# channel-buffering
+# Channel Buffering
-# channel-directions
+# Channel Directions
-# synchronization
+# Synchronization
-# select
+# Select
-# timeouts
+# Timeouts
-# scatter-gather
+# Scatter Gather
-# rate-limiting
+# Rate Limiting
-# worker-pools
+# Worker Pools
-# non-blocking-channel-operations
+# Non-Blocking Channel Operations
-# closing-channels
+# Closing Channels
-timers
+Timers
-tickers
+Tickers
-# state-goroutine
+# State Goroutine
-# state-mutex
+# State Mutex
-sorting
+Sorting
-sorting-by-functions
+Sorting by Functions
-# collection-functions
+# Collection Functions
-# string-functions
+# String Functions
-# string-formatting
+# String Formatting
-# regexs
+# Regexs
-# bytes
+# Bytes
-# json
+# JSON
-# time
+# Time
-# epochs
+# Epochs
-# elapsed-time
+# Elapsed Time
-# random-numbers
+# Random Numbers
-# number-parsing
+# Number Parsing
-# urls
+# URLs
-# sha1-hashes
+# SHA1 Hashes
-# base64-encoding
+# Base64 Encoding
-# reading-files
+# Reading Files
-# writing-files
+# Writing Files
-line-filters
+Line Filters
-# command-line-arguments
+# Command-Line Arguments
-# command-line-flags
+# Command-Line Flags
-# environment-variables
+# Environment Variables
-# spawning-processes
+# Spawning Processes
-# execing-processes
+# Execing Processes
-# signals
+# Signals
-# exit
+# Exit
-# http-client
+# HTTP Client
-# https-client
+# HTTPS Client
-# redis
+# Redis
-# postgres
+# Postgres
-# hello-web
+# Hello Web
-# responses
+# Responses
-# request-routing
+# Request Routing
-# request-logging
+# Request Logging
-# static-content
+# Static Content
-# basic-authentication
+# Basic Authentication
-# canonical-hosts
+# Canonical Hosts
-# middleware
+# Middleware
-# graceful-shutdown
+# Graceful Shutdown
-# https-servers
+# HTTPS Servers

src/arrays/arrays.go

@@ -1,5 +1,3 @@
-// ## Arrays
-
 package main
 
 import "fmt"

src/base64-encoding/base64-encoding.go

@@ -1,5 +1,3 @@
-// ## Base64 Encoding
-
 package main
 
 import b64 "encoding/base64"

src/basic-authentication/basic-authentication.go

@@ -1,5 +1,3 @@
-// ## Basic Authentication
-
 package main
 
 import (

src/bytes/bytes.go

@@ -1,5 +1,3 @@
-// ## Bytes
-
 package main
 
 import "fmt"

src/canonical-hosts/canonical-hosts.go

@@ -1,5 +1,3 @@
-// ## Canonical Hosts
-
 package main
 
 import "net/http"

src/channel-buffering/channel-buffering.go

@@ -1,5 +1,3 @@
-// ## Channel Buffering
-
 package main
 
 import "fmt"

src/channel-directions/channel-directions.go

@@ -1,5 +1,3 @@
-// ## Channel Directions
-
 package main
 
 import "fmt"

src/channels/channels.go

@@ -1,5 +1,3 @@
-// ## Channels
-
 package main
 
 import "fmt"

src/closing-channels/closing-channels.go

@@ -1,5 +1,3 @@
-// ## Closing Channels
-
 package main
 
 import "fmt"

src/closures/closures.go

@@ -1,5 +1,3 @@
-// ## Closures
-
 package main
 
 import "fmt"

src/collection-functions/collection-functions.go

@@ -1,5 +1,3 @@
-// ## Collection Functions
-
 package main
 
 import "strings"
@@ -92,4 +90,4 @@ func main() {
     fmt.Println()
 }
 
-// todo: generics
+// todo: note no generics

src/command-line-arguments/command-line-arguments.go

@@ -1,5 +1,3 @@
-// ## Command Line Arguments
-
 // Use `os.Args` to access command-line arguments and
 // the name of the program.
 package main

src/command-line-flags/command-line-flags.go

@@ -1,5 +1,3 @@
-// ## Command Line Flags
-
 package main
 
 import "flag"

src/concurrent-goroutines/concurrent-goroutines.go

@@ -1,5 +1,3 @@
-// ## Concurrent Goroutines
-
 package main
 
 import "time"

src/constants/constants.go

@@ -1,5 +1,3 @@
-// ## Constants
-
 package main
 
 import "fmt"

src/defer/defer.go

@@ -1,5 +1,3 @@
-// ## Defer
-
 package main
 
 import "fmt"

src/elapsed-time/elapsed-time.go

@@ -1,5 +1,3 @@
-// ## Elapsed Time
-
 package main
 
 import "time"

src/embedding/embedding.go

@@ -1,5 +1,3 @@
-// ## Embedding
-
 package main
 
 import "math"

src/environment-variables/environment-variables.go

@@ -1,5 +1,3 @@
-// ## Environment Variables
-
 package main
 
 // Use the `os` package to list, set, and get environment

src/epochs/epochs.go

@@ -1,5 +1,3 @@
-// ## Epochs
-
 // A common requirement in programms is getting the number
 // of seconds, milliseconds, or nanoseconds since the Unix
 // epoch. Here's how to do it in Go.

src/errors/errors.go

@@ -1,5 +1,3 @@
-// ## Errors
-
 package main
 
 import (

src/execing-processes/execing-processes.go

@@ -1,5 +1,3 @@
-// ## Exec'ing Processes
-
 // In the previous chapter we looked at spawning external
 // process. We do this when we need the functionality
 // of another process accessable to a running Go process.

src/exit/exit.go

@@ -1,5 +1,3 @@
-// ## Exit
-
 // Use `os.Exit` to immediatly exit with a given
 // status.
 

src/for/for.go

@@ -1,5 +1,3 @@
-// ## For
-
 // `for` is Go's only looping construct. Here are
 // two common forms.
 package main

src/functions/functions.go

@@ -1,5 +1,3 @@
-// ## Functions
-
 // Funcations are critical in Go as in any other language.
 // We'll look at some basic examples first.
 

src/goroutines/goroutines.go

@@ -1,5 +1,3 @@
-// ## Goroutines
-
 package main
 
 import "fmt"

src/graceful-shutdown/graceful-shutdown.go

@@ -1,5 +1,3 @@
-// ## Graceful Shutdown
-
 package main
 
 import (
@@ -96,8 +94,5 @@ func main() {
     }
 }
 
-// todo: clean up logging
+// todo: pull in work from gobyexample-server
-// todo: limit shutdown time
 // todo: factor out to cut-and-pastable against normal app
-// todo: credit http://blog.nella.org/?p=879
-// todo: comment about tcp servers

src/hello-web/hello-web.go

@@ -1,5 +1,3 @@
-// ## Hello Web
-
 package main
 
 import "net/http"

src/hello-world/hello-world.go

@@ -1,5 +1,3 @@
-// ## Hello World
-
 // Our first program will print the classic "Hello world"`
 // message. Here's the full source code.
 package main

src/http-client/http-client.go

@@ -1,5 +1,3 @@
-// ## HTTP Client
-
 package main
 
 import "net/http"

src/https-client/https-client.go

@@ -1,5 +1,3 @@
-// ## HTTPS Client
-
 package main
 
 import "net/http"

src/https-servers/https-servers.go

@@ -1,5 +1,3 @@
-// ## HTTPS Servers
-
 package main
 
 import "net/http"

src/if-else/if-else.go

@@ -1,6 +1,5 @@
-// ## If/Else
+// If/else in Go is straight-forward.
 
-// If/else in go is straight-forward
 package main
 
 import "fmt"

src/inline-assignment/inline-assignment.sh

@@ -1,2 +0,0 @@
-$ go run inline-assignment.go
-Hello assignment

src/interfaces/interfaces.go

@@ -1,5 +1,3 @@
-// ## Interfaces
-
 package main
 
 import "fmt"

src/json/json.go

@@ -1,5 +1,3 @@
-// ## JSON
-
 package main
 
 import "encoding/json"

src/line-filters/line-filters.go

@@ -1,5 +1,3 @@
-// ## Line Filters
-
 // A _line filter_ is a common type of program that reads
 // input on stdin, processes it, and then prints some
 // derived result to stdout. `grep` and `sed` are common

src/maps/maps.go

@@ -1,5 +1,3 @@
-// ## Maps
-
 // Maps are Go's built-in associative data type (sometimes
 // called "hashes" or "dicts" in other languages).
 

src/methods/methods.go

@@ -1,5 +1,3 @@
-// ## Methods
-
 package main
 
 import "fmt"

src/middleware/middleware.go

@@ -1,5 +1,3 @@
-// ## Middleware
-
 package main
 
 import "net/http"

src/multiple-return-values/multiple-return-values.go

@@ -1,5 +1,3 @@
-// ## Multiple Return Values
-
 // Go has built-in support for multiple return values.
 // This feature is used often in idiomatic Go, for example
 // to return both result and error values from a function.

src/new/new.go

@@ -1,5 +1,3 @@
-// ## New
-
 package main
 
 import "fmt"

src/non-blocking-channel-operations/non-blocking-channel-operations.go

@@ -1,5 +1,3 @@
-// ## Non-blocking Channel Operations
-
 package main
 
 import "fmt"

src/number-parsing/number-parsing.go

@@ -1,5 +1,3 @@
-// ## Number Parsing
-
 package main
 
 // Package `strconv` provides the number parsing.

src/ok-guards/ok-guards.go

@@ -1,5 +1,3 @@
-// ## OK Guards
-
 package main
 
 import "fmt"

src/panic/panic.go

@@ -1,5 +1,3 @@
-// ## Panic
-
 // A `panic` means something went unexpectedly wrong.
 // Mostly we use it to fail fast on errors that
 // shouldn't occur during normal operation.

src/pointers/pointers.go

@@ -1,5 +1,3 @@
-// ## Pointers
-
 package main
 
 import "fmt"

src/postgres/postgres.go

@@ -1,5 +1,3 @@
-// ## Postgres
-
 package main
 
 import _ "github.com/bmizerany/pq"

src/random-numbers/random-numbers.go

@@ -1,5 +1,3 @@
-// ## Random Numbers
-
 package main
 
 // The `math/rand` package provides psuedo-random

src/range/range.go

@@ -1,5 +1,3 @@
-// ## Range
-
 package main
 
 import "fmt"

src/rate-limiting/rate-limiting.go

@@ -1,4 +1,3 @@
-// ## Rate Limiting
 package main
 
 import "time"

src/reading-files/reading-files.go

@@ -1,5 +1,3 @@
-// ## Reading files
-
 package main
 
 import "io/ioutil"

src/recursion/recursion.go

@@ -1,5 +1,3 @@
-// ## Recursion
-
 package main
 
 import "fmt"

src/redis/redis.go

@@ -1,5 +1,3 @@
-// ## Redis
-
 package main
 
 import "github.com/fzzbt/radix/redis"

src/regexs/regexs.go

@@ -1,5 +1,3 @@
-// ## Regexs
-
 package main
 
 import "regexp"

src/request-logging/request-logging.go

@@ -1,5 +1,3 @@
-// ## Request Logging
-
 package main
 
 import "net/http"

src/request-routing/request-routing.go

@@ -1,5 +1,3 @@
-// ## HTTP Server Routing
-
 package main
 
 import "github.com/bmizerany/pat"

src/responses/responses.go

@@ -1,5 +1,3 @@
-// ## Responses
-
 package main
 
 import "net/http"

src/scatter-gather/scatter-gather.go

@@ -1,5 +1,3 @@
-// ## Scatter-Gather
-
 package main
 
 import "sync"

src/select/select.go

@@ -1,5 +1,3 @@
-// ## Select
-
 package main
 
 import "time"

src/sha1-hashes/sha1-hashes.go

@@ -1,5 +1,3 @@
-// ## SHA1 Hashes
-
 package main
 
 // Package `crypto/sha1` computes SHA1 hashes.

src/short-declarations/short-declarations.go

@@ -1,11 +1,9 @@
-// ## Inline Assignment
-
 package main
 
 import "fmt"
 
 func main() {
     // `x := val` is shorthand for `var x type = val`.
-    x := "Hello assignment"
+    x := "Hello var"
     fmt.Println(x)
 }

src/short-declarations/short-declarations.sh

@@ -0,0 +1,2 @@
+$ go run short-declarations.go
+Hello var

src/signals/signals.go

@@ -1,5 +1,3 @@
-// ## Signals
-
 // Sometines we'd like our Go programs to intelligently
 // handle Unix signals. For example, we might want a
 // server to gracefully shutdown when it receives a

src/slices/slices.go

@@ -1,5 +1,3 @@
-// ## Slices
-
 package main
 
 import "fmt"

src/sorting-by-functions/sorting-by-functions.go

@@ -1,5 +1,3 @@
-// ## Sorting by Functions
-
 // Sometimes we'll want to sort a collection by something
 // other than its natural order. For example, suppose we
 // wanted to sort strings by their length instead of

src/sorting/sorting.go

@@ -1,5 +1,3 @@
-// ## Sorting
-
 // Go's `sort` package implements sorting for builtins
 // and user-defined types. We'll look at sorting for
 // builtins first.

src/spawning-processes/spawning-processes.go

@@ -1,5 +1,3 @@
-// ## Spawning Processes
-
 // Sometimes our Go programs need to spawn other, non-Go
 // processes. For example, the syntax highlighting in this
 // book is implementing by spawning a [`pygmentize`]()

src/state-goroutine/state-goroutine.go

@@ -1,5 +1,3 @@
-// ## State Goroutine
-
 package main
 
 import "fmt"

src/state-mutex/state-mutex.go

@@ -1,5 +1,3 @@
-// ## State Mutex
-
 package main
 
 import "fmt"
@@ -64,3 +62,5 @@ func main() {
     finalOpCount := atomic.LoadInt64(&opCount)
     fmt.Println(finalOpCount)
 }
+
+// todo: "State with Mutexes?"

src/static-content/static-content.go

@@ -1,5 +1,3 @@
-// ## Static Content
-
 package main
 
 import "net/http"

src/string-formatting/string-formatting.go

@@ -1,5 +1,3 @@
-// ## String Formatting
-
 package main
 
 import "fmt"

src/string-functions/string-functions.go

@@ -1,5 +1,3 @@
-// ## String Functions
-
 // The standard library's `strings` package provides many
 // useful string-related functions. 
 

src/structs/structs.go

@@ -1,5 +1,3 @@
-// ## Structs
-
 package main
 
 import "fmt"

src/switch/switch.go

@@ -1,5 +1,3 @@
-// ## Switch
-
 // Switch statements allow...
 
 package main

src/synchronization/synchronization.go

@@ -1,5 +1,3 @@
-// ## Synchronization
-
 // We can use channels to synchronize execution
 // accross goroutines. Here's an example of waiting
 // for another goroutine to finish.

src/tickers/tickers.go

@@ -1,5 +1,3 @@
-// ## Tickers
-
 // [Timers](timers) are for when you want to do
 // something once in the future - tickers are for when you
 // want to do something repeatedly at regular intervals.

src/time/time.go

@@ -1,5 +1,3 @@
-// ## Time
-
 package main
 
 import "time"

src/timeouts/timeouts.go

@@ -1,5 +1,3 @@
-// ## Timeouts
-
 package main
 
 import "time"

src/timers/timers.go

@@ -1,5 +1,3 @@
-// ## Timers
-
 // We often want to execute Go code at some point in the
 // future, or repeatedly at some interval. Go's built-in
 // timer and ticker features make both of these tasks

src/urls/urls.go

@@ -1,5 +1,3 @@
-// ## URLs
-
 package main
 
 import "fmt"

src/values/values.go

@@ -1,5 +1,3 @@
-// ## Values
-
 // Go has various value types, including strings,
 // different types of numbers, booleans, etc.
 package main

src/varadic-functions/varadic-functions.go

@@ -1,5 +1,3 @@
-// ## Varadic Functions
-
 // Varadic functions can be called with any number of
 // trailing arguments. This is useful if you don't know
 // number of arguments that will be needed for a function

src/variables/variables.go

@@ -1,5 +1,3 @@
-// ## Variables
-
 package main
 
 import "fmt"

src/worker-pools/worker-pools.go

@@ -1,5 +1,3 @@
-// ## Worker Pools
-
 package main
 
 import "time"

src/writing-files/writing-files.go

@@ -1,11 +1,9 @@
-// ## Writing Files
-
 package main
 
 import "os"
 
 func main() {
-    file, err := os.Create("xx-file-write.txt")
+    file, err := os.Create("writing-files.txt")
     if err != nil {
         panic(err)
     }

template/chapter.tmpl

@@ -17,6 +17,7 @@
   </script>
   <body>
     <div class="chapter" id="{{.Id}}">
+      <h2>{{.Name}}</h2>
       <table cellspacing="0" cellpadding="0">
         <tbody>
         {{range .Segs}}

tool/generate.go

@@ -130,7 +130,6 @@ type Chapter struct {
 func parseSegs(sourcePath string) []*Seg {
     lines := readLines(sourcePath)
     segs := []*Seg{}
-    segs = append(segs, &Seg{Code: "", Docs: ""})
     lastSeen := ""
     for _, line := range lines {
         if line == "" {
@@ -142,9 +141,8 @@ func parseSegs(sourcePath string) []*Seg {
         }
         matchDocs := docsPat.MatchString(line)
         matchCode := !matchDocs
-        lastSeg := segs[len(segs)-1]
+        newDocs := (lastSeen == "") || ((lastSeen != "docs") && (segs[len(segs)-1].Docs != ""))
-        newDocs := (lastSeen == "") || ((lastSeen != "docs") && (lastSeg.Docs != ""))
+        newCode := (lastSeen == "") || ((lastSeen != "code") && (segs[len(segs)-1].Code != ""))
-        newCode := (lastSeen == "") || ((lastSeen != "code") && (lastSeg.Code != ""))
         if newDocs || newCode {
             debug("NEWSEG")
         }
@@ -154,7 +152,7 @@ func parseSegs(sourcePath string) []*Seg {
                 newSeg := Seg{Docs: trimmed, Code: ""}
                 segs = append(segs, &newSeg)
             } else {
-                lastSeg.Docs = lastSeg.Docs + "\n" + trimmed
+                segs[len(segs)-1].Docs = segs[len(segs)-1].Docs + "\n" + trimmed
             }
             debug("DOCS: " + line)
             lastSeen = "docs"
@@ -163,7 +161,7 @@ func parseSegs(sourcePath string) []*Seg {
                 newSeg := Seg{Docs: "", Code: line}
                 segs = append(segs, &newSeg)
             } else {
-                lastSeg.Code = lastSeg.Code + "\n" + line
+                segs[len(segs)-1].Code = segs[len(segs)-1].Code + "\n" + line
             }
             debug("CODE: " + line)
             lastSeen = "code"
@@ -187,15 +185,16 @@ func parseAndRenderSegs(sourcePath string) []*Seg {
 }
 
 func parseChapters() []*Chapter {
-    chapterLines := readLines("meta/chapters.txt")
+    chapterNames := readLines("meta/chapters.txt")
     chapters := make([]*Chapter, 0)
-    for _, chapterId := range chapterLines {
+    for _, chapterName := range chapterNames {
-        if (chapterId != "") && !strings.HasPrefix(chapterId, "#") {
+        if (chapterName != "") && !strings.HasPrefix(chapterName, "#") {
-            chapter := Chapter{Id: chapterId}
+            chapter := Chapter{Name: chapterName}
-            chapterLines := readLines("src/" + chapterId + "/" + chapterId + ".go")
+            chapterId := strings.ToLower(chapterName)
-            chapter.Name = chapterLines[0][6:]
+            chapterId = strings.Replace(chapterId, " ", "-", -1)
-            chapterPath := "src/" + chapterId
+            chapterId = strings.Replace(chapterId, "/", "-", -1)
-            sourcePaths := mustGlob(chapterPath + "/*")
+            chapter.Id = chapterId
+            sourcePaths := mustGlob("src/" + chapterId + "/*")
             segs := []*Seg{}
             for _, sourcePath := range sourcePaths {
                 sourceSegs := parseAndRenderSegs(sourcePath)