Add HTML file content matcher and fix unmatched tags in the html example template

Author: Sam Goldman

features/html_documentation.feature

@@ -57,10 +57,65 @@ Feature: Generate HTML documentation from test examples
 
   Scenario: Create an index of all API examples, including all resources and examples
     Then  the file "docs/index.html" should contain "<h2>Greetings</h2>"
-    And   the file "docs/index.html" should contain:
+    And   the file "docs/index.html" should contain HTML:
       """
-      <a href="greetings/greeting_your_favorite_gem.html">Greeting your favorite gem</a>
+      <h2>Greetings</h2>
+
+      <ul>
+          <li>
+            <a href="greetings/greeting_your_favorite_gem.html">Greeting your favorite gem</a>
+          </li>
+      </ul>
       """
 
-  Scenario: Create a file for each API example
-    Then  the file "docs/greetings/greeting_your_favorite_gem.html" should contain "<h2>Greeting your favorite gem</h2>"
+  Scenario: Example HTML documentation includes the parameters
+    Then  the file "docs/greetings/greeting_your_favorite_gem.html" should contain HTML:
+      """
+      <h3>Parameters</h3>
+      <table>
+        <thead>
+          <tr>
+            <th>Name</th>
+            <th>Description</th>
+          </tr>
+        </thead>
+        <tbody>
+          <tr>
+            <th>
+              <span class="name">target</span>
+            </th>
+            <td>
+              <span class="description">The thing you want to greet</span>
+            </td>
+          </tr>
+        </tbody>
+      </table>
+      """
+
+  Scenario: Example HTML documentation includes the request information
+    Then  the file "docs/greetings/greeting_your_favorite_gem.html" should contain HTML:
+      """
+      <h3>Request</h3>
+      <h4>Headers</h4>
+      <pre class="headers">Host: example.org
+      Cookie: </pre>
+      <h4>Route</h4>
+      <pre class="request highlight">GET /greetings?target=rspec_api_documentation</pre>
+      <h4>Query Parameters</h4>
+      <pre class="request highlight">target: rspec_api_documentation</pre>
+      """
+
+  Scenario: Example HTML documentation includes the response information
+    Then  the file "docs/greetings/greeting_your_favorite_gem.html" should contain HTML:
+      """
+      <h3>Response</h3>
+      <h4>Headers</h4>
+      <pre class="headers">Content-Type: application/json
+      Content-Length: 35</pre>
+      <h4>Status</h4>
+      <pre class="response_status">200 OK</pre>
+      <h4>Body</h4>
+      <pre class="response highlight">{
+      &quot;hello&quot;: &quot;rspec_api_documentation&quot;
+      }</pre>
+      """

features/step_definitions/html_steps.rb

@@ -0,0 +1,13 @@
+RSpec::Matchers.define :contain_ignoring_whitespace do |expected|
+  match do |actual|
+    insignificant_whitespace = /(^\s*)|(\s*$)/
+    actual.gsub(insignificant_whitespace, "").should =~ regexp(expected.gsub(insignificant_whitespace, ""))
+  end
+end
+
+Then /^the file "([^"]*)" should contain HTML:$/ do |file, partial_html|
+  prep_for_fs_check do
+    content = IO.read(file)
+    content.should contain_ignoring_whitespace(partial_html)
+  end
+end

templates/rspec_api_documentation/html_example.mustache

@@ -40,7 +40,7 @@
             <tbody>
               {{# parameters }}
               <tr>
-                <td{{# required }} class="required"{{/ required }}>
+                <th{{# required }} class="required"{{/ required }}>
                   <span class="name">{{ name }}</span>
                 </th>
                 <td>